PHP Extension GMail: Lists the messages in the user's mailbox.

Back to Index

Lists the messages in the user's mailbox.

Documentation: https://developers.google.com/gmail/api/v1/reference/users/messages/list

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

$rest = new CkRest();

//   Provide a previously obtained OAuth2 access token.
$oauth2 = new CkOAuth2();
$oauth2->put_AccessToken('OAUTH2_ACCESS_TOKEN');
$rest->SetAuthOAuth2($oauth2);

$success = $rest->Connect('www.googleapis.com',443,true,true);
if ($success != true) {
    print $rest->lastErrorText() . "\n";
    exit;
}

$sbJson = new CkStringBuilder();
$success = $rest->FullRequestNoBodySb('GET','/gmail/v1/users/me/messages',$sbJson);
if ($success != true) {
    print $rest->lastErrorText() . "\n";
    exit;
}

if ($rest->get_ResponseStatusCode() != 200) {
    print 'Received error response code: ' . $rest->get_ResponseStatusCode() . "\n";
    print 'Response body:' . "\n";
    print $sbJson->getAsString() . "\n";
    exit;
}

$json = new CkJsonObject();
$json->LoadSb($sbJson);

//  The following code parses the JSON response.
//  A sample JSON response is shown below the sample code.

$resultSizeEstimate = $json->IntOf('resultSizeEstimate');
$i = 0;
$count_i = $json->SizeOfArray('messages');
while ($i < $count_i) {
    $json->put_I($i);
    $id = $json->stringOf('messages[i].id');
    $threadId = $json->stringOf('messages[i].threadId');
    $i = $i + 1;
}

print 'Example Completed.' . "\n";

?>

Sample JSON Response Body

{
  "messages": [
    {
      "id": "15fc237e79da4174",
      "threadId": "15fc237e79da4174"
    },
    {
      "id": "15fc23688c553739",
      "threadId": "15fc23688c553739"
    },
    {
      "id": "15fbd37d3a8f9950",
      "threadId": "15fbd37d3a8f9950"
    },
    {
      "id": "15fb5e49b822ac1d",
      "threadId": "15fb5e49b822ac1d"
    },
    {
      "id": "15fb5e49b7a0739b",
      "threadId": "15fb5e49b7a0739b"
    }
  ],
  "resultSizeEstimate": 5
}