PHP Extension

Outlook -- Get Number of Emails

Gets the number of emails in an Outlook folder. This uses the OData $count system query option. See OData System Query Option $count for general information.

This example first gets the combined total number of messages across all folders.

Note: This example requires Chilkat v9.5.0.68 or greater.

Chilkat PHP Extension Downloads

Download Chilkat for PHP Extension

PHP Extension

<?php

include("chilkat.php");

$success = false;

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

$http = new CkHttp();

// Use your previously obtained access token here:
// See the following examples for getting an access token:
//    Get Microsoft Graph OAuth2 Access Token (Azure AD v2.0 Endpoint).
//    Get Microsoft Graph OAuth2 Access Token (Azure AD Endpoint).
//    Refresh Access Token (Azure AD v2.0 Endpoint).
//    Refresh Access Token (Azure AD Endpoint).

$http->put_AuthToken('MICROSOFT_GRAPH_ACCESS_TOKEN');

$sbResponse = new CkStringBuilder();

// This gets the combined total number of emails in all folders.
$success = $http->QuickGetSb('https://graph.microsoft.com/v1.0/me/messages/$count',$sbResponse);
if (($success != true) and ($http->get_LastStatus() == 0)) {
    print $http->lastErrorText() . "\n";
    exit;
}

$json = new CkJsonObject();
$json->put_EmitCompact(false);

// If the status code was not 200, then it failed and the response is likely JSON:
if ($http->get_LastStatus() != 200) {
    print 'Status code = ' . $http->get_LastStatus() . "\n";
    $json->LoadSb($sbResponse);
    print $json->emit() . "\n";
    print 'Failed.' . "\n";
    exit;
}

// A success response payload contains just the integer value (it is not JSON)
print 'Combined Total Number of Emails = ' . $sbResponse->getAsString() . "\n";
print '--' . "\n";

// ---------------------------------------------------------------------------
// To get the number of emails in a particular folder, we need to use the folder id.
// 

// In this example, we'd like to get number of messages in the folder "/Inbox/abc",
// but we must specify the corresponding folder_id.  The best way to do this is to create
// a local map of folderPaths-to-folderIds.
// We'll use the map created by this example:  Create Outlook Folder Map)
$htFolderMap = new CkHashtable();
$sbMap = new CkStringBuilder();
$sbMap->LoadFile('qa_data/outlook/folderMap.xml','utf-8');
$htFolderMap->AddFromXmlSb($sbMap);

// Get the ID for the "/Inbox/abc" folder:
$folderId = $htFolderMap->lookupStr('/Inbox/abc');
if ($htFolderMap->get_LastMethodSuccess() != true) {
    print 'Folder ID not found' . "\n";
    exit;
}

$http->SetUrlVar('folder_id',$folderId);

// Send the request get the folder information.
// In this case we are NOT using the $count system query option.
$success = $http->QuickGetSb('https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}',$sbResponse);
if (($success != true) and ($http->get_LastStatus() == 0)) {
    print $http->lastErrorText() . "\n";
    exit;
}

$json->LoadSb($sbResponse);
print $json->emit() . "\n";
print '--' . "\n";

if ($http->get_LastStatus() != 200) {
    print 'Status code = ' . $http->get_LastStatus() . "\n";
    print 'Failed.' . "\n";
    exit;
}

// The successful JSON response looks like this;

// 	{
// 	  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('me')/mailFolders/$entity",
// 	  "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAAA=",
// 	  "displayName": "abc",
// 	  "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA",
// 	  "childFolderCount": 2,
// 	  "unreadItemCount": 0,
// 	  "totalItemCount": 3
// 	}
// 

// Get the integer value from the JSON like this:
$totalItemCount = $json->IntOf('totalItemCount');
print 'totalItemCount = ' . $totalItemCount . "\n";

$childFolderCount = $json->IntOf('childFolderCount');
print 'childFolderCount = ' . $childFolderCount . "\n";

// etc..

?>