Class: Aws::SES::Types::SendBulkTemplatedEmailRequest

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-ses/types.rb

Overview

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

[1]: docs.aws.amazon.com/ses/latest/dg/send-personalized-email-api.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#configuration_set_name ⇒ String

The name of the configuration set to use when you send an email using ‘SendBulkTemplatedEmail`.

Returns:

  • (String) 


3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
 
# File 'lib/aws-sdk-ses/types.rb', line 3904

class SendBulkTemplatedEmailRequest < Struct.new(
  :source,
  :source_arn,
  :reply_to_addresses,
  :return_path,
  :return_path_arn,
  :configuration_set_name,
  :default_tags,
  :template,
  :template_arn,
  :default_template_data,
  :destinations)
  SENSITIVE = []
  include Aws::Structure
end

#default_tags ⇒ Array<Types::MessageTag>

A list of tags, in the form of name/value pairs, to apply to an email that you send to a destination using ‘SendBulkTemplatedEmail`.

Returns:



3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
 
# File 'lib/aws-sdk-ses/types.rb', line 3904

class SendBulkTemplatedEmailRequest < Struct.new(
  :source,
  :source_arn,
  :reply_to_addresses,
  :return_path,
  :return_path_arn,
  :configuration_set_name,
  :default_tags,
  :template,
  :template_arn,
  :default_template_data,
  :destinations)
  SENSITIVE = []
  include Aws::Structure
end

#default_template_data ⇒ String

A list of replacement values to apply to the template when replacement data is not specified in a Destination object. These values act as a default or fallback option when no other data is available.

The template data is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

Returns:

  • (String) 


3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
 
# File 'lib/aws-sdk-ses/types.rb', line 3904

class SendBulkTemplatedEmailRequest < Struct.new(
  :source,
  :source_arn,
  :reply_to_addresses,
  :return_path,
  :return_path_arn,
  :configuration_set_name,
  :default_tags,
  :template,
  :template_arn,
  :default_template_data,
  :destinations)
  SENSITIVE = []
  include Aws::Structure
end

#destinations ⇒ Array<Types::BulkEmailDestination>

One or more ‘Destination` objects. All of the recipients in a `Destination` receive the same version of the email. You can specify up to 50 `Destination` objects within a `Destinations` array.

Returns:



3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
 
# File 'lib/aws-sdk-ses/types.rb', line 3904

class SendBulkTemplatedEmailRequest < Struct.new(
  :source,
  :source_arn,
  :reply_to_addresses,
  :return_path,
  :return_path_arn,
  :configuration_set_name,
  :default_tags,
  :template,
  :template_arn,
  :default_template_data,
  :destinations)
  SENSITIVE = []
  include Aws::Structure
end

#reply_to_addresses ⇒ Array<String>

The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address receives the reply.

Returns:

  • (Array<String>) 


3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
 
# File 'lib/aws-sdk-ses/types.rb', line 3904

class SendBulkTemplatedEmailRequest < Struct.new(
  :source,
  :source_arn,
  :reply_to_addresses,
  :return_path,
  :return_path_arn,
  :configuration_set_name,
  :default_tags,
  :template,
  :template_arn,
  :default_template_data,
  :destinations)
  SENSITIVE = []
  include Aws::Structure
end

#return_path ⇒ String

The email address that bounces and complaints are forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message is returned from the recipient’s ISP; this message is forwarded to the email address specified by the ‘ReturnPath` parameter. The `ReturnPath` parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.

Returns:

  • (String) 


3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
 
# File 'lib/aws-sdk-ses/types.rb', line 3904

class SendBulkTemplatedEmailRequest < Struct.new(
  :source,
  :source_arn,
  :reply_to_addresses,
  :return_path,
  :return_path_arn,
  :configuration_set_name,
  :default_tags,
  :template,
  :template_arn,
  :default_template_data,
  :destinations)
  SENSITIVE = []
  include Aws::Structure
end

#return_path_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 ‘ReturnPath` 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 `[email protected]`, then you would specify the `ReturnPathArn` to be `arn:aws:ses:us-east-1:123456789012:identity/example.com`, and the `ReturnPath` to be `[email protected]`.

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

