Class MailFromAttributes
- java.lang.Object
-
- software.amazon.awssdk.services.sesv2.model.MailFromAttributes
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<MailFromAttributes.Builder,MailFromAttributes>
@Generated("software.amazon.awssdk:codegen") public final class MailFromAttributes extends Object implements SdkPojo, Serializable, ToCopyableBuilder<MailFromAttributes.Builder,MailFromAttributes>
A list of attributes that are associated with a MAIL FROM domain.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
MailFromAttributes.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description BehaviorOnMxFailure
behaviorOnMxFailure()
The action to take if the required MX record can't be found when you send an email.String
behaviorOnMxFailureAsString()
The action to take if the required MX record can't be found when you send an email.static MailFromAttributes.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
String
mailFromDomain()
The name of a domain that an email identity uses as a custom MAIL FROM domain.MailFromDomainStatus
mailFromDomainStatus()
The status of the MAIL FROM domain.String
mailFromDomainStatusAsString()
The status of the MAIL FROM domain.Map<String,SdkField<?>>
sdkFieldNameToField()
List<SdkField<?>>
sdkFields()
static Class<? extends MailFromAttributes.Builder>
serializableBuilderClass()
MailFromAttributes.Builder
toBuilder()
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
-
mailFromDomain
public final String mailFromDomain()
The name of a domain that an email identity uses as a custom MAIL FROM domain.
- Returns:
- The name of a domain that an email identity uses as a custom MAIL FROM domain.
-
mailFromDomainStatus
public final MailFromDomainStatus mailFromDomainStatus()
The status of the MAIL FROM domain. This status can have the following values:
-
PENDING
– Amazon SES hasn't started searching for the MX record yet. -
SUCCESS
– Amazon SES detected the required MX record for the MAIL FROM domain. -
FAILED
– Amazon SES can't find the required MX record, or the record no longer exists. -
TEMPORARY_FAILURE
– A temporary issue occurred, which prevented Amazon SES from determining the status of the MAIL FROM domain.
If the service returns an enum value that is not available in the current SDK version,
mailFromDomainStatus
will returnMailFromDomainStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommailFromDomainStatusAsString()
.- Returns:
- The status of the MAIL FROM domain. This status can have the following values:
-
PENDING
– Amazon SES hasn't started searching for the MX record yet. -
SUCCESS
– Amazon SES detected the required MX record for the MAIL FROM domain. -
FAILED
– Amazon SES can't find the required MX record, or the record no longer exists. -
TEMPORARY_FAILURE
– A temporary issue occurred, which prevented Amazon SES from determining the status of the MAIL FROM domain.
-
- See Also:
MailFromDomainStatus
-
-
mailFromDomainStatusAsString
public final String mailFromDomainStatusAsString()
The status of the MAIL FROM domain. This status can have the following values:
-
PENDING
– Amazon SES hasn't started searching for the MX record yet. -
SUCCESS
– Amazon SES detected the required MX record for the MAIL FROM domain. -
FAILED
– Amazon SES can't find the required MX record, or the record no longer exists. -
TEMPORARY_FAILURE
– A temporary issue occurred, which prevented Amazon SES from determining the status of the MAIL FROM domain.
If the service returns an enum value that is not available in the current SDK version,
mailFromDomainStatus
will returnMailFromDomainStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommailFromDomainStatusAsString()
.- Returns:
- The status of the MAIL FROM domain. This status can have the following values:
-
PENDING
– Amazon SES hasn't started searching for the MX record yet. -
SUCCESS
– Amazon SES detected the required MX record for the MAIL FROM domain. -
FAILED
– Amazon SES can't find the required MX record, or the record no longer exists. -
TEMPORARY_FAILURE
– A temporary issue occurred, which prevented Amazon SES from determining the status of the MAIL FROM domain.
-
- See Also:
MailFromDomainStatus
-
-
behaviorOnMxFailure
public final BehaviorOnMxFailure behaviorOnMxFailure()
The action to take if the required MX record can't be found when you send an email. When you set this value to
USE_DEFAULT_VALUE
, the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value toREJECT_MESSAGE
, the Amazon SES API v2 returns aMailFromDomainNotVerified
error, and doesn't attempt to deliver the email.These behaviors are taken when the custom MAIL FROM domain configuration is in the
Pending
,Failed
, andTemporaryFailure
states.If the service returns an enum value that is not available in the current SDK version,
behaviorOnMxFailure
will returnBehaviorOnMxFailure.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frombehaviorOnMxFailureAsString()
.- Returns:
- The action to take if the required MX record can't be found when you send an email. When you set this
value to
USE_DEFAULT_VALUE
, the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value toREJECT_MESSAGE
, the Amazon SES API v2 returns aMailFromDomainNotVerified
error, and doesn't attempt to deliver the email.These behaviors are taken when the custom MAIL FROM domain configuration is in the
Pending
,Failed
, andTemporaryFailure
states. - See Also:
BehaviorOnMxFailure
-
behaviorOnMxFailureAsString
public final String behaviorOnMxFailureAsString()
The action to take if the required MX record can't be found when you send an email. When you set this value to
USE_DEFAULT_VALUE
, the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value toREJECT_MESSAGE
, the Amazon SES API v2 returns aMailFromDomainNotVerified
error, and doesn't attempt to deliver the email.These behaviors are taken when the custom MAIL FROM domain configuration is in the
Pending
,Failed
, andTemporaryFailure
states.If the service returns an enum value that is not available in the current SDK version,
behaviorOnMxFailure
will returnBehaviorOnMxFailure.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frombehaviorOnMxFailureAsString()
.- Returns:
- The action to take if the required MX record can't be found when you send an email. When you set this
value to
USE_DEFAULT_VALUE
, the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value toREJECT_MESSAGE
, the Amazon SES API v2 returns aMailFromDomainNotVerified
error, and doesn't attempt to deliver the email.These behaviors are taken when the custom MAIL FROM domain configuration is in the
Pending
,Failed
, andTemporaryFailure
states. - See Also:
BehaviorOnMxFailure
-
toBuilder
public MailFromAttributes.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<MailFromAttributes.Builder,MailFromAttributes>
-
builder
public static MailFromAttributes.Builder builder()
-
serializableBuilderClass
public static Class<? extends MailFromAttributes.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final 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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
-
-