[PHP] Gmail APIを使って特定のメール数を取得する方法

〇〇からの、○日に届いたメール数を取得したかったのですが、Gmail APIのドキュメントがわかりづらくて苦戦しました。

いろいろ試してなんとかできたので、メモしておきます。

以下は、2021/01/01に「aaa@bbb」から受信したメール数を表示するコードです。(Gmail APIのインストール?とかしてある状態です)

<?php
$client = getClient(); // 下に関数があります
$service = new Google_Service_Gmail($client);

$optParams = [];
$optParams['q'] = 'from:aaa@bbb after:2021/01/01 before:2021/01/02';

$user = 'me';
$results = $service->users_messages->listUsersMessages($user, $optParams);

// 条件に一致するメール数を表示(0件でもOK)
echo $results['resultSizeEstimate']; 

/**
 * Returns an authorized API client.
 * @return Google_Client the authorized client object
 */
function getClient()
{
    $client = new Google_Client();
    $client->setApplicationName('Gmail API PHP Quickstart');
    $client->setScopes(Google_Service_Gmail::GMAIL_READONLY);
    $client->setAuthConfig('credentials.json');
    $client->setAccessType('offline');
    $client->setPrompt('select_account consent');

    // Load previously authorized token from a file, if it exists.
    // The file token.json stores the user's access and refresh tokens, and is
    // created automatically when the authorization flow completes for the first
    // time.
    $tokenPath = 'token.json';
    if (file_exists($tokenPath)){
        $accessToken = json_decode(file_get_contents($tokenPath), true);
        $client->setAccessToken($accessToken);
    }

    // If there is no previous token or it's expired.
    if ($client->isAccessTokenExpired()) {
        // Refresh the token if possible, else fetch a new one.
        if ($client->getRefreshToken()) {
            $client->fetchAccessTokenWithRefreshToken($client->getRefreshToken());
        } else {
            // Request authorization from the user.
            $authUrl = $client->createAuthUrl();
            printf("Open the following link in your browser:\n%s\n", $authUrl);
            print 'Enter verification code: ';
            $authCode = trim(fgets(STDIN));

            // Exchange authorization code for an access token.
            $accessToken = $client->fetchAccessTokenWithAuthCode($authCode);
            $client->setAccessToken($accessToken);

            // Check to see if there was an error.
            if (array_key_exists('error', $accessToken)) {
                throw new Exception(join(', ', $accessToken));
            }
        }
        // Save the token to a file.
        if (!file_exists(dirname($tokenPath))) {
            mkdir(dirname($tokenPath), 0700, true);
        }
        file_put_contents($tokenPath, json_encode($client->getAccessToken()));
    }
    return $client;
}

APIのリファレンスについては、下記のあたりを参照しました。