Search Activity
The Search activity enables the retrieval of specific email messages from a mail server based on defined filtering criteria. It allows users to scan designated folders and store the resulting metadata into a structured dataset for further processing.
| Field | Description | Requirement |
|---|---|---|
| Connection name | The reference name of a previously established mail connection selected from the dropdown menu. | Required |
| Folder name | The name of the mailbox folder where the search will be conducted. | Required |
| Message id | The unique identifier associated with a specific email message. | Optional |
| From | The sender's email address. Multiple addresses may be entered using a comma as a separator. | Optional |
| Only with attachment? | A boolean filter to restrict results to emails that contain or do not contain attachments. | Optional |
| Search limit | The maximum number of email records to be retrieved from the mailbox. | Optional |
| Max date | The upper date and time boundary for the search criteria. | Optional |
| Min date | The lower date and time boundary for the search criteria. | Optional |
| Subject | The specific text string to be matched within the email subject line. | Optional |
| Case sensitive | A toggle to determine if the subject search should distinguish between uppercase and lowercase letters. | Optional |
| Only Unread? | A filter to determine whether the search includes only unread emails or all emails. | Optional |
| New dataset name | The unique reference name for the dataset that will store the search results. | Required |
Action Types & Examples
Search Criteria Filtering
- Format: string
- Example Result: "About the Financial Statement"
Result Set Generation
- Format: dataset
- Example Result: "searchDS"
Implementation Examples
Field Setup - Connection name: mailConnection - Folder name: INBOX - New dataset name: searchDS
Execution Parameters - From: albert.baker@gmail.com - Search limit: 50 - Max date: 05.01.2023 16:11:08 - Min date: 01.03.2020 - Subject: "About the Financial Statement"
Technical Notes
The Search activity requires an active mail connection to be established prior to execution. When searching by folder, "INBOX" is the standard default; however, custom folder names such as "MANAGER" are supported. For date-based filtering, the system accepts both standard date formats and full timestamp strings. If multiple email addresses are provided in the "From" field, ensure they are delimited by a comma.