Sample code for 30+ languages & platforms
CkPython 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

Chilkat CkPython Downloads

CkPython
import sys
import chilkat

success = False

#  Assumes Chilkat is unlocked. See Global Unlock Sample.

token = chilkat.CkJsonObject()
success = token.LoadFile("gmail-token.json")
if (success != True):
    print("Could not read gmail-token.json from the private working directory.")
    sys.exit()

if ((token.JsonTypeOf("access_token") != 1) or (token.StringOfEquals("access_token","",True) == True)):
    print("An OAuth access token is required.")
    sys.exit()

http = chilkat.CkHttp()
http.put_RequireSslCertVerify(True)
http.put_AuthToken(token.stringOf("access_token"))
resp = chilkat.CkHttpResponse()
reply = chilkat.CkJsonObject()
success = http.HttpNoBody("GET","https://gmail.googleapis.com/gmail/v1/users/me/labels",resp)
if (resp.get_StatusCode() == 0):
    print("Gmail did not return an HTTP response.")
    sys.exit()

if ((success != True) or (resp.get_StatusCode() < 200) or (resp.get_StatusCode() >= 300)):
    print("Gmail HTTP " + str(resp.get_StatusCode()))
    success = reply.Load(resp.bodyStr())
    if (success == True):
        print(reply.stringOf("error.message"))

    sys.exit()

success = reply.Load(resp.bodyStr())
if (success != True):
    print("Expected a Gmail JSON response.")
    sys.exit()

if (reply.JsonTypeOf("labels") != 4):
    print("Expected a list of labels.")
    sys.exit()

label = chilkat.CkJsonObject()
success = reply.FindRecord2("labels","name","To review",True,label)
if (success != True):
    print("No label with that exact name. Check the name or create the label first.")
    sys.exit()

labelId = chilkat.CkStringBuilder()
success = label.StringOfSb("id",labelId)
if (success != True):
    print("Could not read the label ID.")
    sys.exit()

ids = chilkat.CkStringTable()
baseUrl = chilkat.CkStringBuilder()
baseUrl.Append("https://gmail.googleapis.com/gmail/v1/users/me/messages?maxResults=500")
searchQuery = "has:attachment"
baseUrl.Append("&q=")
baseUrl.Append(http.urlEncode(searchQuery))
url = chilkat.CkStringBuilder()
pageToken = chilkat.CkStringBuilder()
more = True
while (more == True) :
    url.SetString(baseUrl.getAsString())
    if (pageToken.get_Length() > 0):
        url.Append("&pageToken=")
        url.Append(http.urlEncode(pageToken.getAsString()))

    success = http.HttpNoBody("GET",url.getAsString(),resp)
    if (resp.get_StatusCode() == 0):
        print("Gmail did not return an HTTP response.")
        sys.exit()

    if ((success != True) or (resp.get_StatusCode() < 200) or (resp.get_StatusCode() >= 300)):
        print("Gmail HTTP " + str(resp.get_StatusCode()))
        success = reply.Load(resp.bodyStr())
        if (success == True):
            print(reply.stringOf("error.message"))

        sys.exit()

    success = reply.Load(resp.bodyStr())
    if (success != True):
        print("Expected a Gmail JSON response.")
        sys.exit()

    #  Gmail can omit messages when the search or mailbox is empty.
    count = reply.SizeOfArray("messages")
    i = 0
    while (i < count) :
        reply.put_I(i)
        success = ids.Append(reply.stringOf("messages[i].id"))
        if (success != True):
            print("Could not retain a message ID.")
            sys.exit()

        i = i + 1

    more = False
    if (reply.JsonTypeOf("nextPageToken") == 1):
        pageToken.SetString(reply.stringOf("nextPageToken"))
        more = pageToken.get_Length() > 0

#  Search is complete. Apply the label to each group and track confirmed progress.
request = chilkat.CkJsonObject()
done = 0
while (done < ids.get_Count()) :
    request.Clear()
    request.UpdateString("addLabelIds[0]",labelId.getAsString())
    n = 0
    while ((n < 1000) and ((done + n) < ids.get_Count())) :
        request.put_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.get_StatusCode() == 0):
        print("Gmail did not return an HTTP response.")
        sys.exit()

    if ((success != True) or (resp.get_StatusCode() < 200) or (resp.get_StatusCode() >= 300)):
        print("Gmail HTTP " + str(resp.get_StatusCode()))
        success = reply.Load(resp.bodyStr())
        if (success == True):
            print(reply.stringOf("error.message"))

        sys.exit()

    done = done + n
    print("Messages labeled so far: " + str(done))

print("Total messages labeled: " + str(done))