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

Gmail POP3: Authenticate with OAuth2 and Check Available Mail

See more GMail SMTP/IMAP/POP Examples

Connect to pop.gmail.com:995 over implicit TLS, authenticate with XOAUTH2, and query the number of messages currently available through POP. The example does not retrieve or delete messages. It never prints the POP session log, which can contain an encoded bearer token.

Enable POP in Gmail's Forwarding and POP/IMAP settings and choose whether to make all mail or only new mail available. Workspace policy must also permit POP. Gmail's POP delivery history, delivery window, and batching mean the POP count is not the total number of messages in the account. Review the setting that controls what Gmail does after a message is accessed with POP before adding retrieval code.

For multiple clients, IMAP is usually the better fit. Gmail also provides a POP recent mode for mail from the last 30 days, but this example uses ordinary POP delivery. Gmail's removal of Check mail from other accounts concerns Gmail fetching external providers' mail; it does not remove applications' access to pop.gmail.com. See Google's POP changes FAQ.

This example reads gmail-mail-token.json from a private working directory. Authorize the account first, then refresh the access token before it expires. The separate filename avoids confusing this full-mail grant with a narrower Gmail REST token. Store credentials in protected application storage; never distribute a user's token file with an application.

Gmail SMTP, IMAP, and POP3 use the https://mail.google.com/ OAuth scope. Narrower Gmail REST scopes such as gmail.send or gmail.readonly do not authorize these protocols. Public applications using this restricted scope must meet Google's verification requirements. See Gmail OAuth scopes and XOAUTH2.

Google documentation

Chilkat PHP ActiveX Downloads

PHP ActiveX
<?php

$success = 0;

//  Assumes Chilkat is unlocked. See Global Unlock Sample.

$token = new COM("Chilkat.JsonObject");
$success = $token->LoadFile('gmail-mail-token.json');
if ($success != 1) {
    print 'Could not read gmail-mail-token.json from the private working directory.' . "\n";
    exit;
}

if (($token->JsonTypeOf('access_token') != 1) or ($token->StringOfEquals('access_token','',1) == 1)) {
    print 'An OAuth access token is required. Authorize or refresh the account first.' . "\n";
    exit;
}

$mailbox = 'user@example.com';
$mailman = new COM("Chilkat.MailMan");
$mailman->MailHost = 'pop.gmail.com';
$mailman->MailPort = 995;
$mailman->PopSsl = 1;
$mailman->RequireSslCertVerify = 1;
$mailman->PopUsername = $mailbox;
$mailman->PopPassword = '';
$mailman->OAuth2AccessToken = $token->stringOf('access_token');
$success = $mailman->Pop3Connect();
if ($success != 1) {
    print 'Could not establish the Gmail POP3 TLS connection.' . "\n";
    exit;
}

$success = $mailman->Pop3Authenticate();
if ($success != 1) {
    $mailman->Pop3EndSessionNoQuit();
    print 'POP3 authentication failed. Check the token, mailbox, POP setting, and Workspace policy.' . "\n";
    exit;
}

//  STAT counts currently available POP messages. It does not retrieve or delete them.
$count = $mailman->CheckMail();
if ($count < 0) {
    $mailman->Pop3EndSessionNoQuit();
    print 'Could not obtain the POP message count.' . "\n";
    exit;
}

print 'Messages currently available through POP: ' . $count . "\n";
//  No DELE commands were issued, so this QUIT commits no deletions.
$success = $mailman->Pop3EndSession();
if ($success != 1) {
    print 'The count was obtained, but ending the POP session failed.' . "\n";
}


?>