Options for creating inbox rulesets. Inbox rulesets can be used to block, allow, filter, or forward emails when sending or receiving using the inbox.
|Name ||Type ||Description ||Notes |
|scope ||str ||What type of emails actions to apply ruleset to. Either |
RECEIVING_EMAILS will apply action and target to any sending or receiving of emails respectively.
|action ||str ||Action to be taken when the ruleset matches an email for the given scope. For example: |
BLOCK action with target
* and scope
SENDING_EMAILS blocks sending to all recipients. Note
ALLOW takes precedent over
FILTER_REMOVE is like block but will remove offending email addresses during a send or receive event instead of blocking the action.
|target ||str ||Target to match emails with. Can be a wild-card type pattern or a valid email address. For instance |
*@gmail.com matches all gmail addresses while
firstname.lastname@example.org matches one address exactly. The target is applied to every recipient field email address when
SENDING_EMAILS is the scope and is applied to sender of email when
[Back to Model list] [Back to API list] [Back to ]