putEmailIdentityDkimAttributes method

Future<void> putEmailIdentityDkimAttributes({ required String emailIdentity, bool? signingEnabled, })

Used to enable or disable DKIM authentication for an email identity.

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

Parameter emailIdentity : The email identity that you want to change the DKIM settings for.

Parameter signingEnabled : Sets the DKIM signing configuration for the identity.

When you set this value true, then the messages that are sent from the identity are signed using DKIM. If you set this value to false, your messages are sent without DKIM signing.

Implementation

Future<void> putEmailIdentityDkimAttributes({
  required String emailIdentity,
  bool? signingEnabled,
}) async {
  ArgumentError.checkNotNull(emailIdentity, 'emailIdentity');
  _s.validateStringLength(
    'emailIdentity',
    emailIdentity,
    1,
    1152921504606846976,
    isRequired: true,
  );
  final $payload = <String, dynamic>{
    if (signingEnabled != null) 'SigningEnabled': signingEnabled,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'PUT',
    requestUri:
        '/v2/email/identities/${Uri.encodeComponent(emailIdentity)}/dkim',
    exceptionFnMap: _exceptionFns,
  );
}