(PHP Extension) OAuth2 for GMail using a Service Account Key

Demonstrates how to use GMail with OAuth2 for a Google Service Account. The 1st step is to obtain a temporary access token from the Google OAuth 2.0 Authorization Server. This can be accomplished using Chilkat HTTP.

Once the access token is obtained, it may be used in IMAP XOAUTH2 authentication. The access token may be used while it remains valid to send as many emails as desired. Once it expires, a new access token needs to be obtained (using the same procedure).

Note: This is for OAuth2 using Google Service account keys.

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.

// --------------------------------------------------------------------
// Important:  In most cases, this example is not what you are looking for.
// This example is for OAuth2 using a Google Service Account Key.
// 
// It is more likely that the example you actually need is here:
// Get GMail IMAP OAuth2 Access Token 
// --------------------------------------------------------------------

// When a service account (Client ID) is created at https://code.google.com/apis/console/
// Google will generate a P12 key.  This is a PKCS12 (PFX) file that you will download
// and save.  The password to access the contents of this file is "notasecret".
// NOTE: The Chilkat Pfx API provides the ability to load a PFX/P12 and re-save
// with a different password.

// Begin by loading the downloaded .p12 into a Chilkat certificate object:
$cert = new CkCert();
$success = $cert->LoadPfxFile('/myDir/API Project-1c43a291e2a1-notasecret.p12','notasecret');
if ($success != true) {
    print $cert->lastErrorText() . "\n";
    exit;
}

// The next (and final) step is to request the access token.  Chilkat internally
// does all the work of forming the JWT header and JWT claim set, encoding and
// signing the JWT, and sending the access token request.
// The application need only provide the inputs: The iss, scope(s), sub, and the
// desired duration with a max of 3600 seconds (1 hour).
// 
// Each of these inputs is defined as follows 
// (see https://developers.google.com/accounts/docs/OAuth2ServiceAccount
// iss: The email address of the service account.
// scope: A space-delimited list of the permissions that the application requests.
// sub: The email address of the user for which the application is requesting delegated access.
//      The sub may be empty if there is no delegation. (This is typical.)
// numSec: The number of seconds for which the access token will be valid (max 3600).

$iss = '761326798069-r5mljlln1rd4lrbhg75efgigp36m78j5@developer.gserviceaccount.com';
$scope = 'https://mail.google.com/';
$sub = '';
$numSec = 3600;

$http = new CkHttp();
$accessToken = $http->g_SvcOauthAccessToken($iss,$scope,$sub,$numSec,$cert);
if ($http->get_LastMethodSuccess() != true) {
    print $http->lastErrorText() . "\n";
    exit;
}
else {
    print 'access token: ' . $accessToken . "\n";
}

// Now that we have the access token, it may be used to authenticate via XOAUTH2 with GMail:

$imap = new CkImap();

// GMail's IMAP service uses SSL and port 993.
$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
// The username must be the email address used for the "sub" argument when getting
// the access token.  Instead of using a password, pass the access token in the 2nd argument:
$success = $imap->Login('user@your-domain.com',$accessToken);
if ($success != true) {
    print $imap->lastErrorText() . "\n";
}
else {
    print 'Successfully authenticate with GMail IMAP using XOAUTH2!' . "\n";
}


?>