Class PutEmailIdentityMailFromAttributesRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<PutEmailIdentityMailFromAttributesRequest.Builder,
PutEmailIdentityMailFromAttributesRequest>
A request to configure the custom MAIL FROM domain for a verified identity.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
-
Method Summary
Modifier and TypeMethodDescriptionfinal BehaviorOnMxFailure
The action to take if the required MX record isn't found when you send an email.final String
The action to take if the required MX record isn't found when you send an email.builder()
final String
The verified email identity.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) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final String
The custom MAIL FROM domain that you want the verified identity to use.static Class
<? extends PutEmailIdentityMailFromAttributesRequest.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 class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
emailIdentity
The verified email identity.
- Returns:
- The verified email identity.
-
mailFromDomain
The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM domain must meet the following criteria:
-
It has to be a subdomain of the verified identity.
-
It can't be used to receive email.
-
It can't be used in a "From" address if the MAIL FROM domain is a destination for feedback forwarding emails.
- Returns:
- The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM domain must meet
the following criteria:
-
It has to be a subdomain of the verified identity.
-
It can't be used to receive email.
-
It can't be used in a "From" address if the MAIL FROM domain is a destination for feedback forwarding emails.
-
-
-
behaviorOnMxFailure
The action to take if the required MX record isn't found when you send an email. When you set this value to
UseDefaultValue
, the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value toRejectMessage
, 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 isn't found when you send an email. When you set this value
to
UseDefaultValue
, the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value toRejectMessage
, 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 isn't found when you send an email. When you set this value to
UseDefaultValue
, the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value toRejectMessage
, 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 isn't found when you send an email. When you set this value
to
UseDefaultValue
, the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value toRejectMessage
, 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<PutEmailIdentityMailFromAttributesRequest.Builder,
PutEmailIdentityMailFromAttributesRequest> - Specified by:
toBuilder
in classSesV2Request
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends PutEmailIdentityMailFromAttributesRequest.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-