(Objective-C) Get IMAP UID from Email Header

Demonstrates how to get the IMAP UID from an email header. After fetching an email or header using IMAP, the UID is contained in the ckx-imap-uid header field.

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

#import <CkoImap.h>
#import <CkoMessageSet.h>
#import <CkoEmailBundle.h>
#import <CkoEmail.h>
#import <NSString.h>

// This example requires 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: @"login" password: @"password"];
if (success != YES) {
    NSLog(@"%@",imap.LastErrorText);
    return;
}

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

BOOL fetchUids = YES;
// Get the message UIDs of all the emails in the mailbox
CkoMessageSet *messageSet = [imap Search: @"ALL" bUid: fetchUids];
if (imap.LastMethodSuccess != YES) {
    NSLog(@"%@",imap.LastErrorText);
    return;
}

CkoEmailBundle *bundle = [imap FetchHeaders: messageSet];
if (imap.LastMethodSuccess != YES) {

    NSLog(@"%@",imap.LastErrorText);
    return;
}

// The UID of each fetched email header is available 
// in the ckx-imap-uid header field.
int i = 0;
int szBundle = [bundle.MessageCount intValue];
CkoMessageSet *msOneMsg = [[CkoMessageSet alloc] init];
while (i < szBundle) {
    CkoEmail *email = [bundle GetEmail: [NSNumber numberWithInt: i]];

    // Build a message set containing one UID
    NSString *uidStr = [email GetHeaderField: @"ckx-imap-uid"];
    [msOneMsg FromCompactString: uidStr];

    // Move this message to some other folder.
    success = [imap MoveMessages: msOneMsg destFolder: @"someOtherFolder"];
    if (success != YES) {
        NSLog(@"%@",imap.LastErrorText);
        // Exit the loop...
        i = szBundle;
    }

    i = i + 1;
}

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