Options for matching emails in an inbox. Each match option object contains a field, should and value property. Together they form logical conditions such as SUBJECT should CONTAIN value.

Properties

NameTypeDescriptionNotes
fieldFieldEnumFields of an email object that can be used to filter results
shouldShouldEnumHow the value of the email field specified should be compared to the value given in the match options.
valueStringThe value you wish to compare with the value of the field specified using the should value passed. For example BODY should CONTAIN a value passed.

Enum: FieldEnum

NameValue
SUBJECT“SUBJECT”
TO“TO”
BCC“BCC”
CC“CC”
FROM“FROM”

Enum: ShouldEnum

NameValue
CONTAIN“CONTAIN”
EQUAL“EQUAL”