(Perl) 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 Perl Downloads

Perl Module for Windows, MacOS, Linux, Alpine Linux, Solaris

use chilkat();

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

$http = chilkat::CkHttp->new();

# 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 = chilkat::CkStringBuilder->new();

# 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 != 1) and ($http->get_LastStatus() == 0)) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

$json = chilkat::CkJsonObject->new();
$json->put_EmitCompact(0);

# 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() . "\r\n";
    $json->LoadSb($sbResponse);
    print $json->emit() . "\r\n";
    print "Failed." . "\r\n";
    exit;
}

# A success response payload contains just the integer value (it is not JSON)
print "Combined Total Number of Emails = " . $sbResponse->getAsString() . "\r\n";
print "--" . "\r\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 = chilkat::CkHashtable->new();
$sbMap = chilkat::CkStringBuilder->new();
$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() != 1) {
    print "Folder ID not found" . "\r\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 != 1) and ($http->get_LastStatus() == 0)) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

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

if ($http->get_LastStatus() != 200) {
    print "Status code = " . $http->get_LastStatus() . "\r\n";
    print "Failed." . "\r\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 . "\r\n";

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

# etc..