(Tcl) Outlook -- Create a Mail Folder

Creates a new mail folder as a child of an existing mail folder.

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 Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

set http [new_CkHttp]

# Use your previously obtained access token here:
CkHttp_put_AuthToken $http "MICROSOFT_GRAPH_ACCESS_TOKEN"

# This example will create a new mail folder as a child of /Inbox/abc

# Get the existing folder ID from the folder map created by this example 
set htFolderMap [new_CkHashtable]

set sbMap [new_CkStringBuilder]

CkStringBuilder_LoadFile $sbMap "qa_data/outlook/folderMap.xml" "utf-8"
CkHashtable_AddFromXmlSb $htFolderMap $sbMap

set existingFolderId [CkHashtable_lookupStr $htFolderMap "/Inbox/abc"]
if {[CkHashtable_get_LastMethodSuccess $htFolderMap] != 1} then {
    puts "Folder ID not found"
    delete_CkHttp $http
    delete_CkHashtable $htFolderMap
    delete_CkStringBuilder $sbMap
    exit
}

# Create a JSON request body with this content:
# 
# 	{
# 	  "displayName": "displayName-value",
# 	}

# This example will create /Inbox/abc/subFolderC
set jsonRequestBody [new_CkJsonObject]

CkJsonObject_UpdateString $jsonRequestBody "displayName" "subFolderC"

CkHttp_SetUrlVar $http "folder_id" $existingFolderId

# Create the folder "subFolderC" at the specified location.
# resp is a CkHttpResponse
set resp [CkHttp_PostJson2 $http "https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/childFolders" "application/json" [CkJsonObject_emit $jsonRequestBody]]
if {[CkHttp_get_LastMethodSuccess $http] != 1} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkHashtable $htFolderMap
    delete_CkStringBuilder $sbMap
    delete_CkJsonObject $jsonRequestBody
    exit
}

# A 201 response indicates success.
if {[CkHttp_get_LastStatus $http] == 201} then {
    puts "Folder created."
} else {
    puts "Response status code = [CkHttpResponse_get_StatusCode $resp]"
    puts "Error: Folder not created."
}

# Show the response in both cases..
set jsonResponse [new_CkJsonObject]

CkJsonObject_put_EmitCompact $jsonResponse 0
CkJsonObject_Load $jsonResponse [CkHttpResponse_bodyStr $resp]
puts [CkJsonObject_emit $jsonResponse]

delete_CkHttpResponse $resp

# A sample successful JSON response looks like this:

# 	{
# 	  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('me')/mailFolders('AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAAA%3D')/childFolders/$entity",
# 	  "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAM6JqMIAAAA=",
# 	  "displayName": "subFolderC",
# 	  "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAAA=",
# 	  "childFolderCount": 0,
# 	  "unreadItemCount": 0,
# 	  "totalItemCount": 0
# 	}

delete_CkHttp $http
delete_CkHashtable $htFolderMap
delete_CkStringBuilder $sbMap
delete_CkJsonObject $jsonRequestBody
delete_CkJsonObject $jsonResponse