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

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

{
  source: "Address", # required
  source_arn: "AmazonResourceName",
  reply_to_addresses: ["Address"],
  return_path: "Address",
  return_path_arn: "AmazonResourceName",
  configuration_set_name: "ConfigurationSetName",
  default_tags: [
    {
      name: "MessageTagName", # required
      value: "MessageTagValue", # required
    },
  ],
  template: "TemplateName", # required
  template_arn: "AmazonResourceName",
  default_template_data: "TemplateData",
  destinations: [ # required
    {
      destination: { # required
        to_addresses: ["Address"],
        cc_addresses: ["Address"],
        bcc_addresses: ["Address"],
      },
      replacement_tags: [
        {
          name: "MessageTagName", # required
          value: "MessageTagValue", # required
        },
      ],
      replacement_template_data: "TemplateData",
    },
  ],
}

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/DeveloperGuide/send-personalized-email-api.html

See Also:

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) 


4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
 
# File 'lib/aws-sdk-ses/types.rb', line 4041

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)
  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:



4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
 
# File 'lib/aws-sdk-ses/types.rb', line 4041

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)
  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) 


4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
 
# File 'lib/aws-sdk-ses/types.rb', line 4041

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)
  include Aws::Structure
end

#destinations ⇒ Array<Types::BulkEmailDestination>

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

Returns:



4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
 
# File 'lib/aws-sdk-ses/types.rb', line 4041

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)
  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 will receive the reply.

Returns:

  • (Array<String>) 


4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
 
# File 'lib/aws-sdk-ses/types.rb', line 4041

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)
  include Aws::Structure
end

#return_path ⇒ String

The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient’s ISP; this message will then be 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) 


4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
 
# File 'lib/aws-sdk-ses/types.rb', line 4041

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)
  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/DeveloperGuide/sending-authorization.html

Returns:

  • (String) 


4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
 
# File 'lib/aws-sdk-ses/types.rb', line 4041

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)
  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 *local part* of a source email address (the part of the email address that precedes the @ sign) may only contain [7-bit ASCII characters]. If the *domain part* of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in [RFC3492]. The sender name (also known as the *friendly name*) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in [RFC 2047]. MIME encoded-word syntax uses the following form: ‘=?charset?encoding?encoded-text?=`.

</note>

[1]: docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html [2]: docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html [3]: tools.ietf.org/html/rfc6531 [4]: en.wikipedia.org/wiki/Email_address#Local-part [5]: tools.ietf.org/html/rfc3492.html [6]: tools.ietf.org/html/rfc2047

Returns:

  • (String) 


4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
 
# File 'lib/aws-sdk-ses/types.rb', line 4041

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)
  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/DeveloperGuide/sending-authorization.html

Returns:

  • (String) 


4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
 
# File 'lib/aws-sdk-ses/types.rb', line 4041

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)
  include Aws::Structure
end

#template ⇒ String

The template to use when sending this email.

Returns:

  • (String) 


4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
 
# File 'lib/aws-sdk-ses/types.rb', line 4041

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)
  include Aws::Structure
end

#template_arn ⇒ String

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

Returns:

  • (String) 


4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
 
# File 'lib/aws-sdk-ses/types.rb', line 4041

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)
  include Aws::Structure
end