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

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

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#action ⇒ String

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

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

Returns:

  • (String) 


3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
 
# File 'lib/aws-sdk-ses/types.rb', line 3452

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

#diagnostic_code ⇒ String

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

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

Returns:

  • (String) 


3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
 
# File 'lib/aws-sdk-ses/types.rb', line 3452

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

#extension_fields ⇒ Array<Types::ExtensionField>

Additional X-headers to include in the DSN.

Returns:



3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
 
# File 'lib/aws-sdk-ses/types.rb', line 3452

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

#final_recipient ⇒ String

The email address that the message was ultimately delivered to. 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.

<note markdown=“1”> Do not prepend the ‘FinalRecipient` email address with `rfc 822;`, as described in [RFC 3798].

</note>

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

Returns:

  • (String) 


3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
 
# File 'lib/aws-sdk-ses/types.rb', line 3452

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

#last_attempt_date ⇒ Time

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

[1]: www.ietf.org/rfc/rfc0822.txt

Returns:

  • (Time) 


3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
 
# File 'lib/aws-sdk-ses/types.rb', line 3452

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

#remote_mta ⇒ String

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.

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

Returns:

  • (String) 


3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
 
# File 'lib/aws-sdk-ses/types.rb', line 3452

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

#status ⇒ String

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

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

Returns:

  • (String) 


3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
 
# File 'lib/aws-sdk-ses/types.rb', line 3452

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