Sample code for 30+ languages & platforms
PHP ActiveX Requires Chilkat v11.1.0+

Gmail IMAP: Workspace Domain-Wide Delegation

See more GMail SMTP/IMAP/POP Examples

Use a JSON service-account key to impersonate a Workspace user for IMAP with https://www.googleapis.com/auth/gmail.imap_admin. A Workspace administrator must authorize the service account's numeric OAuth client ID for this exact scope in domain-wide delegation. The impersonated user must have an active Gmail mailbox.

This IMAP-only scope reveals labels hidden by Show in IMAP and messages excluded by the user's folder-size limit. It does not authorize SMTP or POP and is not available for personal Gmail accounts or ordinary user-consent flows. Workspace administrative access policies still apply.

Protect the private key and limit who can execute the delegated application. The signed JWT exchange produces a short-lived token without a refresh token; obtain another when necessary and reconnect. Keep the computer clock accurate. This example lists folders and examines INBOX read-only without printing credentials.

Google documentation

Chilkat PHP ActiveX Downloads

PHP ActiveX
<?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://www.googleapis.com/auth/gmail.imap_admin';
$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;
}

//  With gmail.imap_admin, labels hidden by the user's Show in IMAP setting are included.
$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();

?>