Read IMAP Email Headers

Call FetchHeaders to download only the email headers.

Download Chilkat Ruby Library

require 'chilkat'

imap = Chilkat::CkImap.new()

#  Anything unlocks the component and begins a fully-functional 30-day trial.
success = imap.UnlockComponent("Anything for 30-day trial")
if (success != true)
    print imap.lastErrorText() + "\n"
    exit
end

#  Connect to an IMAP server.
success = imap.Connect("mail.chilkatsoft.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

#  We can choose to fetch UIDs or sequence numbers.
fetchUids = true
#  Get the message IDs of all the emails in the mailbox
# messageSet is a CkMessageSet
messageSet = imap.Search("ALL",fetchUids)
if (messageSet == nil )
    print imap.lastErrorText() + "\n"
    exit
end

#  When downloading headers, each email object contains
#  (obviously) the headers, but the body will be missing.
#  Also, attachments will not be included.  However, it is
#  possible to get information about the attachments
#  as well as the complete size of the email.

# bundle is a CkEmailBundle
bundle = imap.FetchHeaders(messageSet)
if (bundle == nil )

    print imap.lastErrorText() + "\n"
    exit
end

#  Loop over the email objects and display information
#  about each:

for i in 0 .. bundle.get_MessageCount() - 1

    # email is a CkEmail
    email = bundle.GetEmail(i)

    #  Display the From and Subject
    print email.ck_from() + "\n";
    print email.subject() + "\n";

    #  Display the recipients:

    for j in 0 .. email.get_NumTo() - 1
        name = email.getToName(j)
        addr = email.getToAddr(j)
        print name + ", " + addr + "\n";
    end
    for j in 0 .. email.get_NumCC() - 1
        name = email.getCcName(j)
        addr = email.getCcAddr(j)
        print name + ", " + addr + "\n";
    end

    #  Show the total size of the email, including body and attachments:
    print email.get_Size().to_s().to_s() + "\n";

    #  When a full email is downloaded, we would use the
    #  email.NumAttachments property in conjunction with the
    #  email.GetMailAttach* methods.
    #  However, when an email object contains only the header,
    #  we need to access the attachment info differently:
    numAttach = imap.GetMailNumAttach(email)
    for j in 0 .. numAttach - 1
        print imap.getMailAttachFilename(email,j) + "\n";
        attachSize = imap.GetMailAttachSize(email,j)
        print "    size = " + attachSize.to_s() + 
            " bytes" + "\n";
    end

    print "--" + "\n";

end

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