Visual Basic 6.0

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 Visual Basic 6.0 Downloads

Download Chilkat for Visual Basic 6.0

Visual Basic 6.0

Dim success As Long
success = 0

'  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 ChilkatImap

imap.Ssl = 1
imap.Port = 993

success = imap.Connect("imap.example.com")
If (success = 0) Then
    Debug.Print imap.LastErrorText
    Exit Sub
End If

success = imap.Login("user@example.com","myPassword")
If (success = 0) Then
    Debug.Print imap.LastErrorText
    Exit Sub
End If

success = imap.SelectMailbox("Inbox")
If (success = 0) Then
    Debug.Print imap.LastErrorText
    Exit Sub
End If

Dim msgSet As New MessageSet
success = imap.QueryMbx("ALL",1,msgSet)
If (success = 0) Then
    Debug.Print imap.LastErrorText
    Exit Sub
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 Long
    uid = msgSet.GetId(0)
    success = imap.SetFlag(uid,1,"Deleted",1)
    If (success = 0) Then
        Debug.Print imap.LastErrorText
        Exit Sub
    End If

    '  Permanently remove all messages flagged as Deleted.
    success = imap.Expunge()
    If (success = 0) Then
        Debug.Print imap.LastErrorText
        Exit Sub
    End If

    Debug.Print "Deleted UID " & uid
End If

success = imap.Disconnect()
If (success = 0) Then
    Debug.Print imap.LastErrorText
    Exit Sub
End If