Objective-C

List and Inspect IMAP Mailboxes

Demonstrates the Chilkat Mailboxes class, a read-only result collection populated by Imap.MbxList. This example connects to an IMAP server, lists all mailboxes into a Mailboxes object, then loops from 0 to Count - 1 and inspects each mailbox: its name (GetName), whether it is selectable (IsSelectable) or marked (IsMarked), whether it may have child mailboxes (HasInferiors), a specific flag (HasFlag), and all of its flags both as a string (GetFlags) and individually (GetNumFlags with GetNthFlag). Finally it looks up a mailbox by name with GetMailboxIndex.

Background: Mailboxes is how an application renders an IMAP folder tree. Because it is read-only, you never construct it directly — you receive it from MbxList and read its entries by index. Mailbox names come back as normal Unicode text (Chilkat handles the modified UTF-7 / IMAP UTF-8 encoding at the protocol level), so a name from GetName can be passed straight to methods like SelectMailbox. Note that HasInferiors is often true: it means children exist or may be created, which is not the same as \HasChildren.

Chilkat Objective-C Downloads

Download Chilkat for Objective-C

Objective-C

#import <CkoImap.h>
#import <CkoMailboxes.h>
#import <NSString.h>

BOOL success = NO;

//  Demonstrates using Chilkat.Imap to populate a Mailboxes object (via MbxList), then looping
//  over the collection to inspect each mailbox's name and attributes.  Mailboxes is a read-only
//  result collection -- applications inspect the entries but do not add, remove, or modify them.

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;
}

//  Populate a Mailboxes object with the full list of mailboxes.  The first argument requests
//  all mailboxes (not subscribed-only) and "*" matches any name.
BOOL subscribedOnly = NO;
CkoMailboxes *mailboxes = [[CkoMailboxes alloc] init];
success = [imap MbxList: subscribedOnly reference: @"" mbxPattern: @"*" mboxes: mailboxes];
if (success == NO) {
    NSLog(@"%@",imap.LastErrorText);
    return;
}

//  Loop over each mailbox in the returned collection.
int n = [mailboxes.Count intValue];
NSLog(@"%@%d",@"Number of mailboxes: ",n);

int i;
for (i = 0; i <= n - 1; i++) {
    NSString *name = [mailboxes GetName: [NSNumber numberWithInt: i]];
    NSLog(@"%@%@",@"Mailbox: ",name);

    //  Whether the mailbox can be selected or examined for message access.
    if ([mailboxes IsSelectable: [NSNumber numberWithInt: i]]) {
        NSLog(@"%@",@"  Selectable: yes");
    }
    else {
        NSLog(@"%@",@"  Selectable: no");
    }

    //  Whether the server marked the mailbox as possibly having new messages.
    if ([mailboxes IsMarked: [NSNumber numberWithInt: i]]) {
        NSLog(@"%@",@"  Marked: yes");
    }

    //  Whether the mailbox has, or may contain, child mailboxes.
    if ([mailboxes HasInferiors: [NSNumber numberWithInt: i]]) {
        NSLog(@"%@",@"  May have child mailboxes");
    }

    //  Check for a specific flag by name.  Include the leading backslash for a system flag;
    //  in CkScript a literal backslash in a string is written as "\\".
    if ([mailboxes HasFlag: [NSNumber numberWithInt: i] flagName: @"\\HasChildren"]) {
        NSLog(@"%@",@"  Has child mailboxes");
    }

    //  Get all of the mailbox's flags as a comma-separated string.
    NSString *flags = [mailboxes GetFlags: [NSNumber numberWithInt: i]];
    NSLog(@"%@%@",@"  Flags: ",flags);

    //  Iterate the flags individually.
    int numFlags = [[mailboxes GetNumFlags: [NSNumber numberWithInt: i]] intValue];
    int j;
    for (j = 0; j <= numFlags - 1; j++) {
        NSString *flag = [mailboxes GetNthFlag: [NSNumber numberWithInt: i] flagIndex: [NSNumber numberWithInt: j]];
        NSLog(@"%@%d%@%@",@"    Flag ",j,@": ",flag);
    }

}

//  Look up a mailbox by name.  Returns -1 if no mailbox with that name is present.
int sentIndex = [[mailboxes GetMailboxIndex: @"Sent"] intValue];
if (sentIndex >= 0) {
    NSLog(@"%@%d",@"The Sent mailbox is at index ",sentIndex);
}

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