CkPython

Outlook -- Copy Mail Folder and Contents to another Mail Folder

See more Outlook Examples

Copy a mailfolder and its contents to another mailfolder.

This example applies to: Exchange Online | Office 365 | Hotmail.com | Live.com | MSN.com | Outlook.com | Passport.com

CkPython

import sys
import chilkat

success = False

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

http = chilkat.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 = chilkat.CkHashtable()
sbMap = chilkat.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")
    sys.exit()

dstFolderId = htFolderMap.lookupStr("/Inbox/xyz")
if (htFolderMap.get_LastMethodSuccess() != True):
    print("Destination folder ID not found")
    sys.exit()

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

jsonRequestBody = chilkat.CkJsonObject()
jsonRequestBody.UpdateString("DestinationId",dstFolderId)

http.SetUrlVar("src_folder_id",srcFolderId)

# Copy the source folder to the new location
resp = chilkat.CkHttpResponse()
success = http.HttpJson("POST","https://graph.microsoft.com/v1.0/me/mailFolders/{$src_folder_id}/copy",jsonRequestBody,"application/json",resp)
if (success == False):
    print(http.lastErrorText())
    sys.exit()

# A 201 response indicates success.
if (resp.get_StatusCode() == 201):
    print("Folder copied.")
else:
    print("Response status code = " + str(resp.get_StatusCode()))
    print("Error: Folder not copied.")

# Show the response in both cases..
jsonResponse = chilkat.CkJsonObject()
jsonResponse.put_EmitCompact(False)
jsonResponse.Load(resp.bodyStr())
print(jsonResponse.emit())

# 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
# 	}