Unicode C
Unicode C
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 Unicode C Downloads
#include <C_CkHttpW.h>
#include <C_CkHashtableW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkStringArrayW.h>
void ChilkatSample(void)
{
BOOL success;
HCkHttpW http;
HCkHashtableW folderMap;
HCkStringBuilderW sbResponse;
HCkJsonObjectW json;
HCkStringArrayW idQueue;
HCkStringBuilderW sbFolderPath;
HCkStringBuilderW sbQueueEntry;
const wchar_t *folderName;
const wchar_t *folderPath;
const wchar_t *folderId;
int i;
int numFolders;
const wchar_t *parentFolderPath;
const wchar_t *parentFolderId;
HCkStringBuilderW sbFolderMapXml;
HCkHashtableW ht2;
HCkStringBuilderW sb2;
success = FALSE;
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
// Our folder path --> ID map will be stored in this hash table.
folderMap = CkHashtableW_Create();
// 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).
CkHttpW_putAuthToken(http,L"MICROSOFT_GRAPH_ACCESS_TOKEN");
sbResponse = CkStringBuilderW_Create();
// Begin by getting the top-level folders.
CkHttpW_ClearUrlVars(http);
CkHttpW_SetUrlVar(http,L"userPrincipalName",L"chilkatsoft@outlook.com");
success = CkHttpW_QuickGetSb(http,L"https://graph.microsoft.com/v1.0/users/{$userPrincipalName}/mailFolders",sbResponse);
if ((success != TRUE) && (CkHttpW_getLastStatus(http) == 0)) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkHashtableW_Dispose(folderMap);
CkStringBuilderW_Dispose(sbResponse);
return;
}
json = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(json,sbResponse);
CkJsonObjectW_putEmitCompact(json,FALSE);
wprintf(L"Status code = %d\n",CkHttpW_getLastStatus(http));
if (CkHttpW_getLastStatus(http) != 200) {
wprintf(L"%s\n",CkJsonObjectW_emit(json));
wprintf(L"Failed.\n");
}
// 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 = CkStringArrayW_Create();
sbFolderPath = CkStringBuilderW_Create();
sbQueueEntry = CkStringBuilderW_Create();
// Prime the map and idQueue with the top-level folders.
i = 0;
numFolders = CkJsonObjectW_SizeOfArray(json,L"value");
while (i < numFolders) {
CkJsonObjectW_putI(json,i);
folderName = CkJsonObjectW_stringOf(json,L"value[i].displayName");
folderId = CkJsonObjectW_stringOf(json,L"value[i].id");
CkStringBuilderW_SetString(sbFolderPath,L"/");
CkStringBuilderW_Append(sbFolderPath,folderName);
folderPath = CkStringBuilderW_getAsString(sbFolderPath);
CkHashtableW_AddStr(folderMap,folderPath,folderId);
wprintf(L"%s --> %s\n",folderPath,folderId);
// Push the folder path + id onto the idQueue.
CkStringBuilderW_Clear(sbQueueEntry);
CkStringBuilderW_SetNth(sbQueueEntry,0,folderPath,L"|",FALSE,FALSE);
CkStringBuilderW_SetNth(sbQueueEntry,1,folderId,L"|",FALSE,FALSE);
CkStringArrayW_Append(idQueue,CkStringBuilderW_getAsString(sbQueueEntry));
i = i + 1;
}
// 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.
while (CkStringArrayW_getLength(idQueue) > 0) {
CkStringBuilderW_SetString(sbQueueEntry,CkStringArrayW_getString(idQueue,0));
CkStringArrayW_RemoveAt(idQueue,0);
parentFolderPath = CkStringBuilderW_getNth(sbQueueEntry,0,L"|",FALSE,FALSE);
parentFolderId = CkStringBuilderW_getNth(sbQueueEntry,1,L"|",FALSE,FALSE);
CkHttpW_SetUrlVar(http,L"id",parentFolderId);
success = CkHttpW_QuickGetSb(http,L"https://graph.microsoft.com/v1.0/users/{$userPrincipalName}/mailFolders/{$id}/childFolders",sbResponse);
if ((success != TRUE) && (CkHttpW_getLastStatus(http) == 0)) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkHashtableW_Dispose(folderMap);
CkStringBuilderW_Dispose(sbResponse);
CkJsonObjectW_Dispose(json);
CkStringArrayW_Dispose(idQueue);
CkStringBuilderW_Dispose(sbFolderPath);
CkStringBuilderW_Dispose(sbQueueEntry);
return;
}
CkJsonObjectW_LoadSb(json,sbResponse);
if (CkHttpW_getLastStatus(http) != 200) {
wprintf(L"Status code = %d\n",CkHttpW_getLastStatus(http));
wprintf(L"%s\n",CkJsonObjectW_emit(json));
wprintf(L"Failed.\n");
}
i = 0;
numFolders = CkJsonObjectW_SizeOfArray(json,L"value");
while (i < numFolders) {
CkJsonObjectW_putI(json,i);
folderName = CkJsonObjectW_stringOf(json,L"value[i].displayName");
folderId = CkJsonObjectW_stringOf(json,L"value[i].id");
CkStringBuilderW_SetString(sbFolderPath,parentFolderPath);
CkStringBuilderW_Append(sbFolderPath,L"/");
CkStringBuilderW_Append(sbFolderPath,folderName);
folderPath = CkStringBuilderW_getAsString(sbFolderPath);
CkHashtableW_AddStr(folderMap,folderPath,folderId);
wprintf(L"%s --> %s\n",folderPath,folderId);
// Push the folder path + id onto the idQueue.
CkStringBuilderW_Clear(sbQueueEntry);
CkStringBuilderW_SetNth(sbQueueEntry,0,folderPath,L"|",FALSE,FALSE);
CkStringBuilderW_SetNth(sbQueueEntry,1,folderId,L"|",FALSE,FALSE);
CkStringArrayW_Append(idQueue,CkStringBuilderW_getAsString(sbQueueEntry));
i = i + 1;
}
}
// The hash table of mail folder paths --> ID's can be persisted to XML and saved to a file or database (or anywhere..)
sbFolderMapXml = CkStringBuilderW_Create();
CkHashtableW_ToXmlSb(folderMap,sbFolderMapXml);
CkStringBuilderW_WriteFile(sbFolderMapXml,L"qa_data/outlook/folderMap.xml",L"utf-8",FALSE);
// The hash table can be restored from the serialized XML like this:
ht2 = CkHashtableW_Create();
sb2 = CkStringBuilderW_Create();
CkStringBuilderW_LoadFile(sb2,L"qa_data/outlook/folderMap.xml",L"utf-8");
CkHashtableW_AddFromXmlSb(ht2,sb2);
// What's the ID for the folder "/Inbox/abc/subFolderA" ?
wprintf(L"id for /Inbox/abc/subFolderA = %s\n",CkHashtableW_lookupStr(ht2,L"/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.
CkHttpW_Dispose(http);
CkHashtableW_Dispose(folderMap);
CkStringBuilderW_Dispose(sbResponse);
CkJsonObjectW_Dispose(json);
CkStringArrayW_Dispose(idQueue);
CkStringBuilderW_Dispose(sbFolderPath);
CkStringBuilderW_Dispose(sbQueueEntry);
CkStringBuilderW_Dispose(sbFolderMapXml);
CkHashtableW_Dispose(ht2);
CkStringBuilderW_Dispose(sb2);
}