(PHP Extension) Outlook -- Copy Mail Folder and Contents to another Mail Folder

Copy a mailfolder and its contents to another mailfolder.

Note: This example requires Chilkat v9.5.0.68 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, MacOS, Alpine Linux, Solaris

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

// Use your previously obtained access token here:
$http->put_AuthToken('MICROSOFT_GRAPH_ACCESS_TOKEN');

// This example will copy /Inbox/abc/subFolderA and its contents to /Inbox/xyz
// We'll need the folder ids for both source and destination folders..

// Get the folder IDs from the folder map created by this example 
$htFolderMap = new CkHashtable();
$sbMap = new CkStringBuilder();
$sbMap->LoadFile('qa_data/outlook/folderMap.xml','utf-8');
$htFolderMap->AddFromXmlSb($sbMap);

// Get the IDs for the source and destination folders.
$srcFolderId = $htFolderMap->lookupStr('/Inbox/abc/subFolderA');
if ($htFolderMap->get_LastMethodSuccess() != true) {
    print 'Folder ID not found' . "\n";
    exit;
}

$dstFolderId = $htFolderMap->lookupStr('/Inbox/xyz');
if ($htFolderMap->get_LastMethodSuccess() != true) {
    print 'Destination folder ID not found' . "\n";
    exit;
}

// Create a JSON request body with this content:
// 
// 		{
// 		  "DestinationId": "destinationId-value"
// 		}

$jsonRequestBody = new CkJsonObject();
$jsonRequestBody->UpdateString('DestinationId',$dstFolderId);

$http->SetUrlVar('src_folder_id',$srcFolderId);

// Copy the source folder to the new location
// resp is a CkHttpResponse
$resp = $http->PostJson2('https://graph.microsoft.com/v1.0/me/mailFolders/{$src_folder_id}/copy','application/json',$jsonRequestBody->emit());
if ($http->get_LastMethodSuccess() != true) {
    print $http->lastErrorText() . "\n";
    exit;
}

// A 201 response indicates success.
if ($resp->get_StatusCode() == 201) {
    print 'Folder copied.' . "\n";
}
else {
    print 'Response status code = ' . $resp->get_StatusCode() . "\n";
    print 'Error: Folder not copied.' . "\n";
}

// Show the response in both cases..
$jsonResponse = new CkJsonObject();
$jsonResponse->put_EmitCompact(false);
$jsonResponse->Load($resp->bodyStr());
print $jsonResponse->emit() . "\n";

// A sample successful JSON response looks like this:

// 	{
// 	  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#mailFolder",
// 	  "@odata.type": "#microsoft.graph.mailFolder",
// 	  "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAM6JqMAAAAA=",
// 	  "displayName": "subFolderA",
// 	  "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huwEAAAA=",
// 	  "childFolderCount": 1,
// 	  "unreadItemCount": 0,
// 	  "totalItemCount": 0
// 	}

?>