Tcl
Outlook -- List Mail Folders

Uses the Microsoft Graph API to list Outlook mail folders.
Note: This example requires Chilkat v9.5.0.67 or greater.
Chilkat Tcl Downloads

Tcl

load ./chilkat.dll

set success 0

# 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:
# 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).

CkHttp_put_AuthToken $http "MICROSOFT_GRAPH_ACCESS_TOKEN"

set sbResponse [new_CkStringBuilder]

# Sends:  GET /users/{id | userPrincipalName}/mailFolders
# Note: It is also possible to use the literal string "me" for the current logged-on user.
# For example: GET /me/mailFolders
CkHttp_ClearUrlVars $http
CkHttp_SetUrlVar $http "userPrincipalName" "chilkatsoft@outlook.com"
set success [CkHttp_QuickGetSb $http "https://graph.microsoft.com/v1.0/users/{$userPrincipalName}/mailFolders" $sbResponse]
if {expr [$success != 1]  &&  [[CkHttp_get_LastStatus $http] == 0]} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponse
    exit
}

set json [new_CkJsonObject]

CkJsonObject_LoadSb $json $sbResponse
CkJsonObject_put_EmitCompact $json 0

puts "Status code = [CkHttp_get_LastStatus $http]"
if {[CkHttp_get_LastStatus $http] != 200} then {
    puts [CkJsonObject_emit $json]
    puts "Failed."
}

puts [CkJsonObject_emit $json]
puts "----"

# In my test case, this is the result (see below)
# Apparently, this lists folders without listing subfolders (aka child folders)
# There's another REST API call to list child folders.

# To iterate over the folders:
set i 0
set numFolders [CkJsonObject_SizeOfArray $json "value"]
while {$i < $numFolders} {
    CkJsonObject_put_I $json $i
    puts [CkJsonObject_stringOf $json {value[i].displayName}]
    set i [expr $i + 1]
}

# The output from the above loop:

# 	Archive
# 	Deleted Items
# 	Drafts
# 	Inbox
# 	Junk Email
# 	Outbox
# 	Sent Items

# ------------------------------------------------------------------------------------
# The raw JSON response: 

# {
#   "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('chilkatsoft%40outlook.com')/mailFolders",
#   "value": [
#     {
#       "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAG8XunwAAAA=",
#       "displayName": "Archive",
#       "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEIAAAA",
#       "childFolderCount": 0,
#       "unreadItemCount": 0,
#       "totalItemCount": 0
#     },
#     {
#       "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEKAAAA",
#       "displayName": "Deleted Items",
#       "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEIAAAA",
#       "childFolderCount": 0,
#       "unreadItemCount": 0,
#       "totalItemCount": 0
#     },
#     {
#       "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEPAAAA",
#       "displayName": "Drafts",
#       "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEIAAAA",
#       "childFolderCount": 0,
#       "unreadItemCount": 0,
#       "totalItemCount": 0
#     },
#     {
#       "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA",
#       "displayName": "Inbox",
#       "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEIAAAA",
#       "childFolderCount": 2,
#       "unreadItemCount": 0,
#       "totalItemCount": 4
#     },
#     {
#       "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEiAAAA",
#       "displayName": "Junk Email",
#       "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEIAAAA",
#       "childFolderCount": 0,
#       "unreadItemCount": 0,
#       "totalItemCount": 0
#     },
#     {
#       "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgELAAAA",
#       "displayName": "Outbox",
#       "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEIAAAA",
#       "childFolderCount": 0,
#       "unreadItemCount": 0,
#       "totalItemCount": 0
#     },
#     {
#       "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEJAAAA",
#       "displayName": "Sent Items",
#       "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEIAAAA",
#       "childFolderCount": 0,
#       "unreadItemCount": 0,
#       "totalItemCount": 14
#     }
#   ]
# }
# 

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

delete_CkHttp $http
delete_CkStringBuilder $sbResponse
delete_CkJsonObject $json