(Lianja) Outlook -- Search Multiple Folders

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 Lianja Extension Download Chilkat Lianja Extension

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

loHttp = createobject("CkHttp")

// 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"

// 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)
loXmlMap = createobject("CkXml")
llSuccess = loXmlMap.LoadXmlFile("qa_data/outlook/folderMap.xml")
if (llSuccess <> .T.) then
    ? "Failed to load XML folder map."
    release loHttp
    release loXmlMap
    return
endif

// We're going to return just the message id, subject, and FROM name/address.
loHttp.SetUrlVar("select","id,subject,from")

// Our search will be for emails with the word "sample" in the subject.
loHttp.SetUrlVar("filter","contains(subject,'sample')")

loJson = createobject("CkJsonObject")
loJson.EmitCompact = .F.

loJsonCombined = createobject("CkJsonObject")
loJsonCombined.EmitCompact = .F.

loSbResponse = createobject("CkStringBuilder")
loSbPath = createobject("CkStringBuilder")
lnNumFolders = loXmlMap.NumChildren
i = 0
j = 0
k = 0
do while i < lnNumFolders
    loXmlMap.I = i
    loSbPath.SetString(loXmlMap.GetChildContent("e[i]|k"))

    if (loSbPath.StartsWith("/Inbox",.T.) = .T.) then

        ? "------------------------------------------------------------------"
        ? "Searching " + loSbPath.GetAsString()

        // Search this mail folder..
        loHttp.SetUrlVar("folder_id",loXmlMap.GetChildContent("e[i]|v"))

        loSbResponse.Clear()
        llSuccess = loHttp.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}",loSbResponse)
        if ((llSuccess <> .T.) and (loHttp.LastStatus = 0)) then
            ? loHttp.LastErrorText
            release loHttp
            release loXmlMap
            release loJson
            release loJsonCombined
            release loSbResponse
            release loSbPath
            return
        endif

        loJson.LoadSb(loSbResponse)

        if (loHttp.LastStatus <> 200) then
            ? "HTTP response status = " + str(loHttp.LastStatus)
            ? loJson.Emit()
            ? "Failed."
            release loHttp
            release loXmlMap
            release loJson
            release loJsonCombined
            release loSbResponse
            release loSbPath
            return
        endif

        ? loJson.Emit()

        // 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.
        // 			  ]
        // 			}

        lnNumMessages = loJson.SizeOfArray("value")
        j = 0
        do while j < lnNumMessages
            loJson.J = j

            // Add this message to the final result set.
            loJsonCombined.K = k
            loJsonCombined.UpdateString("value[k].folderPath",loSbPath.GetAsString())
            loJsonCombined.UpdateString("value[k].id",loJson.StringOf("value[j].id"))
            loJsonCombined.UpdateString("value[k].subject",loJson.StringOf("value[j].subject"))
            loJsonCombined.UpdateString("value[k].from.emailAddress.name",loJson.StringOf("value[j].from.emailAddress.name"))
            loJsonCombined.UpdateString("value[k].from.emailAddress.address",loJson.StringOf("value[j].from.emailAddress.address"))
            k = k + 1

            j = j + 1
        enddo

    endif

    i = i + 1
enddo

// Show the final combined JSON search result.
? "------------------------------------------------------------------"
? "Combined Search Results:"
? loJsonCombined.Emit()

// 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"
//         }
//       }
//     }
//   ]
// }
// 


release loHttp
release loXmlMap
release loJson
release loJsonCombined
release loSbResponse
release loSbPath