Class: Aws::SES::Types::ReceiptRule
- Inherits:
-
Struct
- Object
- Struct
- Aws::SES::Types::ReceiptRule
- Includes:
- Aws::Structure
- Defined in:
- lib/aws-sdk-ses/types.rb
Overview
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,
}
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
Instance Attribute Summary collapse
-
#actions ⇒ Array<Types::ReceiptAction>
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 ⇒ Boolean
If ‘true`, the receipt rule is active.
-
#name ⇒ String
The name of the receipt rule.
-
#recipients ⇒ Array<String>
The recipient domains and email addresses that the receipt rule applies to.
-
#scan_enabled ⇒ Boolean
If ‘true`, then messages that this receipt rule applies to are scanned for spam and viruses.
-
#tls_policy ⇒ String
Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS).
Instance Attribute Details
#actions ⇒ Array<Types::ReceiptAction>
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.
3304 3305 3306 3307 3308 3309 3310 3311 3312 |
# File 'lib/aws-sdk-ses/types.rb', line 3304 class ReceiptRule < Struct.new( :name, :enabled, :tls_policy, :recipients, :actions, :scan_enabled) include Aws::Structure end |
#enabled ⇒ Boolean
If ‘true`, the receipt rule is active. The default value is `false`.
3304 3305 3306 3307 3308 3309 3310 3311 3312 |
# File 'lib/aws-sdk-ses/types.rb', line 3304 class ReceiptRule < Struct.new( :name, :enabled, :tls_policy, :recipients, :actions, :scan_enabled) include Aws::Structure end |
#name ⇒ String
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.
3304 3305 3306 3307 3308 3309 3310 3311 3312 |
# File 'lib/aws-sdk-ses/types.rb', line 3304 class ReceiptRule < Struct.new( :name, :enabled, :tls_policy, :recipients, :actions, :scan_enabled) include Aws::Structure end |
#recipients ⇒ Array<String>
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.
3304 3305 3306 3307 3308 3309 3310 3311 3312 |
# File 'lib/aws-sdk-ses/types.rb', line 3304 class ReceiptRule < Struct.new( :name, :enabled, :tls_policy, :recipients, :actions, :scan_enabled) include Aws::Structure end |
#scan_enabled ⇒ Boolean
If ‘true`, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is `false`.
3304 3305 3306 3307 3308 3309 3310 3311 3312 |
# File 'lib/aws-sdk-ses/types.rb', line 3304 class ReceiptRule < Struct.new( :name, :enabled, :tls_policy, :recipients, :actions, :scan_enabled) include Aws::Structure end |
#tls_policy ⇒ String
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`.
3304 3305 3306 3307 3308 3309 3310 3311 3312 |
# File 'lib/aws-sdk-ses/types.rb', line 3304 class ReceiptRule < Struct.new( :name, :enabled, :tls_policy, :recipients, :actions, :scan_enabled) include Aws::Structure end |