(Visual FoxPro) 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.

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

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

LOCAL loHttp
LOCAL loSbResponse
LOCAL loHtFolderMap
LOCAL loSbMap
LOCAL lcFolderId
LOCAL lnSuccess
LOCAL loJson
LOCAL loSbExpression
LOCAL loDt
LOCAL loDtObj

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('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).

loHttp.AuthToken = "MICROSOFT_GRAPH_ACCESS_TOKEN"

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponse = CreateObject('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)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Hashtable')
loHtFolderMap = CreateObject('Chilkat.Hashtable')
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbMap = CreateObject('Chilkat.StringBuilder')
loSbMap.LoadFile("qa_data/outlook/folderMap.xml","utf-8")
loHtFolderMap.AddFromXmlSb(loSbMap)

* Get the ID for the "/Inbox" folder:
lcFolderId = loHtFolderMap.LookupStr("/Inbox")
IF (loHtFolderMap.LastMethodSuccess <> 1) THEN
    ? "Folder ID not found"
    RELEASE loHttp
    RELEASE loSbResponse
    RELEASE loHtFolderMap
    RELEASE loSbMap
    CANCEL
ENDIF

lnSuccess = 1
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.EmitCompact = 0

loHttp.SetUrlVar("folder_id",lcFolderId)
loHttp.SetUrlVar("select","subject,from")

* -----------------------------------------------------------------------------------------------------
* Only return emails from "chilkat.support@gmail.com"
loHttp.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.
lnSuccess = loHttp.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}",loSbResponse)
IF ((lnSuccess <> 1) AND (loHttp.LastStatus = 0)) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponse
    RELEASE loHtFolderMap
    RELEASE loSbMap
    RELEASE loJson
    CANCEL
ENDIF

loJson.LoadSb(loSbResponse)
? loJson.Emit()

* -----------------------------------------------------------------------------------------------------
* Only return emails where the subject contains "Amazon"
loHttp.SetUrlVar("filter","contains(subject,'Amazon')")

lnSuccess = loHttp.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}",loSbResponse)
IF ((lnSuccess <> 1) AND (loHttp.LastStatus = 0)) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponse
    RELEASE loHtFolderMap
    RELEASE loSbMap
    RELEASE loJson
    CANCEL
ENDIF

loJson.LoadSb(loSbResponse)
? loJson.Emit()

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

lnSuccess = loHttp.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}",loSbResponse)
IF ((lnSuccess <> 1) AND (loHttp.LastStatus = 0)) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponse
    RELEASE loHtFolderMap
    RELEASE loSbMap
    RELEASE loJson
    CANCEL
ENDIF

loJson.LoadSb(loSbResponse)
? loJson.Emit()

* -----------------------------------------------------------------------------------------------------
* Only return emails received within the last 24 hours
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbExpression = CreateObject('Chilkat.StringBuilder')

loSbExpression.Append("receivedDateTime ge ")
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.CkDateTime')
loDt = CreateObject('Chilkat.CkDateTime')
loDt.SetFromCurrentSystemTime()
loDt.AddDays(-1)
loSbExpression.Append(loDt.GetAsTimestamp(0))

loHttp.SetUrlVar("filter",loSbExpression.GetAsString())

lnSuccess = loHttp.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}",loSbResponse)
IF ((lnSuccess <> 1) AND (loHttp.LastStatus = 0)) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponse
    RELEASE loHtFolderMap
    RELEASE loSbMap
    RELEASE loJson
    RELEASE loSbExpression
    RELEASE loDt
    CANCEL
ENDIF

loJson.LoadSb(loSbResponse)
? loJson.Emit()

* -----------------------------------------------------------------------------------------------------
* Only return emails received in October 2016
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.DtObj')
loDtObj = CreateObject('Chilkat.DtObj')
loDtObj.Year = 2016
loDtObj.Month = 10
loDtObj.Day = 1
loDtObj.Utc = 1
loDt.SetFromDtObj(loDtObj)

loSbExpression.Clear()
loSbExpression.Append("(receivedDateTime ge ")
loSbExpression.Append(loDt.GetAsTimestamp(0))
loSbExpression.Append(") and (receivedDateTime lt ")
loDtObj.Month = 11
loDt.SetFromDtObj(loDtObj)
loSbExpression.Append(loDt.GetAsTimestamp(0))
loSbExpression.Append(")")

* This is the expression we just built:  (receivedDateTime ge 2016-10-01T00:00:00Z) and (receivedDateTime lt 2016-11-01T00:00:00Z)
? loSbExpression.GetAsString()

loHttp.SetUrlVar("filter",loSbExpression.GetAsString())

lnSuccess = loHttp.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}",loSbResponse)
IF ((lnSuccess <> 1) AND (loHttp.LastStatus = 0)) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponse
    RELEASE loHtFolderMap
    RELEASE loSbMap
    RELEASE loJson
    RELEASE loSbExpression
    RELEASE loDt
    RELEASE loDtObj
    CANCEL
ENDIF

loJson.LoadSb(loSbResponse)
? loJson.Emit()

* -----------------------------------------------------------------------------------------------------
* Return unread emails
loHttp.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 ((lnSuccess <> 1) AND (loHttp.LastStatus = 0)) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponse
    RELEASE loHtFolderMap
    RELEASE loSbMap
    RELEASE loJson
    RELEASE loSbExpression
    RELEASE loDt
    RELEASE loDtObj
    CANCEL
ENDIF

loJson.LoadSb(loSbResponse)
? loJson.Emit()

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

lnSuccess = loHttp.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}",loSbResponse)
IF ((lnSuccess <> 1) AND (loHttp.LastStatus = 0)) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponse
    RELEASE loHtFolderMap
    RELEASE loSbMap
    RELEASE loJson
    RELEASE loSbExpression
    RELEASE loDt
    RELEASE loDtObj
    CANCEL
ENDIF

loJson.LoadSb(loSbResponse)
? loJson.Emit()

* -----------------------------------------------------------------------------------------------------
* 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
loHttp.SetUrlVar("search","Amazon")

lnSuccess = loHttp.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$search={$search}&$select={$select}",loSbResponse)
IF ((lnSuccess <> 1) AND (loHttp.LastStatus = 0)) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponse
    RELEASE loHtFolderMap
    RELEASE loSbMap
    RELEASE loJson
    RELEASE loSbExpression
    RELEASE loDt
    RELEASE loDtObj
    CANCEL
ENDIF

loJson.LoadSb(loSbResponse)
? loJson.Emit()

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

lnSuccess = loHttp.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$search={$search}&$select={$select}",loSbResponse)
IF ((lnSuccess <> 1) AND (loHttp.LastStatus = 0)) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponse
    RELEASE loHtFolderMap
    RELEASE loSbMap
    RELEASE loJson
    RELEASE loSbExpression
    RELEASE loDt
    RELEASE loDtObj
    CANCEL
ENDIF

loJson.LoadSb(loSbResponse)
? loJson.Emit()

RELEASE loHttp
RELEASE loSbResponse
RELEASE loHtFolderMap
RELEASE loSbMap
RELEASE loJson
RELEASE loSbExpression
RELEASE loDt
RELEASE loDtObj