(Objective-C) 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 Objective-C Library Downloads MAC OS X (Cocoa) Libs iOS Libs

#import <CkoHttp.h>
#import <CkoStringBuilder.h>
#import <CkoHashtable.h>
#import <NSString.h>
#import <CkoJsonObject.h>
#import <CkoDateTime.h>
#import <CkoDtObj.h>

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

CkoHttp *http = [[CkoHttp alloc] init];

// 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";

CkoStringBuilder *sbResponse = [[CkoStringBuilder alloc] init];

// 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)
CkoHashtable *htFolderMap = [[CkoHashtable alloc] init];
CkoStringBuilder *sbMap = [[CkoStringBuilder alloc] init];
[sbMap LoadFile: @"qa_data/outlook/folderMap.xml" charset: @"utf-8"];
[htFolderMap AddFromXmlSb: sbMap];

// Get the ID for the "/Inbox" folder:
NSString *folderId = [htFolderMap LookupStr: @"/Inbox"];
if (htFolderMap.LastMethodSuccess != YES) {
    NSLog(@"%@",@"Folder ID not found");
    return;
}

BOOL success = YES;
CkoJsonObject *json = [[CkoJsonObject alloc] init];
json.EmitCompact = NO;

[http SetUrlVar: @"folder_id" value: folderId];
[http SetUrlVar: @"select" value: @"subject,from"];

// -----------------------------------------------------------------------------------------------------
// Only return emails from "chilkat.support@gmail.com"
[http SetUrlVar: @"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: @"https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}" sbContent: sbResponse];
if ((success != YES) && ([http.LastStatus intValue] == 0)) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

[json LoadSb: sbResponse];
NSLog(@"%@",[json Emit]);

// -----------------------------------------------------------------------------------------------------
// Only return emails where the subject contains "Amazon"
[http SetUrlVar: @"filter" value: @"contains(subject,'Amazon')"];

success = [http QuickGetSb: @"https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}" sbContent: sbResponse];
if ((success != YES) && ([http.LastStatus intValue] == 0)) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

[json LoadSb: sbResponse];
NSLog(@"%@",[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: @"filter" value: @"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}" sbContent: sbResponse];
if ((success != YES) && ([http.LastStatus intValue] == 0)) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

[json LoadSb: sbResponse];
NSLog(@"%@",[json Emit]);

// -----------------------------------------------------------------------------------------------------
// Only return emails received within the last 24 hours
CkoStringBuilder *sbExpression = [[CkoStringBuilder alloc] init];

[sbExpression Append: @"receivedDateTime ge "];
CkoDateTime *dt = [[CkoDateTime alloc] init];
[dt SetFromCurrentSystemTime];
[dt AddDays: [NSNumber numberWithInt: -1]];
[sbExpression Append: [dt GetAsTimestamp: NO]];

[http SetUrlVar: @"filter" value: [sbExpression GetAsString]];

success = [http QuickGetSb: @"https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}" sbContent: sbResponse];
if ((success != YES) && ([http.LastStatus intValue] == 0)) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

[json LoadSb: sbResponse];
NSLog(@"%@",[json Emit]);

// -----------------------------------------------------------------------------------------------------
// Only return emails received in October 2016
CkoDtObj *dtObj = [[CkoDtObj alloc] init];
dtObj.Year = [NSNumber numberWithInt:2016];
dtObj.Month = [NSNumber numberWithInt:10];
dtObj.Day = [NSNumber numberWithInt:1];
dtObj.Utc = YES;
[dt SetFromDtObj: dtObj];

[sbExpression Clear];
[sbExpression Append: @"(receivedDateTime ge "];
[sbExpression Append: [dt GetAsTimestamp: NO]];
[sbExpression Append: @") and (receivedDateTime lt "];
dtObj.Month = [NSNumber numberWithInt:11];
[dt SetFromDtObj: dtObj];
[sbExpression Append: [dt GetAsTimestamp: NO]];
[sbExpression Append: @")"];

// This is the expression we just built:  (receivedDateTime ge 2016-10-01T00:00:00Z) and (receivedDateTime lt 2016-11-01T00:00:00Z)
NSLog(@"%@",[sbExpression GetAsString]);

[http SetUrlVar: @"filter" value: [sbExpression GetAsString]];

success = [http QuickGetSb: @"https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}" sbContent: sbResponse];
if ((success != YES) && ([http.LastStatus intValue] == 0)) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

[json LoadSb: sbResponse];
NSLog(@"%@",[json Emit]);

// -----------------------------------------------------------------------------------------------------
// Return unread emails
[http SetUrlVar: @"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 != YES) && ([http.LastStatus intValue] == 0)) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

[json LoadSb: sbResponse];
NSLog(@"%@",[json Emit]);

// -----------------------------------------------------------------------------------------------------
// Return emails with a plain-text or HTML body containing the phrase "Outlook 365"
[http SetUrlVar: @"filter" value: @"contains(body/content,'Outlook 365')"];

success = [http QuickGetSb: @"https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}" sbContent: sbResponse];
if ((success != YES) && ([http.LastStatus intValue] == 0)) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

[json LoadSb: sbResponse];
NSLog(@"%@",[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: @"search" value: @"Amazon"];

success = [http QuickGetSb: @"https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$search={$search}&$select={$select}" sbContent: sbResponse];
if ((success != YES) && ([http.LastStatus intValue] == 0)) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

[json LoadSb: sbResponse];
NSLog(@"%@",[json Emit]);

// -----------------------------------------------------------------------------------------------------
// Search for chilkatsoft.com
// Some chars, such as the "." make it necessary to enclose the search expression in double-quotes.
[http SetUrlVar: @"search" value: @"\"chilkatsoft.com\""];

success = [http QuickGetSb: @"https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$search={$search}&$select={$select}" sbContent: sbResponse];
if ((success != YES) && ([http.LastStatus intValue] == 0)) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

[json LoadSb: sbResponse];
NSLog(@"%@",[json Emit]);