Xbase++ Requires Chilkat v11.0.0+
Xbase++
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.
Chilkat Xbase++ Downloads
LOCAL nSuccess
LOCAL oToken
LOCAL oHttp
LOCAL oResp
LOCAL oReply
LOCAL oLabel
LOCAL oLabelId
LOCAL oIds
LOCAL oBaseUrl
LOCAL cSearchQuery
LOCAL oUrl
LOCAL oPageToken
LOCAL nMore
LOCAL nCount
LOCAL i
LOCAL oRequest
LOCAL nDone
LOCAL n
nSuccess := 0
// Assumes Chilkat is unlocked. See Global Unlock Sample.
oToken := CreateObject("Chilkat.JsonObject")
nSuccess := oToken:LoadFile("gmail-token.json")
IF (nSuccess != 1)
? "Could not read gmail-token.json from the private working directory."
oToken:destroy()
RETURN
ENDIF
IF ((oToken:JsonTypeOf("access_token") != 1) .OR. (oToken:StringOfEquals("access_token", "", 1) == 1))
? "An OAuth access token is required."
oToken:destroy()
RETURN
ENDIF
oHttp := CreateObject("Chilkat.Http")
oHttp:RequireSslCertVerify := 1
oHttp:AuthToken := oToken:StringOf("access_token")
oResp := CreateObject("Chilkat.HttpResponse")
oReply := CreateObject("Chilkat.JsonObject")
nSuccess := oHttp:HttpNoBody("GET", "https://gmail.googleapis.com/gmail/v1/users/me/labels", oResp)
IF (oResp:StatusCode == 0)
? "Gmail did not return an HTTP response."
oToken:destroy()
oHttp:destroy()
oResp:destroy()
oReply:destroy()
RETURN
ENDIF
IF ((nSuccess != 1) .OR. (oResp:StatusCode < 200) .OR. (oResp:StatusCode >= 300))
? "Gmail HTTP " + Str(oResp:StatusCode)
nSuccess := oReply:Load(oResp:BodyStr)
IF (nSuccess == 1)
? oReply:StringOf("error.message")
ENDIF
oToken:destroy()
oHttp:destroy()
oResp:destroy()
oReply:destroy()
RETURN
ENDIF
nSuccess := oReply:Load(oResp:BodyStr)
IF (nSuccess != 1)
? "Expected a Gmail JSON response."
oToken:destroy()
oHttp:destroy()
oResp:destroy()
oReply:destroy()
RETURN
ENDIF
IF (oReply:JsonTypeOf("labels") != 4)
? "Expected a list of labels."
oToken:destroy()
oHttp:destroy()
oResp:destroy()
oReply:destroy()
RETURN
ENDIF
oLabel := CreateObject("Chilkat.JsonObject")
nSuccess := oReply:FindRecord2("labels", "name", "To review", 1, oLabel)
IF (nSuccess != 1)
? "No label with that exact name. Check the name or create the label first."
oToken:destroy()
oHttp:destroy()
oResp:destroy()
oReply:destroy()
oLabel:destroy()
RETURN
ENDIF
oLabelId := CreateObject("Chilkat.StringBuilder")
nSuccess := oLabel:StringOfSb("id", oLabelId)
IF (nSuccess != 1)
? "Could not read the label ID."
oToken:destroy()
oHttp:destroy()
oResp:destroy()
oReply:destroy()
oLabel:destroy()
oLabelId:destroy()
RETURN
ENDIF
oIds := CreateObject("Chilkat.StringTable")
oBaseUrl := CreateObject("Chilkat.StringBuilder")
oBaseUrl:Append("https://gmail.googleapis.com/gmail/v1/users/me/messages?maxResults=500")
cSearchQuery := "has:attachment"
oBaseUrl:Append("&q=")
oBaseUrl:Append(oHttp:UrlEncode(cSearchQuery))
oUrl := CreateObject("Chilkat.StringBuilder")
oPageToken := CreateObject("Chilkat.StringBuilder")
nMore := 1
DO WHILE (nMore == 1)
oUrl:SetString(oBaseUrl:GetAsString())
IF (oPageToken:Length > 0)
oUrl:Append("&pageToken=")
oUrl:Append(oHttp:UrlEncode(oPageToken:GetAsString()))
ENDIF
nSuccess := oHttp:HttpNoBody("GET", oUrl:GetAsString(), oResp)
IF (oResp:StatusCode == 0)
? "Gmail did not return an HTTP response."
oToken:destroy()
oHttp:destroy()
oResp:destroy()
oReply:destroy()
oLabel:destroy()
oLabelId:destroy()
oIds:destroy()
oBaseUrl:destroy()
oUrl:destroy()
oPageToken:destroy()
RETURN
ENDIF
IF ((nSuccess != 1) .OR. (oResp:StatusCode < 200) .OR. (oResp:StatusCode >= 300))
? "Gmail HTTP " + Str(oResp:StatusCode)
nSuccess := oReply:Load(oResp:BodyStr)
IF (nSuccess == 1)
? oReply:StringOf("error.message")
ENDIF
oToken:destroy()
oHttp:destroy()
oResp:destroy()
oReply:destroy()
oLabel:destroy()
oLabelId:destroy()
oIds:destroy()
oBaseUrl:destroy()
oUrl:destroy()
oPageToken:destroy()
RETURN
ENDIF
nSuccess := oReply:Load(oResp:BodyStr)
IF (nSuccess != 1)
? "Expected a Gmail JSON response."
oToken:destroy()
oHttp:destroy()
oResp:destroy()
oReply:destroy()
oLabel:destroy()
oLabelId:destroy()
oIds:destroy()
oBaseUrl:destroy()
oUrl:destroy()
oPageToken:destroy()
RETURN
ENDIF
// Gmail can omit messages when the search or mailbox is empty.
nCount := oReply:SizeOfArray("messages")
i := 0
DO WHILE (i < nCount)
oReply:I := i
nSuccess := oIds:Append(oReply:StringOf("messages[i].id"))
IF (nSuccess != 1)
? "Could not retain a message ID."
oToken:destroy()
oHttp:destroy()
oResp:destroy()
oReply:destroy()
oLabel:destroy()
oLabelId:destroy()
oIds:destroy()
oBaseUrl:destroy()
oUrl:destroy()
oPageToken:destroy()
RETURN
ENDIF
i := i + 1
ENDDO
nMore := 0
IF (oReply:JsonTypeOf("nextPageToken") == 1)
oPageToken:SetString(oReply:StringOf("nextPageToken"))
nMore := oPageToken:Length > 0
ENDIF
ENDDO
// Search is complete. Apply the label to each group and track confirmed progress.
oRequest := CreateObject("Chilkat.JsonObject")
nDone := 0
DO WHILE (nDone < oIds:Count)
oRequest:Clear()
oRequest:UpdateString("addLabelIds[0]", oLabelId:GetAsString())
n := 0
DO WHILE ((n < 1000) .AND. ((nDone + n) < oIds:Count))
oRequest:I := n
oRequest:UpdateString("ids[i]", oIds:StringAt(nDone + n))
n := n + 1
ENDDO
nSuccess := oHttp:HttpJson("POST", "https://gmail.googleapis.com/gmail/v1/users/me/messages/batchModify", oRequest, "application/json", oResp)
IF (oResp:StatusCode == 0)
? "Gmail did not return an HTTP response."
oToken:destroy()
oHttp:destroy()
oResp:destroy()
oReply:destroy()
oLabel:destroy()
oLabelId:destroy()
oIds:destroy()
oBaseUrl:destroy()
oUrl:destroy()
oPageToken:destroy()
oRequest:destroy()
RETURN
ENDIF
IF ((nSuccess != 1) .OR. (oResp:StatusCode < 200) .OR. (oResp:StatusCode >= 300))
? "Gmail HTTP " + Str(oResp:StatusCode)
nSuccess := oReply:Load(oResp:BodyStr)
IF (nSuccess == 1)
? oReply:StringOf("error.message")
ENDIF
oToken:destroy()
oHttp:destroy()
oResp:destroy()
oReply:destroy()
oLabel:destroy()
oLabelId:destroy()
oIds:destroy()
oBaseUrl:destroy()
oUrl:destroy()
oPageToken:destroy()
oRequest:destroy()
RETURN
ENDIF
nDone := nDone + n
? "Messages labeled so far: " + Str(nDone)
ENDDO
? "Total messages labeled: " + Str(nDone)
oToken:destroy()
oHttp:destroy()
oResp:destroy()
oReply:destroy()
oLabel:destroy()
oLabelId:destroy()
oIds:destroy()
oBaseUrl:destroy()
oUrl:destroy()
oPageToken:destroy()
oRequest:destroy()