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

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.

Google documentation

Chilkat CkJava Downloads

CkJava
import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

  public static void main(String argv[])
  {
    boolean success = false;

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

    CkJsonObject token = new CkJsonObject();
    success = token.LoadFile("gmail-token.json");
    if (success != true) {
        System.out.println("Could not read gmail-token.json from the private working directory.");
        return;
        }

    if ((token.JsonTypeOf("access_token") != 1) || (token.StringOfEquals("access_token","",true) == true)) {
        System.out.println("An OAuth access token is required.");
        return;
        }

    CkHttp http = new CkHttp();
    http.put_RequireSslCertVerify(true);
    http.put_AuthToken(token.stringOf("access_token"));
    CkHttpResponse resp = new CkHttpResponse();
    CkJsonObject reply = new CkJsonObject();
    String searchQuery = "from:sender@example.com has:attachment filename:pdf";
    CkStringBuilder baseUrl = new CkStringBuilder();
    baseUrl.Append("https://gmail.googleapis.com/gmail/v1/users/me/messages?maxResults=100&q=");
    baseUrl.Append(http.urlEncode(searchQuery));
    CkStringBuilder url = new CkStringBuilder();
    String pageToken = "";
    CkJsonObject page = new CkJsonObject();
    int total = 0;
    boolean more = true;
    while ((more == true)) {
        url.SetString(baseUrl.getAsString());
        url.Append("&pageToken=");
        url.Append(http.urlEncode(pageToken));
        success = http.HttpNoBody("GET",url.getAsString(),resp);
        if (resp.get_StatusCode() == 0) {
            System.out.println("Gmail did not return an HTTP response.");
            return;
            }

        if ((success != true) || (resp.get_StatusCode() < 200) || (resp.get_StatusCode() >= 300)) {
            System.out.println("Gmail HTTP " + resp.get_StatusCode());
            success = reply.Load(resp.bodyStr());
            if (success == true) {
                System.out.println(reply.stringOf("error.message"));
                }

            return;
            }

        success = reply.Load(resp.bodyStr());
        if (success != true) {
            System.out.println("Expected a Gmail JSON response.");
            return;
            }

        //  Keep this page while individual message requests reuse reply.
        success = reply.MakeCopy(page);
        if (success != true) {
            System.out.println(reply.lastErrorText());
            return;
            }

        int i = 0;
        while ((i < page.SizeOfArray("messages"))) {
            page.put_I(i);
            String 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.get_StatusCode() != 404) {
                if (resp.get_StatusCode() == 0) {
                    System.out.println("Gmail did not return an HTTP response.");
                    return;
                    }

                if ((success != true) || (resp.get_StatusCode() < 200) || (resp.get_StatusCode() >= 300)) {
                    System.out.println("Gmail HTTP " + resp.get_StatusCode());
                    success = reply.Load(resp.bodyStr());
                    if (success == true) {
                        System.out.println(reply.stringOf("error.message"));
                        }

                    return;
                    }

                success = reply.Load(resp.bodyStr());
                if (success != true) {
                    System.out.println("Expected a Gmail JSON response.");
                    return;
                    }

                System.out.println("Message: " + messageId);
                int h = 0;
                while ((h < reply.SizeOfArray("payload.headers"))) {
                    reply.put_I(h);
                    System.out.println(reply.stringOf("payload.headers[i].name") + ": " + reply.stringOf("payload.headers[i].value"));
                    h = h+1;
                    }

                total = total+1;
                }

            i = i+1;
            }

        pageToken = "";
        if (page.JsonTypeOf("nextPageToken") == 1) {
            pageToken = page.stringOf("nextPageToken");
            }

        more = pageToken != "";
        }

    System.out.println("Matching messages read: " + total);
  }
}