(DataFlex) Download and Save Email Attachments (POP3)

See more POP3 Examples

Downloads emails from a POP3 mailbox and saves all attachments.

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

Use ChilkatAx-win32.pkg

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

    // 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.
    // CopyMail 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 ComCopyMail Of hoMailman To vBundle
    If (IsComObject(vBundle)) Begin
        Get Create (RefClass(cComChilkatEmailBundle)) To hoBundle
        Set pvComObject Of hoBundle To vBundle
    End
    Get ComLastMethodSuccess Of hoMailman To bTemp1
    If (bTemp1 <> True) 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

    Move 0 To iBundleIndex
    Get ComMessageCount Of hoBundle To iNumMessages

    While (iBundleIndex < iNumMessages)
        Get ComGetEmail Of hoBundle iBundleIndex To vEmail
        If (IsComObject(vEmail)) Begin
            Get Create (RefClass(cComChilkatEmail)) To hoEmail
            Set pvComObject Of hoEmail To vEmail
        End

        // 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 <> True) 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 <> True) 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 <> True) 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

        Send Destroy of hoEmail

        Move (iBundleIndex + 1) To iBundleIndex
    Loop

    Send Destroy of hoBundle


End_Procedure