You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::SES::Types::ReceiptAction

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb

Overview

Note:

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.

Instance Attribute Summary collapse

Instance Attribute Details

#add_header_actionTypes::AddHeaderAction

Adds a header to the received email.



2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 2474

class ReceiptAction < Struct.new(
  :s3_action,
  :bounce_action,
  :workmail_action,
  :lambda_action,
  :stop_action,
  :add_header_action,
  :sns_action)
  include Aws::Structure
end

#bounce_actionTypes::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).

Returns:



2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 2474

class ReceiptAction < Struct.new(
  :s3_action,
  :bounce_action,
  :workmail_action,
  :lambda_action,
  :stop_action,
  :add_header_action,
  :sns_action)
  include Aws::Structure
end

#lambda_actionTypes::LambdaAction

Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.

Returns:



2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 2474

class ReceiptAction < Struct.new(
  :s3_action,
  :bounce_action,
  :workmail_action,
  :lambda_action,
  :stop_action,
  :add_header_action,
  :sns_action)
  include Aws::Structure
end

#s3_actionTypes::S3Action

Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.

Returns:



2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 2474

class ReceiptAction < Struct.new(
  :s3_action,
  :bounce_action,
  :workmail_action,
  :lambda_action,
  :stop_action,
  :add_header_action,
  :sns_action)
  include Aws::Structure
end

#sns_actionTypes::SNSAction

Publishes the email content within a notification to Amazon SNS.

Returns:



2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 2474

class ReceiptAction < Struct.new(
  :s3_action,
  :bounce_action,
  :workmail_action,
  :lambda_action,
  :stop_action,
  :add_header_action,
  :sns_action)
  include Aws::Structure
end

#stop_actionTypes::StopAction

Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.

Returns:



2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 2474

class ReceiptAction < Struct.new(
  :s3_action,
  :bounce_action,
  :workmail_action,
  :lambda_action,
  :stop_action,
  :add_header_action,
  :sns_action)
  include Aws::Structure
end

#workmail_actionTypes::WorkmailAction

Calls Amazon WorkMail and, optionally, publishes a notification to Amazon SNS.



2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 2474

class ReceiptAction < Struct.new(
  :s3_action,
  :bounce_action,
  :workmail_action,
  :lambda_action,
  :stop_action,
  :add_header_action,
  :sns_action)
  include Aws::Structure
end