Optional
conditionsZero or more conditions such as { condition: 'HAS_ATTACHMENTS', value: 'TRUE' }
. Note the values are the strings TRUE|FALSE
not booleans.
MatchOptions
Optional
matchesZero or more match options such as { field: 'SUBJECT', should: 'CONTAIN', value: 'Welcome' }
. Options are additive so if one does not match the email is excluded from results
MatchOptions
Optional filter for matching emails based on fields. For instance filter results to only include emails whose
SUBJECT
value doesCONTAIN
given match value. An example payload would be{ matches: [{ field: 'SUBJECT', should: 'CONTAIN', value: 'Welcome' }] }
. You can also pass conditions such asHAS_ATTACHMENT
. If you wish to extract regex matches inside the email content see thegetEmailContentMatch
method in the EmailController.Export
Interface
MatchOptions