Package software.amazon.awssdk.services.sesv2.model

Class PutEmailIdentityMailFromAttributesRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.sesv2.model.SesV2Request
software.amazon.awssdk.services.sesv2.model.PutEmailIdentityMailFromAttributesRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<PutEmailIdentityMailFromAttributesRequest.Builder,PutEmailIdentityMailFromAttributesRequest>
@Generated("software.amazon.awssdk:codegen") public final class PutEmailIdentityMailFromAttributesRequest extends SesV2Request implements ToCopyableBuilder<PutEmailIdentityMailFromAttributesRequest.Builder,PutEmailIdentityMailFromAttributesRequest>

A request to configure the custom MAIL FROM domain for a verified identity.

  • Method Details

    • emailIdentity

      public final String emailIdentity()

      The verified email identity.

      Returns:
      The verified email identity.

    • mailFromDomain

      public final String 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

      public final BehaviorOnMxFailure 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 to RejectMessage, the Amazon SES API v2 returns a MailFromDomainNotVerified 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, and TemporaryFailure states.

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

      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 to RejectMessage, the Amazon SES API v2 returns a MailFromDomainNotVerified 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, and TemporaryFailure states.

      See Also:

    • behaviorOnMxFailureAsString

      public final String 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 to RejectMessage, the Amazon SES API v2 returns a MailFromDomainNotVerified 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, and TemporaryFailure states.

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

      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 to RejectMessage, the Amazon SES API v2 returns a MailFromDomainNotVerified 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, and TemporaryFailure states.

      See Also:

    • toBuilder

      public PutEmailIdentityMailFromAttributesRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<PutEmailIdentityMailFromAttributesRequest.Builder,PutEmailIdentityMailFromAttributesRequest>
      Specified by:
      toBuilder in class SesV2Request

    • builder

      public static PutEmailIdentityMailFromAttributesRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo