(Ruby) Delete IMAP Email

To delete an email, the "Deleted" flag must be set to 1 for each message to be deleted. You must also call Expunge or ExpungeAndClose to remove the emails marked as deleted.

Note: This example requires Chilkat v11.0.0 or greater.

Chilkat Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

success = false

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

# This example deletes email matching a criteria from Inbox.
imap = Chilkat::CkImap.new()

# Turn on session logging:
imap.put_KeepSessionLog(true)

# 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

fetchUids = true
# Get the message IDs for all emails having "FTP2" in the subject.
messageSet = Chilkat::CkMessageSet.new()
success = imap.QueryMbx("SUBJECT FTP2",fetchUids,messageSet)
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

# Set the Deleted flag for each message:
success = imap.SetFlags(messageSet,"Deleted",1)
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

# Expunge and close the mailbox.
success = imap.ExpungeAndClose()
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

# Display the session log.
print imap.sessionLog() + "\n";

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