Xojo Plugin

Set a Single Flag on One IMAP Message

Demonstrates the Chilkat Imap.SetFlag method, which sets or clears a single flag on one message identified by ID. The first argument is the message ID, the second (bUid) selects UID vs sequence number, the third is the flag name, and the fourth is the value (1 to set, 0 to clear). This example flags one message as Deleted and then calls Expunge to permanently remove it.

Background: Deleting an IMAP message is a two-step process by design: setting the Deleted flag only marks the message, and Expunge is what actually removes every message so marked. This separation lets a client show "deleted" items and offer an undo before the change becomes permanent. SetFlag handles one flag on one message; use StoreFlags to change several flags at once, or SetFlags to update a whole MessageSet.

Chilkat Xojo Plugin Downloads

Download Chilkat for Xojo Plugin

Xojo Plugin

Dim success As Boolean
success = False

//  Demonstrates the Imap.SetFlag method, which sets or clears a single flag on one message
//  identified by ID.  The 1st argument is the message ID, the 2nd (bUid) selects UID vs
//  sequence number, the 3rd is the flag name, and the 4th is the value (1 to set, 0 to clear).

Dim imap As New Chilkat.Imap

imap.Ssl = True
imap.Port = 993

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

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

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

Dim msgSet As New Chilkat.MessageSet
success = imap.QueryMbx("ALL",True,msgSet)
If (success = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

If (msgSet.Count > 0) Then
    //  Mark the first message for deletion.  The "Deleted" flag is later acted upon by Expunge.
    Dim uid As UInt32
    uid = msgSet.GetId(0)
    success = imap.SetFlag(uid,True,"Deleted",1)
    If (success = False) Then
        System.DebugLog(imap.LastErrorText)
        Return
    End If

    //  Permanently remove all messages flagged as Deleted.
    success = imap.Expunge()
    If (success = False) Then
        System.DebugLog(imap.LastErrorText)
        Return
    End If

    System.DebugLog("Deleted UID " + Str(uid))
End If

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