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

List Gmail message IDs across all pages

See more GMail REST API Examples

List message and thread IDs for the authenticated user. Continue with nextPageToken until it is absent. A message ID is a Gmail identifier, distinct from the RFC Message-ID header. Use it in the reading examples. Spam and Trash are excluded by default.

Authorize the application with https://www.googleapis.com/auth/gmail.readonly. 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();
$total = 0;
$baseUrl = chilkat::CkStringBuilder->new();
$baseUrl->Append("https://gmail.googleapis.com/gmail/v1/users/me/messages?maxResults=100");
$url = chilkat::CkStringBuilder->new();
$pageToken = chilkat::CkStringBuilder->new();
$more = 1;
while (($more == 1)) {
    $url->SetString($baseUrl->getAsString());
    if ($pageToken->get_Length() > 0) {
        $url->Append("&pageToken=");
        $url->Append($http->urlEncode($pageToken->getAsString()));
    }

    $success = $http->HttpNoBody("GET",$url->getAsString(),$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;
    }

    #  Gmail can omit messages when the search or mailbox is empty.
    $count = $reply->SizeOfArray("messages");
    $i = 0;
    while (($i < $count)) {
        $reply->put_I($i);
        print $reply->stringOf("messages[i].id") . "  thread " . $reply->stringOf("messages[i].threadId") . "\r\n";
        $total = $total + 1;
        $i = $i + 1;
    }

    $more = 0;
    if ($reply->JsonTypeOf("nextPageToken") == 1) {
        $pageToken->SetString($reply->stringOf("nextPageToken"));
        $more = $pageToken->get_Length() > 0;
    }

}

print "Messages listed: " . $total . "\r\n";