(Ruby) Fetch Inbox Email Headers

Downloads the headers of all emails in the Inbox and shows some information about each, such as From, Subject, and whether the email has been seen (already read) or not.

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

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("myLogin","myPassword")
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

# Normally, when an email is downloaded, its "Seen" flag is automatically set.
# We don't want our program to be interfering with the "Seen" flags.
# To do this, set the PeekMode to true.
imap.put_PeekMode(true)

# After selecting the mailbox, the NumMessages property
# will contain the number of emails in the mailbox.
# When sequence numbers (not UIDs) are used to reference emails,
# they range from 1 to N, where N is the number of messages in the mailbox.
# This example will download the headers by sequence numbers.
# bundle is a CkEmailBundle
bundle = imap.FetchSequenceHeaders(1,imap.get_NumMessages())
if (imap.get_LastMethodSuccess() != true)
    print imap.lastErrorText() + "\n";
    exit
end

if (bundle.get_MessageCount() == 0)
    print "No messages in Inbox." + "\n";

    exit
end

# Loop over the email headers.  

for i in 0 .. bundle.get_MessageCount() - 1
    # emailHeader is a CkEmail
    emailHeader = bundle.GetEmail(i)
    print emailHeader.ck_from() + "\n";
    print emailHeader.subject() + "\n";

    # Get the "Seen" flag.
    # When an email is fetched from the IMAP server, the email flags are stored
    # within the email in the "ckx-imap-flags" header.
    # The call to GetMailFlag is simply getting the information from the email header.
    # (it is not communicating with the IMAP server to get this information, because
    # the information was obtained when downloading the headers)
    seenFlag = imap.GetMailFlag(emailHeader,"Seen")
    if (seenFlag == 1)
        print "This email has been read (already seen)" + "\n";
    else
        print "This email has not yet been read (it is not yet seen)" + "\n";
    end

    # We can also look directly at the "ckx-imap-flags" header:
    print "ckx-imap-flags: " + emailHeader.getHeaderField("ckx-imap-flags") + "\n";

    print "--" + "\n";

end

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