(PureBasic) Sorting Email

Demonstrates how to sort an email bundle.

Chilkat PureBasic Module Download Chilkat PureBasic Module

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

Procedure ChilkatExample()

    ; 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 the IMAP server.
    ; Use TLS
    CkImap::setCkSsl(imap, 1)
    CkImap::setCkPort(imap, 993)
    success.i = CkImap::ckConnect(imap,"imap.someMailServer.com")
    If success <> 1
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    ; Login
    success = CkImap::ckLogin(imap,"myLogin","myPassword")
    If success <> 1
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

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

    ; We can choose to fetch UIDs or sequence numbers.
    fetchUids.i = 1

    ; Pass any of the above strings here to test a search:
    messageSet.i = CkImap::ckSearch(imap,"ALL",fetchUids)
    If CkImap::ckLastMethodSuccess(imap) = 0
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    ; Fetch the email headers into a bundle object:
    bundle.i = CkImap::ckFetchHeaders(imap,messageSet)
    If CkImap::ckLastMethodSuccess(imap) = 0
        CkMessageSet::ckDispose(messageSet)

        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    ; Sort the email bundle by date, recipient, sender, or subject:
    ascending.i = 1
    CkEmailBundle::ckSortByDate(bundle,ascending)

    ; To sort by recipient, sender, or subject, call 
    ; SortBySender, SortByRecipient, or SortBySubject.

    ; Display the Subject and From of each email.
    i.i = 0
    While i < CkEmailBundle::ckMessageCount(bundle)
        email.i
        email = CkEmailBundle::ckGetEmail(bundle,i)

        Debug CkEmail::ckGetHeaderField(email,"Date")
        Debug CkEmail::ckSubject(email)
        Debug CkEmail::ckFrom(email)
        Debug "--"

        CkEmail::ckDispose(email)

        i = i + 1
    Wend

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

    CkMessageSet::ckDispose(messageSet)

    CkEmailBundle::ckDispose(bundle)



    CkImap::ckDispose(imap)


    ProcedureReturn
EndProcedure