Struct aws_sdk_sesv2::types::DkimAttributes

#[non_exhaustive]
pub struct DkimAttributes {
    pub signing_enabled: bool,
    pub status: Option<DkimStatus>,
    pub tokens: Option<Vec<String>>,
    pub signing_attributes_origin: Option<DkimSigningAttributesOrigin>,
    pub next_signing_key_length: Option<DkimSigningKeyLength>,
    pub current_signing_key_length: Option<DkimSigningKeyLength>,
    pub last_key_generation_timestamp: Option<DateTime>,
}

An object that contains information about the DKIM authentication status for an email identity.

Amazon SES determines the authentication status by searching for specific records in the DNS configuration for the domain. If you used Easy DKIM to set up DKIM authentication, Amazon SES tries to find three unique CNAME records in the DNS configuration for your domain. If you provided a public key to perform DKIM authentication, Amazon SES tries to find a TXT record that uses the selector that you specified. The value of the TXT record must be a public key that's paired with the private key that you specified in the process of creating the identity

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

signing_enabled: bool

If the value is true, then the messages that you send from the identity are signed using DKIM. If the value is false, then the messages that you send from the identity aren't DKIM-signed.

status: Option<DkimStatus>

Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain. The status can be one of the following:

• PENDING – The verification process was initiated, but Amazon SES hasn't yet detected the DKIM records in the DNS configuration for the domain.

• SUCCESS – The verification process completed successfully.

• FAILED – The verification process failed. This typically occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the domain.

• TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES from determining the DKIM authentication status of the domain.

• NOT_STARTED – The DKIM verification process hasn't been initiated for the domain.

tokens: Option<Vec<String>>

If you used Easy DKIM to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete.

If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector for the public key.

Regardless of the DKIM authentication method you use, Amazon SES searches for the appropriate records in the DNS configuration of the domain for up to 72 hours.

signing_attributes_origin: Option<DkimSigningAttributesOrigin>

A string that indicates how DKIM was configured for the identity. These are the possible values:

• AWS_SES – Indicates that DKIM was configured for the identity by using Easy DKIM.

• EXTERNAL – Indicates that DKIM was configured for the identity by using Bring Your Own DKIM (BYODKIM).

next_signing_key_length: Option<DkimSigningKeyLength>

\[Easy DKIM\] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.

current_signing_key_length: Option<DkimSigningKeyLength>

\[Easy DKIM\] The key length of the DKIM key pair in use.

last_key_generation_timestamp: Option<DateTime>

\[Easy DKIM\] The last time a key pair was generated for this identity.

Implementations

impl DkimAttributes

pub fn signing_enabled(&self) -> bool

If the value is true, then the messages that you send from the identity are signed using DKIM. If the value is false, then the messages that you send from the identity aren't DKIM-signed.

pub fn status(&self) -> Option<&DkimStatus>

Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain. The status can be one of the following:

• PENDING – The verification process was initiated, but Amazon SES hasn't yet detected the DKIM records in the DNS configuration for the domain.

• SUCCESS – The verification process completed successfully.

• FAILED – The verification process failed. This typically occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the domain.

• TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES from determining the DKIM authentication status of the domain.

• NOT_STARTED – The DKIM verification process hasn't been initiated for the domain.

pub fn tokens(&self) -> &[String]

If you used Easy DKIM to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete.

If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector for the public key.

Regardless of the DKIM authentication method you use, Amazon SES searches for the appropriate records in the DNS configuration of the domain for up to 72 hours.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tokens.is_none().

pub fn signing_attributes_origin(&self) -> Option<&DkimSigningAttributesOrigin>

A string that indicates how DKIM was configured for the identity. These are the possible values:

• AWS_SES – Indicates that DKIM was configured for the identity by using Easy DKIM.

• EXTERNAL – Indicates that DKIM was configured for the identity by using Bring Your Own DKIM (BYODKIM).

pub fn next_signing_key_length(&self) -> Option<&DkimSigningKeyLength>

\[Easy DKIM\] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.

pub fn current_signing_key_length(&self) -> Option<&DkimSigningKeyLength>

\[Easy DKIM\] The key length of the DKIM key pair in use.

pub fn last_key_generation_timestamp(&self) -> Option<&DateTime>

\[Easy DKIM\] The last time a key pair was generated for this identity.

impl DkimAttributes

pub fn builder() -> DkimAttributesBuilder

Creates a new builder-style object to manufacture DkimAttributes.

Trait Implementations

impl Clone for DkimAttributes

fn clone(&self) -> DkimAttributes

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DkimAttributes

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for DkimAttributes

fn eq(&self, other: &DkimAttributes) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DkimAttributes