DkimAttributes (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.simpleemailv2.model.DkimAttributes

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DkimAttributes
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DkimAttributes()

Constructors
Constructor and Description
`DkimAttributes()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DkimAttributes`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getSigningAttributesOrigin()` A string that indicates how DKIM was configured for the identity.
`Boolean`	`getSigningEnabled()` If the value is `true`, then the messages that you send from the identity are signed using DKIM.
`String`	`getStatus()` Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain.
`List<String>`	`getTokens()` 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.
`int`	`hashCode()`
`Boolean`	`isSigningEnabled()` If the value is `true`, then the messages that you send from the identity are signed using DKIM.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setSigningAttributesOrigin(String signingAttributesOrigin)` A string that indicates how DKIM was configured for the identity.
`void`	`setSigningEnabled(Boolean signingEnabled)` If the value is `true`, then the messages that you send from the identity are signed using DKIM.
`void`	`setStatus(String status)` Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain.
`void`	`setTokens(Collection<String> tokens)` 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.
`String`	`toString()` Returns a string representation of this object.
`DkimAttributes`	`withSigningAttributesOrigin(DkimSigningAttributesOrigin signingAttributesOrigin)` A string that indicates how DKIM was configured for the identity.
`DkimAttributes`	`withSigningAttributesOrigin(String signingAttributesOrigin)` A string that indicates how DKIM was configured for the identity.
`DkimAttributes`	`withSigningEnabled(Boolean signingEnabled)` If the value is `true`, then the messages that you send from the identity are signed using DKIM.
`DkimAttributes`	`withStatus(DkimStatus status)` Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain.
`DkimAttributes`	`withStatus(String status)` Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain.
`DkimAttributes`	`withTokens(Collection<String> tokens)` 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.
`DkimAttributes`	`withTokens(String... tokens)` 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.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DkimAttributes
```
public DkimAttributes()
```
- Method Detail
  - setSigningEnabled
```
public void setSigningEnabled(Boolean signingEnabled)
```
    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.
    
    Parameters:
    
    signingEnabled - 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.
  - getSigningEnabled
```
public Boolean getSigningEnabled()
```
    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.
    
    Returns:
    
    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.
  - withSigningEnabled
```
public DkimAttributes withSigningEnabled(Boolean signingEnabled)
```
    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.
    
    Parameters:
    
    signingEnabled - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isSigningEnabled
```
public Boolean isSigningEnabled()
```
    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.
    
    Returns:
    
    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.
  - setStatus
```
public void setStatus(String status)
```
    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.
    Parameters:
    status - 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.
    See Also:
    
    DkimStatus
  - getStatus
```
public String getStatus()
```
    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.
    Returns:
    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.
    See Also:
    
    DkimStatus
  - withStatus
```
public DkimAttributes withStatus(String status)
```
    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.
    Parameters:
    status - 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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DkimStatus
  - withStatus
```
public DkimAttributes withStatus(DkimStatus status)
```
    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.
    Parameters:
    status - 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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DkimStatus
  - getTokens
```
public List<String> getTokens()
```
    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.
    
    Returns:
    
    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.
  - setTokens
```
public void setTokens(Collection<String> tokens)
```
    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.
    
    Parameters:
    
    tokens - 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.
  - withTokens
```
public DkimAttributes withTokens(String... tokens)
```
    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.
    
    NOTE: This method appends the values to the existing list (if any). Use setTokens(java.util.Collection) or withTokens(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tokens - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTokens
```
public DkimAttributes withTokens(Collection<String> tokens)
```
    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.
    
    Parameters:
    
    tokens - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSigningAttributesOrigin
```
public void setSigningAttributesOrigin(String signingAttributesOrigin)
```
    A string that indicates how DKIM was configured for the identity. There are two 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).
    Parameters:
    signingAttributesOrigin - A string that indicates how DKIM was configured for the identity. There are two 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).
    See Also:
    
    DkimSigningAttributesOrigin
  - getSigningAttributesOrigin
```
public String getSigningAttributesOrigin()
```
    A string that indicates how DKIM was configured for the identity. There are two 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).
    Returns:
    A string that indicates how DKIM was configured for the identity. There are two 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).
    See Also:
    
    DkimSigningAttributesOrigin
  - withSigningAttributesOrigin
```
public DkimAttributes withSigningAttributesOrigin(String signingAttributesOrigin)
```
    A string that indicates how DKIM was configured for the identity. There are two 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).
    Parameters:
    signingAttributesOrigin - A string that indicates how DKIM was configured for the identity. There are two 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).
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DkimSigningAttributesOrigin
  - withSigningAttributesOrigin
```
public DkimAttributes withSigningAttributesOrigin(DkimSigningAttributesOrigin signingAttributesOrigin)
```
    A string that indicates how DKIM was configured for the identity. There are two 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).
    Parameters:
    signingAttributesOrigin - A string that indicates how DKIM was configured for the identity. There are two 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).
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DkimSigningAttributesOrigin
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DkimAttributes clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class DkimAttributes

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DkimAttributes

Method Detail

setSigningEnabled

getSigningEnabled

withSigningEnabled

isSigningEnabled

setStatus

getStatus

withStatus

withStatus

getTokens

setTokens

withTokens

withTokens

setSigningAttributesOrigin

getSigningAttributesOrigin

withSigningAttributesOrigin

withSigningAttributesOrigin

toString

equals

hashCode

clone

marshall