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 <C_CkJsonObjectW.h>
#include <C_CkHttpW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>
void ChilkatSample(void)
{
BOOL success;
HCkJsonObjectW token;
HCkHttpW http;
HCkHttpResponseW resp;
HCkJsonObjectW reply;
const wchar_t *searchQuery;
HCkStringBuilderW baseUrl;
HCkStringBuilderW url;
const wchar_t *pageToken;
HCkJsonObjectW page;
int total;
BOOL more;
int i;
const wchar_t *messageId;
int h;
success = FALSE;
// Assumes Chilkat is unlocked. See Global Unlock Sample.
token = CkJsonObjectW_Create();
success = CkJsonObjectW_LoadFile(token,L"gmail-token.json");
if (success != TRUE) {
wprintf(L"Could not read gmail-token.json from the private working directory.\n");
CkJsonObjectW_Dispose(token);
return;
}
if ((CkJsonObjectW_JsonTypeOf(token,L"access_token") != 1) || (CkJsonObjectW_StringOfEquals(token,L"access_token",L"",TRUE) == TRUE)) {
wprintf(L"An OAuth access token is required.\n");
CkJsonObjectW_Dispose(token);
return;
}
http = CkHttpW_Create();
CkHttpW_putRequireSslCertVerify(http,TRUE);
CkHttpW_putAuthToken(http,CkJsonObjectW_stringOf(token,L"access_token"));
resp = CkHttpResponseW_Create();
reply = CkJsonObjectW_Create();
searchQuery = L"from:sender@example.com has:attachment filename:pdf";
baseUrl = CkStringBuilderW_Create();
CkStringBuilderW_Append(baseUrl,L"https://gmail.googleapis.com/gmail/v1/users/me/messages?maxResults=100&q=");
CkStringBuilderW_Append(baseUrl,CkHttpW_urlEncode(http,searchQuery));
url = CkStringBuilderW_Create();
pageToken = L"";
page = CkJsonObjectW_Create();
total = 0;
more = TRUE;
while ((more == TRUE)) {
CkStringBuilderW_SetString(url,CkStringBuilderW_getAsString(baseUrl));
CkStringBuilderW_Append(url,L"&pageToken=");
CkStringBuilderW_Append(url,CkHttpW_urlEncode(http,pageToken));
success = CkHttpW_HttpNoBody(http,L"GET",CkStringBuilderW_getAsString(url),resp);
if (CkHttpResponseW_getStatusCode(resp) == 0) {
wprintf(L"Gmail did not return an HTTP response.\n");
CkJsonObjectW_Dispose(token);
CkHttpW_Dispose(http);
CkHttpResponseW_Dispose(resp);
CkJsonObjectW_Dispose(reply);
CkStringBuilderW_Dispose(baseUrl);
CkStringBuilderW_Dispose(url);
CkJsonObjectW_Dispose(page);
return;
}
if ((success != TRUE) || (CkHttpResponseW_getStatusCode(resp) < 200) || (CkHttpResponseW_getStatusCode(resp) >= 300)) {
wprintf(L"Gmail HTTP %d\n",CkHttpResponseW_getStatusCode(resp));
success = CkJsonObjectW_Load(reply,CkHttpResponseW_bodyStr(resp));
if (success == TRUE) {
wprintf(L"%s\n",CkJsonObjectW_stringOf(reply,L"error.message"));
}
CkJsonObjectW_Dispose(token);
CkHttpW_Dispose(http);
CkHttpResponseW_Dispose(resp);
CkJsonObjectW_Dispose(reply);
CkStringBuilderW_Dispose(baseUrl);
CkStringBuilderW_Dispose(url);
CkJsonObjectW_Dispose(page);
return;
}
success = CkJsonObjectW_Load(reply,CkHttpResponseW_bodyStr(resp));
if (success != TRUE) {
wprintf(L"Expected a Gmail JSON response.\n");
CkJsonObjectW_Dispose(token);
CkHttpW_Dispose(http);
CkHttpResponseW_Dispose(resp);
CkJsonObjectW_Dispose(reply);
CkStringBuilderW_Dispose(baseUrl);
CkStringBuilderW_Dispose(url);
CkJsonObjectW_Dispose(page);
return;
}
// Keep this page while individual message requests reuse reply.
success = CkJsonObjectW_MakeCopy(reply,page);
if (success != TRUE) {
wprintf(L"%s\n",CkJsonObjectW_lastErrorText(reply));
CkJsonObjectW_Dispose(token);
CkHttpW_Dispose(http);
CkHttpResponseW_Dispose(resp);
CkJsonObjectW_Dispose(reply);
CkStringBuilderW_Dispose(baseUrl);
CkStringBuilderW_Dispose(url);
CkJsonObjectW_Dispose(page);
return;
}
i = 0;
while ((i < CkJsonObjectW_SizeOfArray(page,L"messages"))) {
CkJsonObjectW_putI(page,i);
messageId = CkJsonObjectW_stringOf(page,L"messages[i].id");
CkStringBuilderW_SetString(url,L"https://gmail.googleapis.com/gmail/v1/users/me/messages/");
CkStringBuilderW_Append(url,CkHttpW_urlEncode(http,messageId));
CkStringBuilderW_Append(url,L"?format=metadata&metadataHeaders=From&metadataHeaders=Subject");
success = CkHttpW_HttpNoBody(http,L"GET",CkStringBuilderW_getAsString(url),resp);
// A message can disappear between the search and the metadata request.
if (CkHttpResponseW_getStatusCode(resp) != 404) {
if (CkHttpResponseW_getStatusCode(resp) == 0) {
wprintf(L"Gmail did not return an HTTP response.\n");
CkJsonObjectW_Dispose(token);
CkHttpW_Dispose(http);
CkHttpResponseW_Dispose(resp);
CkJsonObjectW_Dispose(reply);
CkStringBuilderW_Dispose(baseUrl);
CkStringBuilderW_Dispose(url);
CkJsonObjectW_Dispose(page);
return;
}
if ((success != TRUE) || (CkHttpResponseW_getStatusCode(resp) < 200) || (CkHttpResponseW_getStatusCode(resp) >= 300)) {
wprintf(L"Gmail HTTP %d\n",CkHttpResponseW_getStatusCode(resp));
success = CkJsonObjectW_Load(reply,CkHttpResponseW_bodyStr(resp));
if (success == TRUE) {
wprintf(L"%s\n",CkJsonObjectW_stringOf(reply,L"error.message"));
}
CkJsonObjectW_Dispose(token);
CkHttpW_Dispose(http);
CkHttpResponseW_Dispose(resp);
CkJsonObjectW_Dispose(reply);
CkStringBuilderW_Dispose(baseUrl);
CkStringBuilderW_Dispose(url);
CkJsonObjectW_Dispose(page);
return;
}
success = CkJsonObjectW_Load(reply,CkHttpResponseW_bodyStr(resp));
if (success != TRUE) {
wprintf(L"Expected a Gmail JSON response.\n");
CkJsonObjectW_Dispose(token);
CkHttpW_Dispose(http);
CkHttpResponseW_Dispose(resp);
CkJsonObjectW_Dispose(reply);
CkStringBuilderW_Dispose(baseUrl);
CkStringBuilderW_Dispose(url);
CkJsonObjectW_Dispose(page);
return;
}
wprintf(L"Message: %s\n",messageId);
h = 0;
while ((h < CkJsonObjectW_SizeOfArray(reply,L"payload.headers"))) {
CkJsonObjectW_putI(reply,h);
wprintf(L"%s: %s\n",CkJsonObjectW_stringOf(reply,L"payload.headers[i].name"),CkJsonObjectW_stringOf(reply,L"payload.headers[i].value"));
h = h + 1;
}
total = total + 1;
}
i = i + 1;
}
pageToken = L"";
if (CkJsonObjectW_JsonTypeOf(page,L"nextPageToken") == 1) {
pageToken = CkJsonObjectW_stringOf(page,L"nextPageToken");
}
more = pageToken != L"";
}
wprintf(L"Matching messages read: %d\n",total);
CkJsonObjectW_Dispose(token);
CkHttpW_Dispose(http);
CkHttpResponseW_Dispose(resp);
CkJsonObjectW_Dispose(reply);
CkStringBuilderW_Dispose(baseUrl);
CkStringBuilderW_Dispose(url);
CkJsonObjectW_Dispose(page);
}