class Aws::SES::Types::SendBounceRequest

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

@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",
    }

@!attribute [rw] original_message_id

The message ID of the message to be bounced.
@return [String]

@!attribute [rw] bounce_sender

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

@!attribute [rw] explanation

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.
@return [String]

@!attribute [rw] message_dsn

Message-related DSN fields. If not specified, Amazon SES will choose
the values.
@return [Types::MessageDsn]

@!attribute [rw] bounced_recipient_info_list

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.
@return [Array<Types::BouncedRecipientInfo>]

@!attribute [rw] bounce_sender_arn

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][1].

[1]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/email-2010-12-01/SendBounceRequest AWS API Documentation

Constants

SENSITIVE