(Objective-C) Download and Save Email Attachments (POP3)

See more POP3 Examples

Downloads emails from a POP3 mailbox and saves all attachments.

Chilkat Objective-C Library Downloads MAC OS X (Cocoa) Libs iOS Libs

#import <CkoMailMan.h>
#import <CkoEmailBundle.h>
#import <NSString.h>
#import <CkoEmail.h>

// 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.
CkoMailMan *mailman = [[CkoMailMan alloc] init];

// 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.
// 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..
CkoEmailBundle *bundle = [mailman CopyMail];
if (mailman.LastMethodSuccess != YES) {
    NSLog(@"%@",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..
NSString *dirPath = @"c:/myAttachments";

BOOL success;
int bundleIndex = 0;
int numMessages = [bundle.MessageCount intValue];
CkoEmail *email = 0;
while ((bundleIndex < numMessages)) {
    email = [bundle GetEmail: [NSNumber numberWithInt: bundleIndex]];

    // Save all attachments to the specified directory.
    // The directory is automatically created if it does not yet exist.
    success = [email SaveAllAttachments: dirPath];
    if (success != YES) {
        NSLog(@"%@",email.LastErrorText);
        return;
    }

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

    // Setting OverwriteExisting = NO 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 = NO;
    success = [email SaveAllAttachments: dirPath];
    if (success != YES) {
        NSLog(@"%@",email.LastErrorText);
        return;
    }

    int numAttachments = [email.NumAttachments intValue];
    int attachIndex = 0;
    while ((attachIndex < numAttachments)) {
        // If the attachment filename was changed to prevent overwriting,
        // GetAttachmentFilename will return the new filename.
        NSLog(@"%@",[email GetAttachmentFilename: [NSNumber numberWithInt: attachIndex]]);
        attachIndex = attachIndex + 1;
    }

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

        NSLog(@"%@%@",@"Original Filename: ",[email GetAttachmentFilename: [NSNumber numberWithInt: attachIndex]]);
        success = [email SaveAttachedFile: [NSNumber numberWithInt: attachIndex] directory: dirPath];
        if (success != YES) {
            NSLog(@"%@",email.LastErrorText);
            return;
        }

        // If OverwriteExisting = YES, 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.
        NSLog(@"%@%@",@"Saved Filename: ",[email GetAttachmentFilename: [NSNumber numberWithInt: attachIndex]]);
        attachIndex = attachIndex + 1;
    }

    bundleIndex = bundleIndex + 1;
}