(Ruby) Fetch 1st N Headers of Search Results

Calls Search to get a message set, then downloads the 1st N messages in the message set. There are two equivalent ways of doing it: (1) iterate from 0 to N-1 and download each message individually, or (2) create a new message set that contains the 1st N messages and pass it to FetchHeaders. Both are demonstrated here.

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

require 'chilkat'

# This example assumes 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

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

numFound = messageSet.get_Count()
if (numFound == 0)
    print "No messages found." + "\n";

    exit
end

# Get the 1st 10 messages in messageSet.
upperBound = 10
if (numFound < upperBound)
    upperBound = numFound
end

i = 0
bUid = messageSet.get_HasUids()
while i < upperBound

    # email is a CkEmail
    email = imap.FetchSingleHeader(messageSet.GetId(i),bUid)
    if (imap.get_LastMethodSuccess() == false)
        print imap.lastErrorText() + "\n";

        exit

    else
        # Do whatever is needed with the email.. 
        # ....

    end

    i = i + 1
end

# Alternatively, create a new message set containing the 1st 10 message id's (UID's) 
# from the search results message set:
firstTen = Chilkat::CkMessageSet.new()

for i in 0 .. upperBound - 1
    firstTen.InsertId(messageSet.GetId(i))
end

# Download the 1st ten headers:

# bundle is a CkEmailBundle
bundle = imap.FetchHeaders(firstTen)
if (imap.get_LastMethodSuccess() == false)

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

# Other examples show how to iterate over the emails contained within the bundle...

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