Lua Requires Chilkat v9.5.0.68+
Lua
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.
This example applies to: Exchange Online | Office 365 | Hotmail.com | Live.com | MSN.com | Outlook.com | Passport.com
Chilkat Lua Downloads
local chilkat = require("chilkat")
-- This example requires the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
local http = chilkat.Http.new()
-- 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).
http.auth_token = "MICROSOFT_GRAPH_ACCESS_TOKEN"
local sbResponse = chilkat.StringBuilder.new()
-- 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)
local htFolderMap = chilkat.Hashtable.new()
local sbMap = chilkat.StringBuilder.new()
sbMap:load_file("qa_data/outlook/folderMap.xml", "utf-8")
htFolderMap:add_from_xml_sb(sbMap)
-- Get the ID for the "/Inbox" folder:
local folderId = htFolderMap:lookup_str("/Inbox")
if not htFolderMap.last_method_success then
print("Folder ID not found")
return
end
local success = true
local json = chilkat.JsonObject.new()
json.emit_compact = false
http:set_url_var("folder_id", folderId)
http:set_url_var("select", "subject,from")
-- -----------------------------------------------------------------------------------------------------
-- Only return emails from "chilkat.support@gmail.com"
http:set_url_var("filter", "from/emailAddress/address eq 'chilkat.support@gmail.com'")
-- To return the full content of each email, omit the "&select=..." part of the URL.
success = http:quick_get_sb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}", sbResponse)
if (not success) and (http.last_status == 0) then
print(http.last_error_text)
return
end
json:load_sb(sbResponse)
print(json:emit())
-- -----------------------------------------------------------------------------------------------------
-- Only return emails where the subject contains "Amazon"
http:set_url_var("filter", "contains(subject,'Amazon')")
success = http:quick_get_sb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}", sbResponse)
if (not success) and (http.last_status == 0) then
print(http.last_error_text)
return
end
json:load_sb(sbResponse)
print(json: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)
http:set_url_var("filter", "startswith(subject,'this email') and (from/emailAddress/address eq 'support@chilkatsoft.com')")
success = http:quick_get_sb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}", sbResponse)
if (not success) and (http.last_status == 0) then
print(http.last_error_text)
return
end
json:load_sb(sbResponse)
print(json:emit())
-- -----------------------------------------------------------------------------------------------------
-- Only return emails received within the last 24 hours
local sbExpression = chilkat.StringBuilder.new()
sbExpression:append("receivedDateTime ge ")
local dt = chilkat.DateTime.new()
dt:set_from_current_system_time()
dt:add_days(-1)
sbExpression:append(dt:get_as_timestamp(false))
http:set_url_var("filter", sbExpression:get_as_string())
success = http:quick_get_sb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}", sbResponse)
if (not success) and (http.last_status == 0) then
print(http.last_error_text)
return
end
json:load_sb(sbResponse)
print(json:emit())
-- -----------------------------------------------------------------------------------------------------
-- Only return emails received in October 2016
local dtObj = chilkat.DtObj.new()
dtObj.year = 2016
dtObj.month = 10
dtObj.day = 1
dtObj.utc = true
dt:set_from_dt_obj(dtObj)
sbExpression:clear()
sbExpression:append("(receivedDateTime ge ")
sbExpression:append(dt:get_as_timestamp(false))
sbExpression:append(") and (receivedDateTime lt ")
dtObj.month = 11
dt:set_from_dt_obj(dtObj)
sbExpression:append(dt:get_as_timestamp(false))
sbExpression:append(")")
-- This is the expression we just built: (receivedDateTime ge 2016-10-01T00:00:00Z) and (receivedDateTime lt 2016-11-01T00:00:00Z)
print(sbExpression:get_as_string())
http:set_url_var("filter", sbExpression:get_as_string())
success = http:quick_get_sb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}", sbResponse)
if (not success) and (http.last_status == 0) then
print(http.last_error_text)
return
end
json:load_sb(sbResponse)
print(json:emit())
-- -----------------------------------------------------------------------------------------------------
-- Return unread emails
http:set_url_var("filter", "isRead eq false")
-- success = http.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}",sbResponse);
if (not success) and (http.last_status == 0) then
print(http.last_error_text)
return
end
json:load_sb(sbResponse)
print(json:emit())
-- -----------------------------------------------------------------------------------------------------
-- Return emails with a plain-text or HTML body containing the phrase "Outlook 365"
http:set_url_var("filter", "contains(body/content,'Outlook 365')")
success = http:quick_get_sb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}", sbResponse)
if (not success) and (http.last_status == 0) then
print(http.last_error_text)
return
end
json:load_sb(sbResponse)
print(json: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
http:set_url_var("search", "Amazon")
success = http:quick_get_sb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$search={$search}&$select={$select}", sbResponse)
if (not success) and (http.last_status == 0) then
print(http.last_error_text)
return
end
json:load_sb(sbResponse)
print(json:emit())
-- -----------------------------------------------------------------------------------------------------
-- Search for chilkatsoft.com
-- Some chars, such as the "." make it necessary to enclose the search expression in double-quotes.
http:set_url_var("search", "\"chilkatsoft.com\"")
success = http:quick_get_sb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$search={$search}&$select={$select}", sbResponse)
if (not success) and (http.last_status == 0) then
print(http.last_error_text)
return
end
json:load_sb(sbResponse)
print(json:emit())