Skip to content


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.


Name Type Description Notes
Field string Fields of an email object that can be used to filter results
Should string How the value of the email field specified should be compared to the value given in the match options.
Value string The 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.

[Back to Model list] [Back to API list] [Back to ]