React Native

GMail IMAP Authentication using OAuth2 Access Token

See more GMail SMTP/IMAP/POP Examples

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. React Native

import { Imap, JsonObject } from '@chilkat/react-native'

async 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"
  // 	}
  // 
  const json = new JsonObject();
  try {
    json.loadFile('qa_data/tokens/_gmailFullAccess.json');
  } catch {
    console.log('Failed to load GMail access token file.');
    return;
  }

  const accessToken = json.stringOf('access_token');

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

  imap.ssl = true;
  imap.port = 993;

  // Connect to the GMail IMAP server.
  try {
    await imap.connectAsync('imap.gmail.com');
  } catch {
    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.
  try {
    await imap.loginAsync('user@gmail.com', accessToken);
    console.log('Successfully authenticated with GMail IMAP using XOAUTH2!');
  } catch {
    console.log(imap.lastErrorText);
  }
}