Find Message

This Email tool searches the specified folder for the first message matching the given criteria. Any empty parameters will not be included in the search.

Inputs

Folder ID

The unique identifier for the folder that will be searched. This ID is retrieved with an Incoming Mail initiator, or the Open Folder tool.

Index

The index of the various messages in each folder indicates the order in which they will be searched (i.e., first, second, third, etc.) This parameter is the number of messages that is skipped before the search begins. When searching forward, zero is the index used to find the first message (i.e., zero messages are skipped). After the first search, the index of the previous matching message plus one will be used.

Example: The first matching message in the folder is third in the index. When first searching this folder, the Index parameter is zero, and so no messages are skipped. After finding the first match (at index three), this tool is called again, this time with an Index parameter of 4.

Search Backwards

Select this option to search messages in the folder in reverse, beginning with the last message. The search starts with the specified index and can be used to find the most recent message first.

Status

Messages can have a status of "read", indicating that the message has already been read, or "unread", indicating that the message has not been read. Only messages of the selected status will be searched.

Importance

The Importance of a message is "low", "high", or "normal". This tool will only search messages with the specified Importance.

Sensitivity

The Sensitivity of a message can be "personal", "private", "confidential", or "none". This tool will only search messages with the specified Sensitivity.

Message Class

The Message Class of a message can be "text", "voice", "fax", or "ndr". This tool will only search messages with the specified Message Class.

Subject

User regular expressions to search for messages based on their field.

Sender

Use regular expressions to search on the friendly name or email address of a particular sender.

Start Date/Time

Only message received after this date and time will be searched.

End Date/Time

Only messages received before this date and time will be searched.

Timeout

The number of seconds the tool should wait for a return value. If no value is returned in the specified time, this tool will take the Failure exit path.

Outputs

Index 

The number indicating the position of the first matching message in the folder.

Result

The results of the operation.

See Email Tool Result Codes for more information.

Exit Paths

Found

The Found exit path is taken if a message matching the search criteria was found.

Not Found

The Not Found path is taken if no matching message was found.

Failure

This path is taken if the operation fails.