Skip to content

Search Activity

The Search activity enables users to locate specific emails on a mail server. It allows filtering emails based on various criteria such as sender, date range, subject, and attachment status, returning the results as a structured dataset.

Field Description Requirement
Folder Specifies the folder path where emails will be searched. Use '/' to denote subfolders. Required
From Filters emails received from a specific email address. Required
Min Date Sets the earliest date for the search criteria. Optional
Has Attachment Determines whether to search for emails with or without attachments. Optional
Max Date Sets the latest date for the search criteria. Optional
Unread Specifies whether to search for read or unread emails. Optional
Subject Filters emails by a specific subject title. Optional
Search Limit Defines the maximum number of emails to retrieve. Optional
Email Address Specifies the email account to search within, particularly useful for multiple configured accounts. Optional
New Dataset Name Assigns a reference name to the dataset that will store the search results. Required

Action Types & Examples

Folder

  • Format: String
  • Example Result: "Inbox/Robusta/RPA"

From

  • Format: String
  • Example Result: "albert.baker@gmail.com"

Min Date

  • Format: DateTime String
  • Example Result: "02.01.2023 16:11:08"

Has Attachment

  • Format: Boolean
  • Example Result: true

Max Date

  • Format: DateTime String
  • Example Result: "05.01.2023 16:11:08"

Unread

  • Format: Boolean
  • Example Result: false

Subject

  • Format: String
  • Example Result: "About the Financial Statement"

Search Limit

  • Format: Integer
  • Example Result: 10

Email Address

  • Format: String
  • Example Result: "user@example.com"

New Dataset Name

  • Format: String
  • Example Result: "searchDS"

Implementation Examples

Field Setup - Folder: Inbox/Robusta/RPA - From: albert.baker@gmail.com - Min Date: 02.01.2023 16:11:08 - Has Attachment: true - Max Date: 05.01.2023 16:11:08 - Unread: false - Subject: About the Financial Statement - Search Limit: 10 - Email Address: myaccount@example.com - New Dataset Name: searchDS

Execution Parameters - Folder: Inbox/Robusta/RPA - From: albert.baker@gmail.com - Min Date: 02.01.2023 16:11:08 - Has Attachment: true - Subject: About the Financial Statement - Search Limit: 50 - New Dataset Name: financialSearch

Technical Notes

The activity returns a dataset containing email metadata. Each entry in the dataset represents a found email and includes properties such as sender, recipient, subject, date, and attachment status. The dataset name is configurable via the 'New Dataset Name' parameter.