(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.

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 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.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

# Get the message IDs of all the emails in the mailbox
# We can choose to fetch UIDs or sequence numbers.
fetchUids = true
messageSet = Chilkat::CkMessageSet.new()
success = imap.QueryMbx("ALL",fetchUids,messageSet)
if (success == 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()
headerOnly = true
email = Chilkat::CkEmail.new()

while i < upperBound

    success = imap.FetchEmail(headerOnly,messageSet.GetId(i),bUid,email)
    if (success == false)
        print imap.lastErrorText() + "\n";
        exit
    end

    print i.to_s() + ": " + email.subject() + "\n";

    i = i + 1
end

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