Java

Find a Label ID by Name

See more GMail REST API Examples

Lookup the ID of a GMail label by the label name. Java

import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

  public static void main(String argv[])
  {
    boolean success = false;

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

    CkHttp http = new CkHttp();
    http.put_AuthToken("GMAIL-ACCESS-TOKEN");

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

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

    // Get the list of GMail labels as JSON.
    CkStringBuilder sb = new CkStringBuilder();
    success = http.QuickGetSb(url,sb);
    if (success != true) {
        System.out.println(http.lastErrorText());
        return;
        }

    CkJsonObject json = new CkJsonObject();
    json.LoadSb(sb);
    json.put_EmitCompact(false);
    System.out.println(json.emit());

    if (http.get_LastStatus() != 200) {
        System.out.println("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...
    CkJsonObject jRecord = json.FindRecord("labels","name","QA",false);
    if (json.get_LastMethodSuccess() == true) {
        System.out.println("The id of QA is: " + jRecord.stringOf("id"));

        }

    jRecord = json.FindRecord("labels","name","[Gmail]/testFolder",false);
    if (json.get_LastMethodSuccess() == true) {
        System.out.println("The id of [Gmail]/testFolder is: " + jRecord.stringOf("id"));

        }

    jRecord = json.FindRecord("labels","name","questions",false);
    if (json.get_LastMethodSuccess() == true) {
        System.out.println("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
  }
}