(Node.js) GMail IMAP Authentication using OAuth2 Access Token

Demonstrates how to do IMAP OAuth2 authentication for GMail (or any other IMAP mail server supporting OAuth2 authentication). This example assumes an OAuth2 access token was previously obtained.

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 requires the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    // See Get GMail IMAP OAuth2 Access Token for Desktop App 
    // for sample code showing how to obtain a GMail IMAP read/write access token.

    // In this example, our access token was previously saved to the following file which contains JSON like this:
    // 	{
    // 	 "access_token": "ya39.Ci-XA_C5bGgRDC3UaD-h0_NeL-DVIQnI2gHtBBBHkZzrwlARkwX6R3O0PCDEzRlfaQ",
    // 	 "token_type": "Bearer",
    // 	 "expires_in": 3600,
    // 	 "refresh_token": "1/r_2c_7jddspcdfesrrfKqfXtqo08D6Q-gUU0DsdfVMsx0c"
    // 	}
    // 
    var json = new chilkat.JsonObject();
    var success = json.LoadFile("qa_data/tokens/_gmailFullAccess.json");
    if (success !== true) {
        console.log("Failed to load GMail 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;

    // Connect to the GMail IMAP server.
    success = imap.Connect("imap.gmail.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 GMail account that granted authorization.
    success = imap.Login("user@gmail.com",accessToken);
    if (success !== true) {
        console.log(imap.LastErrorText);
    }
    else {
        console.log("Successfully authenticated with GMail IMAP using XOAUTH2!");
    }


}

chilkatExample();