ReceiptRuleOptions

class aws_cdk.aws_ses.ReceiptRuleOptions(*, actions=None, after=None, enabled=None, receipt_rule_name=None, recipients=None, scan_enabled=None, tls_policy=None)

Bases: object

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

Parameters
  • actions (Optional[Sequence[IReceiptRuleAction]]) – 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. Default: - No actions.

  • after (Optional[IReceiptRule]) – An existing rule after which the new rule will be placed. Default: - The new rule is inserted at the beginning of the rule list.

  • enabled (Optional[bool]) – Whether the rule is active. Default: true

  • receipt_rule_name (Optional[str]) – The name for the rule. Default: - A CloudFormation generated name.

  • recipients (Optional[Sequence[str]]) – The recipient domains and email addresses that the receipt rule applies to. Default: - Match all recipients under all verified domains.

  • scan_enabled (Optional[bool]) – Whether to scan for spam and viruses. Default: false

  • tls_policy (Optional[TlsPolicy]) – Whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). Default: - Optional which will not check for TLS.

ExampleMetadata

infused

Example:

rule_set = ses.ReceiptRuleSet(self, "RuleSet")

aws_rule = rule_set.add_rule("Aws",
    recipients=["aws.com"]
)

Attributes

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.

Default
  • No actions.

Return type

Optional[List[IReceiptRuleAction]]

after

An existing rule after which the new rule will be placed.

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

Return type

Optional[IReceiptRule]

enabled

Whether the rule is active.

Default

true

Return type

Optional[bool]

receipt_rule_name

The name for the rule.

Default
  • A CloudFormation generated name.

Return type

Optional[str]

recipients

The recipient domains and email addresses that the receipt rule applies to.

Default
  • Match all recipients under all verified domains.

Return type

Optional[List[str]]

scan_enabled

Whether to scan for spam and viruses.

Default

false

Return type

Optional[bool]

tls_policy

Whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS).

Default
  • Optional which will not check for TLS.

Return type

Optional[TlsPolicy]