(Ruby) IMAP Download All Email One at a Time

Demonstrates how to download every email in an IMAP mailbox one at a time as a MIME string or as an email object. (The MIME contains the full contents of the email including all attachments.)

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

require 'chilkat'

imap = Chilkat::CkImap.new()

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

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

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

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

# Once the mailbox is selected, the NumMessages property
# will contain the number of messages in the mailbox.
# You may loop from 1 to NumMessages to
# fetch each message by sequence number.

bUid = false

n = imap.get_NumMessages()
for i in 1 .. n

    # Download the email by sequence number.
    mimeStr = imap.fetchSingleAsMime(i,bUid)

    # ... your application may process each MIME string...
end

# An alternative is to download each email in the form of an
# email object, like this:

for i in 1 .. n

    # Download the email by sequence number.
    # email is a CkEmail
    email = imap.FetchSingle(i,bUid)

    # ... your application may process the email object...

end

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