software.amazon.awssdk.services.sesv2.model

Class DkimAttributes

java.lang.Object

software.amazon.awssdk.services.sesv2.model.DkimAttributes

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DkimAttributes.Builder,DkimAttributes>

@Generated(value="software.amazon.awssdk:codegen")
public final class DkimAttributes
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DkimAttributes.Builder,DkimAttributes>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DkimAttributes.Builder

Method Summary

Modifier and Type	Method and Description
static DkimAttributes.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends DkimAttributes.Builder>	serializableBuilderClass()
Boolean	signingEnabled() If the value is true, then the messages that you send from the identity are signed using DKIM.
DkimStatus	status() Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain.
String	statusAsString() Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain.
DkimAttributes.Builder	toBuilder()
List<String>	tokens() 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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

signingEnabled

public 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.

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.

status

public 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 – Amazon SES hasn't yet detected the DKIM records in the DNS configuration for the domain, but will continue to attempt to locate them.

• SUCCESS – Amazon SES located the DKIM records in the DNS configuration for the domain and determined that they're correct. You can now send DKIM-signed email from the identity.

• FAILED – Amazon SES wasn't able to locate the DKIM records in the DNS settings for the domain, and won't continue to search for them.

• TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon SES from determining the DKIM status for the domain.

• NOT_STARTED – Amazon SES hasn't yet started searching for the DKIM records in the DKIM records for the domain.

If the service returns an enum value that is not available in the current SDK version, status will return DkimStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

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 – Amazon SES hasn't yet detected the DKIM records in the DNS configuration for the domain, but will continue to attempt to locate them.

• SUCCESS – Amazon SES located the DKIM records in the DNS configuration for the domain and determined that they're correct. You can now send DKIM-signed email from the identity.

• FAILED – Amazon SES wasn't able to locate the DKIM records in the DNS settings for the domain, and won't continue to search for them.

• TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon SES from determining the DKIM status for the domain.

• NOT_STARTED – Amazon SES hasn't yet started searching for the DKIM records in the DKIM records for the domain.

See Also:

DkimStatus

statusAsString

public String statusAsString()

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 – Amazon SES hasn't yet detected the DKIM records in the DNS configuration for the domain, but will continue to attempt to locate them.

• SUCCESS – Amazon SES located the DKIM records in the DNS configuration for the domain and determined that they're correct. You can now send DKIM-signed email from the identity.

• FAILED – Amazon SES wasn't able to locate the DKIM records in the DNS settings for the domain, and won't continue to search for them.

• TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon SES from determining the DKIM status for the domain.

• NOT_STARTED – Amazon SES hasn't yet started searching for the DKIM records in the DKIM records for the domain.

If the service returns an enum value that is not available in the current SDK version, status will return DkimStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

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 – Amazon SES hasn't yet detected the DKIM records in the DNS configuration for the domain, but will continue to attempt to locate them.

• SUCCESS – Amazon SES located the DKIM records in the DNS configuration for the domain and determined that they're correct. You can now send DKIM-signed email from the identity.

• FAILED – Amazon SES wasn't able to locate the DKIM records in the DNS settings for the domain, and won't continue to search for them.

• TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon SES from determining the DKIM status for the domain.

• NOT_STARTED – Amazon SES hasn't yet started searching for the DKIM records in the DKIM records for the domain.

See Also:

DkimStatus

tokens

public List<String> tokens()

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. Amazon SES usually detects these records within about 72 hours of adding them to the DNS configuration for your domain.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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. Amazon SES usually detects these records within about 72 hours of adding them to the DNS configuration for your domain.

toBuilder

public DkimAttributes.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DkimAttributes.Builder,DkimAttributes>

builder

public static DkimAttributes.Builder builder()

serializableBuilderClass

public static Class<? extends DkimAttributes.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo