(PureBasic) Read IMAP Email Headers

Call FetchHeaders to download only the email headers.

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

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

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

    ; Connect to an IMAP server.
    ; Use TLS
    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

    ; Login
    success = CkImap::ckLogin(imap,"****","****")
    If success = 0
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    ; Select an IMAP mailbox
    success = CkImap::ckSelectMailbox(imap,"Inbox")
    If success = 0
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    ; Get the message IDs of all the emails in the mailbox
    ; We can choose to fetch UIDs or sequence numbers.
    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

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

    ; Loop over the email objects and display information
    ; about each:
    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 From and Subject
        Debug CkEmail::ckFrom(email)
        Debug CkEmail::ckSubject(email)

        ; Display the recipients:
        j = 0
        While j < CkEmail::ckNumTo(email)
            Debug "TO: " + CkEmail::ckGetToName(email,j) + ", " + CkEmail::ckGetToAddr(email,j)
            j = j + 1
        Wend
        j = 0
        While j < CkEmail::ckNumCC(email)
            Debug "CC: " + CkEmail::ckGetCcName(email,j) + ", " + CkEmail::ckGetCcAddr(email,j)
            j = j + 1
        Wend

        ; Show the total size of the email, including body and attachments:
        Debug Str(CkEmail::ckSize(email))

        ; 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:
        numAttach.i = CkImap::ckGetMailNumAttach(imap,email)
        j = 0
        While j < numAttach
            Debug CkImap::ckGetMailAttachFilename(imap,email,j)
            attachSize.i = CkImap::ckGetMailAttachSize(imap,email,j)
            Debug "    size = " + Str(attachSize) + " bytes"
            j = j + 1
        Wend

        Debug "--"
    Wend

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


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


    ProcedureReturn
EndProcedure