Lianja

BatchModify - Add a Label to each Message in Search Results

See more GMail REST API Examples

Searchs GMail for messages meeting a criteria and adds a label to each message found. Lianja

llSuccess = .F.

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

loHttp = createobject("CkHttp")
loHttp.AuthToken = "GMAIL-ACCESS-TOKEN"

lcUserId = "me"
loHttp.SetUrlVar("userId",lcUserId)

lcQuery = "subject:questions"
loHttp.SetUrlVar("query",lcQuery)

lcUrl = "https://www.googleapis.com/gmail/v1/users/{$userId}/messages?q={$query}"

loSb = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb(lcUrl,loSb)
if (llSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loSb
    return
endif

loJson = createobject("CkJsonObject")
loJson.LoadSb(loSb)
loJson.EmitCompact = .F.
? loJson.Emit()

if (loHttp.LastStatus <> 200) then
    ? "Failed."
    release loHttp
    release loSb
    release loJson
    return
endif

// If successful, the received JSON looks like this:
// {
//   "messages": [
//     {
//       "id": "166f583051d36144",
//       "threadId": "166f583051d36144"
//     },
//     {
//       "id": "166f5815e1f36144",
//       "threadId": "166f5815e1f36144"
//     },
// 	...
//     {
//       "id": "166f580639e36144",
//       "threadId": "166f580639e36144"
//     },
//     {
//       "id": "15dbc2e28ec789c6",
//       "threadId": "15dbc2e28ec789c6"
//     }
//   ],
//   "nextPageToken": "13434766102274844688",
//   "resultSizeEstimate": 103
// }
// 

// Next, we'll be sending an HTTP POST to add the label "questions" to each message in the
// search results.  The JSON to be sent for the batchModify is this:

// 	{
// 	  "ids": [
// 	    string
// 	  ],
// 	  "addLabelIds": [
// 	    string
// 	  ],
// 	  "removeLabelIds": [
// 	    string
// 	  ]
// 	}

// We'll omit "removeLabelIds" because we're not removing any labels.
// We are parsing the JSON search results, and at the same time building the batchModify JSON.

loJson2 = createobject("CkJsonObject")

i = 0
lnNumMessages = loJson.SizeOfArray("messages")
do while (i < lnNumMessages)
    loJson.I = i
    lcId = loJson.StringOf("messages[i].id")
    loJson2.I = i
    loJson2.UpdateString("ids[i]",lcId)
    i = i + 1
enddo

// We need the id of the label (not the name).
// I know the name of the label is "questions", but I need to know the id.
// See this example: Get Label Id by Name
// The id of my label named "questions" is "Label_43"
lcLabelId = "Label_43"
loJson2.UpdateString("addLabelIds[0]",lcLabelId)
loJson2.UpdateNewArray("removeLabelIds")

loJson2.EmitCompact = .F.
? loJson2.Emit()

// Send the batchModify
lcUrl = "https://www.googleapis.com/gmail/v1/users/{$userId}/messages/batchModify"
loResp = createobject("CkHttpResponse")
llSuccess = loHttp.HttpJson("POST",lcUrl,loJson2,"application/json",loResp)
if (llSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loSb
    release loJson
    release loJson2
    release loResp
    return
endif

? "status = " + str(loResp.StatusCode)

// A 204 response status indicate success.
if (loResp.StatusCode <> 204) then
    ? loResp.BodyStr
    ? "Failed."
    release loHttp
    release loSb
    release loJson
    release loJson2
    release loResp
    return
endif

// The 204 response has an empty response body..

? "BatchModify success!"


release loHttp
release loSb
release loJson
release loJson2
release loResp