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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing SendBulkTemplatedEmailRequest as input to an Aws::Client method, you can use a vanilla 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.

Instance Attribute Summary collapse

Instance Attribute Details

#configuration_set_nameString

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

Returns:

  • (String)

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

#default_tagsArray<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:

  • (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.

#default_template_dataString

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)

    A list of replacement values to apply to the template when replacement data is not specified in a Destination object.

#destinationsArray<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:

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

    The reply-to email address(es) for the message.

#return_pathString

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)

    The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled.

#return_path_arnString

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 feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com.

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

Returns:

  • (String)

    This parameter is used only for sending authorization.

#sourceString

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.

In all cases, the email address must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=. For more information, see RFC 2047.

Returns:

  • (String)

    The email address that is sending the email.

#source_arnString

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 user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com.

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

Returns:

  • (String)

    This parameter is used only for sending authorization.

#templateString

The template to use when sending this email.

Returns:

  • (String)

    The template to use when sending this email.

#template_arnString

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

Returns:

  • (String)

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