Delphi DLL
Delphi DLL
Outlook -- Search Multiple Folders
See more Outlook Examples
I don't yet see how it's possible to do a recursive search of Outlook folders using the Microsoft Graph API. My best guess is to somehow use OData v4.0's $expand query option, but the hierarchical structure of the "mailFolder" and "messages" Microsoft Graph resources don't quite fit. Suggestions are welcome and can be sent to support@chilkatsoft.com.This example will iterate over a list of folder previously obtained by a recursive traversal of the Outlook mail folders. (See the link in the example code below.)
A separate search is performed on each desired folder, and the results are combined into a single result set.
Note: This example requires Chilkat v9.5.0.68 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, Xml, JsonObject;
...
procedure TForm1.Button1Click(Sender: TObject);
var
success: Boolean;
http: HCkHttp;
xmlMap: HCkXml;
json: HCkJsonObject;
jsonCombined: HCkJsonObject;
sbResponse: HCkStringBuilder;
sbPath: HCkStringBuilder;
numFolders: Integer;
i: Integer;
j: Integer;
k: Integer;
numMessages: Integer;
begin
success := False;
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_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');
// This example will iterate over the folders previously discovered by recursively traversing the Outlook folders
// as shown in this example: Outlook Recursive Folder Traversal)
// The XML map produced by the recursive traversal looks like this:
// <?xml version="1.0" encoding="utf-8"?>
// <hashtable>
// <e><k>/Sent Items</k><v>AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEJAAAA</v></e>
// <e><k>/Inbox</k><v>AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA</v></e>
// <e><k>/Junk Email</k><v>AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEiAAAA</v></e>
// <e><k>/Inbox/xyz</k><v>AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huwEAAAA=</v></e>
// <e><k>/Inbox/abc/subFolderA/a</k><v>AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huwIAAAA=</v></e>
// <e><k>/Inbox/abc</k><v>AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAAA=</v></e>
// <e><k>/Outbox</k><v>AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgELAAAA</v></e>
// <e><k>/Inbox/abc/subFolderA</k><v>AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huwAAAQ==</v></e>
// <e><k>/Inbox/abc/subFolderB</k><v>AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huwMAAAA=</v></e>
// <e><k>/Archive</k><v>AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAG8XunwAAAA=</v></e>
// <e><k>/Deleted Items</k><v>AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEKAAAA</v></e>
// <e><k>/Drafts</k><v>AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEPAAAA</v></e>
// </hashtable>
// We'll iterate over the folders, and search all folders beginning with "/Inbox" (effectively, we're recursively searching
// everything under Inbox)
xmlMap := CkXml_Create();
success := CkXml_LoadXmlFile(xmlMap,'qa_data/outlook/folderMap.xml');
if (success <> True) then
begin
Memo1.Lines.Add('Failed to load XML folder map.');
Exit;
end;
// We're going to return just the message id, subject, and FROM name/address.
CkHttp_SetUrlVar(http,'select','id,subject,from');
// Our search will be for emails with the word "sample" in the subject.
CkHttp_SetUrlVar(http,'filter','contains(subject,''sample'')');
json := CkJsonObject_Create();
CkJsonObject_putEmitCompact(json,False);
jsonCombined := CkJsonObject_Create();
CkJsonObject_putEmitCompact(jsonCombined,False);
sbResponse := CkStringBuilder_Create();
sbPath := CkStringBuilder_Create();
numFolders := CkXml_getNumChildren(xmlMap);
i := 0;
j := 0;
k := 0;
while i < numFolders do
begin
CkXml_putI(xmlMap,i);
CkStringBuilder_SetString(sbPath,CkXml__getChildContent(xmlMap,'e[i]|k'));
if (CkStringBuilder_StartsWith(sbPath,'/Inbox',True) = True) then
begin
Memo1.Lines.Add('------------------------------------------------------------------');
Memo1.Lines.Add('Searching ' + CkStringBuilder__getAsString(sbPath));
// Search this mail folder..
CkHttp_SetUrlVar(http,'folder_id',CkXml__getChildContent(xmlMap,'e[i]|v'));
CkStringBuilder_Clear(sbResponse);
success := CkHttp_QuickGetSb(http,'https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}',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('HTTP response status = ' + IntToStr(CkHttp_getLastStatus(http)));
Memo1.Lines.Add(CkJsonObject__emit(json));
Memo1.Lines.Add('Failed.');
Exit;
end;
Memo1.Lines.Add(CkJsonObject__emit(json));
// Each mail folder search will return JSON with a value array, which is non-empty if any matching messages were found:
// {
// "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('me')/mailFolders('AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA')/messages(id,subject,from)",
// "value": [
// Individual messages, if any, are listed here.
// ]
// }
numMessages := CkJsonObject_SizeOfArray(json,'value');
j := 0;
while j < numMessages do
begin
CkJsonObject_putJ(json,j);
// Add this message to the final result set.
CkJsonObject_putK(jsonCombined,k);
CkJsonObject_UpdateString(jsonCombined,'value[k].folderPath',CkStringBuilder__getAsString(sbPath));
CkJsonObject_UpdateString(jsonCombined,'value[k].id',CkJsonObject__stringOf(json,'value[j].id'));
CkJsonObject_UpdateString(jsonCombined,'value[k].subject',CkJsonObject__stringOf(json,'value[j].subject'));
CkJsonObject_UpdateString(jsonCombined,'value[k].from.emailAddress.name',CkJsonObject__stringOf(json,'value[j].from.emailAddress.name'));
CkJsonObject_UpdateString(jsonCombined,'value[k].from.emailAddress.address',CkJsonObject__stringOf(json,'value[j].from.emailAddress.address'));
k := k + 1;
j := j + 1;
end;
end;
i := i + 1;
end;
// Show the final combined JSON search result.
Memo1.Lines.Add('------------------------------------------------------------------');
Memo1.Lines.Add('Combined Search Results:');
Memo1.Lines.Add(CkJsonObject__emit(jsonCombined));
// Sample output for the above program:
// ------------------------------------------------------------------
// Searching /Inbox
// {
// "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('me')/mailFolders('AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA')/messages(id,subject,from)",
// "value": [
// {
// "@odata.etag": "W/\"CQAAABYAAADn68XtMop0TpsYJGpfKXY9AADOpwfr\"",
// "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAAM6Jj10AAAA=",
// "subject": "A sample email with Amazon in the body",
// "from": {
// "emailAddress": {
// "name": "Chilkat Software",
// "address": "support@chilkatsoft.com"
// }
// }
// }
// ]
// }
//
// ------------------------------------------------------------------
// Searching /Inbox/xyz
// {
// "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('me')/mailFolders('AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huwEAAAA%3D')/messages(id,subject,from)",
// "value": [
// ]
// }
//
// ------------------------------------------------------------------
// Searching /Inbox/abc/subFolderA/a
// {
// "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('me')/mailFolders('AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huwIAAAA%3D')/messages(id,subject,from)",
// "value": [
// {
// "@odata.etag": "W/\"CQAAABYAAADn68XtMop0TpsYJGpfKXY9AADOpzfb\"",
// "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAL8huwIAAADn68XtMop0TpsYJGpfKXY9AAAAzombFQAAAA==",
// "subject": "Sample email from admin@chilkat.io",
// "from": {
// "emailAddress": {
// "name": "Chilkat Software",
// "address": "admin@chilkat.io"
// }
// }
// }
// ]
// }
//
// ------------------------------------------------------------------
// Searching /Inbox/abc
// {
// "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('me')/mailFolders('AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAAA%3D')/messages(id,subject,from)",
// "value": [
// ]
// }
//
// ------------------------------------------------------------------
// Searching /Inbox/abc/subFolderA
// {
// "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('me')/mailFolders('AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huwAAAQ%3D%3D')/messages(id,subject,from)",
// "value": [
// ]
// }
//
// ------------------------------------------------------------------
// Searching /Inbox/abc/subFolderB
// {
// "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('me')/mailFolders('AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huwMAAAA%3D')/messages(id,subject,from)",
// "value": [
// ]
// }
//
// ------------------------------------------------------------------
// Combined Search Results:
// {
// "value": [
// {
// "folderPath": "/Inbox",
// "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAAM6Jj10AAAA=",
// "subject": "A sample email with Amazon in the body",
// "from": {
// "emailAddress": {
// "name": "Chilkat Software",
// "address": "support@chilkatsoft.com"
// }
// }
// },
// {
// "folderPath": "/Inbox/abc/subFolderA/a",
// "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAL8huwIAAADn68XtMop0TpsYJGpfKXY9AAAAzombFQAAAA==",
// "subject": "Sample email from admin@chilkat.io",
// "from": {
// "emailAddress": {
// "name": "Chilkat Software",
// "address": "admin@chilkat.io"
// }
// }
// }
// ]
// }
//
CkHttp_Dispose(http);
CkXml_Dispose(xmlMap);
CkJsonObject_Dispose(json);
CkJsonObject_Dispose(jsonCombined);
CkStringBuilder_Dispose(sbResponse);
CkStringBuilder_Dispose(sbPath);
end;