Skip to content
v2.274.0

ReceiptRuleOptions Struct ​

Options to add a receipt rule to a receipt rule set.

Example ​

ts
const ruleSet = new ses.ReceiptRuleSet(this, 'RuleSet');

const awsRule = ruleSet.addRule('Aws', {
  recipients: ['aws.com'],
});

Properties ​

actionsIReceiptRuleAction[]actionstyping.List[IReceiptRuleAction]actionsList<IReceiptRuleAction>ActionsIReceiptRuleAction[]Actions*[]IReceiptRuleAction= No actions.#
An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.
afterIReceiptRuleRefafterIReceiptRuleRefafterIReceiptRuleRefAfterIReceiptRuleRefAfterIReceiptRuleRef= The new rule is inserted at the …#
An existing rule after which the new rule will be placed.
default

Default: The new rule is inserted at the beginning of the rule list.

enabledbooleanenabledboolenabledBooleanEnabledboolEnabled*bool= true#
Whether the rule is active.
receiptRuleNamestringreceipt_rule_namestrreceiptRuleNameStringReceiptRuleNamestringReceiptRuleName*string= A CloudFormation generated name.#
The name for the rule.
recipientsstring[]recipientstyping.List[str]recipientsList<String>Recipientsstring[]Recipients*[]*string= Match all recipients under all v…#
The recipient domains and email addresses that the receipt rule applies to.
default

Default: Match all recipients under all verified domains.

scanEnabledbooleanscan_enabledboolscanEnabledBooleanScanEnabledboolScanEnabled*bool= false#
Whether to scan for spam and viruses.
tlsPolicyTlsPolicytls_policyTlsPolicytlsPolicyTlsPolicyTlsPolicyTlsPolicyTlsPolicyTlsPolicy= Optional which will not check fo…#
Whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS).
default

Default: Optional which will not check for TLS.