Objective-C

List IMAP Mailboxes

List the mailboxes available within an IMAP account. Objective-C

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

BOOL success = NO;

//  This example assumes the Chilkat API to have been previously unlocked.
//  See Global Unlock Sample for sample code.

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

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

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

NSString *refName = @"";
//  refName is usually set to an empty string.
//  A non-empty reference name argument is the name of a mailbox or a level of
//  mailbox hierarchy, and indicates the context in which the mailbox
//  name is interpreted.

//  Select all mailboxes matching this pattern:
NSString *wildcardedMailbox = @"*";

BOOL subscribed = NO;

CkoMailboxes *mboxes = [[CkoMailboxes alloc] init];
success = [imap MbxList: subscribed reference: refName mbxPattern: wildcardedMailbox mboxes: mboxes];
if (success == NO) {
    NSLog(@"%@",imap.LastErrorText);
    return;
}

int i = 0;
while (i < [mboxes.Count intValue]) {
    NSLog(@"%@",[mboxes GetName: [NSNumber numberWithInt: i]]);
    i = i + 1;
}

//  Sample output looks like this:
//  INBOX.vendors.shareit
//  INBOX.oldSupport
//  INBOX.vendors.paypal
//  INBOX.sales
//  INBOX.lists
//  INBOX.Drafts
//  INBOX.vendors.dell
//  INBOX.Trash
//  INBOX.invoiceRequests
//  INBOX.purchases
//  INBOX.vendors.inMotion
//  INBOX.oldEmail
//  INBOX.vendors
//  INBOX.lists.python
//  INBOX.vendors.myhosting
//  INBOX.Templates
//  INBOX.friends
//  INBOX.bounceSamples
//  INBOX.lists.ruby
//  INBOX.vendors.peer1
//  INBOX.Sent
//  INBOX.Junk
//  INBOX

//  Disconnect from the IMAP server.
success = [imap Disconnect];