PHP Extension
PHP Extension
Outlook -- List Mail Folders
See more Outlook Examples
Uses the Microsoft Graph API to list Outlook mail folders.Note: This example requires Chilkat v9.5.0.67 or greater.
This example applies to: Exchange Online | Office 365 | Hotmail.com | Live.com | MSN.com | Outlook.com | Passport.com
Chilkat PHP Extension Downloads
<?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();
// Sends: GET /users/{id | userPrincipalName}/mailFolders
// Note: It is also possible to use the literal string "me" for the current logged-on user.
// For example: GET /me/mailFolders
$http->ClearUrlVars();
$http->SetUrlVar('userPrincipalName','chilkatsoft@outlook.com');
$success = $http->QuickGetSb('https://graph.microsoft.com/v1.0/users/{$userPrincipalName}/mailFolders',$sbResponse);
if (($success != true) and ($http->get_LastStatus() == 0)) {
print $http->lastErrorText() . "\n";
exit;
}
$json = new CkJsonObject();
$json->LoadSb($sbResponse);
$json->put_EmitCompact(false);
print 'Status code = ' . $http->get_LastStatus() . "\n";
if ($http->get_LastStatus() != 200) {
print $json->emit() . "\n";
print 'Failed.' . "\n";
}
print $json->emit() . "\n";
print '----' . "\n";
// In my test case, this is the result (see below)
// Apparently, this lists folders without listing subfolders (aka child folders)
// There's another REST API call to list child folders.
// To iterate over the folders:
$i = 0;
$numFolders = $json->SizeOfArray('value');
while ($i < $numFolders) {
$json->put_I($i);
print $json->stringOf('value[i].displayName') . "\n";
$i = $i + 1;
}
// The output from the above loop:
// Archive
// Deleted Items
// Drafts
// Inbox
// Junk Email
// Outbox
// Sent Items
// ------------------------------------------------------------------------------------
// The raw JSON response:
// {
// "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('chilkatsoft%40outlook.com')/mailFolders",
// "value": [
// {
// "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAG8XunwAAAA=",
// "displayName": "Archive",
// "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEIAAAA",
// "childFolderCount": 0,
// "unreadItemCount": 0,
// "totalItemCount": 0
// },
// {
// "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEKAAAA",
// "displayName": "Deleted Items",
// "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEIAAAA",
// "childFolderCount": 0,
// "unreadItemCount": 0,
// "totalItemCount": 0
// },
// {
// "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEPAAAA",
// "displayName": "Drafts",
// "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEIAAAA",
// "childFolderCount": 0,
// "unreadItemCount": 0,
// "totalItemCount": 0
// },
// {
// "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA",
// "displayName": "Inbox",
// "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEIAAAA",
// "childFolderCount": 2,
// "unreadItemCount": 0,
// "totalItemCount": 4
// },
// {
// "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEiAAAA",
// "displayName": "Junk Email",
// "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEIAAAA",
// "childFolderCount": 0,
// "unreadItemCount": 0,
// "totalItemCount": 0
// },
// {
// "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgELAAAA",
// "displayName": "Outbox",
// "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEIAAAA",
// "childFolderCount": 0,
// "unreadItemCount": 0,
// "totalItemCount": 0
// },
// {
// "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEJAAAA",
// "displayName": "Sent Items",
// "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEIAAAA",
// "childFolderCount": 0,
// "unreadItemCount": 0,
// "totalItemCount": 14
// }
// ]
// }
//
// ------------------------------------------------------------------------------------------------------
// This example applies to: Exchange Online | Office 365 | Hotmail.com | Live.com | MSN.com | Outlook.com | Passport.com
//
// The Microsoft Graph Outlook Mail API lets you read, create, and send messages and attachments,
// view and respond to event messages, and manage folders that are secured by Azure Active Directory
// in Office 365. It also provides the same functionality in Microsoft accounts specifically
// in these domains: Hotmail.com, Live.com, MSN.com, Outlook.com, and Passport.com.
?>