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

Class: Aws::SES::Types::RecipientDsnFields

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

{
  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
    },
  ],
}

Recipient-related information to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.

For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.

Instance Attribute Summary collapse

Instance Attribute Details

#actionString

The action performed by the reporting mail transfer agent (MTA) as a result of its attempt to deliver the message to the recipient address. This is required by RFC 3464.

Returns:

  • (String)


2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 2829

class RecipientDsnFields < Struct.new(
  :final_recipient,
  :action,
  :remote_mta,
  :status,
  :diagnostic_code,
  :last_attempt_date,
  :extension_fields)
  include Aws::Structure
end

#diagnostic_codeString

An extended explanation of what went wrong; this is usually an SMTP response. See RFC 3463 for the correct formatting of this parameter.

Returns:

  • (String)


2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 2829

class RecipientDsnFields < Struct.new(
  :final_recipient,
  :action,
  :remote_mta,
  :status,
  :diagnostic_code,
  :last_attempt_date,
  :extension_fields)
  include Aws::Structure
end

#extension_fieldsArray<Types::ExtensionField>

Additional X-headers to include in the DSN.

Returns:



2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 2829

class RecipientDsnFields < Struct.new(
  :final_recipient,
  :action,
  :remote_mta,
  :status,
  :diagnostic_code,
  :last_attempt_date,
  :extension_fields)
  include Aws::Structure
end

#final_recipientString

The email address to which the message was ultimately delivered. This corresponds to the Final-Recipient in the DSN. If not specified, FinalRecipient will be set to the Recipient specified in the BouncedRecipientInfo structure. Either FinalRecipient or the recipient in BouncedRecipientInfo must be a recipient of the original bounced message.

Do not prepend the FinalRecipient email address with rfc 822;, as described in RFC 3798.

Returns:

  • (String)


2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 2829

class RecipientDsnFields < Struct.new(
  :final_recipient,
  :action,
  :remote_mta,
  :status,
  :diagnostic_code,
  :last_attempt_date,
  :extension_fields)
  include Aws::Structure
end

#last_attempt_dateTime

The time the final delivery attempt was made, in RFC 822 date-time format.

Returns:

  • (Time)


2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 2829

class RecipientDsnFields < Struct.new(
  :final_recipient,
  :action,
  :remote_mta,
  :status,
  :diagnostic_code,
  :last_attempt_date,
  :extension_fields)
  include Aws::Structure
end

#remote_mtaString

The MTA to which the remote MTA attempted to deliver the message, formatted as specified in RFC 3464 (mta-name-type; mta-name). This parameter typically applies only to propagating synchronous bounces.

Returns:

  • (String)


2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 2829

class RecipientDsnFields < Struct.new(
  :final_recipient,
  :action,
  :remote_mta,
  :status,
  :diagnostic_code,
  :last_attempt_date,
  :extension_fields)
  include Aws::Structure
end

#statusString

The status code that indicates what went wrong. This is required by RFC 3464.

Returns:

  • (String)


2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 2829

class RecipientDsnFields < Struct.new(
  :final_recipient,
  :action,
  :remote_mta,
  :status,
  :diagnostic_code,
  :last_attempt_date,
  :extension_fields)
  include Aws::Structure
end