MatchOption

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
fieldFieldEnumThe email property to match on. One of SUBJECT, TO, BCC, CC or FROM[optional]
shouldShouldEnumWhat criteria to apply. CONTAIN or EQUAL. Note CONTAIN is recommended due to some SMTP servers adding new lines to fields and body content.[optional]
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.[optional]

Enum: FieldEnum

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

Enum: ShouldEnum

NameValue
CONTAIN“CONTAIN”
EQUAL“EQUAL”