Xojo Plugin

Refresh an Email Object's IMAP Flags

Demonstrates the Chilkat Imap.RefetchMailFlags method, which updates the flags stored on an Email object to the current values on the server. The only argument is the Email object. This example re-reads the flags for a previously fetched message and then checks its Seen state.

Background: Flags are shared mailbox state, so between the time you fetch a message and the time you act on it, another client (a phone, a webmail tab) may have marked it read, flagged, or deleted. RefetchMailFlags pulls just the flags — not the whole message — so a long-running job can cheaply re-check the live state before deciding what to do, avoiding acting on stale information.

Chilkat Xojo Plugin Downloads

Download Chilkat for Xojo Plugin

Xojo Plugin

Dim success As Boolean
success = False

//  Demonstrates the Imap.RefetchMailFlags method, which updates the flags stored on an Email
//  object to the current values on the server.  The only argument is the Email object.

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

Dim bundle As New Chilkat.EmailBundle
success = imap.FetchMsgSet(True,msgSet,bundle)
If (success = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

Dim email As New Chilkat.Email
If (bundle.MessageCount > 0) Then
    success = bundle.EmailAt(0,email)

    //  Re-read the flags from the server, in case another client changed them since the fetch.
    success = imap.RefetchMailFlags(email)
    If (success = False) Then
        System.DebugLog(imap.LastErrorText)
        Return
    End If

    Dim seen As Int32
    seen = imap.GetMailFlag(email,"Seen")
    System.DebugLog("Current Seen state: " + Str(seen))
End If

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