Objective-C

Examine Yahoo Mail IMAP Session Log

See more Yahoo Mail Examples

To examine the IMAP session log, set the KeepSessionLog property = _TRUE_, and then examine the contents of the SessionLog property. Objective-C

#import <CkoJsonObject.h>
#import <NSString.h>
#import <CkoImap.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.

// See Get Yahoo Mail OAuth2 Access Token for Desktop App 
// for sample code showing how to obtain a Yahoo Mail access token.

// In this example, our access token was previously saved to the following file which contains JSON like this:
// {
//   "access_token": "kCVQdnOdul...LHucA--",
//   "refresh_token": "AIenVXETSo0jklFBVkPS8vVm8E.Ej9ToRG.xDbDYmZ65WIs5t6CZhDrD",
//   "expires_in": 3600,
//   "token_type": "bearer",
//   "xoauth_yahoo_guid": "HGDQCVF5JB4YDOWHITQJFBHCWA"
// }

CkoJsonObject *json = [[CkoJsonObject alloc] init];
success = [json LoadFile: @"qa_data/tokens/yahooMail.json"];
if (success != YES) {
    NSLog(@"%@",@"Failed to load Yahoo Mail access token file.");
    return;
}

NSString *accessToken = [json StringOf: @"access_token"];

// Do OAuth2 authentication by using the access token as the password in the Login method below...
CkoImap *imap = [[CkoImap alloc] init];

imap.Ssl = YES;
imap.Port = [NSNumber numberWithInt:993];

// Tell Chilkat IMAP to keep a session log.
imap.KeepSessionLog = YES;

// Connect to the Yahoo IMAP server.
success = [imap Connect: @"imap.mail.yahoo.com"];
if (success == NO) {
    NSLog(@"%@",imap.LastErrorText);
    return;
}

// Indicate that XOAUTH2 authentication is to be used:
imap.AuthMethod = @"XOAUTH2";

// Login
// Use the email address of the Yahoo Mail account that granted authorization.
success = [imap Login: @"user@yahoo.com" password: accessToken];
if (success != YES) {
    NSLog(@"%@",imap.LastErrorText);
}
else {
    NSLog(@"%@",@"Successfully authenticated with Yahoo IMAP using XOAUTH2!");
}

// Get the list of mailboxes.
NSString *refName = @"";
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:

// Archive
// Bulk Mail
// Draft
// Inbox
// Inbox/emailsWithAttach
// Inbox/test
// Sent
// Trash

// Examine the session log
NSLog(@"%@",imap.SessionLog);

// Sample session log

// ----INFO----
// Connecting to IMAP server at imap.mail.yahoo.com:993
// ----IMAP RESPONSE----
// * OK [CAPABILITY IMAP4rev1 SASL-IR AUTH=PLAIN AUTH=XOAUTH2 AUTH=OAUTHBEARER ID MOVE NAMESPACE XYMHIGHESTMODSEQ UIDPLUS LITERAL+ CHILDREN X-MSG-EXT OBJECTID] IMAP4rev1 Hello
// ----IMAP REQUEST----
// aaab AUTHENTICATE XOAUTH2 
// ----IMAP RESPONSE----
// aaab OK AUTHENTICATE completed
// ----IMAP REQUEST----
// aaac LIST "" "*"
// ----IMAP RESPONSE----
// * LIST (\Archive \HasNoChildren) "/" "Archive"
// * LIST (\Junk \HasNoChildren) "/" "Bulk Mail"
// * LIST (\Drafts \HasNoChildren) "/" "Draft"
// * LIST (\HasChildren) "/" "Inbox"
// * LIST (\HasNoChildren) "/" "Inbox/emailsWithAttach"
// * LIST (\HasNoChildren) "/" "Inbox/test"
// * LIST (\Sent \HasNoChildren) "/" "Sent"
// * LIST (\Trash \HasNoChildren) "/" "Trash"
// aaac OK LIST completed

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