sendEmail method

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

Sends an email message. You can use the Amazon Pinpoint Email API 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 Pinpoint 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.

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 or a Raw message.

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

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

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 Amazon Pinpoint should send bounce and complaint notifications to.

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 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,
  required Destination destination,
  String? configurationSetName,
  List<MessageTag>? emailTags,
  String? feedbackForwardingEmailAddress,
  String? fromEmailAddress,
  List<String>? replyToAddresses,
}) async {
  ArgumentError.checkNotNull(content, 'content');
  ArgumentError.checkNotNull(destination, 'destination');
  final $payload = <String, dynamic>{
    'Content': content,
    'Destination': destination,
    if (configurationSetName != null)
      'ConfigurationSetName': configurationSetName,
    if (emailTags != null) 'EmailTags': emailTags,
    if (feedbackForwardingEmailAddress != null)
      'FeedbackForwardingEmailAddress': feedbackForwardingEmailAddress,
    if (fromEmailAddress != null) 'FromEmailAddress': fromEmailAddress,
    if (replyToAddresses != null) 'ReplyToAddresses': replyToAddresses,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/v1/email/outbound-emails',
    exceptionFnMap: _exceptionFns,
  );
  return SendEmailResponse.fromJson(response);
}