Search Gmail by sender, subject, date, or attachment
See more GMail REST API Examples
Choose a Gmail search query, follow every result page, and fetch From and Subject headers for each match. Edit the query to use operators such as from:, subject:, after:, before:, has:attachment, and filename:. Quoted phrases and special characters are URL-encoded once.
Gmail search dates use midnight Pacific Standard Time. Use Unix timestamps in seconds for exact date boundaries in another timezone. Spam and Trash are excluded unless includeSpamTrash=true is added. Search requires gmail.readonly or a broader mail scope. Query searches are unavailable with gmail.metadata.
Authorize the application with https://www.googleapis.com/auth/gmail.readonly. The example reads the access token from gmail-token.json in a private working directory. Authorize a desktop application.
Chilkat PHP ActiveX Downloads
<?php
$success = 0;
// Assumes Chilkat is unlocked. See Global Unlock Sample.
$token = new COM("Chilkat.JsonObject");
$success = $token->LoadFile('gmail-token.json');
if ($success != 1) {
print 'Could not read gmail-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.' . "\n";
exit;
}
$http = new COM("Chilkat.Http");
$http->RequireSslCertVerify = 1;
$http->AuthToken = $token->stringOf('access_token');
$resp = new COM("Chilkat.HttpResponse");
$reply = new COM("Chilkat.JsonObject");
$searchQuery = 'from:sender@example.com has:attachment filename:pdf';
$baseUrl = new COM("Chilkat.StringBuilder");
$baseUrl->Append('https://gmail.googleapis.com/gmail/v1/users/me/messages?maxResults=100&q=');
$baseUrl->Append($http->urlEncode($searchQuery));
$url = new COM("Chilkat.StringBuilder");
$pageToken = '';
$page = new COM("Chilkat.JsonObject");
$total = 0;
$more = 1;
while (($more == 1)) {
$url->SetString($baseUrl->getAsString());
$url->Append('&pageToken=');
$url->Append($http->urlEncode($pageToken));
$success = $http->HttpNoBody('GET',$url->getAsString(),$resp);
if ($resp->StatusCode == 0) {
print 'Gmail did not return an HTTP response.' . "\n";
exit;
}
if (($success != 1) or ($resp->StatusCode < 200) or ($resp->StatusCode >= 300)) {
print 'Gmail HTTP ' . $resp->StatusCode . "\n";
$success = $reply->Load($resp->BodyStr);
if ($success == 1) {
print $reply->stringOf('error.message') . "\n";
}
exit;
}
$success = $reply->Load($resp->BodyStr);
if ($success != 1) {
print 'Expected a Gmail JSON response.' . "\n";
exit;
}
// Keep this page while individual message requests reuse reply.
$success = $reply->MakeCopy($page);
if ($success != 1) {
print $reply->LastErrorText . "\n";
exit;
}
$i = 0;
while (($i < $page->SizeOfArray('messages'))) {
$page->I = $i;
$messageId = $page->stringOf('messages[i].id');
$url->SetString('https://gmail.googleapis.com/gmail/v1/users/me/messages/');
$url->Append($http->urlEncode($messageId));
$url->Append('?format=metadata&metadataHeaders=From&metadataHeaders=Subject');
$success = $http->HttpNoBody('GET',$url->getAsString(),$resp);
// A message can disappear between the search and the metadata request.
if ($resp->StatusCode != 404) {
if ($resp->StatusCode == 0) {
print 'Gmail did not return an HTTP response.' . "\n";
exit;
}
if (($success != 1) or ($resp->StatusCode < 200) or ($resp->StatusCode >= 300)) {
print 'Gmail HTTP ' . $resp->StatusCode . "\n";
$success = $reply->Load($resp->BodyStr);
if ($success == 1) {
print $reply->stringOf('error.message') . "\n";
}
exit;
}
$success = $reply->Load($resp->BodyStr);
if ($success != 1) {
print 'Expected a Gmail JSON response.' . "\n";
exit;
}
print 'Message: ' . $messageId . "\n";
$h = 0;
while (($h < $reply->SizeOfArray('payload.headers'))) {
$reply->I = $h;
print $reply->stringOf('payload.headers[i].name') . ': ' . $reply->stringOf('payload.headers[i].value') . "\n";
$h = $h + 1;
}
$total = $total + 1;
}
$i = $i + 1;
}
$pageToken = '';
if ($page->JsonTypeOf('nextPageToken') == 1) {
$pageToken = $page->stringOf('nextPageToken');
}
$more = $pageToken != '';
}
print 'Matching messages read: ' . $total . "\n";
?>