[1]: docs.aws.amazon.com/ses/latest/dg/sending-authorization.html

Returns:

  • (String) 


3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
 
# File 'lib/aws-sdk-ses/types.rb', line 3904

class SendBulkTemplatedEmailRequest < Struct.new(
  :source,
  :source_arn,
  :reply_to_addresses,
  :return_path,
  :return_path_arn,
  :configuration_set_name,
  :default_tags,
  :template,
  :template_arn,
  :default_template_data,
  :destinations)
  SENSITIVE = []
  include Aws::Structure
end

#source ⇒ String

The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the [Amazon SES Developer Guide].

If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the ‘SourceArn` parameter. For more information about sending authorization, see the [Amazon SES Developer Guide].

<note markdown=“1”> Amazon SES does not support the SMTPUTF8 extension, as described in [RFC6531]. For this reason, the email address string must be 7-bit ASCII. If you want to send to or from email addresses that contain Unicode characters in the domain part of an address, you must encode the domain using Punycode. Punycode is not permitted in the local part of the email address (the part before the @ sign) nor in the “friendly from” name. If you want to use Unicode characters in the “friendly from” name, you must encode the “friendly from” name using MIME encoded-word syntax, as described in [Sending raw email using the Amazon SES API]. For more information about Punycode, see [RFC 3492].

</note>

[1]: docs.aws.amazon.com/ses/latest/dg/creating-identities.html [2]: docs.aws.amazon.com/ses/latest/dg/sending-authorization.html [3]: tools.ietf.org/html/rfc6531 [4]: docs.aws.amazon.com/ses/latest/dg/send-email-raw.html [5]: tools.ietf.org/html/rfc3492

Returns:

  • (String) 


3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
 
# File 'lib/aws-sdk-ses/types.rb', line 3904

class SendBulkTemplatedEmailRequest < Struct.new(
  :source,
  :source_arn,
  :reply_to_addresses,
  :return_path,
  :return_path_arn,
  :configuration_set_name,
  :default_tags,
  :template,
  :template_arn,
  :default_template_data,
  :destinations)
  SENSITIVE = []
  include Aws::Structure
end

#source_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 send for the email address specified in the ‘Source` 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 send from `[email protected]`, then you would specify the `SourceArn` to be `arn:aws:ses:us-east-1:123456789012:identity/example.com`, and the `Source` to be `[email protected]`.

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

[1]: docs.aws.amazon.com/ses/latest/dg/sending-authorization.html

Returns:

  • (String) 


3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
 
# File 'lib/aws-sdk-ses/types.rb', line 3904

class SendBulkTemplatedEmailRequest < Struct.new(
  :source,
  :source_arn,
  :reply_to_addresses,
  :return_path,
  :return_path_arn,
  :configuration_set_name,
  :default_tags,
  :template,
  :template_arn,
  :default_template_data,
  :destinations)
  SENSITIVE = []
  include Aws::Structure
end

#template ⇒ String

The template to use when sending this email.

Returns:

  • (String) 


3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
 
# File 'lib/aws-sdk-ses/types.rb', line 3904

class SendBulkTemplatedEmailRequest < Struct.new(
  :source,
  :source_arn,
  :reply_to_addresses,
  :return_path,
  :return_path_arn,
  :configuration_set_name,
  :default_tags,
  :template,
  :template_arn,
  :default_template_data,
  :destinations)
  SENSITIVE = []
  include Aws::Structure
end

#template_arn ⇒ String

The ARN of the template to use when sending this email.

Returns:

  • (String) 


3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
 
# File 'lib/aws-sdk-ses/types.rb', line 3904

class SendBulkTemplatedEmailRequest < Struct.new(
  :source,
  :source_arn,
  :reply_to_addresses,
  :return_path,
  :return_path_arn,
  :configuration_set_name,
  :default_tags,
  :template,
  :template_arn,
  :default_template_data,
  :destinations)
  SENSITIVE = []
  include Aws::Structure
end