sendEmail method

Future<SendEmailResponse> sendEmail({ required EmailContent content, String? configurationSetName, Destination? destination, List<MessageTag>? emailTags, String? feedbackForwardingEmailAddress, String? feedbackForwardingEmailAddressIdentityArn, String? fromEmailAddress, String? fromEmailAddressIdentityArn, ListManagementOptions? listManagementOptions, List<String>? replyToAddresses, })

Sends an email message. You can use the Amazon SES API v2 to send two types of messages:

• Simple – A standard email message. When you create this type of message, you specify the sender, the recipient, and the message body, and Amazon SES assembles the message for you.
• Raw – A raw, MIME-formatted email message. When you send this type of email, you have to specify all of the message headers, as well as the message body. You can use this message type to send messages that contain attachments. The message that you specify has to be a valid MIME message.
• Templated – A message that contains personalization tags. When you send this type of email, Amazon SES API v2 automatically replaces the tags with values that you specify.

May throw TooManyRequestsException. May throw LimitExceededException. May throw AccountSuspendedException. May throw SendingPausedException. May throw MessageRejected. May throw MailFromDomainNotVerifiedException. May throw NotFoundException. May throw BadRequestException.

Parameter content : An object that contains the body of the message. You can send either a Simple message Raw message or a template Message.

Parameter configurationSetName : The name of the configuration set that you want to use when sending the email.

Parameter destination : An object that contains the recipients of the email message.

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

Parameter feedbackForwardingEmailAddress : The address that you want bounce and complaint notifications to be sent to.

Parameter feedbackForwardingEmailAddressIdentityArn : 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 FeedbackForwardingEmailAddress 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 [e-mail], then you would specify the FeedbackForwardingEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FeedbackForwardingEmailAddress to be [e-mail].

For more information about sending authorization, see the Amazon SES Developer Guide.

Parameter fromEmailAddress : The email address that you want to use as the "From" address for the email. The address that you specify has to be verified.

Parameter fromEmailAddressIdentityArn : 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 FromEmailAddress 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 [e-mail], then you would specify the FromEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FromEmailAddress to be [e-mail].

For more information about sending authorization, see the Amazon SES Developer Guide.

For Raw emails, the FromEmailAddressIdentityArn value overrides the X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email message content.

Parameter listManagementOptions : An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.

Parameter replyToAddresses : The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

Implementation

Future<SendEmailResponse> sendEmail({
  required EmailContent content,
  String? configurationSetName,
  Destination? destination,
  List<MessageTag>? emailTags,
  String? feedbackForwardingEmailAddress,
  String? feedbackForwardingEmailAddressIdentityArn,
  String? fromEmailAddress,
  String? fromEmailAddressIdentityArn,
  ListManagementOptions? listManagementOptions,
  List<String>? replyToAddresses,
}) async {
  ArgumentError.checkNotNull(content, 'content');
  final $payload = <String, dynamic>{
    'Content': content,
    if (configurationSetName != null)
      'ConfigurationSetName': configurationSetName,
    if (destination != null) 'Destination': destination,
    if (emailTags != null) 'EmailTags': emailTags,
    if (feedbackForwardingEmailAddress != null)
      'FeedbackForwardingEmailAddress': feedbackForwardingEmailAddress,
    if (feedbackForwardingEmailAddressIdentityArn != null)
      'FeedbackForwardingEmailAddressIdentityArn':
          feedbackForwardingEmailAddressIdentityArn,
    if (fromEmailAddress != null) 'FromEmailAddress': fromEmailAddress,
    if (fromEmailAddressIdentityArn != null)
      'FromEmailAddressIdentityArn': fromEmailAddressIdentityArn,
    if (listManagementOptions != null)
      'ListManagementOptions': listManagementOptions,
    if (replyToAddresses != null) 'ReplyToAddresses': replyToAddresses,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/v2/email/outbound-emails',
    exceptionFnMap: _exceptionFns,
  );
  return SendEmailResponse.fromJson(response);
}