B4X

Fetch the Flags Set on an IMAP Message

Demonstrates the Chilkat Imap.FetchFlags method, which returns the flags currently set on a single message as a space-separated string. The first argument is the message ID and the second (bUid) selects UID vs sequence number. This example fetches and prints the flags for one message identified by UID.

Background: The returned string is the server's current flag list for the message, such as \Seen \Flagged. This is a quick way to check a single message's state — for example, to decide whether it still needs processing — without downloading the message itself. To read the same information from a message you already have as an Email object, use GetMailFlag instead.

Chilkat B4X Downloads

Download Chilkat for B4X

B4X

Dim success As Boolean = False

'  Demonstrates the Imap.FetchFlags method, which returns the flags currently set on a single
'  message as a space-separated string.  The 1st argument is the message ID and the 2nd (bUid)
'  selects UID vs sequence number.

Dim imap As ChilkatImap
imap.Initialize("imap")

imap.Ssl = True
imap.Port = 993

success = imap.Connect("imap.example.com")
If success = False Then
    Log(imap.LastErrorText)
    Return
End If

success = imap.Login("user@example.com", "myPassword")
If success = False Then
    Log(imap.LastErrorText)
    Return
End If


success = imap.SelectMailbox("Inbox")
If success = False Then
    Log(imap.LastErrorText)
    Return
End If


Dim msgSet As ChilkatMessageSet
msgSet.Initialize
success = imap.QueryMbx("ALL", True, msgSet)
If success = False Then
    Log(imap.LastErrorText)
    Return
End If


If msgSet.Count > 0 Then
    Dim uid As Long = msgSet.GetId(0)
    '  FetchFlags returns a string, so assign it to a string variable and check for success.
    Dim flags As String = imap.FetchFlags(uid, True)
    If imap.LastMethodSuccess = False Then
        Log(imap.LastErrorText)
        Return
    End If

    Log("UID " & uid & " flags: " & flags)
End If


success = imap.Disconnect
If success = False Then
    Log(imap.LastErrorText)
    Return
End If