putEmailIdentityMailFromAttributes method

Future<void> putEmailIdentityMailFromAttributes({ required String emailIdentity, BehaviorOnMxFailure? behaviorOnMxFailure, String? mailFromDomain, })

Used to enable or disable the custom Mail-From domain configuration for an email identity.

May throw NotFoundException. May throw TooManyRequestsException. May throw BadRequestException.

Parameter emailIdentity : The verified email identity that you want to set up the custom MAIL FROM domain for.

Parameter behaviorOnMxFailure : The action that you want Amazon Pinpoint to take if it can't read the required MX record when you send an email. When you set this value to UseDefaultValue, Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, Amazon Pinpoint returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email.

These behaviors are taken when the custom MAIL FROM domain configuration is in the Pending, Failed, and TemporaryFailure states.

Parameter mailFromDomain : The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM domain must meet the following criteria:

• It has to be a subdomain of the verified identity.
• It can't be used to receive email.
• It can't be used in a "From" address if the MAIL FROM domain is a destination for feedback forwarding emails.

Implementation

Future<void> putEmailIdentityMailFromAttributes({
  required String emailIdentity,
  BehaviorOnMxFailure? behaviorOnMxFailure,
  String? mailFromDomain,
}) async {
  ArgumentError.checkNotNull(emailIdentity, 'emailIdentity');
  final $payload = <String, dynamic>{
    if (behaviorOnMxFailure != null)
      'BehaviorOnMxFailure': behaviorOnMxFailure.toValue(),
    if (mailFromDomain != null) 'MailFromDomain': mailFromDomain,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'PUT',
    requestUri:
        '/v1/email/identities/${Uri.encodeComponent(emailIdentity)}/mail-from',
    exceptionFnMap: _exceptionFns,
  );
}