(Tcl) Outlook -- Search Messages in a Particular Folder

Demonstrates search the messages in a particular Outlook mailbox folder.

This uses the OData $filter and $search system query options. See OData System Query Options for general information.

Also see OData URL Conventions for information about $filter, $search and other query options.

This example demonstrates the following searches:

Find emails from a particular email address.
Find emails where the subject contains a particular word or phrase.
Using an "AND" expression.
Find emails received in the last 24 hours.
Find emails received in October 2016
Find unread emails
Find emails containing a particular phrase in the body.
Free-text search of a keyword or phrase.
Free-text search of an email address.

Note: This example requires Chilkat v9.5.0.68 or greater.

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"

set sbResponse [new_CkStringBuilder]

# In this example, we'd like to get the messages in the folder "/Inbox",
# but we must specify the corresponding folder_id.  The best way to do this is to create
# a local map of folderPaths-to-folderIds.
# This example does it:  Create Outlook Folder Map)
set htFolderMap [new_CkHashtable]

set sbMap [new_CkStringBuilder]

CkStringBuilder_LoadFile $sbMap "qa_data/outlook/folderMap.xml" "utf-8"
CkHashtable_AddFromXmlSb $htFolderMap $sbMap

# Get the ID for the "/Inbox" folder:
set folderId [CkHashtable_lookupStr $htFolderMap "/Inbox"]
if {[CkHashtable_get_LastMethodSuccess $htFolderMap] != 1} then {
    puts "Folder ID not found"
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponse
    delete_CkHashtable $htFolderMap
    delete_CkStringBuilder $sbMap
    exit
}

set success 1
set json [new_CkJsonObject]

CkJsonObject_put_EmitCompact $json 0

CkHttp_SetUrlVar $http "folder_id" $folderId
CkHttp_SetUrlVar $http "select" "subject,from"

# -----------------------------------------------------------------------------------------------------
# Only return emails from "chilkat.support@gmail.com"
CkHttp_SetUrlVar $http "filter" "from/emailAddress/address eq 'chilkat.support@gmail.com'"

# To return the full content of each email, omit the "&select=..." part of the URL.
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_CkStringBuilder $sbResponse
    delete_CkHashtable $htFolderMap
    delete_CkStringBuilder $sbMap
    delete_CkJsonObject $json
    exit
}

CkJsonObject_LoadSb $json $sbResponse
puts [CkJsonObject_emit $json]

# -----------------------------------------------------------------------------------------------------
# Only return emails where the subject contains "Amazon"
CkHttp_SetUrlVar $http "filter" "contains(subject,'Amazon')"

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_CkStringBuilder $sbResponse
    delete_CkHashtable $htFolderMap
    delete_CkStringBuilder $sbMap
    delete_CkJsonObject $json
    exit
}

CkJsonObject_LoadSb $json $sbResponse
puts [CkJsonObject_emit $json]

# -----------------------------------------------------------------------------------------------------
# Only return emails where the subject starts with "this email" and the from address is support@chilkatsoft.com
# (the startswith function is case insensitive)
CkHttp_SetUrlVar $http "filter" "startswith(subject,'this email') and (from/emailAddress/address eq 'support@chilkatsoft.com')"

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_CkStringBuilder $sbResponse
    delete_CkHashtable $htFolderMap
    delete_CkStringBuilder $sbMap
    delete_CkJsonObject $json
    exit
}

CkJsonObject_LoadSb $json $sbResponse
puts [CkJsonObject_emit $json]

# -----------------------------------------------------------------------------------------------------
# Only return emails received within the last 24 hours
set sbExpression [new_CkStringBuilder]

CkStringBuilder_Append $sbExpression "receivedDateTime ge "
set dt [new_CkDateTime]

CkDateTime_SetFromCurrentSystemTime $dt
CkDateTime_AddDays $dt -1
CkStringBuilder_Append $sbExpression [CkDateTime_getAsTimestamp $dt 0]

CkHttp_SetUrlVar $http "filter" [CkStringBuilder_getAsString $sbExpression]

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_CkStringBuilder $sbResponse
    delete_CkHashtable $htFolderMap
    delete_CkStringBuilder $sbMap
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbExpression
    delete_CkDateTime $dt
    exit
}

CkJsonObject_LoadSb $json $sbResponse
puts [CkJsonObject_emit $json]

# -----------------------------------------------------------------------------------------------------
# Only return emails received in October 2016
set dtObj [new_CkDtObj]

