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

Apply a Gmail label to search results in batches

See more GMail REST API Examples

Choose a Gmail search query and an existing label name. Resolve the label ID, collect all matching message IDs before changing any labels, then submit at most 1,000 IDs per batchModify call. Empty searches send no updates. For large mailboxes, spool IDs to persistent storage. Completed batches stay applied if a later request fails; adding the same label again is safe.

Authorize the application with https://www.googleapis.com/auth/gmail.modify. The example reads the access token from gmail-token.json in a private working directory. Authorize a desktop application.

Google documentation

Note
This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.
JavaScript
var success = false;

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

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

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

var http = new CkHttp();
http.RequireSslCertVerify = true;
http.AuthToken = token.StringOf("access_token");
var resp = new CkHttpResponse();
var reply = new CkJsonObject();
success = http.HttpNoBody("GET","https://gmail.googleapis.com/gmail/v1/users/me/labels",resp);
if (resp.StatusCode == 0) {
    console.log("Gmail did not return an HTTP response.");
    return;
}

if ((success !== true) || (resp.StatusCode < 200) || (resp.StatusCode >= 300)) {
    console.log("Gmail HTTP " + resp.StatusCode);
    success = reply.Load(resp.BodyStr);
    if (success == true) {
        console.log(reply.StringOf("error.message"));
    }

    return;
}

success = reply.Load(resp.BodyStr);
if (success !== true) {
    console.log("Expected a Gmail JSON response.");
    return;
}

if (reply.JsonTypeOf("labels") !== 4) {
    console.log("Expected a list of labels.");
    return;
}

var label = new CkJsonObject();
success = reply.FindRecord2("labels","name","To review",true,label);
if (success !== true) {
    console.log("No label with that exact name. Check the name or create the label first.");
    return;
}

var labelId = new CkStringBuilder();
success = label.StringOfSb("id",labelId);
if (success !== true) {
    console.log("Could not read the label ID.");
    return;
}

var ids = new CkStringTable();
var baseUrl = new CkStringBuilder();
baseUrl.Append("https://gmail.googleapis.com/gmail/v1/users/me/messages?maxResults=500");
var searchQuery = "has:attachment";
baseUrl.Append("&q=");
baseUrl.Append(http.UrlEncode(searchQuery));
var url = new CkStringBuilder();
var pageToken = new CkStringBuilder();
var more = true;
while ((more == true)) {
    url.SetString(baseUrl.GetAsString());
    if (pageToken.Length > 0) {
        url.Append("&pageToken=");
        url.Append(http.UrlEncode(pageToken.GetAsString()));
    }

    success = http.HttpNoBody("GET",url.GetAsString(),resp);
    if (resp.StatusCode == 0) {
        console.log("Gmail did not return an HTTP response.");
        return;
    }

    if ((success !== true) || (resp.StatusCode < 200) || (resp.StatusCode >= 300)) {
        console.log("Gmail HTTP " + resp.StatusCode);
        success = reply.Load(resp.BodyStr);
        if (success == true) {
            console.log(reply.StringOf("error.message"));
        }

        return;
    }

    success = reply.Load(resp.BodyStr);
    if (success !== true) {
        console.log("Expected a Gmail JSON response.");
        return;
    }

    //  Gmail can omit messages when the search or mailbox is empty.
    var count = reply.SizeOfArray("messages");
    var i = 0;
    while ((i < count)) {
        reply.I = i;
        success = ids.Append(reply.StringOf("messages[i].id"));
        if (success !== true) {
            console.log("Could not retain a message ID.");
            return;
        }

        i = i+1;
    }

    more = false;
    if (reply.JsonTypeOf("nextPageToken") == 1) {
        pageToken.SetString(reply.StringOf("nextPageToken"));
        more = pageToken.Length > 0;
    }

}

//  Search is complete. Apply the label to each group and track confirmed progress.
var request = new CkJsonObject();
var done = 0;
while ((done < ids.Count)) {
    request.Clear();
    request.UpdateString("addLabelIds[0]",labelId.GetAsString());
    var n = 0;
    while (((n < 1000) && ((done+n) < ids.Count))) {
        request.I = n;
        request.UpdateString("ids[i]",ids.StringAt(done+n));
        n = n+1;
    }

    success = http.HttpJson("POST","https://gmail.googleapis.com/gmail/v1/users/me/messages/batchModify",request,"application/json",resp);
    if (resp.StatusCode == 0) {
        console.log("Gmail did not return an HTTP response.");
        return;
    }

    if ((success !== true) || (resp.StatusCode < 200) || (resp.StatusCode >= 300)) {
        console.log("Gmail HTTP " + resp.StatusCode);
        success = reply.Load(resp.BodyStr);
        if (success == true) {
            console.log(reply.StringOf("error.message"));
        }

        return;
    }

    done = done+n;
    console.log("Messages labeled so far: " + done);
}

console.log("Total messages labeled: " + done);