Email Monitor Task Properties

Owned by Former user (Deleted)
Last updated: Dec 14, 2022 by Stonebranch (Deactivated)
7 min read

Email Monitor Task

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

action

Action

Action to take on mail that matches the filter.

Valid values:

  • As String = Mark As Read, As Value = 1
  • As String = Delete, As Value = 2
  • As String = Delete/Mark As Read, As Value = 3
  • As String = Move, As Value = 4
  • As String = Move/Mark As Read, As Value = 5

Default is Mark As Read (1).

N


body

Body

If useAdvancedCriteria is false and bodyFilter is any value other than None, Is Blank, or Is Not Blank; bodyFilter condition value.


N


bodyBeginMarker

Body Begin Marker

If bodyVariables is Within Custom Markers; Value that demarks the place within the Email body to start processing variables.


N


bodyEndMarker

Body End Marker

If bodyVariables is Within Custom Markers; Value that demarks the place within the Email body to stop processing variables.


N


bodyFilter

Body Filter

If useAdvancedCriteria is false; body filter condition to apply.

Valid values:

  • As String = None, As Value = 0
  • As String = Equals, As Value = 1
  • As String = Starts With, As Value = 2
  • As String = Contains, As Value = 3
  • As String = Ends With, As Value = 4
  • As String = Dos Not Equal, As Value = 5
  • As String = Dos Not Start With, As Value = 6
  • As String = Does Not Contain, As Value = 7
  • As String = Dos Not End With, As Value = 8
  • As String = Is Blank, As Value = 9
  • As String = Is Not Blank, As Value = 10
  • As String = Regex, As Value = 11

Default is None (0).

N


bodyVariables

Body Variables

Specification for whether to parse the Email body for name/value pairs to create variables from.

  • If None is selected, no processing of the Email body will occur.
  • If When Within Body is selected, the entire body of the Email will be scanned for a "=" (equal sign) and any lines containing a "=" will be variablized as long as the text to the left of the "=" conforms to the naming standards for variables.
  • If Within Default Markers or Within Custom Markers is selected, the processing for each will be the same, with the only difference being the demarcation values.When markers are used, all lines of the Email body between the begin and end markers will be variablized in accordance to java properties. Any lines of the Email body outside the markers will be ignored with respect to variablization.

Valid values:

  • As String = None, As Value = 0
  • As String = Within Body, As Value = 1
  • As String = Within Default Markers, As Value = 2
  • As String = Within Custom Markers, As Value = 3

Default is None (0).

N


caseSensitive

Case Sensitive

If useAdvancedCriteria is false; Text-based filters should be treated as case-sensitive.

Boolean; Valid values: true/false. Default is false.

N


cc

Cc

If useAdvancedCriteria is false and ccFilter is any value other than None, Is Blank, or Is Not Blank; ccFilter condition value.


N


ccFilter

Cc Filter

If useAdvancedCriteria is false; cc filter condition to apply.

Valid values:

  • As String = None, As Value = 0
  • As String = Equals, As Value = 1
  • As String = Contains, As Value = 3
  • As String = Dos Not Equal, As Value = 5
  • As String = Does Not Contain, As Value = 7
  • As String = Is Blank, As Value = 9
  • As String = Is Not Blank, As Value = 10
  • As String = Regex, As Value = 11

Default is None (0).

N


connection

Email Connection

Email Connection name.


N

connectionVar

connectionVar

Email Connection Variable

Name of a variable that will be resolved at run time to the name of the Email Connection to use.


N

connection

contentProcessingType

Email Content Processing

Method for determining the success or failure of this task based on Email content.

Valid values:

  • As String = -- None --, As Value = 0
  • As String = Success Body Contains , As Value = 1
  • As String = Failure Body Contains , As Value = 2
  • As String = Success Body Does Not Contain, As Value = 3
  • As String = Failure Body Does Not Contain, As Value = 4
  • As String = Success Subject Contains k, As Value = 5
  • As String = Failure Subject Contains , As Value = 6
  • As String = Success Subject Does Not Contain , As Value = 7
  • As String = Failure Subject Does Not Contain , As Value = 8

Default is – None – (0).

N


contentValue

Content Vale

