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 Unicode C++ Downloads
#include <CkJsonObjectW.h>
#include <CkHttpW.h>
#include <CkHttpResponseW.h>
#include <CkStringBuilderW.h>
void ChilkatSample(void)
{
bool success = false;
// Assumes Chilkat is unlocked. See Global Unlock Sample.
CkJsonObjectW token;
success = token.LoadFile(L"gmail-token.json");
if (success != true) {
wprintf(L"Could not read gmail-token.json from the private working directory.\n");
return;
}
if ((token.JsonTypeOf(L"access_token") != 1) || (token.StringOfEquals(L"access_token",L"",true) == true)) {
wprintf(L"An OAuth access token is required.\n");
return;
}
CkHttpW http;
http.put_RequireSslCertVerify(true);
http.put_AuthToken(token.stringOf(L"access_token"));
CkHttpResponseW resp;
CkJsonObjectW reply;
const wchar_t *searchQuery = L"from:sender@example.com has:attachment filename:pdf";
CkStringBuilderW baseUrl;
baseUrl.Append(L"https://gmail.googleapis.com/gmail/v1/users/me/messages?maxResults=100&q=");
baseUrl.Append(http.urlEncode(searchQuery));
CkStringBuilderW url;
const wchar_t *pageToken = L"";
CkJsonObjectW page;
int total = 0;
bool more = true;
while ((more == true)) {
url.SetString(baseUrl.getAsString());
url.Append(L"&pageToken=");
url.Append(http.urlEncode(pageToken));
success = http.HttpNoBody(L"GET",url.getAsString(),resp);
if (resp.get_StatusCode() == 0) {
wprintf(L"Gmail did not return an HTTP response.\n");
return;
}
if ((success != true) || (resp.get_StatusCode() < 200) || (resp.get_StatusCode() >= 300)) {
wprintf(L"Gmail HTTP %d\n",resp.get_StatusCode());
success = reply.Load(resp.bodyStr());
if (success == true) {
wprintf(L"%s\n",reply.stringOf(L"error.message"));
}
return;
}
success = reply.Load(resp.bodyStr());
if (success != true) {
wprintf(L"Expected a Gmail JSON response.\n");
return;
}
// Keep this page while individual message requests reuse reply.
success = reply.MakeCopy(page);
if (success != true) {
wprintf(L"%s\n",reply.lastErrorText());
return;
}
int i = 0;
while ((i < page.SizeOfArray(L"messages"))) {
page.put_I(i);
const wchar_t *messageId = page.stringOf(L"messages[i].id");
url.SetString(L"https://gmail.googleapis.com/gmail/v1/users/me/messages/");
url.Append(http.urlEncode(messageId));
url.Append(L"?format=metadata&metadataHeaders=From&metadataHeaders=Subject");
success = http.HttpNoBody(L"GET",url.getAsString(),resp);
// A message can disappear between the search and the metadata request.
if (resp.get_StatusCode() != 404) {
if (resp.get_StatusCode() == 0) {
wprintf(L"Gmail did not return an HTTP response.\n");
return;
}
if ((success != true) || (resp.get_StatusCode() < 200) || (resp.get_StatusCode() >= 300)) {
wprintf(L"Gmail HTTP %d\n",resp.get_StatusCode());
success = reply.Load(resp.bodyStr());
if (success == true) {
wprintf(L"%s\n",reply.stringOf(L"error.message"));
}
return;
}
success = reply.Load(resp.bodyStr());
if (success != true) {
wprintf(L"Expected a Gmail JSON response.\n");
return;
}
wprintf(L"Message: %s\n",messageId);
int h = 0;
while ((h < reply.SizeOfArray(L"payload.headers"))) {
reply.put_I(h);
wprintf(L"%s: %s\n",reply.stringOf(L"payload.headers[i].name"),reply.stringOf(L"payload.headers[i].value"));
h = h + 1;
}
total = total + 1;
}
i = i + 1;
}
pageToken = L"";
if (page.JsonTypeOf(L"nextPageToken") == 1) {
pageToken = page.stringOf(L"nextPageToken");
}
more = pageToken != L"";
}
wprintf(L"Matching messages read: %d\n",total);
}