(Xojo Plugin) Read IMAP Email Headers

Call FetchHeaders to download only the email headers.

Note: This example requires Chilkat v11.0.0 or greater.

Chilkat Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

Dim success As Boolean
success = False

// This example requires 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
success = imap.Connect("imap.example.com")
If (success = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

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

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

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

// 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.
Dim bundle As New Chilkat.EmailBundle
Dim headersOnly As Boolean
headersOnly = True
success = imap.FetchMsgSet(headersOnly,messageSet,bundle)
If (success = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

// Loop over the email objects and display information
// about each:
Dim email As New Chilkat.Email
Dim name As String
Dim addr As String
Dim i As Int32
i = 0
Dim j As Int32
j = 0
While i < bundle.MessageCount
    success = bundle.EmailAt(i,email)

    // Display the From and Subject
    System.DebugLog(email.From)
    System.DebugLog(email.Subject)

    // Display the recipients:
    j = 0
    While j < email.NumTo
        System.DebugLog("TO: " + email.GetToName(j) + ", " + email.GetToAddr(j))
        j = j + 1
    Wend
    j = 0
    While j < email.NumCC
        System.DebugLog("CC: " + email.GetCcName(j) + ", " + email.GetCcAddr(j))
        j = j + 1
    Wend

    // Show the total size of the email, including body and attachments:
    System.DebugLog(Str(email.Size))

    // 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:
    Dim numAttach As Int32
    numAttach = imap.GetMailNumAttach(email)
    j = 0
    While j < numAttach
        System.DebugLog(imap.GetMailAttachFilename(email,j))
        Dim attachSize As Int32
        attachSize = imap.GetMailAttachSize(email,j)
        System.DebugLog("    size = " + Str(attachSize) + " bytes")
        j = j + 1
    Wend

    System.DebugLog("--")
Wend

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