C
C
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 C Downloads
#include <C_CkHttp.h>
#include <C_CkStringBuilder.h>
#include <C_CkHashtable.h>
#include <C_CkJsonObject.h>
#include <C_CkDateTime.h>
#include <C_CkDtObj.h>
void ChilkatSample(void)
{
BOOL success;
HCkHttp http;
HCkStringBuilder sbResponse;
HCkHashtable htFolderMap;
HCkStringBuilder sbMap;
const char *folderId;
HCkJsonObject json;
HCkStringBuilder sbExpression;
HCkDateTime dt;
HCkDtObj dtObj;
success = FALSE;
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttp_Create();
// 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).
CkHttp_putAuthToken(http,"MICROSOFT_GRAPH_ACCESS_TOKEN");
sbResponse = CkStringBuilder_Create();
// 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 = CkHashtable_Create();
sbMap = CkStringBuilder_Create();
CkStringBuilder_LoadFile(sbMap,"qa_data/outlook/folderMap.xml","utf-8");
CkHashtable_AddFromXmlSb(htFolderMap,sbMap);
// Get the ID for the "/Inbox" folder:
folderId = CkHashtable_lookupStr(htFolderMap,"/Inbox");
if (CkHashtable_getLastMethodSuccess(htFolderMap) != TRUE) {
printf("Folder ID not found\n");
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponse);
CkHashtable_Dispose(htFolderMap);
CkStringBuilder_Dispose(sbMap);
return;
}
success = TRUE;
json = CkJsonObject_Create();
CkJsonObject_putEmitCompact(json,FALSE);
CkHttp_SetUrlVar(http,"folder_id",folderId);
CkHttp_SetUrlVar(http,"select","subject,from");
// -----------------------------------------------------------------------------------------------------
// Only return emails from "chilkat.support@gmail.com"
CkHttp_SetUrlVar(http,"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 = CkHttp_QuickGetSb(http,"https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}",sbResponse);
if ((success != TRUE) && (CkHttp_getLastStatus(http) == 0)) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponse);
CkHashtable_Dispose(htFolderMap);
CkStringBuilder_Dispose(sbMap);
CkJsonObject_Dispose(json);
return;
}
CkJsonObject_LoadSb(json,sbResponse);
printf("%s\n",CkJsonObject_emit(json));
// -----------------------------------------------------------------------------------------------------
// Only return emails where the subject contains "Amazon"
CkHttp_SetUrlVar(http,"filter","contains(subject,'Amazon')");
success = CkHttp_QuickGetSb(http,"https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}",sbResponse);
if ((success != TRUE) && (CkHttp_getLastStatus(http) == 0)) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponse);
CkHashtable_Dispose(htFolderMap);
CkStringBuilder_Dispose(sbMap);
CkJsonObject_Dispose(json);
return;
}
CkJsonObject_LoadSb(json,sbResponse);
printf("%s\n",CkJsonObject_emit(json));
// -----------------------------------------------------------------------------------------------------
// Only return emails where the subject starts with "this email" and the from address is support@chilkatsoft.com
// (the startswith function is case insensitive)
CkHttp_SetUrlVar(http,"filter","startswith(subject,'this email') and (from/emailAddress/address eq 'support@chilkatsoft.com')");
success = CkHttp_QuickGetSb(http,"https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}",sbResponse);
if ((success != TRUE) && (CkHttp_getLastStatus(http) == 0)) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponse);
CkHashtable_Dispose(htFolderMap);
CkStringBuilder_Dispose(sbMap);
CkJsonObject_Dispose(json);
return;
}
CkJsonObject_LoadSb(json,sbResponse);
printf("%s\n",CkJsonObject_emit(json));
// -----------------------------------------------------------------------------------------------------
// Only return emails received within the last 24 hours
sbExpression = CkStringBuilder_Create();
CkStringBuilder_Append(sbExpression,"receivedDateTime ge ");
dt = CkDateTime_Create();
CkDateTime_SetFromCurrentSystemTime(dt);
CkDateTime_AddDays(dt,-1);
CkStringBuilder_Append(sbExpression,CkDateTime_getAsTimestamp(dt,FALSE));
CkHttp_SetUrlVar(http,"filter",CkStringBuilder_getAsString(sbExpression));
success = CkHttp_QuickGetSb(http,"https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}",sbResponse);
if ((success != TRUE) && (CkHttp_getLastStatus(http) == 0)) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponse);
CkHashtable_Dispose(htFolderMap);
CkStringBuilder_Dispose(sbMap);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbExpression);
CkDateTime_Dispose(dt);
return;
}
CkJsonObject_LoadSb(json,sbResponse);
printf("%s\n",CkJsonObject_emit(json));
// -----------------------------------------------------------------------------------------------------
// Only return emails received in October 2016
dtObj = CkDtObj_Create();
CkDtObj_putYear(dtObj,2016);
CkDtObj_putMonth(dtObj,10);
CkDtObj_putDay(dtObj,1);
CkDtObj_putUtc(dtObj,TRUE);
CkDateTime_SetFromDtObj(dt,dtObj);
CkStringBuilder_Clear(sbExpression);
CkStringBuilder_Append(sbExpression,"(receivedDateTime ge ");
CkStringBuilder_Append(sbExpression,CkDateTime_getAsTimestamp(dt,FALSE));
CkStringBuilder_Append(sbExpression,") and (receivedDateTime lt ");
CkDtObj_putMonth(dtObj,11);
CkDateTime_SetFromDtObj(dt,dtObj);
CkStringBuilder_Append(sbExpression,CkDateTime_getAsTimestamp(dt,FALSE));
CkStringBuilder_Append(sbExpression,")");
// This is the expression we just built: (receivedDateTime ge 2016-10-01T00:00:00Z) and (receivedDateTime lt 2016-11-01T00:00:00Z)
printf("%s\n",CkStringBuilder_getAsString(sbExpression));
CkHttp_SetUrlVar(http,"filter",CkStringBuilder_getAsString(sbExpression));
success = CkHttp_QuickGetSb(http,"https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}",sbResponse);
if ((success != TRUE) && (CkHttp_getLastStatus(http) == 0)) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponse);
CkHashtable_Dispose(htFolderMap);
CkStringBuilder_Dispose(sbMap);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbExpression);
CkDateTime_Dispose(dt);
CkDtObj_Dispose(dtObj);
return;
}
CkJsonObject_LoadSb(json,sbResponse);
printf("%s\n",CkJsonObject_emit(json));
// -----------------------------------------------------------------------------------------------------
// Return unread emails
CkHttp_SetUrlVar(http,"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) && (CkHttp_getLastStatus(http) == 0)) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponse);
CkHashtable_Dispose(htFolderMap);
CkStringBuilder_Dispose(sbMap);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbExpression);
CkDateTime_Dispose(dt);
CkDtObj_Dispose(dtObj);
return;
}
CkJsonObject_LoadSb(json,sbResponse);
printf("%s\n",CkJsonObject_emit(json));
// -----------------------------------------------------------------------------------------------------
// Return emails with a plain-text or HTML body containing the phrase "Outlook 365"
CkHttp_SetUrlVar(http,"filter","contains(body/content,'Outlook 365')");
success = CkHttp_QuickGetSb(http,"https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}",sbResponse);
if ((success != TRUE) && (CkHttp_getLastStatus(http) == 0)) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponse);
CkHashtable_Dispose(htFolderMap);
CkStringBuilder_Dispose(sbMap);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbExpression);
CkDateTime_Dispose(dt);
CkDtObj_Dispose(dtObj);
return;
}
CkJsonObject_LoadSb(json,sbResponse);
printf("%s\n",CkJsonObject_emit(json));
// -----------------------------------------------------------------------------------------------------
// 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
CkHttp_SetUrlVar(http,"search","Amazon");
success = CkHttp_QuickGetSb(http,"https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$search={$search}&$select={$select}",sbResponse);
if ((success != TRUE) && (CkHttp_getLastStatus(http) == 0)) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponse);
CkHashtable_Dispose(htFolderMap);
CkStringBuilder_Dispose(sbMap);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbExpression);
CkDateTime_Dispose(dt);
CkDtObj_Dispose(dtObj);
return;
}
CkJsonObject_LoadSb(json,sbResponse);
printf("%s\n",CkJsonObject_emit(json));
// -----------------------------------------------------------------------------------------------------
// Search for chilkatsoft.com
// Some chars, such as the "." make it necessary to enclose the search expression in double-quotes.
CkHttp_SetUrlVar(http,"search","\"chilkatsoft.com\"");
success = CkHttp_QuickGetSb(http,"https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$search={$search}&$select={$select}",sbResponse);
if ((success != TRUE) && (CkHttp_getLastStatus(http) == 0)) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponse);
CkHashtable_Dispose(htFolderMap);
CkStringBuilder_Dispose(sbMap);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbExpression);
CkDateTime_Dispose(dt);
CkDtObj_Dispose(dtObj);
return;
}
CkJsonObject_LoadSb(json,sbResponse);
printf("%s\n",CkJsonObject_emit(json));
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponse);
CkHashtable_Dispose(htFolderMap);
CkStringBuilder_Dispose(sbMap);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbExpression);
CkDateTime_Dispose(dt);
CkDtObj_Dispose(dtObj);
}