Class MailFromAttributes
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<MailFromAttributes.Builder,
MailFromAttributes>
A list of attributes that are associated with a MAIL FROM domain.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal BehaviorOnMxFailure
The action to take if the required MX record can't be found when you send an email.final String
The action to take if the required MX record can't be found when you send an email.static MailFromAttributes.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
The name of a domain that an email identity uses as a custom MAIL FROM domain.final MailFromDomainStatus
The status of the MAIL FROM domain.final String
The status of the MAIL FROM domain.static Class
<? extends MailFromAttributes.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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:
-
-
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:
-
-
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:
-
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:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<MailFromAttributes.Builder,
MailFromAttributes> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-