Sample code for 30+ languages & platforms
AutoIt

Outlook -- Search Messages in a Particular Folder

See more Outlook Examples

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.

This example applies to: Exchange Online | Office 365 | Hotmail.com | Live.com | MSN.com | Outlook.com | Passport.com

Chilkat AutoIt Downloads

Download Chilkat for AutoIt
AutoIt 
Local $bSuccess = False

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

$oHttp = ObjCreate("Chilkat.Http")

; 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).

$oHttp.AuthToken = "MICROSOFT_GRAPH_ACCESS_TOKEN"

$oSbResponse = ObjCreate("Chilkat.StringBuilder")

; 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)
$oHtFolderMap = ObjCreate("Chilkat.Hashtable")
$oSbMap = ObjCreate("Chilkat.StringBuilder")
$oSbMap.LoadFile("qa_data/outlook/folderMap.xml","utf-8")
$oHtFolderMap.AddFromXmlSb($oSbMap)

; Get the ID for the "/Inbox" folder:
Local $sFolderId = $oHtFolderMap.LookupStr("/Inbox")
If ($oHtFolderMap.LastMethodSuccess <> True) Then
    ConsoleWrite("Folder ID not found" & @CRLF)
    Exit
EndIf

$bSuccess = True
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.EmitCompact = False

$oHttp.SetUrlVar("folder_id",$sFolderId)
$oHttp.SetUrlVar("select","subject,from")

; -----------------------------------------------------------------------------------------------------
; Only return emails from "chilkat.support@gmail.com"
$oHttp.SetUrlVar("filter","from/emailAddress/address eq 'chilkat.support@gmail.com'")

; To return the full content of each email, omit the "&select=..." part of the URL.
$bSuccess = $oHttp.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}",$oSbResponse)
If (($bSuccess <> True) And ($oHttp.LastStatus = 0)) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJson.LoadSb($oSbResponse)
ConsoleWrite($oJson.Emit() & @CRLF)

; -----------------------------------------------------------------------------------------------------
; Only return emails where the subject contains "Amazon"
$oHttp.SetUrlVar("filter","contains(subject,'Amazon')")

$bSuccess = $oHttp.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}",$oSbResponse)
If (($bSuccess <> True) And ($oHttp.LastStatus = 0)) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJson.LoadSb($oSbResponse)
ConsoleWrite($oJson.Emit() & @CRLF)

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

$bSuccess = $oHttp.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}",$oSbResponse)
If (($bSuccess <> True) And ($oHttp.LastStatus = 0)) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJson.LoadSb($oSbResponse)
ConsoleWrite($oJson.Emit() & @CRLF)

; -----------------------------------------------------------------------------------------------------
; Only return emails received within the last 24 hours
$oSbExpression = ObjCreate("Chilkat.StringBuilder")

$oSbExpression.Append("receivedDateTime ge ")
$oDt = ObjCreate("Chilkat.CkDateTime")
$oDt.SetFromCurrentSystemTime()
$oDt.AddDays(-1)
$oSbExpression.Append($oDt.GetAsTimestamp(False))

$oHttp.SetUrlVar("filter",$oSbExpression.GetAsString())

$bSuccess = $oHttp.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}",$oSbResponse)
If (($bSuccess <> True) And ($oHttp.LastStatus = 0)) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJson.LoadSb($oSbResponse)
ConsoleWrite($oJson.Emit() & @CRLF)

; -----------------------------------------------------------------------------------------------------
; Only return emails received in October 2016
$oDtObj = ObjCreate("Chilkat.DtObj")
$oDtObj.Year = 2016
$oDtObj.Month = 10
$oDtObj.Day = 1
$oDtObj.Utc = True
$oDt.SetFromDtObj($oDtObj)

$oSbExpression.Clear 
$oSbExpression.Append("(receivedDateTime ge ")
$oSbExpression.Append($oDt.GetAsTimestamp(False))
$oSbExpression.Append(") and (receivedDateTime lt ")
$oDtObj.Month = 11
$oDt.SetFromDtObj($oDtObj)
$oSbExpression.Append($oDt.GetAsTimestamp(False))
$oSbExpression.Append(")")

; This is the expression we just built:  (receivedDateTime ge 2016-10-01T00:00:00Z) and (receivedDateTime lt 2016-11-01T00:00:00Z)
ConsoleWrite($oSbExpression.GetAsString() & @CRLF)

$oHttp.SetUrlVar("filter",$oSbExpression.GetAsString())

$bSuccess = $oHttp.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}",$oSbResponse)
If (($bSuccess <> True) And ($oHttp.LastStatus = 0)) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJson.LoadSb($oSbResponse)
ConsoleWrite($oJson.Emit() & @CRLF)

; -----------------------------------------------------------------------------------------------------
; Return unread emails
$oHttp.SetUrlVar("filter","isRead eq false")

; success = http.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}",sbResponse);
If (($bSuccess <> True) And ($oHttp.LastStatus = 0)) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJson.LoadSb($oSbResponse)
ConsoleWrite($oJson.Emit() & @CRLF)

; -----------------------------------------------------------------------------------------------------
; Return emails with a plain-text or HTML body containing the phrase "Outlook 365"
$oHttp.SetUrlVar("filter","contains(body/content,'Outlook 365')")

$bSuccess = $oHttp.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}",$oSbResponse)
If (($bSuccess <> True) And ($oHttp.LastStatus = 0)) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJson.LoadSb($oSbResponse)
ConsoleWrite($oJson.Emit() & @CRLF)

; -----------------------------------------------------------------------------------------------------
; 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
$oHttp.SetUrlVar("search","Amazon")

$bSuccess = $oHttp.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$search={$search}&$select={$select}",$oSbResponse)
If (($bSuccess <> True) And ($oHttp.LastStatus = 0)) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJson.LoadSb($oSbResponse)
ConsoleWrite($oJson.Emit() & @CRLF)

; -----------------------------------------------------------------------------------------------------
; Search for chilkatsoft.com
; Some chars, such as the "." make it necessary to enclose the search expression in double-quotes.
$oHttp.SetUrlVar("search","""chilkatsoft.com""")

$bSuccess = $oHttp.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$search={$search}&$select={$select}",$oSbResponse)
If (($bSuccess <> True) And ($oHttp.LastStatus = 0)) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJson.LoadSb($oSbResponse)
ConsoleWrite($oJson.Emit() & @CRLF)