Swift
Swift
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 Swift Downloads
func chilkatTest() {
var success: Bool = false
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()!
// 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.authToken = "MICROSOFT_GRAPH_ACCESS_TOKEN"
let sbResponse = CkoStringBuilder()!
// 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)
let htFolderMap = CkoHashtable()!
let sbMap = CkoStringBuilder()!
sbMap.loadFile(path: "qa_data/outlook/folderMap.xml", charset: "utf-8")
htFolderMap.add(fromXmlSb: sbMap)
// Get the ID for the "/Inbox" folder:
var folderId: String? = htFolderMap.lookupStr(key: "/Inbox")
if htFolderMap.lastMethodSuccess != true {
print("Folder ID not found")
return
}
success = true
let json = CkoJsonObject()!
json.emitCompact = false
http.setUrlVar(name: "folder_id", value: folderId)
http.setUrlVar(name: "select", value: "subject,from")
// -----------------------------------------------------------------------------------------------------
// Only return emails from "chilkat.support@gmail.com"
http.setUrlVar(name: "filter", value: "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.quickGetSb(url: "https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}", sbContent: sbResponse)
if (success != true) && (http.lastStatus.intValue == 0) {
print("\(http.lastErrorText!)")
return
}
json.loadSb(sb: sbResponse)
print("\(json.emit()!)")
// -----------------------------------------------------------------------------------------------------
// Only return emails where the subject contains "Amazon"
http.setUrlVar(name: "filter", value: "contains(subject,'Amazon')")
success = http.quickGetSb(url: "https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}", sbContent: sbResponse)
if (success != true) && (http.lastStatus.intValue == 0) {
print("\(http.lastErrorText!)")
return
}
json.loadSb(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.setUrlVar(name: "filter", value: "startswith(subject,'this email') and (from/emailAddress/address eq 'support@chilkatsoft.com')")
success = http.quickGetSb(url: "https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}", sbContent: sbResponse)
if (success != true) && (http.lastStatus.intValue == 0) {
print("\(http.lastErrorText!)")
return
}
json.loadSb(sb: sbResponse)
print("\(json.emit()!)")
// -----------------------------------------------------------------------------------------------------
// Only return emails received within the last 24 hours
let sbExpression = CkoStringBuilder()!
sbExpression.append(value: "receivedDateTime ge ")
let dt = CkoDateTime()!
dt.setFromCurrentSystemTime()
dt.addDays(numDays: -1)
sbExpression.append(value: dt.get(asTimestamp: false))
http.setUrlVar(name: "filter", value: sbExpression.getAsString())
success = http.quickGetSb(url: "https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}", sbContent: sbResponse)
if (success != true) && (http.lastStatus.intValue == 0) {
print("\(http.lastErrorText!)")
return
}
json.loadSb(sb: sbResponse)
print("\(json.emit()!)")
// -----------------------------------------------------------------------------------------------------
// Only return emails received in October 2016
let dtObj = CkoDtObj()!
dtObj.year = 2016
dtObj.month = 10
dtObj.day = 1
dtObj.utc = true
dt.set(fromDtObj: dtObj)
sbExpression.clear()
sbExpression.append(value: "(receivedDateTime ge ")
sbExpression.append(value: dt.get(asTimestamp: false))
sbExpression.append(value: ") and (receivedDateTime lt ")
dtObj.month = 11
dt.set(fromDtObj: dtObj)
sbExpression.append(value: dt.get(asTimestamp: false))
sbExpression.append(value: ")")
// This is the expression we just built: (receivedDateTime ge 2016-10-01T00:00:00Z) and (receivedDateTime lt 2016-11-01T00:00:00Z)
print("\(sbExpression.getAsString()!)")
http.setUrlVar(name: "filter", value: sbExpression.getAsString())
success = http.quickGetSb(url: "https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}", sbContent: sbResponse)
if (success != true) && (http.lastStatus.intValue == 0) {
print("\(http.lastErrorText!)")
return
}
json.loadSb(sb: sbResponse)
print("\(json.emit()!)")
// -----------------------------------------------------------------------------------------------------
// Return unread emails
http.setUrlVar(name: "filter", value: "isRead eq false")
// success = http.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}",sbResponse);
if (success != true) && (http.lastStatus.intValue == 0) {
print("\(http.lastErrorText!)")
return
}
json.loadSb(sb: sbResponse)
print("\(json.emit()!)")
// -----------------------------------------------------------------------------------------------------
// Return emails with a plain-text or HTML body containing the phrase "Outlook 365"
http.setUrlVar(name: "filter", value: "contains(body/content,'Outlook 365')")
success = http.quickGetSb(url: "https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}", sbContent: sbResponse)
if (success != true) && (http.lastStatus.intValue == 0) {
print("\(http.lastErrorText!)")
return
}
json.loadSb(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.setUrlVar(name: "search", value: "Amazon")
success = http.quickGetSb(url: "https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$search={$search}&$select={$select}", sbContent: sbResponse)
if (success != true) && (http.lastStatus.intValue == 0) {
print("\(http.lastErrorText!)")
return
}
json.loadSb(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.setUrlVar(name: "search", value: "\"chilkatsoft.com\"")
success = http.quickGetSb(url: "https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$search={$search}&$select={$select}", sbContent: sbResponse)
if (success != true) && (http.lastStatus.intValue == 0) {
print("\(http.lastErrorText!)")
return
}
json.loadSb(sb: sbResponse)
print("\(json.emit()!)")
}