PureBasic

Fetch a Text IMAP Attachment as a String

Demonstrates the Chilkat Imap.FetchAttachmentString method, which returns one text attachment decoded to a string. The first argument is the Email, the second is the zero-based attachment index, and the third is the charset used to decode the bytes. This example returns the first attachment as a UTF-8 string.

Background: This is the convenient form when you simply want a small text attachment's content inline as a string. Only use it for attachments known to be text; decoding binary content through a charset can alter or corrupt the bytes. For binary data use FetchAttachmentBd, and for large text a StringBuilder (via FetchAttachmentSb) avoids an extra copy.

Chilkat PureBasic Downloads

Download Chilkat for PureBasic

PureBasic

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

Procedure ChilkatExample()

    success.i = 0

    ;  Demonstrates the Imap.FetchAttachmentString method, which downloads one text attachment and
    ;  returns it decoded to a string.  The 1st argument is the Email, the 2nd is the zero-based
    ;  attachment index, and the 3rd is the charset used to decode the bytes.
    ;  
    ;  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
        ;  FetchAttachmentString returns a string, so assign it to a string variable.
        attachText.s = CkImap::ckFetchAttachmentString(imap,email,0,"utf-8")
        If CkImap::ckLastMethodSuccess(imap) = 0
            Debug CkImap::ckLastErrorText(imap)
            CkImap::ckDispose(imap)
            CkEmail::ckDispose(email)
            ProcedureReturn
        EndIf

        Debug attachText
    EndIf

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



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


    ProcedureReturn
EndProcedure