Search Emails

Search email in Office 365 Mail.

Options

Field Definition Type Required
Mail Determines the type of user mail:
  • My Mail: owned by the connected user.

  • User Mail: user shared or delegated with the connected user.

Dropdown TRUE
Result Set Specifies the number of emails returned in the response.

Choose a method to filter search results:

  • First Matching Record: returns the first record that matches.
  • First 200 Matching Records: returns the first 200 matching records.
  • Stream Matching Records: passes all matching records from your parent flow to a helper flow. A Streaming input section is added to the card from which you can select a helper flow for streaming and adding custom extensible fields.
Dropdown TRUE
Search By Specifies how to compare input text values. Searches all text fields. Choose an operator to search by:
  • Exact Match: returns emails when the search fully matches the entered text/number values. For example: search for all subjects that contain Important.
  • Contains: returns emails with partial matching of entered text/number values. For example: search in the Sender field for words that contain Smith.
  • Starts With: returns emails when the search starts with the entered text/number values.
Dropdown TRUE
Date Filter Specifies the date of the email in the response. Searches all text fields. Choose an operator to search by:
  • Greater Than: returns emails that were sent or received in a time period that is greater than the Start Date Filter fields. For example, search for all emails where the date is greater than 1/1/2022.
  • Less Than: returns emails that were sent or received in a time period that is less than the End Date Filter fields. For example, search in the End field for a value less than 3/19/2022.
  • Range: returns email that are within a specific date range for date values.
  • None: Date searches are not used.
Dropdown TRUE
Tip

To learn how to return a large number of records, see Set up the stream matching option with a helper flow.

Input

Field Definition Type Required
User
User ID or Username User ID of the email’s attachment that is uploaded.

For example, john.doe@somedomain.com. This could be the user’s email address, but this is not true in all cases.

This property cannot contain accent characters. Only the following characters are allowed A - Z, a - z, 0 - 9, ' . - _ ! # ^ ~.

Appears when User Mail is selected from the Mail option.

String TRUE
Search Appears when Contains is selected from the Search By option unless otherwise specified.    
Subject Subject of the message.

Appears when Starts With and Contains are selected from the Search By option.

String FALSE
Body Body of the message. It can be in HTML or text format.

Searching the body of the message using text is supported. Searching the body of the message using HTML is not supported.

Appears when Starts With and Contains are selected from the Search By option.

String FALSE
From Owner of the mailbox from which the message is sent. String FALSE
Sender Account that is actually used to generate the message.

Does not display when None is selected from the Search By option.

String FALSE
Has Attachments? True if the message has attachments; otherwise, False. To verify the existence of inline attachments, parse the body property to look for a src attribute.

For example, <IMG src="cid:image001.jpg@01D26CD8.6C05F070">.

Appears when Exact Match is selected from the Search By option.

Note

This field doesn't include inline attachments. If a message contains only inline attachments, this field is False.

Boolean FALSE
Importance Importance of the message. The possible values are:
  • Low

  • Normal

  • High

Appears when Exact Match is selected from the Search By option.

String FALSE
Is Read? True if the message has been read; otherwise False.

Appears when Exact Match is selected from the Search By option.

