Node.js GMail: List all GMail Labels

Back to Index

Lists all labels in the user's mailbox.

Documentation: https://developers.google.com/gmail/api/v1/reference/users/labels/list

CURL Command

curl -X GET https://www.googleapis.com/gmail/v1/users/me/labels \
    --header "Authorization: Bearer GMAIL_TOKEN"

Node.js Example

var os = require('os');
if (os.platform() == 'win32') {  
    var chilkat = require('chilkat_node10_win32'); 
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('chilkat_node10_arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('chilkat_node10_linux32');
    } else {
        var chilkat = require('chilkat_node10_linux64');
    }
} else if (os.platform() == 'darwin') {
    var chilkat = require('chilkat_node10_macosx');
}

function chilkatExample() {

    var rest = new chilkat.Rest();
    var success;

    //  URL: https://www.googleapis.com/gmail/v1/users/me/labels
    var bTls = true;
    var port = 443;
    var bAutoReconnect = true;
    success = rest.Connect("www.googleapis.com",port,bTls,bAutoReconnect);
    if (success !== true) {
        console.log("ConnectFailReason: " + rest.ConnectFailReason);
        console.log(rest.LastErrorText);
        return;
    }

    rest.AddHeader("Authorization","Bearer GMAIL_TOKEN");

    var sbResponseBody = new chilkat.StringBuilder();
    success = rest.FullRequestNoBodySb("GET","/gmail/v1/users/me/labels",sbResponseBody);
    if (success !== true) {
        console.log(rest.LastErrorText);
        return;
    }

    var respStatusCode = rest.ResponseStatusCode;
    if (respStatusCode >= 400) {
        console.log("Response Status Code = " + respStatusCode);
        console.log("Response Header:");
        console.log(rest.ResponseHeader);
        console.log("Response Body:");
        console.log(sbResponseBody.GetAsString());
        return;
    }

    var jsonResponse = new chilkat.JsonObject();
    jsonResponse.LoadSb(sbResponseBody);

    //  See the Online Tool for Generating JSON Parse Code
    var i;
    var count_i;

    i = 0;
    count_i = jsonResponse.SizeOfArray("labels");
    while (i < count_i) {
        jsonResponse.I = i;
        var id = jsonResponse.StringOf("labels[i].id");
        var name = jsonResponse.StringOf("labels[i].name");
        var messageListVisibility = jsonResponse.StringOf("labels[i].messageListVisibility");
        var labelListVisibility = jsonResponse.StringOf("labels[i].labelListVisibility");
        var type = jsonResponse.StringOf("labels[i].type");
        i = i+1;
    }


}

chilkatExample();

Sample JSON Response Body

{
  "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"
    },
    {
      "id": "Label_8",
      "name": "old",
      "type": "user"
    },
    {
      "id": "CATEGORY_SOCIAL",
      "name": "CATEGORY_SOCIAL",
      "type": "system"
    },
    {
      "id": "Label_7",
      "name": "labél with space",
      "type": "user"
    },
    {
      "id": "Label_41",
      "name": "QA/qa_fetchSingleAsMime",
      "type": "user"
    },
    {
      "id": "Label_4",
      "name": "[Imap]/Trash",
      "messageListVisibility": "hide",
      "labelListVisibility": "labelShow",
      "type": "user"
    },
    {
      "id": "Label_1",
      "name": "\"test\"",
      "messageListVisibility": "hide",
      "labelListVisibility": "labelShow",
      "type": "user"
    },
    {
      "id": "Label_6",
      "name": "QA/Entwürfe",
      "messageListVisibility": "hide",
      "labelListVisibility": "labelShow",
      "type": "user"
    },
    {
      "id": "CATEGORY_FORUMS",
      "name": "CATEGORY_FORUMS",
      "type": "system"
    },
    {
      "id": "Label_42",
      "name": "[Gmail]/フルタイムの共有ソリューションはjapan",
      "type": "user"
    },
    {
      "id": "Label_3",
      "name": "[Gmail]/ö",
      "messageListVisibility": "hide",
      "labelListVisibility": "labelShow",
      "type": "user"
    },
    {
      "id": "IMPORTANT",
      "name": "IMPORTANT",
      "messageListVisibility": "hide",
      "labelListVisibility": "labelShow",
      "type": "system"
    },
    {
      "id": "Label_2",
      "name": "[Gmail]/X&Y",
      "type": "user"
    },
    {
      "id": "CATEGORY_UPDATES",
      "name": "CATEGORY_UPDATES",
      "type": "system"
    },
    {
      "id": "CHAT",
      "name": "CHAT",
      "messageListVisibility": "hide",
      "labelListVisibility": "labelShow",
      "type": "system"
    },
    {
      "id": "SENT",
      "name": "SENT",
      "messageListVisibility": "hide",
      "labelListVisibility": "labelShow",
      "type": "system"
    },
    {
      "id": "INBOX",
      "name": "INBOX",
      "messageListVisibility": "hide",
      "labelListVisibility": "labelShow",
      "type": "system"
    },
    {
      "id": "TRASH",
      "name": "TRASH",
      "messageListVisibility": "hide",
      "labelListVisibility": "labelHide",
      "type": "system"
    },
    {
      "id": "CATEGORY_PROMOTIONS",
      "name": "CATEGORY_PROMOTIONS",
      "type": "system"
    },
    {
      "id": "DRAFT",
      "name": "DRAFT",
      "messageListVisibility": "hide",
      "labelListVisibility": "labelShow",
      "type": "system"
    },
    {
      "id": "SPAM",
      "name": "SPAM",
      "messageListVisibility": "hide",
      "labelListVisibility": "labelHide",
      "type": "system"
    },
    {
      "id": "STARRED",
      "name": "STARRED",
      "messageListVisibility": "hide",
      "labelListVisibility": "labelShow",
      "type": "system"
    },
    {
      "id": "UNREAD",
      "name": "UNREAD",
      "type": "system"
    }
  ]
}