class Aws::SES::Types::ReceiptRule

Receipt rules enable you to specify which actions Amazon SES should take when it receives mail on behalf of one or more email addresses or domains that you own.

Each receipt rule defines a set of email addresses or domains that it applies to. If the email addresses or domains match at least one recipient address of the message, Amazon SES executes all of the receipt rule's actions on the message.

For information about setting up receipt rules, see the [Amazon SES Developer Guide].

[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html

@note When making an API call, you may pass ReceiptRule

data as a hash:

    {
      name: "ReceiptRuleName", # required
      enabled: false,
      tls_policy: "Require", # accepts Require, Optional
      recipients: ["Recipient"],
      actions: [
        {
          s3_action: {
            topic_arn: "AmazonResourceName",
            bucket_name: "S3BucketName", # required
            object_key_prefix: "S3KeyPrefix",
            kms_key_arn: "AmazonResourceName",
          },
          bounce_action: {
            topic_arn: "AmazonResourceName",
            smtp_reply_code: "BounceSmtpReplyCode", # required
            status_code: "BounceStatusCode",
            message: "BounceMessage", # required
            sender: "Address", # required
          },
          workmail_action: {
            topic_arn: "AmazonResourceName",
            organization_arn: "AmazonResourceName", # required
          },
          lambda_action: {
            topic_arn: "AmazonResourceName",
            function_arn: "AmazonResourceName", # required
            invocation_type: "Event", # accepts Event, RequestResponse
          },
          stop_action: {
            scope: "RuleSet", # required, accepts RuleSet
            topic_arn: "AmazonResourceName",
          },
          add_header_action: {
            header_name: "HeaderName", # required
            header_value: "HeaderValue", # required
          },
          sns_action: {
            topic_arn: "AmazonResourceName", # required
            encoding: "UTF-8", # accepts UTF-8, Base64
          },
        },
      ],
      scan_enabled: false,
    }

@!attribute [rw] name

The name of the receipt rule. The name must:

* This value can only contain ASCII letters (a-z, A-Z), numbers
  (0-9), underscores (\_), or dashes (-).

* Start and end with a letter or number.

* Contain less than 64 characters.
@return [String]

@!attribute [rw] enabled

If `true`, the receipt rule is active. The default value is `false`.
@return [Boolean]

@!attribute [rw] tls_policy

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 will bounce
emails that are not received over TLS. The default is `Optional`.
@return [String]

@!attribute [rw] recipients

The recipient domains and email addresses that the receipt rule
applies to. If this field is not specified, this rule will match all
recipients under all verified domains.
@return [Array<String>]

@!attribute [rw] 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.
@return [Array<Types::ReceiptAction>]

@!attribute [rw] scan_enabled

If `true`, then messages that this receipt rule applies to are
scanned for spam and viruses. The default value is `false`.
@return [Boolean]

@see docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/ReceiptRule AWS API Documentation

Constants

SENSITIVE