sendBulkTemplatedEmail method

Future<SendBulkTemplatedEmailResponse> sendBulkTemplatedEmail({
  1. required List<BulkEmailDestination> destinations,
  2. required String source,
  3. required String template,
  4. String? configurationSetName,
  5. List<MessageTag>? defaultTags,
  6. String? defaultTemplateData,
  7. List<String>? replyToAddresses,
  8. String? returnPath,
  9. String? returnPathArn,
  10. String? sourceArn,
  11. String? templateArn,
})

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

May throw MessageRejected. May throw MailFromDomainNotVerifiedException. May throw ConfigurationSetDoesNotExistException. May throw TemplateDoesNotExistException. May throw ConfigurationSetSendingPausedException. May throw AccountSendingPausedException.

Parameter destinations : 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.

Parameter source : 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.

Parameter template : The template to use when sending this email.

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

Parameter defaultTags : A list of tags, in the form of name/value pairs, to apply to an email that you send to a destination using SendBulkTemplatedEmail.

Parameter defaultTemplateData : 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.

Parameter replyToAddresses : The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.

Parameter returnPath : 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.

Parameter returnPathArn : 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.

Parameter sourceArn : 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.

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

Implementation

Future<SendBulkTemplatedEmailResponse> sendBulkTemplatedEmail({
  required List<BulkEmailDestination> destinations,
  required String source,
  required String template,
  String? configurationSetName,
  List<MessageTag>? defaultTags,
  String? defaultTemplateData,
  List<String>? replyToAddresses,
  String? returnPath,
  String? returnPathArn,
  String? sourceArn,
  String? templateArn,
}) async {
  ArgumentError.checkNotNull(destinations, 'destinations');
  ArgumentError.checkNotNull(source, 'source');
  ArgumentError.checkNotNull(template, 'template');
  _s.validateStringLength(
    'defaultTemplateData',
    defaultTemplateData,
    0,
    262144,
  );
  final $request = <String, dynamic>{};
  $request['Destinations'] = destinations;
  $request['Source'] = source;
  $request['Template'] = template;
  configurationSetName?.also((arg) => $request['ConfigurationSetName'] = arg);
  defaultTags?.also((arg) => $request['DefaultTags'] = arg);
  defaultTemplateData?.also((arg) => $request['DefaultTemplateData'] = arg);
  replyToAddresses?.also((arg) => $request['ReplyToAddresses'] = arg);
  returnPath?.also((arg) => $request['ReturnPath'] = arg);
  returnPathArn?.also((arg) => $request['ReturnPathArn'] = arg);
  sourceArn?.also((arg) => $request['SourceArn'] = arg);
  templateArn?.also((arg) => $request['TemplateArn'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'SendBulkTemplatedEmail',
    version: '2010-12-01',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['SendBulkTemplatedEmailRequest'],
    shapes: shapes,
    resultWrapper: 'SendBulkTemplatedEmailResult',
  );
  return SendBulkTemplatedEmailResponse.fromXml($result);
}