Classic ASP
Classic ASP
Outlook -- Create Map of Folder Paths to IDs
See more Outlook Examples
Recursively descends folders and creates a hashtable of folder paths to IDs. This can be done once at the start of your program (or even less if the map is persisted to a file or database).The reason this is necessary is because folder ID's need to be passed to the Outlook API, and an application will typically be working with folder paths.
Note: This example requires Chilkat v9.5.0.67 or greater.
This example applies to: Exchange Online | Office 365 | Hotmail.com | Live.com | MSN.com | Outlook.com | Passport.com
Chilkat Classic ASP Downloads
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head>
<body>
<%
success = 0
' This example requires the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
set http = Server.CreateObject("Chilkat.Http")
' Our folder path --> ID map will be stored in this hash table.
set folderMap = Server.CreateObject("Chilkat.Hashtable")
' 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).
http.AuthToken = "MICROSOFT_GRAPH_ACCESS_TOKEN"
set sbResponse = Server.CreateObject("Chilkat.StringBuilder")
' Begin by getting the top-level folders.
http.ClearUrlVars
success = http.SetUrlVar("userPrincipalName","chilkatsoft@outlook.com")
success = http.QuickGetSb("https://graph.microsoft.com/v1.0/users/{$userPrincipalName}/mailFolders",sbResponse)
If ((success <> 1) And (http.LastStatus = 0)) Then
Response.Write "<pre>" & Server.HTMLEncode( http.LastErrorText) & "</pre>"
Response.End
End If
set json = Server.CreateObject("Chilkat.JsonObject")
success = json.LoadSb(sbResponse)
json.EmitCompact = 0
Response.Write "<pre>" & Server.HTMLEncode( "Status code = " & http.LastStatus) & "</pre>"
If (http.LastStatus <> 200) Then
Response.Write "<pre>" & Server.HTMLEncode( json.Emit()) & "</pre>"
Response.Write "<pre>" & Server.HTMLEncode( "Failed.") & "</pre>"
End If
' This is our queue/stack of unprocessed folder ID's
' The recursive nature of this example is that we get the
' child folders for each folder ID in the idQueue, which may
' cause additional ID's to be added. We continue until the idQueue
' is empty.
set idQueue = Server.CreateObject("Chilkat.StringArray")
set sbFolderPath = Server.CreateObject("Chilkat.StringBuilder")
set sbQueueEntry = Server.CreateObject("Chilkat.StringBuilder")
' Prime the map and idQueue with the top-level folders.
i = 0
numFolders = json.SizeOfArray("value")
Do While i < numFolders
json.I = i
folderName = json.StringOf("value[i].displayName")
folderId = json.StringOf("value[i].id")
success = sbFolderPath.SetString("/")
success = sbFolderPath.Append(folderName)
folderPath = sbFolderPath.GetAsString()
success = folderMap.AddStr(folderPath,folderId)
Response.Write "<pre>" & Server.HTMLEncode( folderPath & " --> " & folderId) & "</pre>"
' Push the folder path + id onto the idQueue.
sbQueueEntry.Clear
success = sbQueueEntry.SetNth(0,folderPath,"|",0,0)
success = sbQueueEntry.SetNth(1,folderId,"|",0,0)
success = idQueue.Append(sbQueueEntry.GetAsString())
i = i + 1
Loop
' Initial output:
' /Archive --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAG8XunwAAAA=
' /Deleted Items --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEKAAAA
' /Drafts --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEPAAAA
' /Inbox --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA
' /Junk Email --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEiAAAA
' /Outbox --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgELAAAA
' /Sent Items --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEJAAAA
'
' Process the idQueue until it becomes empty. This is the recursive loop.
Do While idQueue.Length > 0
success = sbQueueEntry.SetString(idQueue.GetString(0))
success = idQueue.RemoveAt(0)
parentFolderPath = sbQueueEntry.GetNth(0,"|",0,0)
parentFolderId = sbQueueEntry.GetNth(1,"|",0,0)
success = http.SetUrlVar("id",parentFolderId)
success = http.QuickGetSb("https://graph.microsoft.com/v1.0/users/{$userPrincipalName}/mailFolders/{$id}/childFolders",sbResponse)
If ((success <> 1) And (http.LastStatus = 0)) Then
Response.Write "<pre>" & Server.HTMLEncode( http.LastErrorText) & "</pre>"
Response.End
End If
success = json.LoadSb(sbResponse)
If (http.LastStatus <> 200) Then
Response.Write "<pre>" & Server.HTMLEncode( "Status code = " & http.LastStatus) & "</pre>"
Response.Write "<pre>" & Server.HTMLEncode( json.Emit()) & "</pre>"
Response.Write "<pre>" & Server.HTMLEncode( "Failed.") & "</pre>"
End If
i = 0
numFolders = json.SizeOfArray("value")
Do While i < numFolders
json.I = i
folderName = json.StringOf("value[i].displayName")
folderId = json.StringOf("value[i].id")
success = sbFolderPath.SetString(parentFolderPath)
success = sbFolderPath.Append("/")
success = sbFolderPath.Append(folderName)
folderPath = sbFolderPath.GetAsString()
success = folderMap.AddStr(folderPath,folderId)
Response.Write "<pre>" & Server.HTMLEncode( folderPath & " --> " & folderId) & "</pre>"
' Push the folder path + id onto the idQueue.
sbQueueEntry.Clear
success = sbQueueEntry.SetNth(0,folderPath,"|",0,0)
success = sbQueueEntry.SetNth(1,folderId,"|",0,0)
success = idQueue.Append(sbQueueEntry.GetAsString())
i = i + 1
Loop
Loop
' The hash table of mail folder paths --> ID's can be persisted to XML and saved to a file or database (or anywhere..)
set sbFolderMapXml = Server.CreateObject("Chilkat.StringBuilder")
success = folderMap.ToXmlSb(sbFolderMapXml)
success = sbFolderMapXml.WriteFile("qa_data/outlook/folderMap.xml","utf-8",0)
' The hash table can be restored from the serialized XML like this:
set ht2 = Server.CreateObject("Chilkat.Hashtable")
set sb2 = Server.CreateObject("Chilkat.StringBuilder")
success = sb2.LoadFile("qa_data/outlook/folderMap.xml","utf-8")
success = ht2.AddFromXmlSb(sb2)
' What's the ID for the folder "/Inbox/abc/subFolderA" ?
Response.Write "<pre>" & Server.HTMLEncode( "id for /Inbox/abc/subFolderA = " & ht2.LookupStr("/Inbox/abc/subFolderA")) & "</pre>"
' Final output:
' /Archive --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAG8XunwAAAA=
' /Deleted Items --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEKAAAA
' /Drafts --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEPAAAA
' /Inbox --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA
' /Junk Email --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEiAAAA
' /Outbox --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgELAAAA
' /Sent Items --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEJAAAA
' /Inbox/abc --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAAA=
' /Inbox/xyz --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huwEAAAA=
' /Inbox/abc/subFolderA --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huwAAAQ==
' /Inbox/abc/subFolderB --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huwMAAAA=
' /Inbox/abc/subFolderA/a --> AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huwIAAAA=
'
' ------------------------------------------------------------------------------------------------------
' 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.
%>
</body>
</html>