createEmailIdentity method

Future<CreateEmailIdentityResponse> createEmailIdentity({ required String emailIdentity, DkimSigningAttributes? dkimSigningAttributes, List<Tag>? tags, })

Starts the process of verifying an email identity. An identity is an email address or domain that you use when you send email. Before you can use an identity to send email, you first have to verify it. By verifying an identity, you demonstrate that you're the owner of the identity, and that you've given Amazon SES API v2 permission to send email from the identity.

When you verify an email address, Amazon SES sends an email to the address. Your email address is verified as soon as you follow the link in the verification email.

When you verify a domain without specifying the DkimSigningAttributes object, this operation provides a set of DKIM tokens. You can convert these tokens into CNAME records, which you then add to the DNS configuration for your domain. Your domain is verified when Amazon SES detects these records in the DNS configuration for your domain. This verification method is known as Easy DKIM.

Alternatively, you can perform the verification process by providing your own public-private key pair. This verification method is known as Bring Your Own DKIM (BYODKIM). To use BYODKIM, your call to the CreateEmailIdentity operation has to include the DkimSigningAttributes object. When you specify this object, you provide a selector (a component of the DNS record name that identifies the public key that you want to use for DKIM authentication) and a private key.

May throw AlreadyExistsException. May throw LimitExceededException. May throw TooManyRequestsException. May throw BadRequestException. May throw ConcurrentModificationException.

Parameter emailIdentity : The email address or domain that you want to verify.

Parameter dkimSigningAttributes : If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, as opposed to the default method, Easy DKIM.

You can only specify this object if the email identity is a domain, as opposed to an address.

Parameter tags : An array of objects that define the tags (keys and values) that you want to associate with the email identity.

Implementation

Future<CreateEmailIdentityResponse> createEmailIdentity({
  required String emailIdentity,
  DkimSigningAttributes? dkimSigningAttributes,
  List<Tag>? tags,
}) async {
  ArgumentError.checkNotNull(emailIdentity, 'emailIdentity');
  _s.validateStringLength(
    'emailIdentity',
    emailIdentity,
    1,
    1152921504606846976,
    isRequired: true,
  );
  final $payload = <String, dynamic>{
    'EmailIdentity': emailIdentity,
    if (dkimSigningAttributes != null)
      'DkimSigningAttributes': dkimSigningAttributes,
    if (tags != null) 'Tags': tags,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/v2/email/identities',
    exceptionFnMap: _exceptionFns,
  );
  return CreateEmailIdentityResponse.fromJson(response);
}