Class: Aws::SES::Types::BounceAction

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

Overview

Note:

When making an API call, you may pass BounceAction data as a hash:

{
  topic_arn: "AmazonResourceName",
  smtp_reply_code: "BounceSmtpReplyCode", # required
  status_code: "BounceStatusCode",
  message: "BounceMessage", # required
  sender: "Address", # required
}

When included in a receipt rule, this action rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

For information about sending a bounce message in response to a received email, see the [Amazon SES Developer Guide].

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#message ⇒ String

Human-readable text to include in the bounce message.

Returns:

  • (String) 


148
149
150
151
152
153
154
155
 
# File 'lib/aws-sdk-ses/types.rb', line 148

class BounceAction < Struct.new(
  :topic_arn,
  :smtp_reply_code,
  :status_code,
  :message,
  :sender)
  include Aws::Structure
end

#sender ⇒ String

The email address of the sender of the bounced email. This is the address from which the bounce message will be sent.

Returns:

  • (String) 


148
149
150
151
152
153
154
155
 
# File 'lib/aws-sdk-ses/types.rb', line 148

class BounceAction < Struct.new(
  :topic_arn,
  :smtp_reply_code,
  :status_code,
  :message,
  :sender)
  include Aws::Structure
end

#smtp_reply_code ⇒ String

The SMTP reply code, as defined by [RFC 5321].

[1]: tools.ietf.org/html/rfc5321

Returns:

  • (String) 


148
149
150
151
152
153
154
155
 
# File 'lib/aws-sdk-ses/types.rb', line 148

class BounceAction < Struct.new(
  :topic_arn,
  :smtp_reply_code,
  :status_code,
  :message,
  :sender)
  include Aws::Structure
end

#status_code ⇒ String

The SMTP enhanced status code, as defined by [RFC 3463].

[1]: tools.ietf.org/html/rfc3463

Returns:

  • (String) 


148
149
150
151
152
153
154
155
 
# File 'lib/aws-sdk-ses/types.rb', line 148

class BounceAction < Struct.new(
  :topic_arn,
  :smtp_reply_code,
  :status_code,
  :message,
  :sender)
  include Aws::Structure
end

#topic_arn ⇒ String

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. An example of an Amazon SNS topic ARN is ‘arn:aws:sns:us-west-2:123456789012:MyTopic`. For more information about Amazon SNS topics, see the [Amazon SNS Developer Guide].

[1]: docs.aws.amazon.com/sns/latest/dg/CreateTopic.html

Returns:

  • (String) 


148
149
150
151
152
153
154
155
 
# File 'lib/aws-sdk-ses/types.rb', line 148

class BounceAction < Struct.new(
  :topic_arn,
  :smtp_reply_code,
  :status_code,
  :message,
  :sender)
  include Aws::Structure
end