(Lianja) 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 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"

loSbResponse = createobject("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)
loHtFolderMap = createobject("CkHashtable")
loSbMap = createobject("CkStringBuilder")
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 <> .T.) then
    ? "Folder ID not found"
    release loHttp
    release loSbResponse
    release loHtFolderMap
    release loSbMap
    return
endif

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

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.
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 loSbResponse
    release loHtFolderMap
    release loSbMap
    release loJson
    return
endif

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

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

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 loSbResponse
    release loHtFolderMap
    release loSbMap
    release loJson
    return
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')")

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 loSbResponse
    release loHtFolderMap
    release loSbMap
    release loJson
    return
endif

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

// -----------------------------------------------------------------------------------------------------
// Only return emails received within the last 24 hours
loSbExpression = createobject("CkStringBuilder")

loSbExpression.Append("receivedDateTime ge ")
loDt = createobject("CkDateTime")
loDt.SetFromCurrentSystemTime()
loDt.AddDays(-1)
loSbExpression.Append(loDt.GetAsTimestamp(.F.))

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

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 loSbResponse
    release loHtFolderMap
    release loSbMap
    release loJson
    release loSbExpression
    release loDt
    return
endif

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

// -----------------------------------------------------------------------------------------------------
// Only return emails received in October 2016
loDtObj = createobject("CkDtObj")
loDtObj.Year = 2016
loDtObj.Month = 10
loDtObj.Day = 1
loDtObj.Utc = .T.
loDt.SetFromDtObj(loDtObj)

loSbExpression.Clear()
loSbExpression.Append("(receivedDateTime ge ")
loSbExpression.Append(loDt.GetAsTimestamp(.F.))
loSbExpression.Append(") and (receivedDateTime lt ")
loDtObj.Month = 11
loDt.SetFromDtObj(loDtObj)
loSbExpression.Append(loDt.GetAsTimestamp(.F.))
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())

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 loSbResponse
    release loHtFolderMap
    release loSbMap
    release loJson
    release loSbExpression
    release loDt
    release loDtObj
    return
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 ((llSuccess <> .T.) and (loHttp.LastStatus = 0)) then
    ? loHttp.LastErrorText
    release loHttp
    release loSbResponse
    release loHtFolderMap
    release loSbMap
    release loJson
    release loSbExpression
    release loDt
    release loDtObj
    return
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')")

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 loSbResponse
    release loHtFolderMap
    release loSbMap
    release loJson
    release loSbExpression
    release loDt
    release loDtObj
    return
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")

llSuccess = loHttp.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$search={$search}&$select={$select}",loSbResponse)
if ((llSuccess <> .T.) and (loHttp.LastStatus = 0)) then
    ? loHttp.LastErrorText
    release loHttp
    release loSbResponse
    release loHtFolderMap
    release loSbMap
    release loJson
    release loSbExpression
    release loDt
    release loDtObj
    return
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"')

llSuccess = loHttp.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$search={$search}&$select={$select}",loSbResponse)
if ((llSuccess <> .T.) and (loHttp.LastStatus = 0)) then
    ? loHttp.LastErrorText
    release loHttp
    release loSbResponse
    release loHtFolderMap
    release loSbMap
    release loJson
    release loSbExpression
    release loDt
    release loDtObj
    return
endif

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


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