(Objective-C) IMAP Get List of Flags

When a mailbox is selected, the server response includes a list of flags:

The FLAGS response occurs as a result of a SELECT or EXAMINE command. The flag parenthesized list identifies the flags (at a minimum, the system-defined flags) that are applicable for this mailbox. Flags other than the system flags can also exist, depending on server implementation.

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

#import <CkoImap.h>
#import <NSString.h>
#import <CkoStringBuilder.h>
#import <CkoStringTable.h>

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

// This example assumes Chilkat Imap to have been previously unlocked.
// See Unlock Imap for sample code.

// Connect to an IMAP server.
// Use TLS
imap.Ssl = YES;
imap.Port = [NSNumber numberWithInt:993];
BOOL success = [imap Connect: @"MY-IMAP-DOMAIN"];
if (success != YES) {
    NSLog(@"%@",imap.LastErrorText);
    return;
}

// Login
success = [imap Login: @"MY-IMAP-LOGIN" password: @"MY-IMAP-PASSWORD"];
if (success != YES) {
    NSLog(@"%@",imap.LastErrorText);
    return;
}

// Select an IMAP mailbox
success = [imap SelectMailbox: @"INBOX"];
if (success != YES) {
    NSLog(@"%@",imap.LastErrorText);
    return;
}

// The LastResponse property contains the full response of the last command.
NSString *selectResponse = imap.LastResponse;
NSLog(@"%@",selectResponse);

// For example, on GMail, the SELECT response looks like this:

// 	* FLAGS (\Answered \Flagged \Draft \Deleted \Seen $Forwarded $NotPhishing $Phishing $label1 $label2 $label3 $label4 $label5 Junk NonJunk)
// 	* OK [PERMANENTFLAGS (\Answered \Flagged \Draft \Deleted \Seen $Forwarded $NotPhishing $Phishing $label1 $label2 $label3 $label4 $label5 Junk NonJunk \*)] Flags permitted.
// 	* OK [UIDVALIDITY 3] UIDs valid.
// 	* 46 EXISTS
// 	* 0 RECENT
// 	* OK [UIDNEXT 4147] Predicted next UID.
// 	* OK [HIGHESTMODSEQ 402971]
// 	aaac OK [READ-WRITE] INBOX selected. (Success)

// The goal of this example is to capture the list of FLAGS.
// All IMAP servers will respond with the list of flags in a SPACE separated list enclosed in parentheses.

CkoStringBuilder *sbResponse = [[CkoStringBuilder alloc] init];
[sbResponse Append: selectResponse];

// Get just the list of flags:
CkoStringBuilder *sbFlagList = [[CkoStringBuilder alloc] init];
[sbFlagList Append: [sbResponse GetAfterBetween: @"* FLAGS" beginMark: @"(" endMark: @")"]];
NSLog(@"%@",[sbFlagList GetAsString]);

// sbFlagList contains this:  
// 
//     \Answered \Flagged \Draft \Deleted \Seen $Forwarded $NotPhishing $Phishing $label1 $label2 $label3 $label4 $label5 Junk NonJunk
// 

// Make sure no more than one SPACE char in a row exists.
[sbFlagList TrimInsideSpaces];
// Modify sbFlagList to one flag per line
int numReplaced = [[sbFlagList Replace: @" " replacement: @"\r\n"] intValue];

// Load a StringTable with the flag names.
CkoStringTable *flagsTable = [[CkoStringTable alloc] init];
[flagsTable AppendFromSb: sbFlagList];

// Iterate over the individual flag names:
int i = 0;
while (i < [flagsTable.Count intValue]) {
    NSLog(@"%d%@%@",i,@": ",[flagsTable StringAt: [NSNumber numberWithInt: i]]);
    i = i + 1;
}

// The output is:
// 
// 	0: \Answered
// 	1: \Flagged
// 	2: \Draft
// 	3: \Deleted
// 	4: \Seen
// 	5: $Forwarded
// 	6: $NotPhishing
// 	7: $Phishing
// 	8: $label1
// 	9: $label2
// 	10: $label3
// 	11: $label4
// 	12: $label5
// 	13: Junk
// 	14: NonJunk
//