Ruby

Download the Full Version of a Partial Email

Demonstrates the Chilkat MailMan.FetchFull method, which downloads the complete version of a header-only or partial Email and stores it in a second Email. The full result includes the complete body and any attachments, and the partial email must retain its UIDL. This example previews message 1 (headers only) and then downloads it in full.

Background: A common pattern is to download headers first — cheap and fast — show the user a message list, and only pull the full content when a message is actually opened. FetchFull completes that "download on demand" flow: given a partial email (which carries its UIDL), it fetches the rest from the server. This keeps bandwidth and latency low when browsing a large mailbox.

Chilkat Ruby Downloads

Download Chilkat for Ruby

Ruby

require 'chilkat'

success = false

#  Demonstrates the MailMan.FetchFull method, which downloads the complete version of a
#  header-only or partial Email and stores it in a second Email.  The full result includes
#  the complete body and any attachments.  The partial email must retain its UIDL.

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")

#  First fetch message 1 as headers only (a fast preview).  headerOnly=true.
partialEmail = Chilkat::CkEmail.new()

success = mailman.FetchOne(true,0,1,partialEmail)
if (success == false)
    print mailman.lastErrorText() + "\n";
    exit
end

print "Preview subject: " + partialEmail.subject() + "\n";

#  Now download the complete message (body and attachments).
fullEmail = Chilkat::CkEmail.new()
success = mailman.FetchFull(partialEmail,fullEmail)
if (success == false)
    print mailman.lastErrorText() + "\n";
    exit
end

print "Full email NumAttachments: " + fullEmail.get_NumAttachments().to_s() + "\n";

#  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.