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

Class: Aws::SES::Types::BouncedRecipientInfo

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

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

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.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#bounce_type ⇒ String

The reason for the bounce. You must provide either this parameter or RecipientDsnFields.

Returns:

  • (String) 


220
221
222
223
224
225
226
 
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 220

class BouncedRecipientInfo < Struct.new(
  :recipient,
  :recipient_arn,
  :bounce_type,
  :recipient_dsn_fields)
  include Aws::Structure
end

#recipient ⇒ String

The email address of the recipient of the bounced email.

Returns:

  • (String) 


220
221
222
223
224
225
226
 
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 220

class BouncedRecipientInfo < Struct.new(
  :recipient,
  :recipient_arn,
  :bounce_type,
  :recipient_dsn_fields)
  include Aws::Structure
end

#recipient_arn ⇒ String

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 receive email for the recipient of the bounced email. For more information about sending authorization, see the Amazon SES Developer Guide.

Returns:

  • (String) 


220
221
222
223
224
225
226
 
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 220

class BouncedRecipientInfo < Struct.new(
  :recipient,
  :recipient_arn,
  :bounce_type,
  :recipient_dsn_fields)
  include Aws::Structure
end

#recipient_dsn_fields ⇒ Types::RecipientDsnFields

Recipient-related DSN fields, most of which would normally be filled in automatically when provided with a BounceType. You must provide either this parameter or BounceType.

Returns:



220
221
222
223
224
225
226
 
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 220

class BouncedRecipientInfo < Struct.new(
  :recipient,
  :recipient_arn,
  :bounce_type,
  :recipient_dsn_fields)
  include Aws::Structure
end