(Tcl) 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 Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

set http [new_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).

CkHttp_put_AuthToken $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)
set xmlMap [new_CkXml]

set success [CkXml_LoadXmlFile $xmlMap "qa_data/outlook/folderMap.xml"]
if {$success != 1} then {
    puts "Failed to load XML folder map."
    delete_CkHttp $http
    delete_CkXml $xmlMap
    exit
}

# 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')"

set json [new_CkJsonObject]

CkJsonObject_put_EmitCompact $json 0

set jsonCombined [new_CkJsonObject]

CkJsonObject_put_EmitCompact $jsonCombined 0

set sbResponse [new_CkStringBuilder]

set sbPath [new_CkStringBuilder]

set numFolders [CkXml_get_NumChildren $xmlMap]
set i 0
set j 0
set k 0
while {$i < $numFolders} {
    CkXml_put_I $xmlMap $i
    CkStringBuilder_SetString $sbPath [CkXml_getChildContent $xmlMap "e[i]|k"]

    if {[CkStringBuilder_StartsWith $sbPath "/Inbox" 1] == 1} then {

        puts "------------------------------------------------------------------"
        puts "Searching [CkStringBuilder_getAsString $sbPath]"

        # Search this mail folder..
        CkHttp_SetUrlVar $http "folder_id" [CkXml_getChildContent $xmlMap "e[i]|v"]

        CkStringBuilder_Clear $sbResponse
        set success [CkHttp_QuickGetSb $http "https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}" $sbResponse]
        if {expr [$success != 1]  &&  [[CkHttp_get_LastStatus $http] == 0]} then {
            puts [CkHttp_lastErrorText $http]
            delete_CkHttp $http
            delete_CkXml $xmlMap
            delete_CkJsonObject $json
            delete_CkJsonObject $jsonCombined
            delete_CkStringBuilder $sbResponse
            delete_CkStringBuilder $sbPath
            exit
        }

        CkJsonObject_LoadSb $json $sbResponse

        if {[CkHttp_get_LastStatus $http] != 200} then {
            puts "HTTP response status = [CkHttp_get_LastStatus $http]"
            puts [CkJsonObject_emit $json]
            puts "Failed."
            delete_CkHttp $http
            delete_CkXml $xmlMap
            delete_CkJsonObject $json
            delete_CkJsonObject $jsonCombined
            delete_CkStringBuilder $sbResponse
            delete_CkStringBuilder $sbPath
            exit
        }

        puts [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.
        # 			  ]
        # 			}

        set numMessages [CkJsonObject_SizeOfArray $json "value"]
        set j 0
        while {$j < $numMessages} {
            CkJsonObject_put_J $json $j

            # Add this message to the final result set.
            CkJsonObject_put_K $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"]
            set k [expr $k + 1]

            set j [expr $j + 1]
        }

    }

    set i [expr $i + 1]
}

# Show the final combined JSON search result.
puts "------------------------------------------------------------------"
puts "Combined Search Results:"
puts [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"
#         }
#       }
#     }
#   ]
# }
# 

delete_CkHttp $http
delete_CkXml $xmlMap
delete_CkJsonObject $json
delete_CkJsonObject $jsonCombined
delete_CkStringBuilder $sbResponse
delete_CkStringBuilder $sbPath