Boolean FALSE
Is Draft? True if the message is a draft (hasn't been sent); otherwise, False.

Appears when Exact Match is selected from the Search By option.

Boolean FALSE
Flag Status Status for follow-up for an item. Possible values are:
  • Not Flagged

  • Complete

  • Flagged

Appears when Exact Match is selected from the Search By option.

Object FALSE
Is Delivery Receipt Requested? True if a read receipt is requested for the message; otherwise False.

Appears when Exact Match is selected from the Search By option.

Boolean FALSE
Is Read Receipt Requested? True if a read receipt is requested for the message; otherwise False.

Appears when Exact Match is selected from the Search By option.

Boolean FALSE
Start Date Filter Appears when any of the following Greater Than or Range are selected from the Date Filter option.    
Created Date Time Date and time the message was created.

For example, 2020-01-01T00:00:00Z.

Date and Time FALSE
Last Modified Date Time Date and time the message was last changed.

For example, 2020-01-01T00:00:00Z.

Date and Time FALSE
Receive Date Time Date and time the message was received.

For example, 2020-01-01T00:00:00Z.

Date and Time FALSE
Sent Date Time Date and time the message was sent.

For example, 2020-01-01T00:00:00Z.

Date and Time FALSE
End Date Filter Appears when any of the following Range or Less Than are selected from the Date Filter option.    
Created Date Time Date and time the message was created.

For example, 2020-01-01T00:00:00Z.

Date and Time FALSE
Last Modified Date Time Date and time the message was last changed.

For example, 2020-01-01T00:00:00Z.

Date and Time FALSE
Receive Date Time Date and time the message was received.

For example, 2020-01-01T00:00:00Z.

Date and Time FALSE
Sent Date Time Date and time the message was sent.

For example, 2014-01-01T00:00:00Z.

Date and Time FALSE
Search Criteria      
Record Limit

Specify the number of records to stream.

  • When the Limit field is set to 0, no records are returned.

  • When the Limit field is set to greater than 0, records greater than 0 and up the maximum number of records specified are returned.

  • When the Limit field is empty or not selected, all records are streamed.

  • Default value is 10 million.

  • Valid range is 0 to 10 million.

Appears when Stream Matching Records is selected from the Result Set option.

Number FALSE
Streaming      
Flow

Click Choose Flow to browse and select a helper flow where the search results will be streamed, then click Choose to confirm.

Optionally, click the empty field under Click or drop here to create and add custom extensible fields that pass data to the helper flow. These fields are added as key/value pairs under the State output object in the helper flow.

Flow TRUE

Output

Note

Input fields that are left empty are ignored.

Field Definition Type
Result Appears when First Matching Record or 200 Matching Records are selected from the Result Set option unless otherwise specified.  
ID Unique ID of the message. String
Subject Subject of the email. String
Body Preview First 255 characters of the message body in text format. String
Body Body of the message. It can be in HTML or text format. Find out about safe HTML in a message body. Object
Content Type Content type of the message. String
Content Content of the message. String
Created Date Time Date and time when the attachment was last created.

For example, 2020-01-01T00:00:00Z.

Date and Time
Last Modified Date Time Date and time when the attachment was last modified.

For example, 2020-01-01T00:00:00Z.

Date and Time
Change Key Version of the message. String
Categories Categories associated with the message. List of Strings
Received Date Time Date and time the message was received.

For example, 2020-01-01T00:00:00Z.

Date and Time
Sent Date Time Date and time the message was sent.

For example, 2020-01-01T00:00:00Z.

Date and Time
Has Attachments? True if the message has attachments; otherwise, False. To verify the existence of inline attachments, parse the body property to look for a src attribute.

For example, <IMG src="cid:image001.jpg@01D26CD8.6C05F070">.

This field doesn't include inline attachments. If a message contains only inline attachments, this field is False.

Boolean
Internet Message ID Message ID in the format specified by RFC2822. String
Importance Importance of the message. The possible values are:
  • Low

  • Normal

  • High

String
Parent Folder ID Unique identifier for the message's parent mail folder. String
Conversation ID Unique identifier to which the conversation of the email belongs. String
Conversation Index Indicates the position of the message within the conversation. String
Is Delivery Receipt Requested? True if a read receipt is requested for the message; otherwise False. Boolean
Is Read Receipt Requested? True if a read receipt is requested for the message; otherwise False. Boolean
Is Read? True if the message has been read; otherwise False. Boolean
Is Draft? True if the message is a draft and hasn't been sent; otherwise, False. Boolean
Web Link URL to open the message in Outlook on the web. You can append an ispopout argument to the end of the URL to change how the message is displayed. If ispopout is not present or if it is set to 1, then the message is shown in a popout window. If ispopout is set to 0, then the browser will show the message in the Outlook on the web review pane. The message will open in the browser if you are logged in to your mailbox via Outlook on the web. You will be prompted to login if you are not already logged in with the browser. This URL cannot be accessed from within an iFrame. String
Sender Account that is actually used to generate the message. In most cases, this value is the same as the from property. You can set this property to a different value when sending a message from a shared mailbox, for a shared calendar, or as a delegate. In any case, the value must correspond to the actual mailbox used. Find out more about setting the from and sender properties of a message.

In most cases, this value is the same as the From property. You can set this property to a different value when sending a message from a shared mailbox, for a shared calendar, or as a delegate. In any case, the value must correspond to the actual mailbox used.

Object
Email Address Recipient's email address. Object
Name Name of the recipient. String
Address Email address of the recipient. String
From Email address of the sender of the email.

In most cases, this value is the same as the sender property, except for sharing or delegation scenarios. The value must correspond to the actual mailbox used.

Object
Email Address Recipient's email address. Object
Name Name of the recipient. String
Address Email address of the recipient. String
To Recipients To: recipients for the message. List of Objects
Email Address Recipient's email address. Object
Name Name of the recipient. String
Address Email address of the recipient. String
CC Recipients Cc: recipients for the message. List of Objects
Email Address Recipient's email address. Object
Name Name of the recipient. String
Address Email address of the recipient. String
BCC Recipients Bcc: recipients for the message. List of Objects
Email Address Recipient's email address. Object
Name Name of the recipient. String
Address Email address of the recipient. String
Reply To Email addresses to use when replying. List of Strings
Flag Flag value that indicates the status, start date, due date, or completion date for the message. String
Attachments Attachment for the email. List of Objects
ID Unique ID of the attachment. String
Name Name representing the text that is displayed below the icon representing the embedded attachment. This does not need to be the actual file name. String
Last Modified Date an Time Date and time that the attachment was modified. Date and Time
Content Type Content type of the attachment. String
Size Size in bytes of the attachment. Number
Is Inline? Yes if attachment is inline; otherwise False. Boolean
Records Streamed

Number of records streamed in a streaming flow.

Appears when Stream Matching Records is selected from the Result Set option.

Number

Related topics

Office 365 Mail connector

About the elements of Okta Workflows

Guidance for Office 365 Mail connector

Microsoft Graph Rest API