Xbase++ Requires Chilkat v11.0.0+

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

Demonstrates how to mark emails as read or unread. Xbase++

LOCAL nSuccess
LOCAL oImap
LOCAL nNumMsgs
LOCAL oEmail
LOCAL i
LOCAL nBIsUid

nSuccess := 0

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

oImap := CreateObject("Chilkat.Imap")

//  Connect to an IMAP server.
//  Use TLS
oImap:Ssl := 1
oImap:Port := 993
nSuccess := oImap:Connect("imap.example.com")
IF (nSuccess == 0)
    ? oImap:LastErrorText
    oImap:destroy()
    RETURN
ENDIF

//  Login
nSuccess := oImap:Login("myLogin", "myPassword")
IF (nSuccess == 0)
    ? oImap:LastErrorText
    oImap:destroy()
    RETURN
ENDIF

//  Select an IMAP mailbox
nSuccess := oImap:SelectMailbox("Inbox")
IF (nSuccess == 0)
    ? oImap:LastErrorText
    oImap:destroy()
    RETURN
ENDIF

//  Set PeekMode so that downloaded messages are not
//  automatically marked as seen.
oImap:PeekMode := 1

//  The NumMessages property contains the number of messages 
//  in the currently selected mailbox.
nNumMsgs := oImap:NumMessages
IF (nNumMsgs == 0)
    oImap:destroy()
    RETURN
ENDIF

oEmail := CreateObject("Chilkat.Email")

FOR i := 1 TO nNumMsgs
    //  Download each email by sequence number (not UID)
    nSuccess := oImap:FetchEmail(0, i, 0, oEmail)
    IF (nSuccess == 0)
        ? oImap:LastErrorText
        oImap:destroy()
        oEmail:destroy()
        RETURN
    ENDIF

    //  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:
    nBIsUid := 0
    //  Set the SEEN flag = 1 to mark the email as SEEN,
    //  or set it to 0 to mark it as not-seen.
    nSuccess := oImap:SetFlag(i, nBIsUid, "SEEN", 1)
    IF (nSuccess == 0)
        ? oImap:LastErrorText
        oImap:destroy()
        oEmail:destroy()
        RETURN
    ENDIF

    //  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:
    nSuccess := oImap:SetMailFlag(oEmail, "SEEN", 1)
    IF (nSuccess == 0)
        ? oImap:LastErrorText
        oImap:destroy()
        oEmail:destroy()
        RETURN
    ENDIF

NEXT

//  Disconnect from the IMAP server.
nSuccess := oImap:Disconnect()

oImap:destroy()
oEmail:destroy()