Sample code for 30+ languages & platforms
CkPerl Requires Chilkat v11.0.0+

Find a Gmail label ID by name

See more GMail REST API Examples

Look up a label using its exact display name, including any parent/child path. Labels and their IDs belong to the authenticated mailbox. Use Gmail’s returned ID when applying a user label to messages.

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.

Google documentation

Chilkat CkPerl Downloads

CkPerl
use chilkat();

$success = 0;

#  Assumes Chilkat is unlocked. See Global Unlock Sample.

$token = chilkat::CkJsonObject->new();
$success = $token->LoadFile("gmail-token.json");
if ($success != 1) {
    print "Could not read gmail-token.json from the private working directory." . "\r\n";
    exit;
}

if (($token->JsonTypeOf("access_token") != 1) or ($token->StringOfEquals("access_token","",1) == 1)) {
    print "An OAuth access token is required." . "\r\n";
    exit;
}

$http = chilkat::CkHttp->new();
$http->put_RequireSslCertVerify(1);
$http->put_AuthToken($token->stringOf("access_token"));
$resp = chilkat::CkHttpResponse->new();
$reply = chilkat::CkJsonObject->new();
$success = $http->HttpNoBody("GET","https://gmail.googleapis.com/gmail/v1/users/me/labels",$resp);
if ($resp->get_StatusCode() == 0) {
    print "Gmail did not return an HTTP response." . "\r\n";
    exit;
}

if (($success != 1) or ($resp->get_StatusCode() < 200) or ($resp->get_StatusCode() >= 300)) {
    print "Gmail HTTP " . $resp->get_StatusCode() . "\r\n";
    $success = $reply->Load($resp->bodyStr());
    if ($success == 1) {
        print $reply->stringOf("error.message") . "\r\n";
    }

    exit;
}

$success = $reply->Load($resp->bodyStr());
if ($success != 1) {
    print "Expected a Gmail JSON response." . "\r\n";
    exit;
}

if ($reply->JsonTypeOf("labels") != 4) {
    print "Expected a list of labels." . "\r\n";
    exit;
}

$label = chilkat::CkJsonObject->new();
$success = $reply->FindRecord2("labels","name","To review",1,$label);
if ($success != 1) {
    print "No label with that exact name. Check the name or create the label first." . "\r\n";
    exit;
}

print "Label ID: " . $label->stringOf("id") . "\r\n";