B4X

Store One or More Flags on a Single Message

Demonstrates the Chilkat Imap.StoreFlags method, which sets or clears one or more flags on a single message identified by ID. The first argument is the message ID, the second (bUid) selects UID vs sequence number, the third is a space-separated list of flag names, and the fourth is the value (1 to set, 0 to clear). This example applies the Seen and Flagged flags to one message by UID.

Background: StoreFlags is the single-message counterpart to SetFlags and lets you change several flags at once by listing them space-separated (without leading backslashes). Because the ID can be either a UID or a sequence number, the bUid argument must match how you obtained it — a UID from a UID search, or a sequence number from a sequence-based operation. UIDs are the safer choice since they remain valid as the mailbox changes.

Chilkat B4X Downloads

Download Chilkat for B4X

B4X

Dim success As Boolean = False

'  Demonstrates the Imap.StoreFlags method, which sets or clears one or more flags on a single
'  message identified by ID.  The 1st argument is the message ID, the 2nd (bUid) selects UID
'  vs sequence number, the 3rd is a space-separated list of flag names, and the 4th is the
'  value (1 to set, 0 to clear).

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


'  Get the UIDs of all messages.
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
    '  Apply the Seen and Flagged flags to the first message.  bUid is True because the ID
    '  came from a UID search.
    Dim uid As Long = msgSet.GetId(0)
    success = imap.StoreFlags(uid, True, "Seen Flagged", 1)
    If success = False Then
        Log(imap.LastErrorText)
        Return
    End If

    Log("Updated flags on UID " & uid)
End If


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