sendEmail method
Composes an email message and immediately queues it for sending. In order
to send email using the SendEmail operation, your message
must meet the following requirements:
- The message must be sent from a verified email address or domain. If you attempt to send email using a non-verified address or domain, the operation will result in an "Email address not verified" error.
- 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.
- The message 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
SendEmailoperation several times to send the message to each group.
May throw MessageRejected. May throw MailFromDomainNotVerifiedException. May throw ConfigurationSetDoesNotExistException. May throw ConfigurationSetSendingPausedException. May throw AccountSendingPausedException.
Parameter destination :
The destination for this email, composed of To:, CC:, and BCC: fields.
Parameter message :
The message to be sent.
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 configurationSetName :
The name of the configuration set to use when you send an email using
SendEmail.
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 tags :
A list of tags, in the form of name/value pairs, to apply to an email that
you send using SendEmail. Tags correspond to characteristics
of the email that you define, so that you can publish email sending
events.
Implementation
Future<SendEmailResponse> sendEmail({
required Destination destination,
required Message message,
required String source,
String? configurationSetName,
List<String>? replyToAddresses,
String? returnPath,
String? returnPathArn,
String? sourceArn,
List<MessageTag>? tags,
}) async {
ArgumentError.checkNotNull(destination, 'destination');
ArgumentError.checkNotNull(message, 'message');
ArgumentError.checkNotNull(source, 'source');
final $request = <String, dynamic>{};
$request['Destination'] = destination;
$request['Message'] = message;
$request['Source'] = source;
configurationSetName?.also((arg) => $request['ConfigurationSetName'] = 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);
tags?.also((arg) => $request['Tags'] = arg);
final $result = await _protocol.send(
$request,
action: 'SendEmail',
version: '2010-12-01',
method: 'POST',
requestUri: '/',
exceptionFnMap: _exceptionFns,
shape: shapes['SendEmailRequest'],
shapes: shapes,
resultWrapper: 'SendEmailResult',
);
return SendEmailResponse.fromXml($result);
}