(JavaScript) Examine Yahoo Mail IMAP Session Log

See more Yahoo Mail Examples

Note: This example requires Chilkat v11.0.0 or greater.

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

var success = false;

// 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"
// }

var json = new CkJsonObject();
success = json.LoadFile("qa_data/tokens/yahooMail.json");
if (success !== true) {
    console.log("Failed to load Yahoo Mail access token file.");
    return;
}

var accessToken = json.StringOf("access_token");

// Do OAuth2 authentication by using the access token as the password in the Login method below...
var imap = new CkImap();

imap.Ssl = true;
imap.Port = 993;

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

// Connect to the Yahoo IMAP server.
success = imap.Connect("imap.mail.yahoo.com");
if (success == false) {
    console.log(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",accessToken);
if (success !== true) {
    console.log(imap.LastErrorText);
}
else {
    console.log("Successfully authenticated with Yahoo IMAP using XOAUTH2!");
}

// Get the list of mailboxes.
var refName = "";
var wildcardedMailbox = "*";
var subscribed = false;

var mboxes = new CkMailboxes();
success = imap.MbxList(subscribed,refName,wildcardedMailbox,mboxes);
if (success == false) {
    console.log(imap.LastErrorText);
    return;
}

var i = 0;
while (i < mboxes.Count) {
    console.log(mboxes.GetName(i));
    i = i+1;
}

// Sample output looks like this:

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

// Examine the session log
console.log(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();