(Ruby) Fetch Full Email Given Email Header

When email headers are fetched using UIDs (not sequence numbers), then the resultant email object (containing only the header) will include auto-generated ckx-imap-* header fields to record information about the uid, attachments, etc. The IMAP UID of the email will be available in the "ckx-imap-uid" header. There will also be a "ckx-imap-isUid" header field having the value "YES" or "NO". If the email header was downloaded by UID, then "ckx-imap-isUID" will contain the value "YES" and the value of the "ckx-imap-uid" header field is the IMAP UID. If the "ckx-imap-isUID" header has a value of "NO", then the "ckx-imap-uid" header field represents the sequence number. (Sequence numbers of emails on the server can change over time, depending on whether emails are deleted. UIDs must be used to ensure that the correct full email is downloaded.)

The Chilkat Email object provides a GetImapUid method to return the UID from the ckx-imap-uid header. This can then be used to download the full email using the FetchSingle method. Assuming the UID is known, download a single email by UID from an IMAP mail server.

Chilkat Ruby Downloads Ruby Library for Linux and MAC OS X

require 'chilkat'

# 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.someMailServer.com")
if (success != true)
    print imap.lastErrorText() + "\n";
    exit
end

# Login
success = imap.Login("***","***")
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

uid = 2014
isUid = true

# Fetch only the email header
# emailHeader is a CkEmail
emailHeader = imap.FetchSingleHeader(uid,isUid)
if (imap.get_LastMethodSuccess() == true)

    # Now fetch the full email
    uidFromCkxHeader = emailHeader.GetImapUid()
    if (uidFromCkxHeader < 0)
        # Failed. 

        print "No ckx-imap-uid header was found." + "\n";
        exit
    end

    # emailFull is a CkEmail
    emailFull = imap.FetchSingle(uidFromCkxHeader,true)
    if (imap.get_LastMethodSuccess() == true)

        # OK, we have the full email, do whatever we want...

    end

end

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