(DataFlex) Download and Save Email Attachments (POP3)

See more POP3 Examples

Note: This example requires Chilkat v11.0.0 or greater.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoMailman
    Variant vBundle
    Handle hoBundle
    Boolean iKeepOnServer
    Boolean iHeadersOnly
    Integer iNumBodyLines
    String sDirPath
    Variant vEmail
    Handle hoEmail
    Integer iBundleIndex
    Integer iNumMessages
    Integer iNumAttachments
    Integer iAttachIndex
    String sTemp1

    Move False To iSuccess

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    // The mailman object is used for receiving (POP3) 
    // and sending (SMTP) email.
    Get Create (RefClass(cComChilkatMailMan)) To hoMailman
    If (Not(IsComObjectCreated(hoMailman))) Begin
        Send CreateComObject of hoMailman
    End

    // Set the POP3 server's hostname
    Set ComMailHost Of hoMailman To "pop.yourserver.com"

    // Set the POP3 login/password.
    Set ComPopUsername Of hoMailman To "***"
    Set ComPopPassword Of hoMailman To "***"

    // Copy the all email from the user's POP3 mailbox 
    // into a bundle object.  The email remains on the server.
    // FetchAll is a reasonable choice for POP3 maildrops that don't have too many
    // emails. For larger mail drops, one might download emails one at a time..
    Get Create (RefClass(cComChilkatEmailBundle)) To hoBundle
    If (Not(IsComObjectCreated(hoBundle))) Begin
        Send CreateComObject of hoBundle
    End
    Move True To iKeepOnServer
    Move False To iHeadersOnly
    // Irrelevent because we are NOT downloading headers-only
    Move 0 To iNumBodyLines
    Get pvComObject of hoBundle to vBundle
    Get ComFetchAll Of hoMailman iKeepOnServer iHeadersOnly iNumBodyLines vBundle To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoMailman To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // The directory path can be relative or absolute.
    // This shows a Windows style directory path.  On other operating systems, the path
    // would be different..
    Move "c:/myAttachments" To sDirPath

    Get Create (RefClass(cComChilkatEmail)) To hoEmail
    If (Not(IsComObjectCreated(hoEmail))) Begin
        Send CreateComObject of hoEmail
    End
    Move 0 To iBundleIndex
    Get ComMessageCount Of hoBundle To iNumMessages

    While (iBundleIndex < iNumMessages)
        Get pvComObject of hoEmail to vEmail
        Get ComEmailAt Of hoBundle iBundleIndex vEmail To iSuccess

        // Save all attachments to the specified directory.
        // The directory is automatically created if it does not yet exist.
        Get ComSaveAllAttachments Of hoEmail sDirPath To iSuccess
        If (iSuccess = False) Begin
            Get ComLastErrorText Of hoEmail To sTemp1
            Showln sTemp1
            Procedure_Return
        End

        // The OverwriteExisting property controls whether already-existing files
        // are automatically overwritten.  By default, it is set to True so that existing
        // files will be overwritten.

        // Setting OverwriteExisting = False will cause the attachment-saving methods to generate
        // unique filenames if a file with the same name already exists.  The actual filename(s)
        // saved will be present by calling GetAttachmentFilename for each attachment *after*
        // saving.
        // For example...
        Set ComOverwriteExisting Of hoEmail To False
        Get ComSaveAllAttachments Of hoEmail sDirPath To iSuccess
        If (iSuccess = False) Begin
            Get ComLastErrorText Of hoEmail To sTemp1
            Showln sTemp1
            Procedure_Return
        End

        Get ComNumAttachments Of hoEmail To iNumAttachments
        Move 0 To iAttachIndex
        While (iAttachIndex < iNumAttachments)
            // If the attachment filename was changed to prevent overwriting,
            // GetAttachmentFilename will return the new filename.
            Get ComGetAttachmentFilename Of hoEmail iAttachIndex To sTemp1
            Showln sTemp1
            Move (iAttachIndex + 1) To iAttachIndex
        Loop

        // Attachments can also be saved individually.
        Move 0 To iAttachIndex
        While (iAttachIndex < iNumAttachments)

            Get ComGetAttachmentFilename Of hoEmail iAttachIndex To sTemp1
            Showln "Original Filename: " sTemp1
            Get ComSaveAttachedFile Of hoEmail iAttachIndex sDirPath To iSuccess
            If (iSuccess = False) Begin
                Get ComLastErrorText Of hoEmail To sTemp1
                Showln sTemp1
                Procedure_Return
            End

            // If OverwriteExisting = True, the saved filename will always equal the original filename,
            // unless there are characters present in the filename that are not allowed by Windows,
            // such as * ? < > | etc.  In those cases the illegal characters are either removed or replaced
            // with underscore characters to allow the file to be saved.
            Get ComGetAttachmentFilename Of hoEmail iAttachIndex To sTemp1
            Showln "Saved Filename: " sTemp1
            Move (iAttachIndex + 1) To iAttachIndex
        Loop

        Move (iBundleIndex + 1) To iBundleIndex
    Loop



End_Procedure