Delphi DLL
Delphi DLL
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 Delphi DLL Downloads
uses
Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Http, StringBuilder, Hashtable, StringArray, JsonObject;
...
procedure TForm1.Button1Click(Sender: TObject);
var
success: Boolean;
http: HCkHttp;
folderMap: HCkHashtable;
sbResponse: HCkStringBuilder;
json: HCkJsonObject;
idQueue: HCkStringArray;
sbFolderPath: HCkStringBuilder;
sbQueueEntry: HCkStringBuilder;
folderName: PWideChar;
folderPath: PWideChar;
folderId: PWideChar;
i: Integer;
numFolders: Integer;
parentFolderPath: PWideChar;
parentFolderId: PWideChar;
sbFolderMapXml: HCkStringBuilder;
ht2: HCkHashtable;
sb2: HCkStringBuilder;
begin
success := False;
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
// Our folder path --> ID map will be stored in this hash table.
folderMap := CkHashtable_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).
CkHttp_putAuthToken(http,'MICROSOFT_GRAPH_ACCESS_TOKEN');
sbResponse := CkStringBuilder_Create();
// Begin by getting the top-level folders.
CkHttp_ClearUrlVars(http);
CkHttp_SetUrlVar(http,'userPrincipalName','chilkatsoft@outlook.com');
success := CkHttp_QuickGetSb(http,'https://graph.microsoft.com/v1.0/users/{$userPrincipalName}/mailFolders',sbResponse);
if ((success <> True) and (CkHttp_getLastStatus(http) = 0)) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
json := CkJsonObject_Create();
CkJsonObject_LoadSb(json,sbResponse);
CkJsonObject_putEmitCompact(json,False);
Memo1.Lines.Add('Status code = ' + IntToStr(CkHttp_getLastStatus(http)));
if (CkHttp_getLastStatus(http) <> 200) then
begin
Memo1.Lines.Add(CkJsonObject__emit(json));
Memo1.Lines.Add('Failed.');
end;
// 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 := CkStringArray_Create();
sbFolderPath := CkStringBuilder_Create();
sbQueueEntry := CkStringBuilder_Create();
// Prime the map and idQueue with the top-level folders.
i := 0;
numFolders := CkJsonObject_SizeOfArray(json,'value');
while i < numFolders do
begin
CkJsonObject_putI(json,i);
folderName := CkJsonObject__stringOf(json,'value[i].displayName');
folderId := CkJsonObject__stringOf(json,'value[i].id');
CkStringBuilder_SetString(sbFolderPath,'/');
CkStringBuilder_Append(sbFolderPath,folderName);
folderPath := CkStringBuilder__getAsString(sbFolderPath);
CkHashtable_AddStr(folderMap,folderPath,folderId);
Memo1.Lines.Add(folderPath + ' --> ' + folderId);
// Push the folder path + id onto the idQueue.
CkStringBuilder_Clear(sbQueueEntry);
CkStringBuilder_SetNth(sbQueueEntry,0,folderPath,'|',False,False);
CkStringBuilder_SetNth(sbQueueEntry,1,folderId,'|',False,False);
CkStringArray_Append(idQueue,CkStringBuilder__getAsString(sbQueueEntry));
i := i + 1;
end;
// 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 CkStringArray_getLength(idQueue) > 0 do
begin
CkStringBuilder_SetString(sbQueueEntry,CkStringArray__getString(idQueue,0));
CkStringArray_RemoveAt(idQueue,0);
parentFolderPath := CkStringBuilder__getNth(sbQueueEntry,0,'|',False,False);
parentFolderId := CkStringBuilder__getNth(sbQueueEntry,1,'|',False,False);
CkHttp_SetUrlVar(http,'id',parentFolderId);
success := CkHttp_QuickGetSb(http,'https://graph.microsoft.com/v1.0/users/{$userPrincipalName}/mailFolders/{$id}/childFolders',sbResponse);
if ((success <> True) and (CkHttp_getLastStatus(http) = 0)) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
CkJsonObject_LoadSb(json,sbResponse);
if (CkHttp_getLastStatus(http) <> 200) then
begin
Memo1.Lines.Add('Status code = ' + IntToStr(CkHttp_getLastStatus(http)));
Memo1.Lines.Add(CkJsonObject__emit(json));
Memo1.Lines.Add('Failed.');
end;
i := 0;
numFolders := CkJsonObject_SizeOfArray(json,'value');
while i < numFolders do
begin
CkJsonObject_putI(json,i);
folderName := CkJsonObject__stringOf(json,'value[i].displayName');
folderId := CkJsonObject__stringOf(json,'value[i].id');
CkStringBuilder_SetString(sbFolderPath,parentFolderPath);
CkStringBuilder_Append(sbFolderPath,'/');
CkStringBuilder_Append(sbFolderPath,folderName);
folderPath := CkStringBuilder__getAsString(sbFolderPath);
CkHashtable_AddStr(folderMap,folderPath,folderId);
Memo1.Lines.Add(folderPath + ' --> ' + folderId);
// Push the folder path + id onto the idQueue.
CkStringBuilder_Clear(sbQueueEntry);
CkStringBuilder_SetNth(sbQueueEntry,0,folderPath,'|',False,False);
CkStringBuilder_SetNth(sbQueueEntry,1,folderId,'|',False,False);
CkStringArray_Append(idQueue,CkStringBuilder__getAsString(sbQueueEntry));
i := i + 1;
end;
end;
// The hash table of mail folder paths --> ID's can be persisted to XML and saved to a file or database (or anywhere..)
sbFolderMapXml := CkStringBuilder_Create();
CkHashtable_ToXmlSb(folderMap,sbFolderMapXml);
CkStringBuilder_WriteFile(sbFolderMapXml,'qa_data/outlook/folderMap.xml','utf-8',False);
// The hash table can be restored from the serialized XML like this:
ht2 := CkHashtable_Create();
sb2 := CkStringBuilder_Create();
CkStringBuilder_LoadFile(sb2,'qa_data/outlook/folderMap.xml','utf-8');
CkHashtable_AddFromXmlSb(ht2,sb2);
// What's the ID for the folder "/Inbox/abc/subFolderA" ?
Memo1.Lines.Add('id for /Inbox/abc/subFolderA = ' + CkHashtable__lookupStr(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_Dispose(http);
CkHashtable_Dispose(folderMap);
CkStringBuilder_Dispose(sbResponse);
CkJsonObject_Dispose(json);
CkStringArray_Dispose(idQueue);
CkStringBuilder_Dispose(sbFolderPath);
CkStringBuilder_Dispose(sbQueueEntry);
CkStringBuilder_Dispose(sbFolderMapXml);
CkHashtable_Dispose(ht2);
CkStringBuilder_Dispose(sb2);
end;