Node.js

Find a Label ID by Name

See more GMail REST API Examples

Lookup the ID of a GMail label by the label name. Node.js

NODEJS_PRELUDE

function chilkatExample() {

    var success = false;

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

    var http = new chilkat.Http();
    http.AuthToken = "GMAIL-ACCESS-TOKEN";

    var userId = "me";
    http.SetUrlVar("userId",userId);

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

    // Get the list of GMail labels as JSON.
    var sb = new chilkat.StringBuilder();
    success = http.QuickGetSb(url,sb);
    if (success !== true) {
        console.log(http.LastErrorText);
        return;
    }

    var json = new chilkat.JsonObject();
    json.LoadSb(sb);
    json.EmitCompact = false;
    console.log(json.Emit());

    if (http.LastStatus !== 200) {
        console.log("Failed.");
        return;
    }

    // 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...
    // jRecord: JsonObject
    var jRecord = json.FindRecord("labels","name","QA",false);
    if (json.LastMethodSuccess == true) {
        console.log("The id of QA is: " + jRecord.StringOf("id"));

    }

    jRecord = json.FindRecord("labels","name","[Gmail]/testFolder",false);
    if (json.LastMethodSuccess == true) {
        console.log("The id of [Gmail]/testFolder is: " + jRecord.StringOf("id"));

    }

    jRecord = json.FindRecord("labels","name","questions",false);
    if (json.LastMethodSuccess == true) {
        console.log("The id of questions is: " + jRecord.StringOf("id"));

    }

    // Output:

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

}

chilkatExample();