Objective-C

Get IMAP Mailbox Status

Demonstrates the Chilkat Imap.GetMailboxStatus method, which sends the IMAP STATUS command for a mailbox and returns the reported values as XML attributes — including messages (total count), recent, uidnext, uidvalidity, and unseen. This example gets the Inbox status.

Tip: XML parsing code for this result can be generated at Chilkat Tools.

Background: STATUS queries a mailbox's summary counts without selecting it — ideal for showing unread counts across many folders in a UI, or checking whether a folder has new mail before deciding to open it. Two values are especially useful for sync: uidvalidity (if it changes, previously stored UIDs are no longer valid) and uidnext (the UID the next new message will get, so anything at or above a remembered value is new).

Chilkat Objective-C Downloads

Download Chilkat for Objective-C

Objective-C

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

BOOL success = NO;

//  Demonstrates the Imap.GetMailboxStatus method, which sends the IMAP STATUS command for a
//  mailbox and returns the reported values as XML attributes (such as messages, recent,
//  uidnext, uidvalidity, and unseen).

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

//  Get the status of a mailbox (without selecting it).
NSString *statusXml = [imap GetMailboxStatus: @"Inbox"];
if (imap.LastMethodSuccess == NO) {
    NSLog(@"%@",imap.LastErrorText);
    return;
}

NSLog(@"%@",statusXml);

//  XML parsing code for this result can be generated at Chilkat's online tool:
//  https://tools.chilkat.io/xmlParse

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