PureBasic

Fetch an IMAP Attachment into a BinData

Demonstrates the Chilkat Imap.FetchAttachmentBd method, which stores one attachment's bytes in a BinData object. The first argument is the Email, the second is the zero-based attachment index, and the third is the BinData, which is cleared before the operation. This example fetches the first attachment and prints its byte count.

Background: A BinData holds raw bytes, so it works for any attachment type — image, PDF, zip, and so on. From there you can save it, hash it, or hand it to another API expecting a byte buffer, all without touching the filesystem. Use the string/StringBuilder variants only when the attachment is known to be text.

Chilkat PureBasic Downloads

Download Chilkat for PureBasic

PureBasic

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

Procedure ChilkatExample()

    success.i = 0

    ;  Demonstrates the Imap.FetchAttachmentBd method, which downloads one attachment's bytes into
    ;  a BinData object.  The 1st argument is the Email, the 2nd is the zero-based attachment
    ;  index, and the 3rd is the BinData (which is 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 just the first attachment's bytes from the server into a BinData.
        bd.i = CkBinData::ckCreate()
        If bd.i = 0
            Debug "Failed to create object."
            ProcedureReturn
        EndIf

        success = CkImap::ckFetchAttachmentBd(imap,email,0,bd)
        If success = 0
            Debug CkImap::ckLastErrorText(imap)
            CkImap::ckDispose(imap)
            CkEmail::ckDispose(email)
            CkBinData::ckDispose(bd)
            ProcedureReturn
        EndIf

        Debug "Attachment size: " + Str(CkBinData::ckNumBytes(bd)) + " bytes"
    EndIf

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



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


    ProcedureReturn
EndProcedure