Swift

Download and Save Email Attachments (POP3)

See more POP3 Examples

Downloads emails from a POP3 mailbox and saves all attachments. Swift

func chilkatTest() {
    var success: Bool = false

    // 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.
    let mailman = CkoMailMan()!

    // Set the POP3 server's hostname
    mailman.mailHost = "pop.yourserver.com"

    // Set the POP3 login/password.
    mailman.popUsername = "***"
    mailman.popPassword = "***"

    // 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..
    let bundle = CkoEmailBundle()!
    var keepOnServer: Bool = true
    var headersOnly: Bool = false
    // Irrelevent because we are NOT downloading headers-only
    var numBodyLines: Int = 0
    success = mailman.fetchAll(keepOnServer: keepOnServer, headersOnly: headersOnly, numBodyLines: numBodyLines, bundle: bundle)
    if success == false {
        print("\(mailman.lastErrorText!)")
        return
    }

    // The directory path can be relative or absolute.
    // This shows a Windows style directory path.  On other operating systems, the path
    // would be different..
    var dirPath: String? = "c:/myAttachments"

    let email = CkoEmail()!
    var bundleIndex: Int = 0
    var numMessages: Int = bundle.messageCount.intValue

    while (bundleIndex < numMessages) {
        bundle.email(at: bundleIndex, email: email)

        // Save all attachments to the specified directory.
        // The directory is automatically created if it does not yet exist.
        success = email.saveAllAttachments(directory: dirPath)
        if success == false {
            print("\(email.lastErrorText!)")
            return
        }

        // 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...
        email.overwriteExisting = false
        success = email.saveAllAttachments(directory: dirPath)
        if success == false {
            print("\(email.lastErrorText!)")
            return
        }

        var numAttachments: Int = email.numAttachments.intValue
        var attachIndex: Int = 0
        while (attachIndex < numAttachments) {
            // If the attachment filename was changed to prevent overwriting,
            // GetAttachmentFilename will return the new filename.
            print("\(email.getAttachmentFilename(index: attachIndex)!)")
            attachIndex = attachIndex + 1
        }

        // Attachments can also be saved individually.
        attachIndex = 0
        while (attachIndex < numAttachments) {

            print("Original Filename: \(email.getAttachmentFilename(index: attachIndex)!)")
            success = email.saveAttachedFile(index: attachIndex, directory: dirPath)
            if success == false {
                print("\(email.lastErrorText!)")
                return
            }

            // 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.
            print("Saved Filename: \(email.getAttachmentFilename(index: attachIndex)!)")
            attachIndex = attachIndex + 1
        }

        bundleIndex = bundleIndex + 1
    }


}