Objective-C

Delete a POP3 Message via an Email Object

Demonstrates the Chilkat MailMan.DeleteEmail method, which deletes a POP3 message using the UIDL stored in the X-UIDL header of an Email object. The email must contain an X-UIDL header, which it does after being fetched from the server. This example fetches a message and then deletes it.

Background: When Chilkat downloads a POP3 message it records the server UIDL in an X-UIDL header on the Email object. DeleteEmail uses that header to tell the server which message to remove — a natural "process then delete" flow: fetch a message, act on it, then delete it. As always in POP3, the deletion is only committed when the session ends (unless ImmediateDelete is set).

Chilkat Objective-C Downloads

Download Chilkat for Objective-C

Objective-C

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

BOOL success = NO;

//  Demonstrates the MailMan.DeleteEmail method, which deletes a POP3 message using the UIDL
//  stored in the X-UIDL header of an Email object.  The email must contain an X-UIDL header
//  (as it does after being fetched from the server).

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 a message (headers are enough; the X-UIDL header identifies it on the server).
CkoEmail *email = [[CkoEmail alloc] init];

success = [mailman FetchOne: YES numBodyLines: [NSNumber numberWithInt: 0] msgNum: [NSNumber numberWithInt: 1] email: email];
if (success == NO) {
    NSLog(@"%@",mailman.LastErrorText);
    return;
}

//  Delete that message using its X-UIDL header.
success = [mailman DeleteEmail: email];
if (success == NO) {
    NSLog(@"%@",mailman.LastErrorText);
    return;
}

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

NSLog(@"%@",@"Deleted the email 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.