Ruby

Fetch a Set of POP3 Messages by UIDL

Demonstrates the Chilkat MailMan.FetchUidlSet method, which retrieves the messages whose UIDLs are listed in a StringTable and appends them to an EmailBundle. The arguments are the UIDL StringTable, headersOnly, numBodyLines, and the EmailBundle. This example fetches two specific messages by UIDL.

Background: This is the efficient way to download a selected subset of a mailbox in one call — exactly the pattern for an incremental client: list the mailbox UIDLs, compare against the ones you've already stored, and fetch only the new UIDLs as a set. It avoids re-downloading messages you already have while still pulling everything new in a single operation.

Chilkat Ruby Downloads

Download Chilkat for Ruby

Ruby

require 'chilkat'

success = false

#  Demonstrates the MailMan.FetchUidlSet method, which retrieves the messages whose UIDLs are
#  listed in a StringTable and appends them to an EmailBundle.  The arguments are the UIDL
#  StringTable, headersOnly, numBodyLines, and the EmailBundle.  The messages remain on the
#  server.

mailman = Chilkat::CkMailMan.new()

#  Configure the POP3 server connection.
mailman.put_MailHost("pop.example.com")
mailman.put_MailPort(995)
mailman.put_PopSsl(true)
mailman.put_PopUsername("user@example.com")
mailman.put_PopPassword("myPassword")

#  Build the set of UIDLs to fetch.
uidls = Chilkat::CkStringTable.new()
uidls.Append("0000000123abcdef")
uidls.Append("0000000124abcdef")

#  Fetch the listed messages (full bodies) into a bundle.
#  headersOnly=false (fetch the entire message).
#  Note: numBodyLines only applies when headersOnly is true (it sets how many lines of the
#  body to include along with the headers).  When headersOnly is false, the entire message
#  is fetched and numBodyLines is ignored.
bundle = Chilkat::CkEmailBundle.new()

success = mailman.FetchUidlSet(uidls,false,0,bundle)
if (success == false)
    print mailman.lastErrorText() + "\n";
    exit
end

n = bundle.get_MessageCount()
print "Fetched " + n.to_s() + " messages." + "\n";

email = Chilkat::CkEmail.new()

for i in 0 .. n - 1
    success = bundle.EmailAt(i,email)
    print email.subject() + "\n";
end

#  Note: Explicitly connecting/authenticating is optional.  Chilkat MailMan automatically
#  connects and authenticates -- using the property settings above -- whenever a server
#  operation requires it.  Calling the explicit connect/authenticate methods can still be
#  helpful to determine whether a failure occurs while connecting or while authenticating.