(Node.js) 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.

Install Chilkat for Node.js and Electron using npm at Chilkat npm packages for Node.js Chilkat npm packages for Electron on Windows, Linux, MacOSX, and ARM

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}

function chilkatExample() {

    // 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 chilkat.JsonObject();
    var 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 chilkat.Imap();

    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 !== true) {
        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!");
    }

    // The ListMailboxes method returns a Mailboxes object
    // that contains the collection of mailboxes.
    // It accepts two arguments: a refName and a wildcardedMailbox.

    var refName = "";
    // refName is usually set to an empty string.
    // A non-empty reference name argument is the name of a mailbox or a level of
    // mailbox hierarchy, and indicates the context in which the mailbox
    // name is interpreted.

    // Select all mailboxes matching this pattern:
    var wildcardedMailbox = "*";

    // mboxes: Mailboxes
    var mboxes = imap.ListMailboxes(refName,wildcardedMailbox);
    if (imap.LastMethodSuccess == 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();


}

chilkatExample();