PureBasic

Fetch a Text IMAP Attachment into a StringBuilder

Demonstrates the Chilkat Imap.FetchAttachmentSb method, which decodes one text attachment into a StringBuilder. The first argument is the Email, the second is the zero-based attachment index, the third is the charset used to decode the bytes, and the fourth is the StringBuilder, which is cleared first. This example decodes the first attachment as UTF-8.

Background: For text attachments — a CSV, a .txt, an XML file — decoding straight to characters saves a manual charset step. The charset argument names the encoding of the attachment bytes (for example utf-8 or iso-8859-1). For binary attachments, use FetchAttachmentBd instead, since forcing binary through a text decoder can corrupt it.

Chilkat PureBasic Downloads

Download Chilkat for PureBasic

PureBasic

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

Procedure ChilkatExample()

    success.i = 0

    ;  Demonstrates the Imap.FetchAttachmentSb method, which downloads one text attachment and
    ;  decodes it into a StringBuilder.  The 1st argument is the Email, the 2nd is the zero-based
    ;  attachment index, the 3rd is the charset used to decode, and the 4th is the StringBuilder
    ;  (cleared first).
    ;  
    ;  The message is fetched headers-only, then the attachment is downloaded on demand.

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

    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

    success = CkImap::ckLogin(imap,"user@example.com","myPassword")
    If success = 0
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    success = CkImap::ckSelectMailbox(imap,"Inbox")
    If success = 0
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    ;  Fetch only the message headers.  Attachment bodies are NOT downloaded, but the ckx-imap-*
    ;  metadata describing the attachments is present, so the attachment info methods still work.
    headersOnly.i = 1
    useUid.i = 0
    seqNum.i = 1
    email.i = CkEmail::ckCreate()
    If email.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkImap::ckFetchEmail(imap,headersOnly,seqNum,useUid,email)
    If success = 0
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        CkEmail::ckDispose(email)
        ProcedureReturn
    EndIf

    numAttach.i = CkImap::ckGetMailNumAttach(imap,email)
    If numAttach > 0
        ;  Download the first (text) attachment and decode it as UTF-8.  Use this only for text.
        sb.i = CkStringBuilder::ckCreate()
        If sb.i = 0
            Debug "Failed to create object."
            ProcedureReturn
        EndIf

        success = CkImap::ckFetchAttachmentSb(imap,email,0,"utf-8",sb)
        If success = 0
            Debug CkImap::ckLastErrorText(imap)
            CkImap::ckDispose(imap)
            CkEmail::ckDispose(email)
            CkStringBuilder::ckDispose(sb)
            ProcedureReturn
        EndIf

        attachText.s = CkStringBuilder::ckGetAsString(sb)
        Debug attachText
    EndIf

    success = CkImap::ckDisconnect(imap)
    If success = 0
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        CkEmail::ckDispose(email)
        CkStringBuilder::ckDispose(sb)
        ProcedureReturn
    EndIf



    CkImap::ckDispose(imap)
    CkEmail::ckDispose(email)
    CkStringBuilder::ckDispose(sb)


    ProcedureReturn
EndProcedure