Ruby Requires Chilkat v11.0.0+

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

Demonstrates how to mark emails as read or unread. Ruby

require 'chilkat'

success = false

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

imap = Chilkat::CkImap.new()

#  Connect to an IMAP server.
#  Use TLS
imap.put_Ssl(true)
imap.put_Port(993)
success = imap.Connect("imap.example.com")
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

#  Login
success = imap.Login("myLogin","myPassword")
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

#  Select an IMAP mailbox
success = imap.SelectMailbox("Inbox")
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

#  Set PeekMode so that downloaded messages are not
#  automatically marked as seen.
imap.put_PeekMode(true)

#  The NumMessages property contains the number of messages 
#  in the currently selected mailbox.
numMsgs = imap.get_NumMessages()
if (numMsgs == 0)
    exit
end

email = Chilkat::CkEmail.new()

for i in 1 .. numMsgs
    #  Download each email by sequence number (not UID)
    success = imap.FetchEmail(false,i,false,email)
    if (success == false)
        print imap.lastErrorText() + "\n";
        exit
    end

    #  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:
    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)
        print imap.lastErrorText() + "\n";
        exit
    end

    #  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)
        print imap.lastErrorText() + "\n";
        exit
    end

end

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