Chilkat Examples

ChilkatHOMEAndroid™Classic ASPCC++C#Mono C#.NET Core C#C# UWP/WinRTDataFlexDelphi ActiveXDelphi DLLVisual FoxProJavaLianjaMFCObjective-CPerlPHP ActiveXPHP ExtensionPowerBuilderPowerShellPureBasicCkPythonChilkat2-PythonRubySQL ServerSwift 2Swift 3/4TclUnicode CUnicode C++Visual Basic 6.0VB.NETVB.NET UWP/WinRTVBScriptXojo PluginNode.jsExcelGo

PHP Extension Examples

Web API Categories

ASN.1
Amazon Glacier
Amazon S3
Amazon S3 (new)
Amazon SES
Amazon SNS
Amazon SQS
Async
Azure Cloud Storage
Azure Service Bus
Base64
Bounced Email
Box
CAdES
CSR
CSV
Certificates
Compression
DKIM / DomainKey
DSA
Diffie-Hellman
Digital Signatures
Dropbox
Dynamics CRM
ECC
Email Object
Encryption
FTP
FileAccess
Firebase
GMail REST API
Geolocation
Google APIs
Google Calendar
Google Cloud Storage
Google Drive
Google Photos
Google Sheets
Google Tasks
Gzip
HTML-to-XML/Text

HTTP
HTTP Misc
IMAP
JSON
JSON Web Encryption (JWE)
JSON Web Signatures (JWS)
JSON Web Token (JWT)
Java KeyStore (JKS)
MHT / HTML Email
MIME
Microsoft Graph
NTLM
OAuth1
OAuth2
OneDrive
OpenSSL
Outlook
PEM
PFX/P12
POP3
PRNG
REST
REST Misc
RSA
SCP
SFTP
SMTP
SSH
SSH Key
SSH Tunnel
SharePoint
Socket/SSL/TLS
Spider
Stream
Tar Archive
Upload
WebSocket
XAdES
XML
XML Digital Signatures
XMP
Zip
curl

 

 

 

(PHP Extension) Outlook -- Create Map of Folder Paths to IDs

Recursively descends folders and creates a hashtable of folder paths to IDs. This can be done once at the start of your program (or even less if the map is persisted to a file or database).

The reason this is necessary is because folder ID's need to be passed to the Outlook API, and an application will typically be working with folder paths.

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 Downloads

PHP Extension for Windows, Linux, MAC OS X,
Alpine Linux, Solaris, OpenBSD, FreeBSD,
and Linux armhf/aarch64

<?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");

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

$http = new CkHttp();

//  Our folder path --> ID map will be stored in this hash table.
$folderMap = new CkHashtable();

//  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();

//  Begin by getting the top-level folders.
$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";
}

//  This is our queue/stack of unprocessed folder ID's
//  The recursive nature of this example is that we get the
//  child folders for each folder ID in the idQueue, which may
//  cause additional ID's to be added.  We continue  until the idQueue
//  is empty.
$idQueue = new CkStringArray();

$sbFolderPath = new CkStringBuilder();
$sbQueueEntry = new CkStringBuilder();

//  Prime the map and idQueue with the top-level folders.
$i = 0;
$numFolders = $json->SizeOfArray('value');
while ($i < $numFolders) {
    $json->put_I($i);
    $folderName = $json->stringOf('value[i].displayName');
    $folderId = $json->stringOf('value[i].id');
    $sbFolderPath->SetString('/');
    $sbFolderPath->Append($folderName);
    $folderPath = $sbFolderPath->getAsString();
    $folderMap->AddStr($folderPath,$folderId);
    print $folderPath . ' --> ' . $folderId . "\n";

    //  Push the folder path + id onto the idQueue.
    $sbQueueEntry->Clear();
    $sbQueueEntry->SetNth(0,$folderPath,'|',false,false);
    $sbQueueEntry->SetNth(1,$folderId,'|',false,false);
    $idQueue->Append($sbQueueEntry->getAsString());
    $i = $i + 1;
}

//  Initial output:
//  /Archive --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAG8XunwAAAA=
//  /Deleted Items --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEKAAAA
//  /Drafts --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEPAAAA
//  /Inbox --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA
//  /Junk Email --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEiAAAA
//  /Outbox --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgELAAAA
//  /Sent Items --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEJAAAA
// 

//  Process the idQueue until it becomes empty.  This is the recursive loop.

while ($idQueue->get_Length() > 0) {
    $sbQueueEntry->SetString($idQueue->getString(0));
    $idQueue->RemoveAt(0);

    $parentFolderPath = $sbQueueEntry->getNth(0,'|',false,false);
    $parentFolderId = $sbQueueEntry->getNth(1,'|',false,false);

    $http->SetUrlVar('id',$parentFolderId);
    $success = $http->QuickGetSb('https://graph.microsoft.com/v1.0/users/{$userPrincipalName}/mailFolders/{$id}/childFolders',$sbResponse);
    if (($success != true) and ($http->get_LastStatus() == 0)) {
        print $http->lastErrorText() . "\n";
        exit;
    }

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

    $i = 0;
    $numFolders = $json->SizeOfArray('value');
    while ($i < $numFolders) {
        $json->put_I($i);
        $folderName = $json->stringOf('value[i].displayName');
        $folderId = $json->stringOf('value[i].id');
        $sbFolderPath->SetString($parentFolderPath);
        $sbFolderPath->Append('/');
        $sbFolderPath->Append($folderName);
        $folderPath = $sbFolderPath->getAsString();
        $folderMap->AddStr($folderPath,$folderId);
        print $folderPath . ' --> ' . $folderId . "\n";

        //  Push the folder path + id onto the idQueue.
        $sbQueueEntry->Clear();
        $sbQueueEntry->SetNth(0,$folderPath,'|',false,false);
        $sbQueueEntry->SetNth(1,$folderId,'|',false,false);
        $idQueue->Append($sbQueueEntry->getAsString());
        $i = $i + 1;
    }

}

//  The hash table of mail folder paths --> ID's can be persisted to XML and saved to a file or database (or anywhere..)
$sbFolderMapXml = new CkStringBuilder();
$folderMap->ToXmlSb($sbFolderMapXml);
$sbFolderMapXml->WriteFile('qa_data/outlook/folderMap.xml','utf-8',false);

//  The hash table can be restored from the serialized XML like this:
$ht2 = new CkHashtable();
$sb2 = new CkStringBuilder();
$sb2->LoadFile('qa_data/outlook/folderMap.xml','utf-8');
$ht2->AddFromXmlSb($sb2);

//  What's the ID for the folder "/Inbox/abc/subFolderA" ?
print 'id for /Inbox/abc/subFolderA = ' . $ht2->lookupStr('/Inbox/abc/subFolderA') . "\n";

//  Final output:

//  /Archive --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAG8XunwAAAA=
//  /Deleted Items --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEKAAAA
//  /Drafts --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEPAAAA
//  /Inbox --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA
//  /Junk Email --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEiAAAA
//  /Outbox --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgELAAAA
//  /Sent Items --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEJAAAA
//  /Inbox/abc --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAAA=
//  /Inbox/xyz --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huwEAAAA=
//  /Inbox/abc/subFolderA --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huwAAAQ==
//  /Inbox/abc/subFolderB --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huwMAAAA=
//  /Inbox/abc/subFolderA/a --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huwIAAAA=
// 

//  ------------------------------------------------------------------------------------------------------
//  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.

?>

 

© 2000-2019 Chilkat Software, Inc. All Rights Reserved.