(Objective-C) Subscribe to Mailboxes and List Subscribed Mailboxes

Demonstrates how to list subscribed mailboxes, and unsubscribe/subscribe to a mailbox.

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

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

// 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];
BOOL success = [imap Connect: @"imap.someMailServer.com"];
if (success != YES) {
    NSLog(@"%@",imap.LastErrorText);
    return;
}

// Login
success = [imap Login: @"myLogin" password: @"myPassword"];
if (success != YES) {
    NSLog(@"%@",imap.LastErrorText);
    return;
}

// First examine the already subscribed mailboxes.
NSString *refName = @"";
NSString *wildcardedMailbox = @"*";

// Alternatively, the ListMailboxes method can be called to list all mailboxes (both subscribed and unsubscribed).
CkoMailboxes *mboxes = [imap ListSubscribed: refName wildcardedMailbox: wildcardedMailbox];
if (imap.LastMethodSuccess != YES) {
    NSLog(@"%@",imap.LastErrorText);
    return;
}

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

NSLog(@"%@",@"----");

// Sample output.

// INBOX
// INBOX/recent
// INBOX/misc
// INBOX/misc/solutions
// ...
// Outbox
// Deleted Items
// Sent Items
// Drafts
// Junk E-mail
// Trash
// Sent
// Templates

// Let's unsubscribe to "INBOX/misc/solutions".
success = [imap Unsubscribe: @"INBOX/misc/solutions"];
if (success != YES) {
    NSLog(@"%@",imap.LastErrorText);
    return;
}

// Get the list of subscribed mailboxes again to verify that "INBOX/misc/solutions" is missing.
mboxes = [imap ListSubscribed: @"" wildcardedMailbox: @"INBOX/misc*"];
if (imap.LastMethodSuccess != YES) {
    NSLog(@"%@",imap.LastErrorText);
    return;
}

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

NSLog(@"%@",@"----");

// Re-subscribe to "INBOX/misc/solutions".
success = [imap Subscribe: @"INBOX/misc/solutions"];
if (success != YES) {
    NSLog(@"%@",imap.LastErrorText);
    return;
}

// Get the list of subscribed mailboxes again to verify that "INBOX/misc/solutions" is back in the list.
mboxes = [imap ListSubscribed: @"" wildcardedMailbox: @"INBOX/misc*"];
if (imap.LastMethodSuccess != YES) {
    NSLog(@"%@",imap.LastErrorText);
    return;
}

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

NSLog(@"%@",@"----");

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