Fetch a Text IMAP Attachment into a StringBuilder

See more IMAP Examples

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.

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoImap
    Boolean iHeadersOnly
    Boolean iUseUid
    Integer iSeqNum
    Variant vEmail
    Handle hoEmail
    Integer iNumAttach
    Variant vSb
    Handle hoSb
    String sAttachText
    String sTemp1

    Move False To iSuccess

    //  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.

    Get Create (RefClass(cComChilkatImap)) To hoImap
    If (Not(IsComObjectCreated(hoImap))) Begin
        Send CreateComObject of hoImap
    End

    Set ComSsl Of hoImap To True
    Set ComPort Of hoImap To 993

    Get ComConnect Of hoImap "imap.example.com" To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComLogin Of hoImap "user@example.com" "myPassword" To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComSelectMailbox Of hoImap "Inbox" To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    //  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.
    Move True To iHeadersOnly
    Move False To iUseUid
    Move 1 To iSeqNum
    Get Create (RefClass(cComChilkatEmail)) To hoEmail
    If (Not(IsComObjectCreated(hoEmail))) Begin
        Send CreateComObject of hoEmail
    End
    Get pvComObject of hoEmail to vEmail
    Get ComFetchEmail Of hoImap iHeadersOnly iSeqNum iUseUid vEmail To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get pvComObject of hoEmail to vEmail
    Get ComGetMailNumAttach Of hoImap vEmail To iNumAttach
    If (iNumAttach > 0) Begin
        //  Download the first (text) attachment and decode it as UTF-8.  Use this only for text.
        Get Create (RefClass(cComChilkatStringBuilder)) To hoSb
        If (Not(IsComObjectCreated(hoSb))) Begin
            Send CreateComObject of hoSb
        End
        Get pvComObject of hoEmail to vEmail
        Get pvComObject of hoSb to vSb
        Get ComFetchAttachmentSb Of hoImap vEmail 0 "utf-8" vSb To iSuccess
        If (iSuccess = False) Begin
            Get ComLastErrorText Of hoImap To sTemp1
            Showln sTemp1
            Procedure_Return
        End

        Get ComGetAsString Of hoSb To sAttachText
        Showln sAttachText
    End

    Get ComDisconnect Of hoImap To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End



End_Procedure