Visual Basic 6.0

Set an IMAP Flag Using an Email Object

Demonstrates the Chilkat Imap.SetMailFlag method, which sets or clears a flag on the server for the message represented by an Email object. The first argument is the Email, the second is the flag name, and the third is the value (1 to set, 0 to clear). This example flags each fetched message as Flagged on the server.

Background: SetMailFlag is convenient when you already hold an Email from a fetch: Chilkat uses the UID it recorded on that object to target the right message on the server, so you do not have to track IDs yourself. It updates both the server and the local Email object, keeping the two in sync. Under the hood this is the same STORE operation as SetFlag — just addressed by object rather than by raw ID.

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.SetMailFlag method, which sets or clears a flag on the server for the
'  message represented by an Email object.  The 1st argument is the Email, the 2nd is the flag
'  name, and the 3rd 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("UNSEEN",1,msgSet)
If (success = 0) Then
    Debug.Print imap.LastErrorText
    Exit Sub
End If

Dim bundle As New ChilkatEmailBundle
success = imap.FetchMsgSet(1,msgSet,bundle)
If (success = 0) Then
    Debug.Print imap.LastErrorText
    Exit Sub
End If

Dim email As New ChilkatEmail
Dim i As Long
For i = 0 To bundle.MessageCount - 1
    success = bundle.EmailAt(i,email)
    '  Mark this message as Flagged on the server.  A value of 1 sets the flag; 0 would clear it.
    success = imap.SetMailFlag(email,"Flagged",1)
    If (success = 0) Then
        Debug.Print imap.LastErrorText
        Exit Sub
    End If

Next

Debug.Print "Flagged " & bundle.MessageCount & " messages."

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