Previous Topic: Common Email Operator ParametersNext Topic: Mail Server Login Parameters


Message Filter Criteria

Message ID

Specifies the unique ID of the email to filter. You can also pass a substring of the Message ID. If the IDs for the desired emails are not known, you can retrieve Message IDs for messages using the Get Email List operator. Action is taken on all the emails that match the subject substring.

Note: This parameter is not available for all Email operators.

Message Number

Specifies the message number of the email to filter. This parameter is not a static number for a message. If emails are deleted and moved to different folders, the message number changes. If there are parallel actions taking place on the same mailbox folder, we recommend using Message ID (rather than Message Number) to specify messages.

Note: This parameter is not available for all Email operators.

Message Subject

Specifies the subject of the email that you want to match. This parameter can be a substring or regular expression. Action is taken on all the emails that match the subject substring.

Message Sender

Specifies the email sender that you want to match. This parameter can be a substring or regular expression. Action is taken on all the emails that match the subject substring.

Message Subject and Sender values are regular expressions

Select this check box to specify that Message Subject and Message Sender values as regular expressions (rather than a simple string) when filtering email.

Important! To parse emails for the Email operators using regular expressions, all emails must be retrieved from the mailbox and parsed at the client side. That is, on the touchpoint where the operator runs. We recommend that you do not select this field and use regular expressions only if it is required.

Message Body

Specifies as a substring of the email body that you want to match.

Earliest Message Sent Time

Match emails that are sent after the time specified. This parameter identifies the earliest time the email that you want to match was sent, specified in an CA Process Automation variable.

Latest Message Sent Time

Match messages that are sent before the time specified. This parameter identifies the latest time the message that you want to match was sent, specified in an CA Process Automation variable.

Note: Earliest Message Sent Time and Latest Message Sent Time fields are CA Process Automation date type variables. System functions like now() or today() generate date type variables. A system function named parseDate (stringDate, simpleDateFormat) creates the date properly. stringDate is the date in string format and simpleDateFormat is the format to use to parse the date. This function can be used to parse a string to a CA Process Automation date type variable. For example:

parseDate("2010/07/28 13:00:01", "yyyy/MM/dd HH:mm:ss")
IMAP Message Flag

IMAP uses message flags to monitor the state of an email. These flags are stored on the server. Different clients accessing the same mailbox at different times can detect the changes that other clients make.

The following flags are valid and can be set programmatic by setting the values to name of flags. The name of the flags is case-sensitive and is passed with all upper cases.

Select the flag that you want to set for your message. These flags work in conjunction with the IMAP Message Flag is set to true check box.

ANSWERED

When you select the IMAP Message Flag is set to true check box, only the emails that have been answered return (those emails on to which the replies were sent).

DELETED

When you select the IMAP Message Flag is set to true check box, any emails that were not marked as deleted from the server return.

DRAFT

When you select the IMAP Message Flag is set to true check box, all emails that are currently not in a draft state return.

FLAGGED

When you select the IMAP Message Flag is set to true check box, any emails that are not flagged return.

RECENT

When you select the IMAP Message Flag is set to true check box, any emails that were never opened (clicked) return.

SEEN

When you select the IMAP Message Flag is set to true check box, any email which is marked as READ returns. When you do not select the IMAP Message Flag is set to true check box, any email which is marked as UNREAD returns.

IMAP Message Flag is set to true

The IMAP flag name is set in the IMAP Message Flag drop-down list. Its Boolean value can be selected from this check box. For example, if you want to select Seen as true, select Seen from the drop-down and then select this check box.