Class: Aws::SESV2::Types::SendBulkEmailRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb

Overview

Represents a request to send email messages to multiple destinations using Amazon SES. For more information, see the Amazon SES Developer Guide.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bulk_email_entries ⇒ Array<Types::BulkEmailEntry>

The list of bulk email entry objects.

Returns:



8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
 
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 8221

class SendBulkEmailRequest < Struct.new(
  :from_email_address,
  :from_email_address_identity_arn,
  :reply_to_addresses,
  :feedback_forwarding_email_address,
  :feedback_forwarding_email_address_identity_arn,
  :default_email_tags,
  :default_content,
  :bulk_email_entries,
  :configuration_set_name,
  :endpoint_id,
  :tenant_name,
  :configuration_overrides)
  SENSITIVE = []
  include Aws::Structure
end

#configuration_overrides ⇒ Types::ConfigurationOverrides

An object that overrides, for the messages in this request only, settings that would otherwise apply to them. The overrides apply to every message in the request. Each setting that you don't override keeps the value that already applies.

Returns:



8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
 
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 8221

class SendBulkEmailRequest < Struct.new(
  :from_email_address,
  :from_email_address_identity_arn,
  :reply_to_addresses,
  :feedback_forwarding_email_address,
  :feedback_forwarding_email_address_identity_arn,
  :default_email_tags,
  :default_content,
  :bulk_email_entries,
  :configuration_set_name,
  :endpoint_id,
  :tenant_name,
  :configuration_overrides)
  SENSITIVE = []
  include Aws::Structure
end

#configuration_set_name ⇒ String

The name of the configuration set to use when sending the email.

Returns:

  • (String) 


8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
 
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 8221

class SendBulkEmailRequest < Struct.new(
  :from_email_address,
  :from_email_address_identity_arn,
  :reply_to_addresses,
  :feedback_forwarding_email_address,
  :feedback_forwarding_email_address_identity_arn,
  :default_email_tags,
  :default_content,
  :bulk_email_entries,
  :configuration_set_name,
  :endpoint_id,
  :tenant_name,
  :configuration_overrides)
  SENSITIVE = []
  include Aws::Structure
end

#default_content ⇒ Types::BulkEmailContent

An object that contains the body of the message. You can specify a template message.

Returns:



8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
 
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 8221

class SendBulkEmailRequest < Struct.new(
  :from_email_address,
  :from_email_address_identity_arn,
  :reply_to_addresses,
  :feedback_forwarding_email_address,
  :feedback_forwarding_email_address_identity_arn,
  :default_email_tags,
  :default_content,
  :bulk_email_entries,
  :configuration_set_name,
  :endpoint_id,
  :tenant_name,
  :configuration_overrides)
  SENSITIVE = []
  include Aws::Structure
end

#default_email_tags ⇒ Array<Types::MessageTag>

A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

Returns:



8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
 
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 8221

class SendBulkEmailRequest < Struct.new(
  :from_email_address,
  :from_email_address_identity_arn,
  :reply_to_addresses,
  :feedback_forwarding_email_address,
  :feedback_forwarding_email_address_identity_arn,
  :default_email_tags,
  :default_content,
  :bulk_email_entries,
  :configuration_set_name,
  :endpoint_id,
  :tenant_name,
  :configuration_overrides)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_id ⇒ String

The ID of the multi-region endpoint (global-endpoint).

Returns:

  • (String) 


8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
 
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 8221

class SendBulkEmailRequest < Struct.new(
  :from_email_address,
  :from_email_address_identity_arn,
  :reply_to_addresses,
  :feedback_forwarding_email_address,
  :feedback_forwarding_email_address_identity_arn,
  :default_email_tags,
  :default_content,
  :bulk_email_entries,
  :configuration_set_name,
  :endpoint_id,
  :tenant_name,
  :configuration_overrides)
  SENSITIVE = []
  include Aws::Structure
end

#feedback_forwarding_email_address ⇒ String

