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

Class: Aws::SES::Types::BulkEmailDestination

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

{
  destination: { # required
    to_addresses: ["Address"],
    cc_addresses: ["Address"],
    bcc_addresses: ["Address"],
  },
  replacement_tags: [
    {
      name: "MessageTagName", # required
      value: "MessageTagValue", # required
    },
  ],
  replacement_template_data: "TemplateData",
}

An array that contains one or more Destinations, as well as the tags and replacement data associated with each of those Destinations.

Instance Attribute Summary collapse

Instance Attribute Details

#destinationTypes::Destination

Represents the destination of the message, consisting of To:, CC:, and BCC: fields.

Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a destination 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.

Returns:



286
287
288
289
290
291
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 286

class BulkEmailDestination < Struct.new(
  :destination,
  :replacement_tags,
  :replacement_template_data)
  include Aws::Structure
end

#replacement_tagsArray<Types::MessageTag>

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

Returns:



286
287
288
289
290
291
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 286

class BulkEmailDestination < Struct.new(
  :destination,
  :replacement_tags,
  :replacement_template_data)
  include Aws::Structure
end

#replacement_template_dataString

A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

Returns:

  • (String)


286
287
288
289
290
291
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 286

class BulkEmailDestination < Struct.new(
  :destination,
  :replacement_tags,
  :replacement_template_data)
  include Aws::Structure
end