Tcl Requires Chilkat v11.0.0+

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

Demonstrates how to mark emails as read or unread. Tcl

load ./chilkat.dll

set success 0

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

set imap [new_CkImap]

#  Connect to an IMAP server.
#  Use TLS
CkImap_put_Ssl $imap 1
CkImap_put_Port $imap 993
set success [CkImap_Connect $imap "imap.example.com"]
if {$success == 0} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

#  Login
set success [CkImap_Login $imap "myLogin" "myPassword"]
if {$success == 0} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

#  Select an IMAP mailbox
set success [CkImap_SelectMailbox $imap "Inbox"]
if {$success == 0} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

#  Set PeekMode so that downloaded messages are not
#  automatically marked as seen.
CkImap_put_PeekMode $imap 1

#  The NumMessages property contains the number of messages 
#  in the currently selected mailbox.
set numMsgs [CkImap_get_NumMessages $imap]
if {$numMsgs == 0} then {
    delete_CkImap $imap
    exit
}

set email [new_CkEmail]

for {set i 1} {$i <= $numMsgs} {incr i} {
    #  Download each email by sequence number (not UID)
    set success [CkImap_FetchEmail $imap 0 $i 0 $email]
    if {$success == 0} then {
        puts [CkImap_lastErrorText $imap]
        delete_CkImap $imap
        delete_CkEmail $email
        exit
    }

    #  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:
    set bIsUid 0
    #  Set the SEEN flag = 1 to mark the email as SEEN,
    #  or set it to 0 to mark it as not-seen.
    set success [CkImap_SetFlag $imap $i $bIsUid "SEEN" 1]
    if {$success == 0} then {
        puts [CkImap_lastErrorText $imap]
        delete_CkImap $imap
        delete_CkEmail $email
        exit
    }

    #  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:
    set success [CkImap_SetMailFlag $imap $email "SEEN" 1]
    if {$success == 0} then {
        puts [CkImap_lastErrorText $imap]
        delete_CkImap $imap
        delete_CkEmail $email
        exit
    }

}

#  Disconnect from the IMAP server.
set success [CkImap_Disconnect $imap]

delete_CkImap $imap
delete_CkEmail $email