Objective-C

Set an IMAP Flag Using an Email Object

Demonstrates the Chilkat Imap.SetMailFlag method, which sets or clears a flag on the server for the message represented by an Email object. The first argument is the Email, the second is the flag name, and the third is the value (1 to set, 0 to clear). This example flags each fetched message as Flagged on the server.

Background: SetMailFlag is convenient when you already hold an Email from a fetch: Chilkat uses the UID it recorded on that object to target the right message on the server, so you do not have to track IDs yourself. It updates both the server and the local Email object, keeping the two in sync. Under the hood this is the same STORE operation as SetFlag — just addressed by object rather than by raw ID.

Chilkat Objective-C Downloads

Download Chilkat for Objective-C

Objective-C

#import <CkoImap.h>
#import <CkoMessageSet.h>
#import <CkoEmailBundle.h>
#import <CkoEmail.h>

BOOL success = NO;

//  Demonstrates the Imap.SetMailFlag method, which sets or clears a flag on the server for the
//  message represented by an Email object.  The 1st argument is the Email, the 2nd is the flag
//  name, and the 3rd is the value (1 to set, 0 to clear).

CkoImap *imap = [[CkoImap alloc] init];

imap.Ssl = YES;
imap.Port = [NSNumber numberWithInt:993];

success = [imap Connect: @"imap.example.com"];
if (success == NO) {
    NSLog(@"%@",imap.LastErrorText);
    return;
}

success = [imap Login: @"user@example.com" password: @"myPassword"];
if (success == NO) {
    NSLog(@"%@",imap.LastErrorText);
    return;
}

success = [imap SelectMailbox: @"Inbox"];
if (success == NO) {
    NSLog(@"%@",imap.LastErrorText);
    return;
}

CkoMessageSet *msgSet = [[CkoMessageSet alloc] init];
success = [imap QueryMbx: @"UNSEEN" bUid: YES msgSet: msgSet];
if (success == NO) {
    NSLog(@"%@",imap.LastErrorText);
    return;
}

CkoEmailBundle *bundle = [[CkoEmailBundle alloc] init];
success = [imap FetchMsgSet: YES msgSet: msgSet bundle: bundle];
if (success == NO) {
    NSLog(@"%@",imap.LastErrorText);
    return;
}

CkoEmail *email = [[CkoEmail alloc] init];
int i;
for (i = 0; i <= [bundle.MessageCount intValue] - 1; i++) {
    success = [bundle EmailAt: [NSNumber numberWithInt: i] email: email];
    //  Mark this message as Flagged on the server.  A value of 1 sets the flag; 0 would clear it.
    success = [imap SetMailFlag: email flagName: @"Flagged" value: [NSNumber numberWithInt: 1]];
    if (success == NO) {
        NSLog(@"%@",imap.LastErrorText);
        return;
    }

}

NSLog(@"%@%d%@",@"Flagged ",[bundle.MessageCount intValue],@" messages.");

success = [imap Disconnect];
if (success == NO) {
    NSLog(@"%@",imap.LastErrorText);
    return;
}