Objective-C

Delete a Bundle of POP3 Messages

Demonstrates the Chilkat MailMan.DeleteBundle method, which deletes POP3 messages using the UIDLs stored in the X-UIDL headers of the Email objects in an EmailBundle. An email without an X-UIDL header is skipped. This example fetches all messages and deletes them.

Background: DeleteBundle is the batch version of DeleteEmail: it marks every message in a downloaded bundle for deletion in one call. A typical "download and clear the mailbox" workflow is to fetch all messages, process them, then delete the whole bundle. Because a bundle can be filtered or built selectively, you can also delete just the subset you no longer need. The deletions commit when the POP3 session ends.

Chilkat Objective-C Downloads

Download Chilkat for Objective-C

Objective-C

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

BOOL success = NO;

//  Demonstrates the MailMan.DeleteBundle method, which deletes POP3 messages using the UIDLs
//  stored in the X-UIDL headers of the Email objects in an EmailBundle.  An email without an
//  X-UIDL header is skipped.

CkoMailMan *mailman = [[CkoMailMan alloc] init];

//  Configure the POP3 server connection.
mailman.MailHost = @"pop.example.com";
mailman.MailPort = [NSNumber numberWithInt:995];
mailman.PopSsl = YES;
mailman.PopUsername = @"user@example.com";
mailman.PopPassword = @"myPassword";

//  Fetch all messages (headers are enough; each carries an X-UIDL header).
CkoEmailBundle *bundle = [[CkoEmailBundle alloc] init];

success = [mailman FetchAll: YES headersOnly: YES numBodyLines: [NSNumber numberWithInt: 0] bundle: bundle];
if (success == NO) {
    NSLog(@"%@",mailman.LastErrorText);
    return;
}

//  Delete every message in the bundle.
success = [mailman DeleteBundle: bundle];
if (success == NO) {
    NSLog(@"%@",mailman.LastErrorText);
    return;
}

//  Unless the ImmediateDelete property is set to true, the messages are only marked for
//  deletion.  End the POP3 session (which sends the QUIT command) to commit the deletions.
success = [mailman Pop3EndSession];
if (success == NO) {
    NSLog(@"%@",mailman.LastErrorText);
    return;
}

NSLog(@"%@%d%@",@"Deleted ",[bundle.MessageCount intValue],@" messages from the POP3 server.");

//  Note: Explicitly connecting/authenticating is optional.  Chilkat MailMan automatically
//  connects and authenticates -- using the property settings above -- whenever a server
//  operation requires it.  Calling the explicit connect/authenticate methods can still be
//  helpful to determine whether a failure occurs while connecting or while authenticating.