Class IdentityMailFromDomainAttributes

java.lang.Object
com.amazonaws.services.simpleemail.model.IdentityMailFromDomainAttributes
All Implemented Interfaces:
Serializable, Cloneable

public class IdentityMailFromDomainAttributes extends Object implements Serializable, Cloneable

Represents the custom MAIL FROM domain attributes of a verified identity (email address or domain).

See Also:
  • Constructor Details

    • IdentityMailFromDomainAttributes

      public IdentityMailFromDomainAttributes()
  • Method Details

    • setMailFromDomain

      public void setMailFromDomain(String mailFromDomain)

      The custom MAIL FROM domain that the identity is configured to use.

      Parameters:
      mailFromDomain - The custom MAIL FROM domain that the identity is configured to use.
    • getMailFromDomain

      public String getMailFromDomain()

      The custom MAIL FROM domain that the identity is configured to use.

      Returns:
      The custom MAIL FROM domain that the identity is configured to use.
    • withMailFromDomain

      public IdentityMailFromDomainAttributes withMailFromDomain(String mailFromDomain)

      The custom MAIL FROM domain that the identity is configured to use.

      Parameters:
      mailFromDomain - The custom MAIL FROM domain that the identity is configured to use.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setMailFromDomainStatus

      public void setMailFromDomainStatus(String mailFromDomainStatus)

      The state that indicates whether Amazon SES has successfully read the MX record required for custom MAIL FROM domain setup. If the state is Success, Amazon SES uses the specified custom MAIL FROM domain when the verified identity sends an email. All other states indicate that Amazon SES takes the action described by BehaviorOnMXFailure.

      Parameters:
      mailFromDomainStatus - The state that indicates whether Amazon SES has successfully read the MX record required for custom MAIL FROM domain setup. If the state is Success, Amazon SES uses the specified custom MAIL FROM domain when the verified identity sends an email. All other states indicate that Amazon SES takes the action described by BehaviorOnMXFailure.
      See Also:
    • getMailFromDomainStatus

      public String getMailFromDomainStatus()

      The state that indicates whether Amazon SES has successfully read the MX record required for custom MAIL FROM domain setup. If the state is Success, Amazon SES uses the specified custom MAIL FROM domain when the verified identity sends an email. All other states indicate that Amazon SES takes the action described by BehaviorOnMXFailure.

      Returns:
      The state that indicates whether Amazon SES has successfully read the MX record required for custom MAIL FROM domain setup. If the state is Success, Amazon SES uses the specified custom MAIL FROM domain when the verified identity sends an email. All other states indicate that Amazon SES takes the action described by BehaviorOnMXFailure.
      See Also:
    • withMailFromDomainStatus

      public IdentityMailFromDomainAttributes withMailFromDomainStatus(String mailFromDomainStatus)

      The state that indicates whether Amazon SES has successfully read the MX record required for custom MAIL FROM domain setup. If the state is Success, Amazon SES uses the specified custom MAIL FROM domain when the verified identity sends an email. All other states indicate that Amazon SES takes the action described by BehaviorOnMXFailure.

      Parameters:
      mailFromDomainStatus - The state that indicates whether Amazon SES has successfully read the MX record required for custom MAIL FROM domain setup. If the state is Success, Amazon SES uses the specified custom MAIL FROM domain when the verified identity sends an email. All other states indicate that Amazon SES takes the action described by BehaviorOnMXFailure.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setMailFromDomainStatus

      public void setMailFromDomainStatus(CustomMailFromStatus mailFromDomainStatus)

      The state that indicates whether Amazon SES has successfully read the MX record required for custom MAIL FROM domain setup. If the state is Success, Amazon SES uses the specified custom MAIL FROM domain when the verified identity sends an email. All other states indicate that Amazon SES takes the action described by BehaviorOnMXFailure.

      Parameters:
      mailFromDomainStatus - The state that indicates whether Amazon SES has successfully read the MX record required for custom MAIL FROM domain setup. If the state is Success, Amazon SES uses the specified custom MAIL FROM domain when the verified identity sends an email. All other states indicate that Amazon SES takes the action described by BehaviorOnMXFailure.
      See Also:
    • withMailFromDomainStatus

      public IdentityMailFromDomainAttributes withMailFromDomainStatus(CustomMailFromStatus mailFromDomainStatus)

      The state that indicates whether Amazon SES has successfully read the MX record required for custom MAIL FROM domain setup. If the state is Success, Amazon SES uses the specified custom MAIL FROM domain when the verified identity sends an email. All other states indicate that Amazon SES takes the action described by BehaviorOnMXFailure.

      Parameters:
      mailFromDomainStatus - The state that indicates whether Amazon SES has successfully read the MX record required for custom MAIL FROM domain setup. If the state is Success, Amazon SES uses the specified custom MAIL FROM domain when the verified identity sends an email. All other states indicate that Amazon SES takes the action described by BehaviorOnMXFailure.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setBehaviorOnMXFailure

      public void setBehaviorOnMXFailure(String behaviorOnMXFailure)

      The action that Amazon SES takes if it cannot successfully read the required MX record when you send an email. A value of UseDefaultValue indicates that if Amazon SES cannot read the required MX record, it uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. A value of RejectMessage indicates that if Amazon SES cannot read the required MX record, Amazon SES returns a MailFromDomainNotVerified error and does not send the email.

      The custom MAIL FROM setup states that result in this behavior are Pending, Failed, and TemporaryFailure.

      Parameters:
      behaviorOnMXFailure - The action that Amazon SES takes if it cannot successfully read the required MX record when you send an email. A value of UseDefaultValue indicates that if Amazon SES cannot read the required MX record, it uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. A value of RejectMessage indicates that if Amazon SES cannot read the required MX record, Amazon SES returns a MailFromDomainNotVerified error and does not send the email.

      The custom MAIL FROM setup states that result in this behavior are Pending, Failed, and TemporaryFailure.

      See Also:
    • getBehaviorOnMXFailure

      public String getBehaviorOnMXFailure()

      The action that Amazon SES takes if it cannot successfully read the required MX record when you send an email. A value of UseDefaultValue indicates that if Amazon SES cannot read the required MX record, it uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. A value of RejectMessage indicates that if Amazon SES cannot read the required MX record, Amazon SES returns a MailFromDomainNotVerified error and does not send the email.

      The custom MAIL FROM setup states that result in this behavior are Pending, Failed, and TemporaryFailure.

      Returns:
      The action that Amazon SES takes if it cannot successfully read the required MX record when you send an email. A value of UseDefaultValue indicates that if Amazon SES cannot read the required MX record, it uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. A value of RejectMessage indicates that if Amazon SES cannot read the required MX record, Amazon SES returns a MailFromDomainNotVerified error and does not send the email.

      The custom MAIL FROM setup states that result in this behavior are Pending, Failed, and TemporaryFailure.

      See Also:
    • withBehaviorOnMXFailure

      public IdentityMailFromDomainAttributes withBehaviorOnMXFailure(String behaviorOnMXFailure)

      The action that Amazon SES takes if it cannot successfully read the required MX record when you send an email. A value of UseDefaultValue indicates that if Amazon SES cannot read the required MX record, it uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. A value of RejectMessage indicates that if Amazon SES cannot read the required MX record, Amazon SES returns a MailFromDomainNotVerified error and does not send the email.

      The custom MAIL FROM setup states that result in this behavior are Pending, Failed, and TemporaryFailure.

      Parameters:
      behaviorOnMXFailure - The action that Amazon SES takes if it cannot successfully read the required MX record when you send an email. A value of UseDefaultValue indicates that if Amazon SES cannot read the required MX record, it uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. A value of RejectMessage indicates that if Amazon SES cannot read the required MX record, Amazon SES returns a MailFromDomainNotVerified error and does not send the email.

      The custom MAIL FROM setup states that result in this behavior are Pending, Failed, and TemporaryFailure.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setBehaviorOnMXFailure

      public void setBehaviorOnMXFailure(BehaviorOnMXFailure behaviorOnMXFailure)

      The action that Amazon SES takes if it cannot successfully read the required MX record when you send an email. A value of UseDefaultValue indicates that if Amazon SES cannot read the required MX record, it uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. A value of RejectMessage indicates that if Amazon SES cannot read the required MX record, Amazon SES returns a MailFromDomainNotVerified error and does not send the email.

      The custom MAIL FROM setup states that result in this behavior are Pending, Failed, and TemporaryFailure.

      Parameters:
      behaviorOnMXFailure - The action that Amazon SES takes if it cannot successfully read the required MX record when you send an email. A value of UseDefaultValue indicates that if Amazon SES cannot read the required MX record, it uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. A value of RejectMessage indicates that if Amazon SES cannot read the required MX record, Amazon SES returns a MailFromDomainNotVerified error and does not send the email.

      The custom MAIL FROM setup states that result in this behavior are Pending, Failed, and TemporaryFailure.

      See Also:
    • withBehaviorOnMXFailure

      public IdentityMailFromDomainAttributes withBehaviorOnMXFailure(BehaviorOnMXFailure behaviorOnMXFailure)

      The action that Amazon SES takes if it cannot successfully read the required MX record when you send an email. A value of UseDefaultValue indicates that if Amazon SES cannot read the required MX record, it uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. A value of RejectMessage indicates that if Amazon SES cannot read the required MX record, Amazon SES returns a MailFromDomainNotVerified error and does not send the email.

      The custom MAIL FROM setup states that result in this behavior are Pending, Failed, and TemporaryFailure.

      Parameters:
      behaviorOnMXFailure - The action that Amazon SES takes if it cannot successfully read the required MX record when you send an email. A value of UseDefaultValue indicates that if Amazon SES cannot read the required MX record, it uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. A value of RejectMessage indicates that if Amazon SES cannot read the required MX record, Amazon SES returns a MailFromDomainNotVerified error and does not send the email.

      The custom MAIL FROM setup states that result in this behavior are Pending, Failed, and TemporaryFailure.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • toString

      public String toString()
      Returns a string representation of this object; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      Overrides:
      clone in class Object