Dkim1 signature¶
DKIM Signature¶
Selector¶
Selector used to locate the DKIM public key in DNS.
Text. Name in the API: selector.
Domain¶
Identifier for the domain this DKIM signature is associated with.
One of your Domains, chosen from a list. Name in the API: domainId.
Tenant¶
Identifier for the tenant this DKIM signature belongs to.
One of your Tenants, chosen from a list. Name in the API: memberTenantId.
Options¶
Signed Headers¶
List of message headers to include in the DKIM signature.
A list. Each one: text. Default: Date, From, Message-ID, Subject…. Name in the API: headers.
Canonicalization¶
Canonicalization algorithm applied to the headers and body before signing.
One of: Relaxed/Relaxed (relaxed/relaxed), Simple/Simple (simple/simple), Relaxed/Simple (relaxed/simple), Simple/Relaxed (simple/relaxed). Default: Relaxed/Relaxed. Name in the API: canonicalization.
Expiration¶
Time after which this DKIM signature expires and should no longer be considered valid.
A length of time. Name in the API: expire.
Request Reports¶
Whether to request failure reports when signature verification fails on the recipient side.
On or off. Default: On. Name in the API: report.
Agent User ID¶
Agent or user identifier included in the DKIM signature header.
Text. Name in the API: auid.
Authorized Third-Party Signatures¶
Authorized Party¶
Authorized third-party signature value, used when signing on behalf of another domain.
Text. Name in the API: thirdParty.
Hash Algorithm¶
Hashing algorithm used to verify the authorized third-party signature DNS record.
One of: SHA-256 (sha256), SHA-1 (sha1). Name in the API: thirdPartyHash.
Key¶
Private Key¶
PEM-encoded private key used to sign outgoing messages.
Settings of their own: see Secret text. Name in the API: privateKey.
Public Key¶
PEM-encoded public key used to verify signatures, derived from the private key.
Text, over several lines if needed. Read only. Name in the API: publicKey.
Rotation¶
Rotation Stage¶
Current stage of the DKIM key in its rotation lifecycle.
One of: DKIM key is published in DNS and used for signing (active), DKIM key is scheduled for DNS publication and not yet active (pending), DKIM key has been superseded by a new key but still published in DNS (retiring), DKIM key has been removed from DNS and is pending deletion (retired). Default: DKIM key is published in DNS and used for signing. Name in the API: stage.
Created At¶
Creation date of the DKIM signature.
A date and time. Read only. Name in the API: createdAt.
Next Transition¶
Date when this key will transition to the next rotation stage, or null if no transition is scheduled.
A date and time. Name in the API: nextTransitionAt.