Gmail IMAP: Workspace Service Account with a JSON Key
Use a service-account JSON key with Google Workspace domain-wide delegation. A Workspace administrator must authorize the service account's numeric OAuth client ID for https://mail.google.com/. Set SubEmailAddress to the Workspace user whose active Gmail mailbox is being accessed, and use that same address for IMAP login.
A service account has no Gmail mailbox of its own; leaving the impersonated user empty does not grant access to a personal Gmail account. The signed JWT exchange yields a short-lived token without a refresh token. Obtain another when needed, protect the private key, and keep the computer clock accurate.
This example lists visible folders and examines INBOX read-only. For the different visibility rules of the IMAP-only administrative scope, see gmail.imap_admin delegation.
See the Gmail SMTP, IMAP, and POP3 guide for current authentication choices and Gmail-specific examples.
Chilkat PHP ActiveX Downloads
<?php
$success = 0;
// Assumes Chilkat is unlocked. See Global Unlock Sample.
$mailbox = 'user@example.com';
$key = new COM("Chilkat.JsonObject");
$success = $key->LoadFile('gmail-service-account.json');
if ($success != 1) {
print 'Could not load the private service-account key.' . "\n";
exit;
}
if (($key->StringOfEquals('type','service_account',1) != 1) or ($key->JsonTypeOf('private_key') != 1)) {
print 'Expected a Google service-account JSON key.' . "\n";
exit;
}
$auth = new COM("Chilkat.AuthGoogle");
$auth->JsonKey = $key->emit();
$auth->SubEmailAddress = $mailbox;
$auth->Scope = 'https://mail.google.com/';
$auth->ExpireNumSeconds = 3600;
$connection = new COM("Chilkat.Socket");
$connection->RequireSslCertVerify = 1;
$success = $connection->Connect('www.googleapis.com',443,1,10000);
if ($success != 1) {
print 'Could not establish the Google token connection.' . "\n";
exit;
}
$success = $auth->ObtainAccessToken($connection);
$connection->Close(1000);
if ($success != 1) {
print 'Check the key, domain-wide delegation client ID/scope, user, and computer clock.' . "\n";
exit;
}
$imap = new COM("Chilkat.Imap");
$imap->Ssl = 1;
$imap->Port = 993;
$imap->RequireSslCertVerify = 1;
$imap->AuthMethod = 'XOAUTH2';
$success = $imap->Connect('imap.gmail.com');
if ($success != 1) {
print 'Could not establish the Gmail IMAP TLS connection.' . "\n";
exit;
}
$success = $imap->Login($mailbox,$auth->AccessToken);
if ($success != 1) {
$imap->Disconnect();
print 'IMAP authentication failed. Check the mailbox, scope, expiry, and account policy.' . "\n";
exit;
}
$folders = new COM("Chilkat.Mailboxes");
$success = $imap->MbxList(0,'','*',$folders);
if ($success != 1) {
$imap->Logout();
$imap->Disconnect();
print 'Could not list Gmail folders.' . "\n";
exit;
}
// List the labels visible through ordinary full-mail IMAP access.
$i = 0;
while (($i < $folders->Count)) {
print $folders->getName($i) . "\n";
$i = $i + 1;
}
$success = $imap->ExamineMailbox('INBOX');
if ($success != 1) {
$imap->Logout();
$imap->Disconnect();
print 'Could not examine the impersonated user's INBOX.' . "\n";
exit;
}
print 'INBOX messages: ' . $imap->NumMessages . "\n";
$imap->Logout();
$imap->Disconnect();
?>