| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.SES.VerifyDomainDkim
Description
Returns a set of DKIM tokens for a domain identity.
When you execute the VerifyDomainDkim operation, the domain that you
specify is added to the list of identities that are associated with your
account. This is true even if you haven't already associated the domain
with your account by using the VerifyDomainIdentity operation.
However, you can't send email from the domain until you either
successfully
verify it
or you successfully
set up DKIM for it.
You use the tokens that are generated by this operation to create CNAME records. When Amazon SES detects that you've added these records to the DNS configuration for a domain, you can start sending email from that domain. You can start sending email even if you haven't added the TXT record provided by the VerifyDomainIdentity operation to the DNS configuration for your domain. All email that you send from the domain is authenticated using DKIM.
To create the CNAME records for DKIM authentication, use the following values:
- Name: token._domainkey.example.com
- Type: CNAME
- Value: token.dkim.amazonses.com
In the preceding example, replace token with one of the tokens that are generated when you execute this operation. Replace example.com with your domain. Repeat this process for each token that's generated by this operation.
You can execute this operation no more than once per second.
Synopsis
- data VerifyDomainDkim = VerifyDomainDkim' {}
- newVerifyDomainDkim :: Text -> VerifyDomainDkim
- verifyDomainDkim_domain :: Lens' VerifyDomainDkim Text
- data VerifyDomainDkimResponse = VerifyDomainDkimResponse' {
- httpStatus :: Int
- dkimTokens :: [Text]
- newVerifyDomainDkimResponse :: Int -> VerifyDomainDkimResponse
- verifyDomainDkimResponse_httpStatus :: Lens' VerifyDomainDkimResponse Int
- verifyDomainDkimResponse_dkimTokens :: Lens' VerifyDomainDkimResponse [Text]
Creating a Request
data VerifyDomainDkim Source #
Represents a request to generate the CNAME records needed to set up Easy DKIM with Amazon SES. For more information about setting up Easy DKIM, see the Amazon SES Developer Guide.
See: newVerifyDomainDkim smart constructor.
Constructors
| VerifyDomainDkim' | |
Instances
Arguments
| :: Text | |
| -> VerifyDomainDkim |
Create a value of VerifyDomainDkim with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domain:VerifyDomainDkim', verifyDomainDkim_domain - The name of the domain to be verified for Easy DKIM signing.
Request Lenses
verifyDomainDkim_domain :: Lens' VerifyDomainDkim Text Source #
The name of the domain to be verified for Easy DKIM signing.
Destructuring the Response
data VerifyDomainDkimResponse Source #
Returns CNAME records that you must publish to the DNS server of your domain to set up Easy DKIM with Amazon SES.
See: newVerifyDomainDkimResponse smart constructor.
Constructors
| VerifyDomainDkimResponse' | |
Fields
| |
Instances
newVerifyDomainDkimResponse Source #
Create a value of VerifyDomainDkimResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:VerifyDomainDkimResponse', verifyDomainDkimResponse_httpStatus - The response's http status code.
$sel:dkimTokens:VerifyDomainDkimResponse', verifyDomainDkimResponse_dkimTokens - A set of character strings that represent the domain's identity. If the
identity is an email address, the tokens represent the domain of that
address.
Using these tokens, you need to create DNS CNAME records that point to DKIM public keys that are hosted by Amazon SES. Amazon Web Services eventually detects that you've updated your DNS records. This detection process might take up to 72 hours. After successful detection, Amazon SES is able to DKIM-sign email originating from that domain. (This only applies to domain identities, not email address identities.)
For more information about creating DNS records using DKIM tokens, see the Amazon SES Developer Guide.
Response Lenses
verifyDomainDkimResponse_httpStatus :: Lens' VerifyDomainDkimResponse Int Source #
The response's http status code.
verifyDomainDkimResponse_dkimTokens :: Lens' VerifyDomainDkimResponse [Text] Source #
A set of character strings that represent the domain's identity. If the identity is an email address, the tokens represent the domain of that address.
Using these tokens, you need to create DNS CNAME records that point to DKIM public keys that are hosted by Amazon SES. Amazon Web Services eventually detects that you've updated your DNS records. This detection process might take up to 72 hours. After successful detection, Amazon SES is able to DKIM-sign email originating from that domain. (This only applies to domain identities, not email address identities.)
For more information about creating DNS records using DKIM tokens, see the Amazon SES Developer Guide.