DataFlex

Get IMAP Attachment Filenames

Demonstrates the Chilkat Imap.GetMailAttachFilename method, which returns the filename of an attachment. The first argument is the Email and the second is the zero-based attachment index. This example fetches only the message headers and lists the attachment filenames.

Background: This method reads the filename from ckx-imap-* metadata, so it works on a header-only email even though the attachment bodies have not been downloaded. That is exactly what a mail client needs to render the paperclip list — the names of the attached files — before the user decides to download any of them.

Chilkat DataFlex Downloads

Download Chilkat for DataFlex

DataFlex

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoImap
    Boolean iHeadersOnly
    Boolean iUseUid
    Integer iSeqNum
    Variant vEmail
    Handle hoEmail
    Integer iNumAttach
    Integer i
    String sFname
    String sTemp1
    Boolean bTemp1

    Move False To iSuccess

    //  Demonstrates the Imap.GetMailAttachFilename method, which returns the filename of an
    //  attachment.  The 1st argument is the Email and the 2nd is the zero-based attachment index.

    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

    //  Loop over the attachments and print each filename.
    Get pvComObject of hoEmail to vEmail
    Get ComGetMailNumAttach Of hoImap vEmail To iNumAttach
    Showln "Attachments: " iNumAttach

    For i From 0 To (iNumAttach - 1)
        //  GetMailAttachFilename returns a string, so assign it to a string variable.
        Get pvComObject of hoEmail to vEmail
        Get ComGetMailAttachFilename Of hoImap vEmail i To sFname
        Get ComLastMethodSuccess Of hoImap To bTemp1
        If (bTemp1 = False) Begin
            Get ComLastErrorText Of hoImap To sTemp1
            Showln sTemp1
            Procedure_Return
        End

        Showln sFname
    Loop

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



End_Procedure