If contentProcessingType is not – None --; Content Value to be matched in the email.


N


csContentProcessing

Case Sensitive Content

If contentProcessingType is not – None --; Indication of whether or not matching will be performed in a case sensitive manner.

Boolean; Valid values: true/false. Default is false.

N


expirationAction

Expiration Action

Expiration Action to specify the timeout Execution status.

Valid values:

  • As String = Failed, As Value = 1

  • As String = Finished, As Value = 2

Default is Failed (1).

N


filterLogic

Filter Logic

Logic to apply when combining filters. If useAdvancedCriteria is true, filterLogic specified the logic to apply when combining Advanced Criteria record.

Valid values:

  • As String = And, As Value = 1
  • As String = Or, As Value = 2

Default is And (1).

N


from

From

If useAdvancedCriteria is false and fromFilter is any value other than None; fromFilter condition value.


N


fromFilter

From Filter

If useAdvancedCriteria is false; from filter condition to apply.

Valid values:

  • As String = None, As Value = 0
  • As String = Equals, As Value = 1
  • As String = Contains, As Value = 3
  • As String = Dos Not Equal, As Value = 5
  • As String = Does Not Contain, As Value = 7
  • As String = Regex, As Value = 11

Default is None (0).

N


includeReadMail

Include Read Mail

Specification for whether or not mail marked as read should be included by the filter.

Boolean; Valid values: true/false. Default is false.

N


mailboxFolder

Mailbox Folder

Mailbox folder to monitor.


Y


mailboxFolderDestination

Mailbox Folder Destination

If action is Move or Move/Mark As Read; Mailbox folder to move matched mail into.


Y


moveToTrash

Move To Trash

If action is Delete or Delete/Mark As Read; Mail matching the filter will be moved to the trash folder in th Email Connection specified by connection.


Y


receivedAfter

Receive After

If receivedRestriction is After; receivedRestriction restriction value.

Valid values:

  • As String = Date, As Value = 1
  • As String = Today, As Value = 2
  • As String = Yesterday, As Value = 3
  • As String = Tomorrow, As Value = 4
  • As String = Launch Time, As Value = 5
  • As String = Relative, As Value = 6

Default is Date (1).

N


receivedAfterDate

Receive After Date

If receivedAfter is Date; Specific date for the receivedAfter restriction value.

Valid format: YYYY-MM-DD

N


receivedAfterOffset

Receive After Offset

If receivedAfter is Relative; Offset, relative to the last launch time, for the receivedAfter restriction value.

Valid Format: [+/-]hh:mm

N


receivedBefore

Receive Before

If receivedRestriction is Before; receivdeRestriction restriction value.

Valid values:

  • As String = Date, As Value = 1
  • As String = Today, As Value = 2
  • As String = Yesterday, As Value = 3
  • As String = Tomorrow, As Value = 4
  • As String = Launch Time, As Value = 5
  • As String = Relative, As Value = 6

Default is Date (1).

N


receivedBeforeDate

Receive Before Date

If receivedBefore is Date; Specific date for the receivedBefore restriction value.

Valid format: YYYY-MM-DD

N


receivedBeforeOffset

Receive Before Offset

If receivedBefore is Relative; Offset, relative to the last launch time, for the receivedBefore restriction value.

Valid Format: [+/-]hh:mm

N


receivedOn

Receive On

If receivedRestriction is On; receivedRestriction restriction value.

Valid values:

  • As String = Date, As Value = 1
  • As String = Today, As Value = 2
  • As String = Yesterday, As Value = 3
  • As String = Tomorrow, As Value = 4

Default is Date (1).

N


receivedOnDate

Receive On Date

If receivedOn is Date; Specific date for the receivedOn restriction value.

Valid format: YYYY-MM-DD

N


receivedRestriction

Receive Restriction

Type of Receive restriction to apply.

Valid values:

  • As String = None, As Value = 0
  • As String = On, As Value = 1
  • As String = Before, As Value = 2
  • As String = After, As Value = 3
  • As String = Span, As Value = 4

Default is None (0).

N


sentAfter

Sent After

If sentRestriction is After; sentRestriction restriction value.

