PureBasic

Fetch Inbox Email Headers

Downloads the headers of all emails in the Inbox and shows some information about each, such as From, Subject, and whether the email has been seen (already read) or not. PureBasic

IncludeFile "CkEmailBundle.pb"
IncludeFile "CkImap.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,"myLogin","myPassword")
    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

    ; Normally, when an email is downloaded, its "Seen" flag is automatically set.
    ; We don't want our program to be interfering with the "Seen" flags.
    ; To do this, set the PeekMode to 1.
    CkImap::setCkPeekMode(imap, 1)

    ; After selecting the mailbox, the NumMessages property
    ; will contain the number of emails in the mailbox.
    ; When sequence numbers (not UIDs) are used to reference emails,
    ; they range from 1 to N, where N is the number of messages in the mailbox.
    ; This example will download the headers by sequence numbers.
    count.i = CkImap::ckNumMessages(imap)

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

    success = CkImap::ckFetchRange(imap,1,1,count,bundle)
    If success = 0
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        CkEmailBundle::ckDispose(bundle)
        ProcedureReturn
    EndIf

    If CkEmailBundle::ckMessageCount(bundle) = 0
        Debug "No messages in Inbox."
        CkImap::ckDispose(imap)
        CkEmailBundle::ckDispose(bundle)
        ProcedureReturn
    EndIf

    ; Loop over the email headers.  
    emailHeader.i = CkEmail::ckCreate()
    If emailHeader.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    i.i = 0
    While i < CkEmailBundle::ckMessageCount(bundle)

        CkEmailBundle::ckEmailAt(bundle,i,emailHeader)

        Debug CkEmail::ckFrom(emailHeader)
        Debug CkEmail::ckSubject(emailHeader)

        ; Get the "Seen" flag.
        ; When an email is fetched from the IMAP server, the email flags are stored
        ; within the email in the "ckx-imap-flags" header.
        ; The call to GetMailFlag is simply getting the information from the email header.
        ; (it is not communicating with the IMAP server to get this information, because
        ; the information was obtained when downloading the headers)
        seenFlag.i = CkImap::ckGetMailFlag(imap,emailHeader,"Seen")
        If seenFlag = 1
            Debug "This email has been read (already seen)"
        Else
            Debug "This email has not yet been read (it is not yet seen)"
        EndIf

        ; We can also look directly at the "ckx-imap-flags" header:
        Debug "ckx-imap-flags: " + CkEmail::ckGetHeaderField(emailHeader,"ckx-imap-flags")

        Debug "--"

        i = i + 1
    Wend

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


    CkImap::ckDispose(imap)
    CkEmailBundle::ckDispose(bundle)
    CkEmail::ckDispose(emailHeader)


    ProcedureReturn
EndProcedure