(PureBasic) Read IMAP Email Headers

This example demonstrates how to connect to an IMAP server and download only the email headers for all messages in a mailbox. Downloading headers only is much faster and more efficient than downloading complete emails because the message bodies and attachment contents are not retrieved.

The example shows how to:

• Connect to an IMAP server using SSL/TLS
• Authenticate and select a mailbox
• Query for all messages in the mailbox
• Fetch header-only email information
• Display sender, subject, recipients, and total message size
• Retrieve attachment metadata such as filenames and sizes without downloading the actual attachments

This technique is useful for quickly scanning large mailboxes, building message summaries, or inspecting attachment information while minimizing bandwidth and memory usage.

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

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkImap.pb"
IncludeFile "CkEmailBundle.pb"
IncludeFile "CkMessageSet.pb"
IncludeFile "CkEmail.pb"

Procedure ChilkatExample()

    success.i = 0

    success = 0

    ; This example assumes the Chilkat API has already been unlocked.
    ; See Global Unlock Sample for example code.

    imap.i = CkImap::ckCreate()
    If imap.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Connect to the IMAP server using SSL/TLS on the standard secure IMAP port.
    CkImap::setCkSsl(imap, 1)
    CkImap::setCkPort(imap, 993)
    success = CkImap::ckConnect(imap,"imap.example.com")
    If success = 0
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    ; Authenticate with the IMAP server.
    success = CkImap::ckLogin(imap,"****","****")
    If success = 0
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    ; Select the mailbox (folder) to access.
    success = CkImap::ckSelectMailbox(imap,"Inbox")
    If success = 0
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    ; Get the identifiers for all messages in the selected mailbox.
    ; Setting fetchUids = cktrue causes IMAP UIDs to be returned.
    ; If ckfalse, IMAP sequence numbers are returned instead.
    fetchUids.i = 1
    messageSet.i = CkMessageSet::ckCreate()
    If messageSet.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkImap::ckQueryMbx(imap,"ALL",fetchUids,messageSet)
    If success = 0
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        CkMessageSet::ckDispose(messageSet)
        ProcedureReturn
    EndIf

    ; Download only the email headers for the messages in the set.
    ; This is much faster than downloading full emails because the
    ; message bodies and attachment contents are not retrieved.
    ; 
    ; Even though the attachments themselves are not downloaded,
    ; Chilkat can still provide information such as attachment
    ; filenames, attachment sizes, and the total message size.
    bundle.i = CkEmailBundle::ckCreate()
    If bundle.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    headersOnly.i = 1
    success = CkImap::ckFetchMsgSet(imap,headersOnly,messageSet,bundle)
    If success = 0
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        CkMessageSet::ckDispose(messageSet)
        CkEmailBundle::ckDispose(bundle)
        ProcedureReturn
    EndIf

    ; Iterate over each email in the bundle and display summary information.
    email.i = CkEmail::ckCreate()
    If email.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    name.s
    addr.s
    i.i = 0
    j.i = 0
    While i < CkEmailBundle::ckMessageCount(bundle)
        CkEmailBundle::ckEmailAt(bundle,i,email)

        ; Display the sender and subject line.
        Debug CkEmail::ckFrom(email)
        Debug CkEmail::ckSubject(email)

        ; Display all "To" recipients.
        j = 0
        While j < CkEmail::ckNumTo(email)
            Debug "TO: " + CkEmail::ckGetToName(email,j) + ", " + CkEmail::ckGetToAddr(email,j)
            j = j + 1
        Wend

        ; Display all "CC" recipients.
        j = 0
        While j < CkEmail::ckNumCC(email)
            Debug "CC: " + CkEmail::ckGetCcName(email,j) + ", " + CkEmail::ckGetCcAddr(email,j)
            j = j + 1
        Wend

        ; Display the total size of the email message, including
        ; the body and all attachments, even though only headers
        ; were downloaded.
        Debug Str(CkEmail::ckSize(email))

        ; When full emails are downloaded, attachment information
        ; is accessed using the email.NumAttachments property and
        ; the email.GetMailAttach* methods.
        ; 
        ; However, because this example downloaded headers only,
        ; attachment metadata must be obtained using the IMAP object.
        numAttach.i = CkImap::ckGetMailNumAttach(imap,email)

        j = 0
        While j < numAttach

            ; Display the attachment filename.
            Debug CkImap::ckGetMailAttachFilename(imap,email,j)

            ; Display the attachment size in bytes.
            attachSize.i = CkImap::ckGetMailAttachSize(imap,email,j)
            Debug "    size = " + Str(attachSize) + " bytes"

            j = j + 1
        Wend

        Debug "--"

        i = i + 1
    Wend

    ; Disconnect from the IMAP server.
    success = CkImap::ckDisconnect(imap)


    CkImap::ckDispose(imap)
    CkMessageSet::ckDispose(messageSet)
    CkEmailBundle::ckDispose(bundle)
    CkEmail::ckDispose(email)


    ProcedureReturn
EndProcedure