Xojo Plugin

Mark IMAP Email as Read/Unread (Seen/Unseen)

Demonstrates how to mark emails as read or unread. Xojo Plugin

Dim success As Boolean
success = False

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

Dim imap As New Chilkat.Imap

// Connect to an IMAP server.
// Use TLS
imap.Ssl = True
imap.Port = 993
success = imap.Connect("imap.example.com")
If (success = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

// Login
success = imap.Login("myLogin","myPassword")
If (success = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

// Select an IMAP mailbox
success = imap.SelectMailbox("Inbox")
If (success = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

// Set PeekMode so that downloaded messages are not
// automatically marked as seen.
imap.PeekMode = True

// The NumMessages property contains the number of messages 
// in the currently selected mailbox.
Dim numMsgs As Int32
numMsgs = imap.NumMessages
If (numMsgs = 0) Then
    Return
End If

Dim email As New Chilkat.Email
Dim i As Int32
For i = 1 To numMsgs
    // Download each email by sequence number (not UID)
    success = imap.FetchEmail(False,i,False,email)
    If (success = False) Then
        System.DebugLog(imap.LastErrorText)
        Return
    End If

    // If desired, mark the email as SEEN.  There are two
    // ways to do it:

    // 1) Set the flag directly by using the sequence number
    // Indicate that we are passing a sequence number and
    // not a UID:
    Dim bIsUid As Boolean
    bIsUid = False
    // Set the SEEN flag = 1 to mark the email as SEEN,
    // or set it to 0 to mark it as not-seen.
    success = imap.SetFlag(i,bIsUid,"SEEN",1)
    If (success = False) Then
        System.DebugLog(imap.LastErrorText)
        Return
    End If

    // 2) Alternatively, we can use the email object.
    // When an email is downloaded from the IMAP server
    // Chilkat will add a "ckx-imap-uid" header to the email.
    // This makes it possible to know the UID associated with
    // the email.  (This is not the sequence number, which may change
    // from session to session, but the UID which does not change.
    // The SetMailFlag method is identical to SetFlag, except
    // it gets the UID from the ckx-imap-uid header.
    // For example:
    success = imap.SetMailFlag(email,"SEEN",1)
    If (success = False) Then
        System.DebugLog(imap.LastErrorText)
        Return
    End If

Next

// Disconnect from the IMAP server.
success = imap.Disconnect()