Sample code for 30+ languages & platforms
Xbase++

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 Xbase++ Downloads

Download Chilkat for Xbase++
Xbase++ 
LOCAL nSuccess
LOCAL oHttp
LOCAL oSbResponse
LOCAL oHtFolderMap
LOCAL oSbMap
LOCAL cFolderId
LOCAL oJson
LOCAL oSbExpression
LOCAL oDt
LOCAL oDtObj

nSuccess := 0

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

oHttp := 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).

oHttp:AuthToken := "MICROSOFT_GRAPH_ACCESS_TOKEN"

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

//  Get the ID for the "/Inbox" folder:
cFolderId := oHtFolderMap:LookupStr("/Inbox")
IF (oHtFolderMap:LastMethodSuccess != 1)
    ? "Folder ID not found"
    oHttp:destroy()
    oSbResponse:destroy()
    oHtFolderMap:destroy()
    oSbMap:destroy()
    RETURN
ENDIF

nSuccess := 1
oJson := CreateObject("Chilkat.JsonObject")
oJson:EmitCompact := 0

oHttp:SetUrlVar("folder_id", cFolderId)
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.
nSuccess := oHttp:QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}", oSbResponse)
IF ((nSuccess != 1) .AND. (oHttp:LastStatus == 0))
    ? oHttp:LastErrorText
    oHttp:destroy()
    oSbResponse:destroy()
    oHtFolderMap:destroy()
    oSbMap:destroy()
    oJson:destroy()
    RETURN
ENDIF

oJson:LoadSb(oSbResponse)
? oJson:Emit()

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

nSuccess := oHttp:QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}", oSbResponse)
IF ((nSuccess != 1) .AND. (oHttp:LastStatus == 0))
    ? oHttp:LastErrorText
    oHttp:destroy()
    oSbResponse:destroy()
    oHtFolderMap:destroy()
    oSbMap:destroy()
    oJson:destroy()
    RETURN
ENDIF

oJson:LoadSb(oSbResponse)
? oJson: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)
oHttp:SetUrlVar("filter", "startswith(subject,'this email') and (from/emailAddress/address eq 'support@chilkatsoft.com')")

nSuccess := oHttp:QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}", oSbResponse)
IF ((nSuccess != 1) .AND. (oHttp:LastStatus == 0))
    ? oHttp:LastErrorText
    oHttp:destroy()
    oSbResponse:destroy()
    oHtFolderMap:destroy()
    oSbMap:destroy()
    oJson:destroy()
    RETURN
ENDIF

oJson:LoadSb(oSbResponse)
? oJson:Emit()

//  -----------------------------------------------------------------------------------------------------
//  Only return emails received within the last 24 hours
oSbExpression := CreateObject("Chilkat.StringBuilder")

oSbExpression:Append("receivedDateTime ge ")
oDt := CreateObject("Chilkat.CkDateTime")
oDt:SetFromCurrentSystemTime()
oDt:AddDays(-1)
oSbExpression:Append(oDt:GetAsTimestamp(0))

oHttp:SetUrlVar("filter", oSbExpression:GetAsString())

nSuccess := oHttp:QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}", oSbResponse)
IF ((nSuccess != 1) .AND. (oHttp:LastStatus == 0))
    ? oHttp:LastErrorText
    oHttp:destroy()
    oSbResponse:destroy()
    oHtFolderMap:destroy()
    oSbMap:destroy()
    oJson:destroy()
    oSbExpression:destroy()
    oDt:destroy()
    RETURN
ENDIF

oJson:LoadSb(oSbResponse)
? oJson:Emit()

//  -----------------------------------------------------------------------------------------------------
//  Only return emails received in October 2016
oDtObj := CreateObject("Chilkat.DtObj")
oDtObj:Year := 2016
oDtObj:Month := 10
oDtObj:Day := 1
oDtObj:Utc := 1
oDt:SetFromDtObj(oDtObj)

oSbExpression:Clear()
oSbExpression:Append("(receivedDateTime ge ")
oSbExpression:Append(oDt:GetAsTimestamp(0))
oSbExpression:Append(") and (receivedDateTime lt ")
oDtObj:Month := 11
oDt:SetFromDtObj(oDtObj)
oSbExpression:Append(oDt:GetAsTimestamp(0))
oSbExpression:Append(")")

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

oHttp:SetUrlVar("filter", oSbExpression:GetAsString())

nSuccess := oHttp:QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}", oSbResponse)
IF ((nSuccess != 1) .AND. (oHttp:LastStatus == 0))
    ? oHttp:LastErrorText
    oHttp:destroy()
    oSbResponse:destroy()
    oHtFolderMap:destroy()
    oSbMap:destroy()
    oJson:destroy()
    oSbExpression:destroy()
    oDt:destroy()
    oDtObj:destroy()
    RETURN
ENDIF

oJson:LoadSb(oSbResponse)
? oJson:Emit()

//  -----------------------------------------------------------------------------------------------------
//  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 ((nSuccess != 1) .AND. (oHttp:LastStatus == 0))
    ? oHttp:LastErrorText
    oHttp:destroy()
    oSbResponse:destroy()
    oHtFolderMap:destroy()
    oSbMap:destroy()
    oJson:destroy()
    oSbExpression:destroy()
    oDt:destroy()
    oDtObj:destroy()
    RETURN
ENDIF

oJson:LoadSb(oSbResponse)
? oJson:Emit()

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

nSuccess := oHttp:QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}", oSbResponse)
IF ((nSuccess != 1) .AND. (oHttp:LastStatus == 0))
    ? oHttp:LastErrorText
    oHttp:destroy()
    oSbResponse:destroy()
    oHtFolderMap:destroy()
    oSbMap:destroy()
    oJson:destroy()
    oSbExpression:destroy()
    oDt:destroy()
    oDtObj:destroy()
    RETURN
ENDIF

oJson:LoadSb(oSbResponse)
? oJson: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
oHttp:SetUrlVar("search", "Amazon")

nSuccess := oHttp:QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$search={$search}&$select={$select}", oSbResponse)
IF ((nSuccess != 1) .AND. (oHttp:LastStatus == 0))
    ? oHttp:LastErrorText
    oHttp:destroy()
    oSbResponse:destroy()
    oHtFolderMap:destroy()
    oSbMap:destroy()
    oJson:destroy()
    oSbExpression:destroy()
    oDt:destroy()
    oDtObj:destroy()
    RETURN
ENDIF

oJson:LoadSb(oSbResponse)
? oJson:Emit()

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

nSuccess := oHttp:QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$search={$search}&$select={$select}", oSbResponse)
IF ((nSuccess != 1) .AND. (oHttp:LastStatus == 0))
    ? oHttp:LastErrorText
    oHttp:destroy()
    oSbResponse:destroy()
    oHtFolderMap:destroy()
    oSbMap:destroy()
    oJson:destroy()
    oSbExpression:destroy()
    oDt:destroy()
    oDtObj:destroy()
    RETURN
ENDIF

oJson:LoadSb(oSbResponse)
? oJson:Emit()

oHttp:destroy()
oSbResponse:destroy()
oHtFolderMap:destroy()
oSbMap:destroy()
oJson:destroy()
oSbExpression:destroy()
oDt:destroy()
oDtObj:destroy()