(Ruby) Scan for Emails with Attachments and Save Attachments to Files

Scan for emails with attachments and save attachments.

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 requires 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

# We can choose to fetch UIDs or sequence numbers.
fetchUids = true

# Get the message IDs of all the emails in the mailbox
messageSet = Chilkat::CkMessageSet.new()
success = imap.QueryMbx("ALL",fetchUids,messageSet)
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

# Fetch the email headers into a bundle object:
bundle = Chilkat::CkEmailBundle.new()
headersOnly = true
success = imap.FetchMsgSet(headersOnly,messageSet,bundle)
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

# Scan for emails with attachments, and save the attachments
# to a sub-directory.
fullEmail = Chilkat::CkEmail.new()
emailHeader = Chilkat::CkEmail.new()
i = 0
while i < bundle.get_MessageCount()
    # The bundle contains email headers..
    bundle.EmailAt(i,emailHeader)

    # Does this email have attachments?
    # Use GetMailNumAttach because the attachments
    # are not actually in the email object because
    # we only downloaded headers.
    numAttach = imap.GetMailNumAttach(emailHeader)

    if (numAttach > 0)
        # Download the entire email and save the
        # attachments. (Remember, we 
        # need to download the entire email because
        # only the headers were previously downloaded.

        # The ckx-imap-uid header field is added when
        # headers are downloaded.  This makes it possible
        # to get the UID from the email object.
        uidStr = emailHeader.getHeaderField("ckx-imap-uid")
        uid = uidStr.to_i()

        success = imap.FetchEmail(false,uid,true,fullEmail)
        if (success == false)
            print imap.lastErrorText() + "\n";
            exit
        end

        success = fullEmail.SaveAllAttachments("attachmentsDir")

        for j in 0 .. numAttach - 1
            filename = imap.getMailAttachFilename(emailHeader,j)
            print filename + "\n";
        end

    end

    i = i + 1
end

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