Ruby

Set a Single Flag on One IMAP Message

Demonstrates the Chilkat Imap.SetFlag method, which sets or clears a single flag on one message identified by ID. The first argument is the message ID, the second (bUid) selects UID vs sequence number, the third is the flag name, and the fourth is the value (1 to set, 0 to clear). This example flags one message as Deleted and then calls Expunge to permanently remove it.

Background: Deleting an IMAP message is a two-step process by design: setting the Deleted flag only marks the message, and Expunge is what actually removes every message so marked. This separation lets a client show "deleted" items and offer an undo before the change becomes permanent. SetFlag handles one flag on one message; use StoreFlags to change several flags at once, or SetFlags to update a whole MessageSet.

Chilkat Ruby Downloads

Download Chilkat for Ruby

Ruby

require 'chilkat'

success = false

#  Demonstrates the Imap.SetFlag method, which sets or clears a single flag on one message
#  identified by ID.  The 1st argument is the message ID, the 2nd (bUid) selects UID vs
#  sequence number, the 3rd is the flag name, and the 4th is the value (1 to set, 0 to clear).

imap = Chilkat::CkImap.new()

imap.put_Ssl(true)
imap.put_Port(993)

success = imap.Connect("imap.example.com")
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

success = imap.Login("user@example.com","myPassword")
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

success = imap.SelectMailbox("Inbox")
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

msgSet = Chilkat::CkMessageSet.new()
success = imap.QueryMbx("ALL",true,msgSet)
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

if (msgSet.get_Count() > 0)
    #  Mark the first message for deletion.  The "Deleted" flag is later acted upon by Expunge.
    uid = msgSet.GetId(0)
    success = imap.SetFlag(uid,true,"Deleted",1)
    if (success == false)
        print imap.lastErrorText() + "\n";
        exit
    end

    #  Permanently remove all messages flagged as Deleted.
    success = imap.Expunge()
    if (success == false)
        print imap.lastErrorText() + "\n";
        exit
    end

    print "Deleted UID " + uid.to_s() + "\n";
end

success = imap.Disconnect()
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end