Skip to content

ReceiptRule

Source code in docs_src/capo_ses/types/receipt_rule.py
class ReceiptRule(TypedDict, closed=True):
    name: "capo_ses.types.receipt_rule_name.ReceiptRuleName"
    """<p>The name of the receipt rule. The name must meet the following requirements:</p> <ul> <li> <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), or periods (.). </p> </li> <li> <p>Start and end with a letter or number.</p> </li> <li> <p>Contain 64 characters or fewer.</p> </li> </ul>"""
    enabled: "capo_ses.types.enabled.Enabled"
    """<p>If <code>true</code>, the receipt rule is active. The default value is <code>false</code>.</p>"""
    tls_policy: NotRequired["capo_ses.types.tls_policy.TlsPolicy"]
    """<p>Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to <code>Require</code>, Amazon SES bounces emails that are not received over TLS. The default is <code>Optional</code>.</p>"""
    recipients: NotRequired["capo_ses.types.recipients_list.RecipientsList"]
    """<p>The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule matches all recipients on all verified domains.</p>"""
    actions: NotRequired["capo_ses.types.receipt_actions_list.ReceiptActionsList"]
    """<p>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.</p>"""
    scan_enabled: "capo_ses.types.enabled.Enabled"
    """<p>If <code>true</code>, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is <code>false</code>.</p>"""

actions instance-attribute

actions: NotRequired[ReceiptActionsList]

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.

enabled instance-attribute

enabled: Enabled

If true, the receipt rule is active. The default value is false.

name instance-attribute

The name of the receipt rule. The name must meet the following requirements:

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), or periods (.).

  • Start and end with a letter or number.

  • Contain 64 characters or fewer.

recipients instance-attribute

recipients: NotRequired[RecipientsList]

The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule matches all recipients on all verified domains.

scan_enabled instance-attribute

scan_enabled: Enabled

If true, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is false.

tls_policy instance-attribute

tls_policy: NotRequired[TlsPolicy]

Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES bounces emails that are not received over TLS. The default is Optional.