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

Class: Aws::SES::Types::SendBounceRequest

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 SendBounceRequest data as a hash:

{
  original_message_id: "MessageId", # required
  bounce_sender: "Address", # required
  explanation: "Explanation",
  message_dsn: {
    reporting_mta: "ReportingMta", # required
    arrival_date: Time.now,
    extension_fields: [
      {
        name: "ExtensionFieldName", # required
        value: "ExtensionFieldValue", # required
      },
    ],
  },
  bounced_recipient_info_list: [ # required
    {
      recipient: "Address", # required
      recipient_arn: "AmazonResourceName",
      bounce_type: "DoesNotExist", # accepts DoesNotExist, MessageTooLarge, ExceededQuota, ContentRejected, Undefined, TemporaryFailure
      recipient_dsn_fields: {
        final_recipient: "Address",
        action: "failed", # required, accepts failed, delayed, delivered, relayed, expanded
        remote_mta: "RemoteMta",
        status: "DsnStatus", # required
        diagnostic_code: "DiagnosticCode",
        last_attempt_date: Time.now,
        extension_fields: [
          {
            name: "ExtensionFieldName", # required
            value: "ExtensionFieldValue", # required
          },
        ],
      },
    },
  ],
  bounce_sender_arn: "AmazonResourceName",
}

Represents a request to send a bounce message to the sender of an email you received through Amazon SES.

Instance Attribute Summary collapse

Instance Attribute Details

#bounce_senderString

The address to use in the "From" header of the bounce message. This must be an identity that you have verified with Amazon SES.

Returns:

  • (String)


3519
3520
3521
3522
3523
3524
3525
3526
3527
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 3519

class SendBounceRequest < Struct.new(
  :original_message_id,
  :bounce_sender,
  :explanation,
  :message_dsn,
  :bounced_recipient_info_list,
  :bounce_sender_arn)
  include Aws::Structure
end

#bounce_sender_arnString

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the address in the "From" header of the bounce. For more information about sending authorization, see the Amazon SES Developer Guide.

Returns:

  • (String)


3519
3520
3521
3522
3523
3524
3525
3526
3527
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 3519

class SendBounceRequest < Struct.new(
  :original_message_id,
  :bounce_sender,
  :explanation,
  :message_dsn,
  :bounced_recipient_info_list,
  :bounce_sender_arn)
  include Aws::Structure
end

#bounced_recipient_info_listArray<Types::BouncedRecipientInfo>

A list of recipients of the bounced message, including the information required to create the Delivery Status Notifications (DSNs) for the recipients. You must specify at least one BouncedRecipientInfo in the list.

Returns:



3519
3520
3521
3522
3523
3524
3525
3526
3527
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 3519

class SendBounceRequest < Struct.new(
  :original_message_id,
  :bounce_sender,
  :explanation,
  :message_dsn,
  :bounced_recipient_info_list,
  :bounce_sender_arn)
  include Aws::Structure
end

#explanationString

Human-readable text for the bounce message to explain the failure. If not specified, the text will be auto-generated based on the bounced recipient information.

Returns:

  • (String)


3519
3520
3521
3522
3523
3524
3525
3526
3527
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 3519

class SendBounceRequest < Struct.new(
  :original_message_id,
  :bounce_sender,
  :explanation,
  :message_dsn,
  :bounced_recipient_info_list,
  :bounce_sender_arn)
  include Aws::Structure
end

#message_dsnTypes::MessageDsn

Message-related DSN fields. If not specified, Amazon SES will choose the values.

Returns:



3519
3520
3521
3522
3523
3524
3525
3526
3527
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 3519

class SendBounceRequest < Struct.new(
  :original_message_id,
  :bounce_sender,
  :explanation,
  :message_dsn,
  :bounced_recipient_info_list,
  :bounce_sender_arn)
  include Aws::Structure
end

#original_message_idString

The message ID of the message to be bounced.

Returns:

  • (String)


3519
3520
3521
3522
3523
3524
3525
3526
3527
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 3519

class SendBounceRequest < Struct.new(
  :original_message_id,
  :bounce_sender,
  :explanation,
  :message_dsn,
  :bounced_recipient_info_list,
  :bounce_sender_arn)
  include Aws::Structure
end