(Ruby) Process Large POP3 Mailbox

Demonstrates how to read email from a mailbox that may contain a large number of emails.

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

require 'chilkat'

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

mailman = Chilkat::CkMailMan.new()

mailman.put_MailHost("pop.example.com")

mailman.put_PopUsername("myLogin")
mailman.put_PopPassword("myPassword")

mailman.put_MailPort(995)
mailman.put_PopSsl(true)

# Get the list of UIDLs for all emails in the mailbox.
# sa is a CkStringArray
sa = mailman.GetUidls()
if (mailman.get_LastMethodSuccess() == false)
    print mailman.lastErrorText() + "\n";
    exit
end

numEmails = sa.get_Count()
if (numEmails == 0)
    print "Mailbox is empty" + "\n";
    exit
end

chunkSize = 6

# Download the emails in chunks of 6 emails each.
chunkBeginIdx = 0
chunkEndIdx = chunkSize - 1
if (chunkEndIdx >= numEmails)
    chunkEndIdx = numEmails - 1
end

saChunk = Chilkat::CkStringArray.new()
while (chunkBeginIdx < numEmails)

    print chunkBeginIdx.to_s() + " to " + chunkEndIdx.to_s() + "\n";

    # Build a chunk of UIDLs.
    saChunk.Clear()
    for i in chunkBeginIdx .. chunkEndIdx
        saChunk.Append(sa.getString(i))
    end

    # Log the UIDLs in this chunk...
    chunkStr = saChunk.saveToText()
    print chunkStr + "\n";

    # Download this chunk of email from the POP3 server.
    # bundle is a CkEmailBundle
    bundle = mailman.FetchMultiple(saChunk)
    if (mailman.get_LastMethodSuccess() == false)
        print mailman.lastErrorText() + "\n";
        exit
    end

    print "Downloaded " + bundle.get_MessageCount().to_s() + " emails." + "\n";
    print "----" + "\n";

    # Process the bundle...
    # (your application's processing code goes here...)

    # Get the next chunk...
    chunkBeginIdx = chunkBeginIdx + chunkSize
    chunkEndIdx = chunkEndIdx + chunkSize
    if (chunkEndIdx >= numEmails)
        chunkEndIdx = numEmails - 1
    end

end