Chilkat Examples

ChilkatHOMEAndroid™Classic ASPCC++C#Mono C#.NET Core C#C# UWP/WinRTDataFlexDelphi ActiveXDelphi DLLVisual FoxProJavaLianjaMFCObjective-CPerlPHP ActiveXPHP ExtensionPowerBuilderPowerShellPureBasicCkPythonChilkat2-PythonRubySQL ServerSwift 2Swift 3/4TclUnicode CUnicode C++Visual Basic 6.0VB.NETVB.NET UWP/WinRTVBScriptXojo PluginNode.jsExcelGo

Ruby Examples

Web API Categories

ASN.1
Amazon Glacier
Amazon S3
Amazon S3 (new)
Amazon SES
Amazon SNS
Amazon SQS
Async
Azure Cloud Storage
Azure Service Bus
Base64
Bounced Email
Box
CSR
CSV
Certificates
Compression
DKIM / DomainKey
DSA
Diffie-Hellman
Digital Signatures
Dropbox
Dynamics CRM
ECC
Email Object
Encryption
FTP
FileAccess
Firebase
GMail REST API
Geolocation
Google APIs
Google Calendar
Google Cloud Storage
Google Drive
Google Photos
Google Sheets
Google Tasks
Gzip
HTML-to-XML/Text

HTTP
HTTP Misc
IMAP
JSON
JSON Web Encryption (JWE)
JSON Web Signatures (JWS)
JSON Web Token (JWT)
Java KeyStore (JKS)
MHT / HTML Email
MIME
Microsoft Graph
NTLM
OAuth1
OAuth2
OneDrive
OpenSSL
Outlook
PEM
PFX/P12
POP3
PRNG
REST
REST Misc
RSA Encryption
SCP
SFTP
SMTP
SSH
SSH Key
SSH Tunnel
SharePoint
Socket/SSL/TLS
Spider
Stream
Tar Archive
Upload
WebSocket
XAdES
XML
XML Digital Signatures
XMP
Zip
curl

 

 

 

(Ruby) 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.
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 Ruby Downloads

Ruby Library for Linux and MAC OS X

require 'chilkat'

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

http = Chilkat::CkHttp.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.put_AuthToken("MICROSOFT_GRAPH_ACCESS_TOKEN")

sbResponse = Chilkat::CkStringBuilder.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)
htFolderMap = Chilkat::CkHashtable.new()
sbMap = Chilkat::CkStringBuilder.new()
sbMap.LoadFile("qa_data/outlook/folderMap.xml","utf-8")
htFolderMap.AddFromXmlSb(sbMap)

# Get the ID for the "/Inbox" folder:
folderId = htFolderMap.lookupStr("/Inbox")
if (htFolderMap.get_LastMethodSuccess() != true)
    print "Folder ID not found" + "\n";
    exit
end

success = true
json = Chilkat::CkJsonObject.new()
json.put_EmitCompact(false)

http.SetUrlVar("folder_id",folderId)
http.SetUrlVar("select","subject,from")

# -----------------------------------------------------------------------------------------------------
# Only return emails from "chilkat.support@gmail.com"
http.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.
success = http.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}",sbResponse)
if ((success != true) and (http.get_LastStatus() == 0))
    print http.lastErrorText() + "\n";
    exit
end

json.LoadSb(sbResponse)
print json.emit() + "\n";

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

success = http.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}",sbResponse)
if ((success != true) and (http.get_LastStatus() == 0))
    print http.lastErrorText() + "\n";
    exit
end

json.LoadSb(sbResponse)
print json.emit() + "\n";

# -----------------------------------------------------------------------------------------------------
# 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("filter","startswith(subject,'this email') and (from/emailAddress/address eq 'support@chilkatsoft.com')")

success = http.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}",sbResponse)
if ((success != true) and (http.get_LastStatus() == 0))
    print http.lastErrorText() + "\n";
    exit
end

json.LoadSb(sbResponse)
print json.emit() + "\n";

# -----------------------------------------------------------------------------------------------------
# Only return emails received within the last 24 hours
sbExpression = Chilkat::CkStringBuilder.new()

sbExpression.Append("receivedDateTime ge ")
dt = Chilkat::CkDateTime.new()
dt.SetFromCurrentSystemTime()
dt.AddDays(-1)
sbExpression.Append(dt.getAsTimestamp(false))

http.SetUrlVar("filter",sbExpression.getAsString())

success = http.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}",sbResponse)
if ((success != true) and (http.get_LastStatus() == 0))
    print http.lastErrorText() + "\n";
    exit
end

json.LoadSb(sbResponse)
print json.emit() + "\n";

# -----------------------------------------------------------------------------------------------------
# Only return emails received in October 2016
dtObj = Chilkat::CkDtObj.new()
dtObj.put_Year(2016)
dtObj.put_Month(10)
dtObj.put_Day(1)
dtObj.put_Utc(true)
dt.SetFromDtObj(dtObj)

sbExpression.Clear()
sbExpression.Append("(receivedDateTime ge ")
sbExpression.Append(dt.getAsTimestamp(false))
sbExpression.Append(") and (receivedDateTime lt ")
dtObj.put_Month(11)
dt.SetFromDtObj(dtObj)
sbExpression.Append(dt.getAsTimestamp(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.getAsString() + "\n";

http.SetUrlVar("filter",sbExpression.getAsString())

success = http.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}",sbResponse)
if ((success != true) and (http.get_LastStatus() == 0))
    print http.lastErrorText() + "\n";
    exit
end

json.LoadSb(sbResponse)
print json.emit() + "\n";

# -----------------------------------------------------------------------------------------------------
# Return unread emails
http.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 ((success != true) and (http.get_LastStatus() == 0))
    print http.lastErrorText() + "\n";
    exit
end

json.LoadSb(sbResponse)
print json.emit() + "\n";

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

success = http.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}",sbResponse)
if ((success != true) and (http.get_LastStatus() == 0))
    print http.lastErrorText() + "\n";
    exit
end

json.LoadSb(sbResponse)
print json.emit() + "\n";

# -----------------------------------------------------------------------------------------------------
# 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("search","Amazon")

success = http.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$search={$search}&$select={$select}",sbResponse)
if ((success != true) and (http.get_LastStatus() == 0))
    print http.lastErrorText() + "\n";
    exit
end

json.LoadSb(sbResponse)
print json.emit() + "\n";

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

success = http.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$search={$search}&$select={$select}",sbResponse)
if ((success != true) and (http.get_LastStatus() == 0))
    print http.lastErrorText() + "\n";
    exit
end

json.LoadSb(sbResponse)
print json.emit() + "\n";

 

© 2000-2019 Chilkat Software, Inc. All Rights Reserved.