(PHP Extension) 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.

Chilkat PHP Downloads PHP Extension for Windows, Linux, MacOS, Alpine Linux, Solaris

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

// 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"
// 	}
// 
$json = new CkJsonObject();
$success = $json->LoadFile('qa_data/tokens/_gmailFullAccess.json');
if ($success != true) {
    print 'Failed to load GMail access token file.' . "\n";
    exit;
}

$accessToken = $json->stringOf('access_token');

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

$imap->put_Ssl(true);
$imap->put_Port(993);

// Connect to the GMail IMAP server.
$success = $imap->Connect('imap.gmail.com');
if ($success != true) {
    print $imap->lastErrorText() . "\n";
    exit;
}

// Indicate that XOAUTH2 authentication is to be used:
$imap->put_AuthMethod('XOAUTH2');

// Login
// Use the email address of the GMail account that granted authorization.
$success = $imap->Login('user@gmail.com',$accessToken);
if ($success != true) {
    print $imap->lastErrorText() . "\n";
}
else {
    print 'Successfully authenticated with GMail IMAP using XOAUTH2!' . "\n";
}


?>