Java
Chilkat2 Java
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 Java Downloads
import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.DateTime;
import com.chilkatsoft.chilkat2.DtObj;
import com.chilkatsoft.chilkat2.Hashtable;
import com.chilkatsoft.chilkat2.Http;
import com.chilkatsoft.chilkat2.JsonObject;
import com.chilkatsoft.chilkat2.StringBuilder;
public class ChilkatExample {
public static void main(String[] args) {
boolean success = false;
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Http http = new Http();
// 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");
StringBuilder sbResponse = new StringBuilder();
// 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)
Hashtable htFolderMap = new Hashtable();
StringBuilder sbMap = new StringBuilder();
sbMap.loadFile("qa_data/outlook/folderMap.xml", "utf-8");
htFolderMap.addFromXmlSb(sbMap);
// Get the ID for the "/Inbox" folder:
String folderId = htFolderMap.lookupStr("/Inbox");
if (folderId == null) {
System.out.println("Folder ID not found");
return;
}
success = true;
JsonObject json = new JsonObject();
json.setEmitCompact(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.
try {
http.quickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}", sbResponse);
success = true;
} catch (ChilkatException e) {
success = false;
}
if ((!success) && (http.getLastStatus() == 0)) {
System.out.println(http.getLastErrorText());
return;
}
json.loadSb(sbResponse);
System.out.println(json.emit());
// -----------------------------------------------------------------------------------------------------
// Only return emails where the subject contains "Amazon"
http.setUrlVar("filter", "contains(subject,'Amazon')");
try {
http.quickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}", sbResponse);
success = true;
} catch (ChilkatException e) {
success = false;
}
if ((!success) && (http.getLastStatus() == 0)) {
System.out.println(http.getLastErrorText());
return;
}
json.loadSb(sbResponse);
System.out.println(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", "startswith(subject,'this email') and (from/emailAddress/address eq 'support@chilkatsoft.com')");
try {
http.quickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}", sbResponse);
success = true;
} catch (ChilkatException e) {
success = false;
}
if ((!success) && (http.getLastStatus() == 0)) {
System.out.println(http.getLastErrorText());
return;
}
json.loadSb(sbResponse);
System.out.println(json.emit());
// -----------------------------------------------------------------------------------------------------
// Only return emails received within the last 24 hours
StringBuilder sbExpression = new StringBuilder();
sbExpression.append("receivedDateTime ge ");
DateTime dt = new DateTime();
dt.setFromCurrentSystemTime();
dt.addDays(-1);
sbExpression.append(dt.getAsTimestamp(false));
http.setUrlVar("filter", sbExpression.getAsString());
try {
http.quickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}", sbResponse);
success = true;
} catch (ChilkatException e) {
success = false;
}
if ((!success) && (http.getLastStatus() == 0)) {
System.out.println(http.getLastErrorText());
return;
}
json.loadSb(sbResponse);
System.out.println(json.emit());
// -----------------------------------------------------------------------------------------------------
// Only return emails received in October 2016
DtObj dtObj = new DtObj();
dtObj.setYear(2016);
dtObj.setMonth(10);
dtObj.setDay(1);
dtObj.setUtc(true);
dt.setFromDtObj(dtObj);
sbExpression.clear();
sbExpression.append("(receivedDateTime ge ");
sbExpression.append(dt.getAsTimestamp(false));
sbExpression.append(") and (receivedDateTime lt ");
dtObj.setMonth(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)
System.out.println(sbExpression.getAsString());
http.setUrlVar("filter", sbExpression.getAsString());
try {
http.quickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}", sbResponse);
success = true;
} catch (ChilkatException e) {
success = false;
}
if ((!success) && (http.getLastStatus() == 0)) {
System.out.println(http.getLastErrorText());
return;
}
json.loadSb(sbResponse);
System.out.println(json.emit());
// -----------------------------------------------------------------------------------------------------
// 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) && (http.getLastStatus() == 0)) {
System.out.println(http.getLastErrorText());
return;
}
json.loadSb(sbResponse);
System.out.println(json.emit());
// -----------------------------------------------------------------------------------------------------
// Return emails with a plain-text or HTML body containing the phrase "Outlook 365"
http.setUrlVar("filter", "contains(body/content,'Outlook 365')");
try {
http.quickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}", sbResponse);
success = true;
} catch (ChilkatException e) {
success = false;
}
if ((!success) && (http.getLastStatus() == 0)) {
System.out.println(http.getLastErrorText());
return;
}
json.loadSb(sbResponse);
System.out.println(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", "Amazon");
try {
http.quickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$search={$search}&$select={$select}", sbResponse);
success = true;
} catch (ChilkatException e) {
success = false;
}
if ((!success) && (http.getLastStatus() == 0)) {
System.out.println(http.getLastErrorText());
return;
}
json.loadSb(sbResponse);
System.out.println(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", "\"chilkatsoft.com\"");
try {
http.quickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$search={$search}&$select={$select}", sbResponse);
success = true;
} catch (ChilkatException e) {
success = false;
}
if ((!success) && (http.getLastStatus() == 0)) {
System.out.println(http.getLastErrorText());
return;
}
json.loadSb(sbResponse);
System.out.println(json.emit());
}
}