/
api_op_SendBulkTemplatedEmail.go
249 lines (225 loc) · 10.2 KB
/
api_op_SendBulkTemplatedEmail.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
// Code generated by smithy-go-codegen DO NOT EDIT.
package ses
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/ses/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Composes an email message to multiple destinations. The message body is created
// using an email template. In order to send email using the SendBulkTemplatedEmail
// operation, your call to the API must meet the following requirements:
//
// * The
// call must refer to an existing email template. You can create email templates
// using the CreateTemplate operation.
//
// * The message must be sent from a verified
// email address or domain.
//
// * If your account is still in the Amazon SES sandbox,
// you may only send to verified addresses or domains, or to email addresses
// associated with the Amazon SES Mailbox Simulator. For more information, see
// Verifying Email Addresses and Domains
// (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html)
// in the Amazon SES Developer Guide.
//
// * The maximum message size is 10 MB.
//
// * Each
// Destination parameter must include at least one recipient email address. The
// recipient address can be a To: address, a CC: address, or a BCC: address. If a
// recipient email address is invalid (that is, it is not in the format
// UserName@[SubDomain.]Domain.TopLevelDomain), the entire message will be
// rejected, even if the message contains other recipients that are valid.
//
// * The
// message may not include more than 50 recipients, across the To:, CC: and BCC:
// fields. If you need to send an email message to a larger audience, you can
// divide your recipient list into groups of 50 or fewer, and then call the
// SendBulkTemplatedEmail operation several times to send the message to each
// group.
//
// * The number of destinations you can contact in a single call to the API
// may be limited by your account's maximum sending rate.
func (c *Client) SendBulkTemplatedEmail(ctx context.Context, params *SendBulkTemplatedEmailInput, optFns ...func(*Options)) (*SendBulkTemplatedEmailOutput, error) {
if params == nil {
params = &SendBulkTemplatedEmailInput{}
}
result, metadata, err := c.invokeOperation(ctx, "SendBulkTemplatedEmail", params, optFns, c.addOperationSendBulkTemplatedEmailMiddlewares)
if err != nil {
return nil, err
}
out := result.(*SendBulkTemplatedEmailOutput)
out.ResultMetadata = metadata
return out, nil
}
// 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).
type SendBulkTemplatedEmailInput struct {
// 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.
//
// This member is required.
Destinations []types.BulkEmailDestination
// 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?=.
//
// This member is required.
Source *string
// The template to use when sending this email.
//
// This member is required.
Template *string
// The name of the configuration set to use when you send an email using
// SendBulkTemplatedEmail.
ConfigurationSetName *string
// A list of tags, in the form of name/value pairs, to apply to an email that you
// send to a destination using SendBulkTemplatedEmail.
DefaultTags []types.MessageTag
// 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.
DefaultTemplateData *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.
ReplyToAddresses []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.
ReturnPath *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).
ReturnPathArn *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).
SourceArn *string
// The ARN of the template to use when sending this email.
TemplateArn *string
noSmithyDocumentSerde
}
type SendBulkTemplatedEmailOutput struct {
// The unique message identifier returned from the SendBulkTemplatedEmail action.
//
// This member is required.
Status []types.BulkEmailDestinationStatus
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationSendBulkTemplatedEmailMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsAwsquery_serializeOpSendBulkTemplatedEmail{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsquery_deserializeOpSendBulkTemplatedEmail{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpSendBulkTemplatedEmailValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opSendBulkTemplatedEmail(options.Region), middleware.Before); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opSendBulkTemplatedEmail(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "ses",
OperationName: "SendBulkTemplatedEmail",
}
}