(Ruby) 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 Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# Use your previously obtained access token here:
http.put_AuthToken("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 
htFolderMap = Chilkat::CkHashtable.new()
sbMap = Chilkat::CkStringBuilder.new()
sbMap.LoadFile("qa_data/outlook/folderMap.xml","utf-8")
htFolderMap.AddFromXmlSb(sbMap)

existingFolderId = htFolderMap.lookupStr("/Inbox/abc")
if (htFolderMap.get_LastMethodSuccess() != true)
    print "Folder ID not found" + "\n";
    exit
end

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

# This example will create /Inbox/abc/subFolderC
jsonRequestBody = Chilkat::CkJsonObject.new()
jsonRequestBody.UpdateString("displayName","subFolderC")

http.SetUrlVar("folder_id",existingFolderId)

# Create the folder "subFolderC" at the specified location.
# resp is a CkHttpResponse
resp = http.PostJson2("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/childFolders","application/json",jsonRequestBody.emit())
if (http.get_LastMethodSuccess() != true)
    print http.lastErrorText() + "\n";
    exit
end

# A 201 response indicates success.
if (http.get_LastStatus() == 201)
    print "Folder created." + "\n";
else
    print "Response status code = " + resp.get_StatusCode().to_s() + "\n";
    print "Error: Folder not created." + "\n";
end

# Show the response in both cases..
jsonResponse = Chilkat::CkJsonObject.new()
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#users('me')/mailFolders('AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAAA%3D')/childFolders/$entity",
# 	  "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAM6JqMIAAAA=",
# 	  "displayName": "subFolderC",
# 	  "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAAA=",
# 	  "childFolderCount": 0,
# 	  "unreadItemCount": 0,
# 	  "totalItemCount": 0
# 	}