Lianja
Lianja
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 Lianja Downloads
llSuccess = .F.
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
// Our folder path --> ID map will be stored in this hash table.
loFolderMap = createobject("CkHashtable")
// 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).
loHttp.AuthToken = "MICROSOFT_GRAPH_ACCESS_TOKEN"
loSbResponse = createobject("CkStringBuilder")
// Begin by getting the top-level folders.
loHttp.ClearUrlVars()
loHttp.SetUrlVar("userPrincipalName","chilkatsoft@outlook.com")
llSuccess = loHttp.QuickGetSb("https://graph.microsoft.com/v1.0/users/{$userPrincipalName}/mailFolders",loSbResponse)
if ((llSuccess <> .T.) and (loHttp.LastStatus = 0)) then
? loHttp.LastErrorText
release loHttp
release loFolderMap
release loSbResponse
return
endif
loJson = createobject("CkJsonObject")
loJson.LoadSb(loSbResponse)
loJson.EmitCompact = .F.
? "Status code = " + str(loHttp.LastStatus)
if (loHttp.LastStatus <> 200) then
? loJson.Emit()
? "Failed."
endif
// 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.
loIdQueue = createobject("CkStringArray")
loSbFolderPath = createobject("CkStringBuilder")
loSbQueueEntry = createobject("CkStringBuilder")
// Prime the map and idQueue with the top-level folders.
i = 0
lnNumFolders = loJson.SizeOfArray("value")
do while i < lnNumFolders
loJson.I = i
lcFolderName = loJson.StringOf("value[i].displayName")
lcFolderId = loJson.StringOf("value[i].id")
loSbFolderPath.SetString("/")
loSbFolderPath.Append(lcFolderName)
lcFolderPath = loSbFolderPath.GetAsString()
loFolderMap.AddStr(lcFolderPath,lcFolderId)
? lcFolderPath + " --> " + lcFolderId
// Push the folder path + id onto the idQueue.
loSbQueueEntry.Clear()
loSbQueueEntry.SetNth(0,lcFolderPath,"|",.F.,.F.)
loSbQueueEntry.SetNth(1,lcFolderId,"|",.F.,.F.)
loIdQueue.Append(loSbQueueEntry.GetAsString())
i = i + 1
enddo
// 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 loIdQueue.Length > 0
loSbQueueEntry.SetString(loIdQueue.GetString(0))
loIdQueue.RemoveAt(0)
lcParentFolderPath = loSbQueueEntry.GetNth(0,"|",.F.,.F.)
lcParentFolderId = loSbQueueEntry.GetNth(1,"|",.F.,.F.)
loHttp.SetUrlVar("id",lcParentFolderId)
llSuccess = loHttp.QuickGetSb("https://graph.microsoft.com/v1.0/users/{$userPrincipalName}/mailFolders/{$id}/childFolders",loSbResponse)
if ((llSuccess <> .T.) and (loHttp.LastStatus = 0)) then
? loHttp.LastErrorText
release loHttp
release loFolderMap
release loSbResponse
release loJson
release loIdQueue
release loSbFolderPath
release loSbQueueEntry
return
endif
loJson.LoadSb(loSbResponse)
if (loHttp.LastStatus <> 200) then
? "Status code = " + str(loHttp.LastStatus)
? loJson.Emit()
? "Failed."
endif
i = 0
lnNumFolders = loJson.SizeOfArray("value")
do while i < lnNumFolders
loJson.I = i
lcFolderName = loJson.StringOf("value[i].displayName")
lcFolderId = loJson.StringOf("value[i].id")
loSbFolderPath.SetString(lcParentFolderPath)
loSbFolderPath.Append("/")
loSbFolderPath.Append(lcFolderName)
lcFolderPath = loSbFolderPath.GetAsString()
loFolderMap.AddStr(lcFolderPath,lcFolderId)
? lcFolderPath + " --> " + lcFolderId
// Push the folder path + id onto the idQueue.
loSbQueueEntry.Clear()
loSbQueueEntry.SetNth(0,lcFolderPath,"|",.F.,.F.)
loSbQueueEntry.SetNth(1,lcFolderId,"|",.F.,.F.)
loIdQueue.Append(loSbQueueEntry.GetAsString())
i = i + 1
enddo
enddo
// The hash table of mail folder paths --> ID's can be persisted to XML and saved to a file or database (or anywhere..)
loSbFolderMapXml = createobject("CkStringBuilder")
loFolderMap.ToXmlSb(loSbFolderMapXml)
loSbFolderMapXml.WriteFile("qa_data/outlook/folderMap.xml","utf-8",.F.)
// The hash table can be restored from the serialized XML like this:
loHt2 = createobject("CkHashtable")
loSb2 = createobject("CkStringBuilder")
loSb2.LoadFile("qa_data/outlook/folderMap.xml","utf-8")
loHt2.AddFromXmlSb(loSb2)
// What's the ID for the folder "/Inbox/abc/subFolderA" ?
? "id for /Inbox/abc/subFolderA = " + loHt2.LookupStr("/Inbox/abc/subFolderA")
// 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.
release loHttp
release loFolderMap
release loSbResponse
release loJson
release loIdQueue
release loSbFolderPath
release loSbQueueEntry
release loSbFolderMapXml
release loHt2
release loSb2