The address that you want bounce and complaint notifications to be sent to.

Returns:

  • (String) 


8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
 
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 8221

class SendBulkEmailRequest < Struct.new(
  :from_email_address,
  :from_email_address_identity_arn,
  :reply_to_addresses,
  :feedback_forwarding_email_address,
  :feedback_forwarding_email_address_identity_arn,
  :default_email_tags,
  :default_content,
  :bulk_email_entries,
  :configuration_set_name,
  :endpoint_id,
  :tenant_name,
  :configuration_overrides)
  SENSITIVE = []
  include Aws::Structure
end

#feedback_forwarding_email_address_identity_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 use the email address specified in the FeedbackForwardingEmailAddress parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the FeedbackForwardingEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FeedbackForwardingEmailAddress to be feedback@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

Returns:

  • (String) 


8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
 
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 8221

class SendBulkEmailRequest < Struct.new(
  :from_email_address,
  :from_email_address_identity_arn,
  :reply_to_addresses,
  :feedback_forwarding_email_address,
  :feedback_forwarding_email_address_identity_arn,
  :default_email_tags,
  :default_content,
  :bulk_email_entries,
  :configuration_set_name,
  :endpoint_id,
  :tenant_name,
  :configuration_overrides)
  SENSITIVE = []
  include Aws::Structure
end

#from_email_address ⇒ String

The email address to use as the "From" address for the email. The address that you specify has to be verified.

Returns:

  • (String) 


8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
 
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 8221

class SendBulkEmailRequest < Struct.new(
  :from_email_address,
  :from_email_address_identity_arn,
  :reply_to_addresses,
  :feedback_forwarding_email_address,
  :feedback_forwarding_email_address_identity_arn,
  :default_email_tags,
  :default_content,
  :bulk_email_entries,
  :configuration_set_name,
  :endpoint_id,
  :tenant_name,
  :configuration_overrides)
  SENSITIVE = []
  include Aws::Structure
end

#from_email_address_identity_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 use the email address specified in the FromEmailAddress parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use sender@example.com, then you would specify the FromEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FromEmailAddress to be sender@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

Returns:

  • (String) 


8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
 
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 8221

class SendBulkEmailRequest < Struct.new(
  :from_email_address,
  :from_email_address_identity_arn,
  :reply_to_addresses,
  :feedback_forwarding_email_address,
  :feedback_forwarding_email_address_identity_arn,
  :default_email_tags,
  :default_content,
  :bulk_email_entries,
  :configuration_set_name,
  :endpoint_id,
  :tenant_name,
  :configuration_overrides)
  SENSITIVE = []
  include Aws::Structure
end

#reply_to_addresses ⇒ Array<String>

The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

Returns:

  • (Array<String>) 


8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
 
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 8221

class SendBulkEmailRequest < Struct.new(
  :from_email_address,
  :from_email_address_identity_arn,
  :reply_to_addresses,
  :feedback_forwarding_email_address,
  :feedback_forwarding_email_address_identity_arn,
  :default_email_tags,
  :default_content,
  :bulk_email_entries,
  :configuration_set_name,
  :endpoint_id,
  :tenant_name,
  :configuration_overrides)
  SENSITIVE = []
  include Aws::Structure
end

#tenant_name ⇒ String

The name of the tenant through which this bulk email will be sent.

The email sending operation will only succeed if all referenced resources (identities, configuration sets, and templates) are associated with this tenant.

Returns:

  • (String) 


8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
 
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 8221

class SendBulkEmailRequest < Struct.new(
  :from_email_address,
  :from_email_address_identity_arn,
  :reply_to_addresses,
  :feedback_forwarding_email_address,
  :feedback_forwarding_email_address_identity_arn,
  :default_email_tags,
  :default_content,
  :bulk_email_entries,
  :configuration_set_name,
  :endpoint_id,
  :tenant_name,
  :configuration_overrides)
  SENSITIVE = []
  include Aws::Structure
end