CkDtObj_put_Year $dtObj 2016
CkDtObj_put_Month $dtObj 10
CkDtObj_put_Day $dtObj 1
CkDtObj_put_Utc $dtObj 1
CkDateTime_SetFromDtObj $dt $dtObj

CkStringBuilder_Clear $sbExpression
CkStringBuilder_Append $sbExpression "(receivedDateTime ge "
CkStringBuilder_Append $sbExpression [CkDateTime_getAsTimestamp $dt 0]
CkStringBuilder_Append $sbExpression ") and (receivedDateTime lt "
CkDtObj_put_Month $dtObj 11
CkDateTime_SetFromDtObj $dt $dtObj
CkStringBuilder_Append $sbExpression [CkDateTime_getAsTimestamp $dt 0]
CkStringBuilder_Append $sbExpression ")"

# This is the expression we just built:  (receivedDateTime ge 2016-10-01T00:00:00Z) and (receivedDateTime lt 2016-11-01T00:00:00Z)
puts [CkStringBuilder_getAsString $sbExpression]

CkHttp_SetUrlVar $http "filter" [CkStringBuilder_getAsString $sbExpression]

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_CkStringBuilder $sbResponse
    delete_CkHashtable $htFolderMap
    delete_CkStringBuilder $sbMap
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbExpression
    delete_CkDateTime $dt
    delete_CkDtObj $dtObj
    exit
}

CkJsonObject_LoadSb $json $sbResponse
puts [CkJsonObject_emit $json]

# -----------------------------------------------------------------------------------------------------
# Return unread emails
CkHttp_SetUrlVar $http "filter" "isRead eq false"

# success = http.QuickGetSb("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_CkStringBuilder $sbResponse
    delete_CkHashtable $htFolderMap
    delete_CkStringBuilder $sbMap
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbExpression
    delete_CkDateTime $dt
    delete_CkDtObj $dtObj
    exit
}

CkJsonObject_LoadSb $json $sbResponse
puts [CkJsonObject_emit $json]

# -----------------------------------------------------------------------------------------------------
# Return emails with a plain-text or HTML body containing the phrase "Outlook 365"
CkHttp_SetUrlVar $http "filter" "contains(body/content,'Outlook 365')"

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_CkStringBuilder $sbResponse
    delete_CkHashtable $htFolderMap
    delete_CkStringBuilder $sbMap
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbExpression
    delete_CkDateTime $dt
    delete_CkDtObj $dtObj
    exit
}

CkJsonObject_LoadSb $json $sbResponse
puts [CkJsonObject_emit $json]

# -----------------------------------------------------------------------------------------------------
# Use the $search query option instead of $filter.
# $search is a free-text search over whatever fields the server deems appropriate, such as in the subject,
# body, address fields, etc.

# Search for the word Amazon
CkHttp_SetUrlVar $http "search" "Amazon"

set success [CkHttp_QuickGetSb $http "https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$search={$search}&$select={$select}" $sbResponse]
if {expr [$success != 1]  &&  [[CkHttp_get_LastStatus $http] == 0]} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponse
    delete_CkHashtable $htFolderMap
    delete_CkStringBuilder $sbMap
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbExpression
    delete_CkDateTime $dt
    delete_CkDtObj $dtObj
    exit
}

CkJsonObject_LoadSb $json $sbResponse
puts [CkJsonObject_emit $json]

# -----------------------------------------------------------------------------------------------------
# Search for chilkatsoft.com
# Some chars, such as the "." make it necessary to enclose the search expression in double-quotes.
CkHttp_SetUrlVar $http "search" "\"chilkatsoft.com\""

set success [CkHttp_QuickGetSb $http "https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$search={$search}&$select={$select}" $sbResponse]
if {expr [$success != 1]  &&  [[CkHttp_get_LastStatus $http] == 0]} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponse
    delete_CkHashtable $htFolderMap
    delete_CkStringBuilder $sbMap
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbExpression
    delete_CkDateTime $dt
    delete_CkDtObj $dtObj
    exit
}

CkJsonObject_LoadSb $json $sbResponse
puts [CkJsonObject_emit $json]

delete_CkHttp $http
delete_CkStringBuilder $sbResponse
delete_CkHashtable $htFolderMap
delete_CkStringBuilder $sbMap
delete_CkJsonObject $json
delete_CkStringBuilder $sbExpression
delete_CkDateTime $dt
delete_CkDtObj $dtObj