(Excel) BatchModify - Add a Label to each Message in Search Results

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

Download Excel Class Modules Chilkat Excel Class Modules

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

Dim http As Chilkat.Http
Set http = Chilkat.NewHttp
http.AuthToken = "GMAIL-ACCESS-TOKEN"


userId = "me"
success = http.SetUrlVar("userId",userId)


query = "subject:questions"
success = http.SetUrlVar("query",query)


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

Dim sb As Chilkat.StringBuilder
Set sb = Chilkat.NewStringBuilder
success = http.QuickGetSb(url,sb)
If (success <> True) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim json As Chilkat.JsonObject
Set json = Chilkat.NewJsonObject
success = json.LoadSb(sb)
json.EmitCompact = False
Debug.Print json.Emit()

If (http.LastStatus <> 200) Then
    Debug.Print "Failed."
    Exit Sub
End If

' 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.

Dim json2 As Chilkat.JsonObject
Set json2 = Chilkat.NewJsonObject


i = 0

numMessages = json.SizeOfArray("messages")
Do While (i < numMessages)
    json.I = i

    id = json.StringOf("messages[i].id")
    json2.I = i
    success = json2.UpdateString("ids[i]",id)
    i = i + 1
Loop

' 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"

labelId = "Label_43"
success = json2.UpdateString("addLabelIds[0]",labelId)
success = json2.UpdateNewArray("removeLabelIds")

json2.EmitCompact = False
Debug.Print json2.Emit()

' Send the batchModify
url = "https://www.googleapis.com/gmail/v1/users/{$userId}/messages/batchModify"

Set resp = http.PostJson3(url,"application/json",json2)
If (http.LastMethodSuccess <> True) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Debug.Print "status = "; resp.StatusCode

' A 204 response status indicate success.
If (resp.StatusCode <> 204) Then
    Debug.Print resp.BodyStr
    Debug.Print "Failed."

    Exit Sub
End If

' The 204 response has an empty response body..

Debug.Print "BatchModify success!"