Lianja

Find a Label ID by Name

See more GMail REST API Examples

Lookup the ID of a GMail label by the label name. 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)

lcUrl = "https://www.googleapis.com/gmail/v1/users/{$userId}/labels"

// Get the list of GMail labels as JSON.
loSb = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb(lcUrl,loSb)
if (llSuccess <> .T.) 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

// 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...
loJRecord = loJson.FindRecord("labels","name","QA",.F.)
if (loJson.LastMethodSuccess = .T.) then
    ? "The id of QA is: " + loJRecord.StringOf("id")
    release loJRecord
endif

loJRecord = loJson.FindRecord("labels","name","[Gmail]/testFolder",.F.)
if (loJson.LastMethodSuccess = .T.) then
    ? "The id of [Gmail]/testFolder is: " + loJRecord.StringOf("id")
    release loJRecord
endif

loJRecord = loJson.FindRecord("labels","name","questions",.F.)
if (loJson.LastMethodSuccess = .T.) then
    ? "The id of questions is: " + loJRecord.StringOf("id")
    release loJRecord
endif

// Output:

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


release loHttp
release loSb
release loJson