Objective-C

Find a Label ID by Name

See more GMail REST API Examples

Lookup the ID of a GMail label by the label name. Objective-C

#import <CkoHttp.h>
#import <NSString.h>
#import <CkoStringBuilder.h>
#import <CkoJsonObject.h>

BOOL success = NO;

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

CkoHttp *http = [[CkoHttp alloc] init];
http.AuthToken = @"GMAIL-ACCESS-TOKEN";

NSString *userId = @"me";
[http SetUrlVar: @"userId" value: userId];

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

//  Get the list of GMail labels as JSON.
CkoStringBuilder *sb = [[CkoStringBuilder alloc] init];
success = [http QuickGetSb: url sbContent: sb];
if (success != YES) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json LoadSb: sb];
json.EmitCompact = NO;
NSLog(@"%@",[json Emit]);

if ([http.LastStatus intValue] != 200) {
    NSLog(@"%@",@"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...
CkoJsonObject *jRecord = [json FindRecord: @"labels" relPath: @"name" value: @"QA" caseSensitive: NO];
if (json.LastMethodSuccess == YES) {
    NSLog(@"%@%@",@"The id of QA is: ",[jRecord StringOf: @"id"]);

}

jRecord = [json FindRecord: @"labels" relPath: @"name" value: @"[Gmail]/testFolder" caseSensitive: NO];
if (json.LastMethodSuccess == YES) {
    NSLog(@"%@%@",@"The id of [Gmail]/testFolder is: ",[jRecord StringOf: @"id"]);

}

jRecord = [json FindRecord: @"labels" relPath: @"name" value: @"questions" caseSensitive: NO];
if (json.LastMethodSuccess == YES) {
    NSLog(@"%@%@",@"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