Ruby

Expunge Deleted Messages and Close the Mailbox

Demonstrates the Chilkat Imap.ExpungeAndClose method, which permanently removes all messages marked with \Deleted from the selected mailbox and then closes the mailbox. This example marks a message deleted and then expunges-and-closes.

Background: This combines two actions into one call: the permanent removal of \Deleted messages (see Expunge) followed by closing the mailbox (see CloseMailbox), returning the session to the authenticated-but-no-mailbox-selected state while staying connected. It's the natural way to finish working with a mailbox after cleaning it up, before selecting another or logging out.

Chilkat Ruby Downloads

Download Chilkat for Ruby

Ruby

require 'chilkat'

success = false

#  Demonstrates the Imap.ExpungeAndClose method, which permanently removes all messages
#  marked with \Deleted from the selected mailbox and then closes the mailbox.

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

#  Mark message (sequence number 1) with the \Deleted flag.
success = imap.SetFlag(1,false,"\Deleted",1)
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

#  Remove the \Deleted messages and close the mailbox in one step.
success = imap.ExpungeAndClose()
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

print "Expunged and closed the mailbox." + "\n";

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