JavaScript Requires Chilkat v11.0.0+
JavaScript
List Gmail labels and their IDs
See more GMail REST API Examples
Read the mailbox label catalog and display each label’s type, ID, and name. System labels include INBOX and TRASH. Use the returned ID in message modification requests. Fetch an individual label if you also need its message or thread counts.
Authorize the application with https://www.googleapis.com/auth/gmail.labels. The example reads the access token from gmail-token.json in a private working directory. Authorize a desktop application.
Note
This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat
v11.4.0 or greater.
var success = false;
// Assumes Chilkat is unlocked. See Global Unlock Sample.
var token = new CkJsonObject();
success = token.LoadFile("gmail-token.json");
if (success !== true) {
console.log("Could not read gmail-token.json from the private working directory.");
return;
}
if ((token.JsonTypeOf("access_token") !== 1) || (token.StringOfEquals("access_token","",true) == true)) {
console.log("An OAuth access token is required.");
return;
}
var http = new CkHttp();
http.RequireSslCertVerify = true;
http.AuthToken = token.StringOf("access_token");
var resp = new CkHttpResponse();
var reply = new CkJsonObject();
success = http.HttpNoBody("GET","https://gmail.googleapis.com/gmail/v1/users/me/labels",resp);
if (resp.StatusCode == 0) {
console.log("Gmail did not return an HTTP response.");
return;
}
if ((success !== true) || (resp.StatusCode < 200) || (resp.StatusCode >= 300)) {
console.log("Gmail HTTP " + resp.StatusCode);
success = reply.Load(resp.BodyStr);
if (success == true) {
console.log(reply.StringOf("error.message"));
}
return;
}
success = reply.Load(resp.BodyStr);
if (success !== true) {
console.log("Expected a Gmail JSON response.");
return;
}
if (reply.JsonTypeOf("labels") !== 4) {
console.log("Expected a list of labels.");
return;
}
var i = 0;
while ((i < reply.SizeOfArray("labels"))) {
reply.I = i;
console.log(reply.StringOf("labels[i].type") + " " + reply.StringOf("labels[i].id") + " " + reply.StringOf("labels[i].name"));
i = i+1;
}