Xojo Plugin

Find a Label ID by Name

See more GMail REST API Examples

Lookup the ID of a GMail label by the label name. Xojo Plugin

Dim success As Boolean
success = False

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

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

Dim userId As String
userId = "me"
success = http.SetUrlVar("userId",userId)

Dim url As String
url = "https://www.googleapis.com/gmail/v1/users/{$userId}/labels"

// Get the list of GMail labels as JSON.
Dim sb As New Chilkat.StringBuilder
success = http.QuickGetSb(url,sb)
If (success <> True) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim json As New Chilkat.JsonObject
success = json.LoadSb(sb)
json.EmitCompact = False
System.DebugLog(json.Emit())

If (http.LastStatus <> 200) Then
    System.DebugLog("Failed.")
    Return
End If

// The JSON returned looks like this:
// {
//   "labels": [
//     {
//       "id": "Label_5",
//       "name": "QA",
//       "messageListVisibility": "show",
//       "labelListVisibility": "labelShow",
//       "type": "user"
//     },
//     {
//       "id": "Label_21",
//       "name": "[Gmail]/testFolder",
//       "type": "user"
//     },
//     {
//       "id": "CATEGORY_PERSONAL",
//       "name": "CATEGORY_PERSONAL",
//       "type": "system"
//     },
// 	...

// The name of the label is generally known because it's what we visually see.
// The id is what we need to get.  Assuming the name is unique,
// find the JSON record having name=<desired name>
// For example...
Dim jRecord As Chilkat.JsonObject
jRecord = json.FindRecord("labels","name","QA",False)
If (json.LastMethodSuccess = True) Then
    System.DebugLog("The id of QA is: " + jRecord.StringOf("id"))

End If

jRecord = json.FindRecord("labels","name","[Gmail]/testFolder",False)
If (json.LastMethodSuccess = True) Then
    System.DebugLog("The id of [Gmail]/testFolder is: " + jRecord.StringOf("id"))

End If

jRecord = json.FindRecord("labels","name","questions",False)
If (json.LastMethodSuccess = True) Then
    System.DebugLog("The id of questions is: " + jRecord.StringOf("id"))

End If

// Output:

// The id of QA is: Label_5
// The id of [Gmail]/testFolder is: Label_21
// The id of questions is: Label_43