Valid values:

  • As String = Date, As Value = 1
  • As String = Today, As Value = 2
  • As String = Yesterday, As Value = 3
  • As String = Tomorrow, As Value = 4
  • As String = Launch Time, As Value = 5
  • As String = Relative, As Value = 6

Default is Date (1).

N


sentAfterDate

Sent After Date

If sentAfter is Date; Specific date for the sentAfter restriction value.

Valid format: YYYY-MM-DD

N


sentAfterOffset

Sent After Offset

If sentAfter is Relative; Offset, relative to the last launch time, for the sentAfter restriction value.

Valid Format: [+/-]hh:mm

N


sentBefore

Sent Before

If sentRestriction is Before; sentRestriction restriction value.

Valid values:

  • As String = Date, As Value = 1
  • As String = Today, As Value = 2
  • As String = Yesterday, As Value = 3
  • As String = Tomorrow, As Value = 4
  • As String = Launch Time, As Value = 5
  • As String = Relative, As Value = 6

Default is Date (1).

N


sentBeforeDate

Sent Before Date

If sentBefore is Date; Specific date for the sentBefore restriction value.

Valid format: YYYY-MM-DD

N


sentBeforeOffset

Sent Before Offset

If sentBefore is Relative; Offset, relative to the last launch time, for the sentBefore restriction value.

Valid Format: [+/-]hh:mm

N


sentOn

Sent On

If sentRestriction is On; sentRestriction restriction value.

Valid values:

  • As String = Date, As Value = 1
  • As String = Today, As Value = 2
  • As String = Yesterday, As Value = 3
  • As String = Tomorrow, As Value = 4

Default is Date (1).

N


sentOnDate

Sent On Date

If sentOn is Date; Specific date for the sentOn restriction value.

Valid format: YYYY-MM-DD

N


sentRestriction

Sent Restriction

Type of Sent restriction to apply.

Valid values:

  • As String = None, As Value = 0
  • As String = On, As Value = 1
  • As String = Before, As Value = 2
  • As String = After, As Value = 3
  • As String = Span, As Value = 4

Default is None (0).

N


subject

Subject

If useAdvancedCriteria is false and subjectFilter is any value other than None, Is Blank, or Is Not Blank; subjectFilter condition value.


N


subjectFilter

Subject Filter

If useAdvancedCriteria is false; subject filter condition to apply.

Valid values:

  • As String = None, As Value = 0
  • As String = Equals, As Value = 1
  • As String = Starts With, As Value = 2
  • As String = Contains, As Value = 3
  • As String = Ends With, As Value = 4
  • As String = Dos Not Equal, As Value = 5
  • As String = Dos Not Start With, As Value = 6
  • As String = Does Not Contain, As Value = 7
  • As String = Dos Not End With, As Value = 8
  • As String = Is Blank, As Value = 9
  • As String = Is Not Blank, As Value = 10
  • As String = Regex, As Value = 11

Default is None (0).

N


timeLimit

Time Limit

Used for Email Monitor tasks not associated with a trigger; Amount of time (in units specified by timeLimitUnit) to monitor for the Email Monitor conditions to be met.

The timeLimit duration is always relative to the start time of the Email Monitor task instance.

N

timeLimitUnit

Time Limit Unit

Unit of time to use for timeLimit.

Valid Values:

  • As String = Minutes, As Value = 2
  • As String = Hours, As Value = 3
  • As String = Days, As Value = 4

Default is Hours (3).

N

to

To

If useAdvancedCriteria is false and toFilter is any value other than None, Is Blank, or Is Not Blank; toFilter condition value.


N


toFilter

To Filter

If useAdvancedCriteria is false; to condition to apply.

Valid values:

  • As String = None, As Value = 0
  • As String = Equals, As Value = 1
  • As String = Contains, As Value = 3
  • As String = Dos Not Equal, As Value = 5
  • As String = Does Not Contain, As Value = 7
  • As String = Is Blank, As Value = 9
  • As String = Is Not Blank, As Value = 10
  • As String = Regex, As Value = 11

Default is None (0).

N


useAdvancedCriteria

Use Advanced Criteria

Specification for whether or not to use Advanced Criteria for the Email Monitor filter criteria.

Boolean; Valid values: true/false. Default is false.

N