Zig
Zig
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 Zig Downloads
const std = @import("std");
const chilkat = @import("chilkat");
pub fn main(init: std.process.Init) !void {
const alloc = init.arena.allocator();
var success: bool = false;
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
const http = try chilkat.Http.init();
defer http.deinit();
// 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.setAuthToken("MICROSOFT_GRAPH_ACCESS_TOKEN");
const sb_response = try chilkat.StringBuilder.init();
defer sb_response.deinit();
// 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)
const ht_folder_map = try chilkat.Hashtable.init();
defer ht_folder_map.deinit();
const sb_map = try chilkat.StringBuilder.init();
defer sb_map.deinit();
sb_map.loadFile("qa_data/outlook/folderMap.xml", "utf-8") catch {};
ht_folder_map.addFromXmlSb(sb_map) catch {};
// Get the ID for the "/Inbox" folder:
const folder_id = ht_folder_map.lookupStr(alloc, "/Inbox") catch {
std.debug.print("Folder ID not found\n", .{});
return;
};
success = true;
const json = try chilkat.JsonObject.init();
defer json.deinit();
json.setEmitCompact(false);
http.setUrlVar("folder_id", folder_id) catch {};
http.setUrlVar("select", "subject,from") catch {};
// -----------------------------------------------------------------------------------------------------
// Only return emails from "chilkat.support@gmail.com"
http.setUrlVar("filter", "from/emailAddress/address eq 'chilkat.support@gmail.com'") catch {};
// To return the full content of each email, omit the "&select=..." part of the URL.
success = if (http.quickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}", sb_response)) true else |_| false;
if ((!success) and (http.getLastStatus() == 0)) {
std.debug.print("{s}\n", .{try http.getLastErrorText(alloc)});
return;
}
json.loadSb(sb_response) catch {};
std.debug.print("{s}\n", .{try json.emit(alloc)});
// -----------------------------------------------------------------------------------------------------
// Only return emails where the subject contains "Amazon"
http.setUrlVar("filter", "contains(subject,'Amazon')") catch {};
success = if (http.quickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}", sb_response)) true else |_| false;
if ((!success) and (http.getLastStatus() == 0)) {
std.debug.print("{s}\n", .{try http.getLastErrorText(alloc)});
return;
}
json.loadSb(sb_response) catch {};
std.debug.print("{s}\n", .{try json.emit(alloc)});
// -----------------------------------------------------------------------------------------------------
// 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')") catch {};
success = if (http.quickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}", sb_response)) true else |_| false;
if ((!success) and (http.getLastStatus() == 0)) {
std.debug.print("{s}\n", .{try http.getLastErrorText(alloc)});
return;
}
json.loadSb(sb_response) catch {};
std.debug.print("{s}\n", .{try json.emit(alloc)});
// -----------------------------------------------------------------------------------------------------
// Only return emails received within the last 24 hours
const sb_expression = try chilkat.StringBuilder.init();
defer sb_expression.deinit();
sb_expression.append("receivedDateTime ge ") catch {};
const dt = try chilkat.DateTime.init();
defer dt.deinit();
dt.setFromCurrentSystemTime() catch {};
dt.addDays(-1) catch {};
sb_expression.append(try dt.getAsTimestamp(alloc, false)) catch {};
http.setUrlVar("filter", try sb_expression.getAsString(alloc)) catch {};
success = if (http.quickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}", sb_response)) true else |_| false;
if ((!success) and (http.getLastStatus() == 0)) {
std.debug.print("{s}\n", .{try http.getLastErrorText(alloc)});
return;
}
json.loadSb(sb_response) catch {};
std.debug.print("{s}\n", .{try json.emit(alloc)});
// -----------------------------------------------------------------------------------------------------
// Only return emails received in October 2016
const dt_obj = try chilkat.DtObj.init();
defer dt_obj.deinit();
dt_obj.setYear(2016);
dt_obj.setMonth(10);
dt_obj.setDay(1);
dt_obj.setUtc(true);
dt.setFromDtObj(dt_obj) catch {};
sb_expression.clear();
sb_expression.append("(receivedDateTime ge ") catch {};
sb_expression.append(try dt.getAsTimestamp(alloc, false)) catch {};
sb_expression.append(") and (receivedDateTime lt ") catch {};
dt_obj.setMonth(11);
dt.setFromDtObj(dt_obj) catch {};
sb_expression.append(try dt.getAsTimestamp(alloc, false)) catch {};
sb_expression.append(")") catch {};
// This is the expression we just built: (receivedDateTime ge 2016-10-01T00:00:00Z) and (receivedDateTime lt 2016-11-01T00:00:00Z)
std.debug.print("{s}\n", .{try sb_expression.getAsString(alloc)});
http.setUrlVar("filter", try sb_expression.getAsString(alloc)) catch {};
success = if (http.quickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}", sb_response)) true else |_| false;
if ((!success) and (http.getLastStatus() == 0)) {
std.debug.print("{s}\n", .{try http.getLastErrorText(alloc)});
return;
}
json.loadSb(sb_response) catch {};
std.debug.print("{s}\n", .{try json.emit(alloc)});
// -----------------------------------------------------------------------------------------------------
// Return unread emails
http.setUrlVar("filter", "isRead eq false") catch {};
// success = http.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}",sbResponse);
if ((!success) and (http.getLastStatus() == 0)) {
std.debug.print("{s}\n", .{try http.getLastErrorText(alloc)});
return;
}
json.loadSb(sb_response) catch {};
std.debug.print("{s}\n", .{try json.emit(alloc)});
// -----------------------------------------------------------------------------------------------------
// Return emails with a plain-text or HTML body containing the phrase "Outlook 365"
http.setUrlVar("filter", "contains(body/content,'Outlook 365')") catch {};
success = if (http.quickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}", sb_response)) true else |_| false;
if ((!success) and (http.getLastStatus() == 0)) {
std.debug.print("{s}\n", .{try http.getLastErrorText(alloc)});
return;
}
json.loadSb(sb_response) catch {};
std.debug.print("{s}\n", .{try json.emit(alloc)});
// -----------------------------------------------------------------------------------------------------
// 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") catch {};
success = if (http.quickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$search={$search}&$select={$select}", sb_response)) true else |_| false;
if ((!success) and (http.getLastStatus() == 0)) {
std.debug.print("{s}\n", .{try http.getLastErrorText(alloc)});
return;
}
json.loadSb(sb_response) catch {};
std.debug.print("{s}\n", .{try json.emit(alloc)});
// -----------------------------------------------------------------------------------------------------
// 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\"") catch {};
success = if (http.quickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$search={$search}&$select={$select}", sb_response)) true else |_| false;
if ((!success) and (http.getLastStatus() == 0)) {
std.debug.print("{s}\n", .{try http.getLastErrorText(alloc)});
return;
}
json.loadSb(sb_response) catch {};
std.debug.print("{s}\n", .{try json.emit(alloc)});
}