Class: Aws::SES::Types::ReceiptAction
- Inherits:
-
Struct
- Object
- Struct
- Aws::SES::Types::ReceiptAction
- Includes:
- Aws::Structure
- Defined in:
- lib/aws-sdk-ses/types.rb
Overview
When making an API call, you may pass ReceiptAction data as a hash:
{
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
},
}
An action that Amazon SES can take when it receives an email on behalf of one or more email addresses or domains that you own. An instance of this data type can represent only one action.
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
-
#add_header_action ⇒ Types::AddHeaderAction
Adds a header to the received email.
-
#bounce_action ⇒ Types::BounceAction
Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
-
#lambda_action ⇒ Types::LambdaAction
Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.
-
#s3_action ⇒ Types::S3Action
Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.
-
#sns_action ⇒ Types::SNSAction
Publishes the email content within a notification to Amazon SNS.
-
#stop_action ⇒ Types::StopAction
Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.
-
#workmail_action ⇒ Types::WorkmailAction
Calls Amazon WorkMail and, optionally, publishes a notification to Amazon Amazon SNS.
Instance Attribute Details
#add_header_action ⇒ Types::AddHeaderAction
Adds a header to the received email.
3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 |
# File 'lib/aws-sdk-ses/types.rb', line 3097 class ReceiptAction < Struct.new( :s3_action, :bounce_action, :workmail_action, :lambda_action, :stop_action, :add_header_action, :sns_action) include Aws::Structure end |
#bounce_action ⇒ Types::BounceAction
Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 |
# File 'lib/aws-sdk-ses/types.rb', line 3097 class ReceiptAction < Struct.new( :s3_action, :bounce_action, :workmail_action, :lambda_action, :stop_action, :add_header_action, :sns_action) include Aws::Structure end |
#lambda_action ⇒ Types::LambdaAction
Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.
3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 |
# File 'lib/aws-sdk-ses/types.rb', line 3097 class ReceiptAction < Struct.new( :s3_action, :bounce_action, :workmail_action, :lambda_action, :stop_action, :add_header_action, :sns_action) include Aws::Structure end |
#s3_action ⇒ Types::S3Action
Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.
3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 |
# File 'lib/aws-sdk-ses/types.rb', line 3097 class ReceiptAction < Struct.new( :s3_action, :bounce_action, :workmail_action, :lambda_action, :stop_action, :add_header_action, :sns_action) include Aws::Structure end |
#sns_action ⇒ Types::SNSAction
Publishes the email content within a notification to Amazon SNS.
3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 |
# File 'lib/aws-sdk-ses/types.rb', line 3097 class ReceiptAction < Struct.new( :s3_action, :bounce_action, :workmail_action, :lambda_action, :stop_action, :add_header_action, :sns_action) include Aws::Structure end |
#stop_action ⇒ Types::StopAction
Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.
3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 |
# File 'lib/aws-sdk-ses/types.rb', line 3097 class ReceiptAction < Struct.new( :s3_action, :bounce_action, :workmail_action, :lambda_action, :stop_action, :add_header_action, :sns_action) include Aws::Structure end |
#workmail_action ⇒ Types::WorkmailAction
Calls Amazon WorkMail and, optionally, publishes a notification to Amazon Amazon SNS.
3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 |
# File 'lib/aws-sdk-ses/types.rb', line 3097 class ReceiptAction < Struct.new( :s3_action, :bounce_action, :workmail_action, :lambda_action, :stop_action, :add_header_action, :sns_action) include Aws::Structure end |