(Xojo Plugin) 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 Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

Dim imap As New Chilkat.Imap

// Connect to an IMAP server.
// Use TLS
imap.Ssl = True
imap.Port = 993
Dim success As Boolean
success = imap.Connect("imap.someMailServer.com")
If (success <> True) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

// Login
success = imap.Login("****","****")
If (success <> True) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

// Select an IMAP mailbox
success = imap.SelectMailbox("Inbox")
If (success <> True) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

Dim messageSet As Chilkat.MessageSet
// We can choose to fetch UIDs or sequence numbers.
Dim fetchUids As Boolean
fetchUids = True
// Get the message IDs of all the emails in the mailbox
messageSet = imap.Search("ALL",fetchUids)
If (imap.LastMethodSuccess = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

Dim numFound As Int32
numFound = messageSet.Count
If (numFound = 0) Then
    System.DebugLog("No messages found.")

    Return
End If

// Get the 1st 10 messages in messageSet.
Dim upperBound As Int32
upperBound = 10
If (numFound < upperBound) Then
    upperBound = numFound
End If

Dim i As Int32
i = 0
Dim bUid As Boolean
bUid = messageSet.HasUids
While i < upperBound

    Dim email As Chilkat.Email
    email = imap.FetchSingleHeader(messageSet.GetId(i),bUid)
    If (imap.LastMethodSuccess = False) Then
        System.DebugLog(imap.LastErrorText)

        Return

    Else
        // Do whatever is needed with the email.. 
        // ....

    End If

    i = i + 1
Wend

// Alternatively, create a new message set containing the 1st 10 message id's (UID's) 
// from the search results message set:
Dim firstTen As New Chilkat.MessageSet

For i = 0 To upperBound - 1
    firstTen.InsertId messageSet.GetId(i)
Next

// Download the 1st ten headers:
Dim bundle As Chilkat.EmailBundle
bundle = imap.FetchHeaders(firstTen)
If (imap.LastMethodSuccess = False) Then

    System.DebugLog(imap.LastErrorText)
    Return
End If

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

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