SES / Client / set_identity_dkim_enabled

set_identity_dkim_enabled#

SES.Client.set_identity_dkim_enabled(**kwargs)#

Enables or disables Easy DKIM signing of email sent from an identity. If Easy DKIM signing is enabled for a domain, then Amazon SES uses DKIM to sign all email that it sends from addresses on that domain. If Easy DKIM signing is enabled for an email address, then Amazon SES uses DKIM to sign all email it sends from that address.

Note

For email addresses (for example, user@example.com), you can only enable DKIM signing if the corresponding domain (in this case, example.com) has been set up to use Easy DKIM.

You can enable DKIM signing for an identity at any time after you start the verification process for the identity, even if the verification process isn’t complete.

You can execute this operation no more than once per second.

For more information about Easy DKIM signing, go to the Amazon SES Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.set_identity_dkim_enabled(
    Identity='string',
    DkimEnabled=True|False
)
Parameters:

  • Identity (string) –

    [REQUIRED]

    The identity for which DKIM signing should be enabled or disabled.

  • DkimEnabled (boolean) –

    [REQUIRED]

    Sets whether DKIM signing is enabled for an identity. Set to true to enable DKIM signing for this identity; false to disable it.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

    An empty element returned on a successful request.

Examples

The following example configures Amazon SES to Easy DKIM-sign the email sent from an identity:

response = client.set_identity_dkim_enabled(
    DkimEnabled=True,
    Identity='user@example.com',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}