PureBasic
PureBasic
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 PureBasic Downloads
IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHashtable.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringArray.pb"
Procedure ChilkatExample()
success.i = 0
; This example requires the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
; Our folder path --> ID map will be stored in this hash table.
folderMap.i = CkHashtable::ckCreate()
If folderMap.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
; 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::setCkAuthToken(http, "MICROSOFT_GRAPH_ACCESS_TOKEN")
sbResponse.i = CkStringBuilder::ckCreate()
If sbResponse.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
; Begin by getting the top-level folders.
CkHttp::ckClearUrlVars(http)
CkHttp::ckSetUrlVar(http,"userPrincipalName","chilkatsoft@outlook.com")
success = CkHttp::ckQuickGetSb(http,"https://graph.microsoft.com/v1.0/users/{$userPrincipalName}/mailFolders",sbResponse)
If (success <> 1) AND (CkHttp::ckLastStatus(http) = 0)
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkHashtable::ckDispose(folderMap)
CkStringBuilder::ckDispose(sbResponse)
ProcedureReturn
EndIf
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(json,sbResponse)
CkJsonObject::setCkEmitCompact(json, 0)
Debug "Status code = " + Str(CkHttp::ckLastStatus(http))
If CkHttp::ckLastStatus(http) <> 200
Debug CkJsonObject::ckEmit(json)
Debug "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.
idQueue.i = CkStringArray::ckCreate()
If idQueue.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
sbFolderPath.i = CkStringBuilder::ckCreate()
If sbFolderPath.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
sbQueueEntry.i = CkStringBuilder::ckCreate()
If sbQueueEntry.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
folderName.s
folderPath.s
folderId.s
; Prime the map and idQueue with the top-level folders.
i.i = 0
numFolders.i = CkJsonObject::ckSizeOfArray(json,"value")
While i < numFolders
CkJsonObject::setCkI(json, i)
folderName = CkJsonObject::ckStringOf(json,"value[i].displayName")
folderId = CkJsonObject::ckStringOf(json,"value[i].id")
CkStringBuilder::ckSetString(sbFolderPath,"/")
CkStringBuilder::ckAppend(sbFolderPath,folderName)
folderPath = CkStringBuilder::ckGetAsString(sbFolderPath)
CkHashtable::ckAddStr(folderMap,folderPath,folderId)
Debug folderPath + " --> " + folderId
; Push the folder path + id onto the idQueue.
CkStringBuilder::ckClear(sbQueueEntry)
CkStringBuilder::ckSetNth(sbQueueEntry,0,folderPath,"|",0,0)
CkStringBuilder::ckSetNth(sbQueueEntry,1,folderId,"|",0,0)
CkStringArray::ckAppend(idQueue,CkStringBuilder::ckGetAsString(sbQueueEntry))
i = i + 1
Wend
; 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.
parentFolderPath.s
parentFolderId.s
While CkStringArray::ckLength(idQueue) > 0
CkStringBuilder::ckSetString(sbQueueEntry,CkStringArray::ckGetString(idQueue,0))
CkStringArray::ckRemoveAt(idQueue,0)
parentFolderPath = CkStringBuilder::ckGetNth(sbQueueEntry,0,"|",0,0)
parentFolderId = CkStringBuilder::ckGetNth(sbQueueEntry,1,"|",0,0)
CkHttp::ckSetUrlVar(http,"id",parentFolderId)
success = CkHttp::ckQuickGetSb(http,"https://graph.microsoft.com/v1.0/users/{$userPrincipalName}/mailFolders/{$id}/childFolders",sbResponse)
If (success <> 1) AND (CkHttp::ckLastStatus(http) = 0)
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkHashtable::ckDispose(folderMap)
CkStringBuilder::ckDispose(sbResponse)
CkJsonObject::ckDispose(json)
CkStringArray::ckDispose(idQueue)
CkStringBuilder::ckDispose(sbFolderPath)
CkStringBuilder::ckDispose(sbQueueEntry)
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(json,sbResponse)
If CkHttp::ckLastStatus(http) <> 200
Debug "Status code = " + Str(CkHttp::ckLastStatus(http))
Debug CkJsonObject::ckEmit(json)
Debug "Failed."
EndIf
i = 0
numFolders = CkJsonObject::ckSizeOfArray(json,"value")
While i < numFolders
CkJsonObject::setCkI(json, i)
folderName = CkJsonObject::ckStringOf(json,"value[i].displayName")
folderId = CkJsonObject::ckStringOf(json,"value[i].id")
CkStringBuilder::ckSetString(sbFolderPath,parentFolderPath)
CkStringBuilder::ckAppend(sbFolderPath,"/")
CkStringBuilder::ckAppend(sbFolderPath,folderName)
folderPath = CkStringBuilder::ckGetAsString(sbFolderPath)
CkHashtable::ckAddStr(folderMap,folderPath,folderId)
Debug folderPath + " --> " + folderId
; Push the folder path + id onto the idQueue.
CkStringBuilder::ckClear(sbQueueEntry)
CkStringBuilder::ckSetNth(sbQueueEntry,0,folderPath,"|",0,0)
CkStringBuilder::ckSetNth(sbQueueEntry,1,folderId,"|",0,0)
CkStringArray::ckAppend(idQueue,CkStringBuilder::ckGetAsString(sbQueueEntry))
i = i + 1
Wend
Wend
; The hash table of mail folder paths --> ID's can be persisted to XML and saved to a file or database (or anywhere..)
sbFolderMapXml.i = CkStringBuilder::ckCreate()
If sbFolderMapXml.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHashtable::ckToXmlSb(folderMap,sbFolderMapXml)
CkStringBuilder::ckWriteFile(sbFolderMapXml,"qa_data/outlook/folderMap.xml","utf-8",0)
; The hash table can be restored from the serialized XML like this:
ht2.i = CkHashtable::ckCreate()
If ht2.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
sb2.i = CkStringBuilder::ckCreate()
If sb2.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkStringBuilder::ckLoadFile(sb2,"qa_data/outlook/folderMap.xml","utf-8")
CkHashtable::ckAddFromXmlSb(ht2,sb2)
; What's the ID for the folder "/Inbox/abc/subFolderA" ?
Debug "id for /Inbox/abc/subFolderA = " + CkHashtable::ckLookupStr(ht2,"/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.
CkHttp::ckDispose(http)
CkHashtable::ckDispose(folderMap)
CkStringBuilder::ckDispose(sbResponse)
CkJsonObject::ckDispose(json)
CkStringArray::ckDispose(idQueue)
CkStringBuilder::ckDispose(sbFolderPath)
CkStringBuilder::ckDispose(sbQueueEntry)
CkStringBuilder::ckDispose(sbFolderMapXml)
CkHashtable::ckDispose(ht2)
CkStringBuilder::ckDispose(sb2)
ProcedureReturn
EndProcedure