AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

SendBulkTemplatedEmailInput

import "github.com/aws/aws-sdk-go/service/ses"

type SendBulkTemplatedEmailInput struct { ConfigurationSetName *string `type:"string"` DefaultTags []*MessageTag `type:"list"` DefaultTemplateData *string `type:"string"` Destinations []*BulkEmailDestination `type:"list" required:"true"` ReplyToAddresses []*string `type:"list"` ReturnPath *string `type:"string"` ReturnPathArn *string `type:"string"` Source *string `type:"string" required:"true"` SourceArn *string `type:"string"` Template *string `type:"string" required:"true"` TemplateArn *string `type:"string"` }

Represents a request to send a templated email to multiple destinations using Amazon SES. For more information, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html).

ConfigurationSetName

Type: *string

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

DefaultTags

Contains the name and value of a tag that you can provide to SendEmail or SendRawEmail to apply to an email.

Message tags, which you use with configuration sets, enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html).

DefaultTemplateData

Type: *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.

Destinations

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

ReplyToAddresses

Type: []*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.

ReturnPath

Type: *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.

ReturnPathArn

Type: *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 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 (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html).

Source

Type: *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 (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html).

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 (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html).

Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531 (https://tools.ietf.org/html/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 (https://en.wikipedia.org/wiki/Email_address#Local-part). 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 (https://tools.ietf.org/html/rfc3492.html). 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 (https://tools.ietf.org/html/rfc2047). MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

Source is a required field

SourceArn

Type: *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 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 (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html).

Template

Type: *string

The template to use when sending this email.

Template is a required field

TemplateArn

Type: *string

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

Method

GoString

func (s SendBulkTemplatedEmailInput) GoString() string

GoString returns the string representation

SetConfigurationSetName

func (s *SendBulkTemplatedEmailInput) SetConfigurationSetName(v string) *SendBulkTemplatedEmailInput

SetConfigurationSetName sets the ConfigurationSetName field's value.

SetDefaultTags

func (s *SendBulkTemplatedEmailInput) SetDefaultTags(v []*MessageTag) *SendBulkTemplatedEmailInput

SetDefaultTags sets the DefaultTags field's value.

SetDefaultTemplateData

func (s *SendBulkTemplatedEmailInput) SetDefaultTemplateData(v string) *SendBulkTemplatedEmailInput

SetDefaultTemplateData sets the DefaultTemplateData field's value.

SetDestinations

func (s *SendBulkTemplatedEmailInput) SetDestinations(v []*BulkEmailDestination) *SendBulkTemplatedEmailInput

SetDestinations sets the Destinations field's value.

SetReplyToAddresses

func (s *SendBulkTemplatedEmailInput) SetReplyToAddresses(v []*string) *SendBulkTemplatedEmailInput

SetReplyToAddresses sets the ReplyToAddresses field's value.

SetReturnPath

func (s *SendBulkTemplatedEmailInput) SetReturnPath(v string) *SendBulkTemplatedEmailInput

SetReturnPath sets the ReturnPath field's value.

SetReturnPathArn

func (s *SendBulkTemplatedEmailInput) SetReturnPathArn(v string) *SendBulkTemplatedEmailInput

SetReturnPathArn sets the ReturnPathArn field's value.

SetSource

func (s *SendBulkTemplatedEmailInput) SetSource(v string) *SendBulkTemplatedEmailInput

SetSource sets the Source field's value.

SetSourceArn

func (s *SendBulkTemplatedEmailInput) SetSourceArn(v string) *SendBulkTemplatedEmailInput

SetSourceArn sets the SourceArn field's value.

SetTemplate

func (s *SendBulkTemplatedEmailInput) SetTemplate(v string) *SendBulkTemplatedEmailInput

SetTemplate sets the Template field's value.

SetTemplateArn

func (s *SendBulkTemplatedEmailInput) SetTemplateArn(v string) *SendBulkTemplatedEmailInput

SetTemplateArn sets the TemplateArn field's value.

String

func (s SendBulkTemplatedEmailInput) String() string

String returns the string representation

Validate

func (s *SendBulkTemplatedEmailInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: