(PureBasic) IMAP Download All Email One at a Time

Demonstrates how to download every email in an IMAP mailbox one at a time as a MIME string or as an email object. (The MIME contains the full contents of the email including all attachments.)

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkEmail.pb"
IncludeFile "CkImap.pb"

Procedure ChilkatExample()

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

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

    ; Connect to an 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

    ; Once the mailbox is selected, the NumMessages property
    ; will contain the number of messages in the mailbox.
    ; You may loop from 1 to NumMessages to
    ; fetch each message by sequence number.

    bUid.i = 0
    mimeStr.s
    i.i
    n.i = CkImap::ckNumMessages(imap)
    For i = 1 To n

        ; Download the email by sequence number.
        mimeStr = CkImap::ckFetchSingleAsMime(imap,i,bUid)

        ; ... your application may process each MIME string...
    Next

    ; An alternative is to download each email in the form of an
    ; email object, like this:
    email.i
    For i = 1 To n

        ; Download the email by sequence number.
        email = CkImap::ckFetchSingle(imap,i,bUid)

        ; ... your application may process the email object...

        CkEmail::ckDispose(email)

    Next

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


    CkImap::ckDispose(imap)


    ProcedureReturn
EndProcedure