Skip to content

Latest commit

 

History

History
19 lines (14 loc) · 1.45 KB

DenyRuleRecord.md

File metadata and controls

19 lines (14 loc) · 1.45 KB

OpenAPIClient::Object::DenyRuleRecord

Load the model package

use OpenAPIClient::Object::DenyRuleRecord;

Properties

Name Type Description Notes
user string Optional SMTP username of the mail order to associate this rule with (e.g. `mb20682`). If omitted the first active order is used. Valid usernames are the `username` values returned by `GET /mail`. [optional]
type string The matching strategy for this rule. `email` blocks an exact sender address, `domain` blocks all senders at a domain, `destination` blocks an exact recipient address, and `startswith` blocks any sender whose local-part begins with the given prefix.
data string The value to match against, interpreted according to `type`: a full email address for `email`/`destination`, a domain name for `domain`, or an alphanumeric prefix string for `startswith`.
id string The numeric ID of the deny rule, as a string. Pass this as `ruleId` to `DELETE /mail/rules/{ruleId}` to remove the rule.
created DATE_TIME The timestamp when the rule was created.

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