(Ruby) Fetch Full Email Given Email Header

When you fetch email headers using UIDs instead of sequence numbers, the email object (which includes only the header) will have auto-generated ckx-imap-* headers. These headers provide details like the UID and attachments. The IMAP UID is found in the ckx-imap-uid header. Additionally, the ckx-imap-isUid header indicates whether the email header was downloaded by UID, showing YES or NO. Since sequence numbers can change if emails are deleted, UIDs are essential for downloading the correct full email.

The Chilkat Email object offers a GetImapUid method to retrieve the UID from the ckx-imap-uid header. This UID can be used to fetch the full email.

Note: This example requires Chilkat v11.0.0 or greater.

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

require 'chilkat'

success = false

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

# Login
success = imap.Login("***","***")
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

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

emailHeader = Chilkat::CkEmail.new()
emailFull = Chilkat::CkEmail.new()

uid = 2014
isUid = true

# Fetch only the email header
success = imap.FetchEmail(true,uid,isUid,emailHeader)
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

# Now fetch the full email
uidFromCkxHeader = emailHeader.GetImapUid()
if (uidFromCkxHeader < 0)
    # Failed. 
    print "No ckx-imap-uid header was found." + "\n";
    exit
end

success = imap.FetchEmail(false,uid,isUid,emailFull)
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

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

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