public class SetIdentityMailFromDomainRequest extends AmazonWebServiceRequest implements java.io.Serializable
Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain).
To send emails using the specified MAIL FROM domain, you must add an MX record to your MAIL FROM domain's DNS settings. If you want your emails to pass Sender Policy Framework (SPF) checks, you must also add or update an SPF record. For more information, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
Constructor and Description |
---|
SetIdentityMailFromDomainRequest() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getBehaviorOnMXFailure()
The action that you want Amazon SES to take if it cannot successfully
read the required MX record when you send an email.
|
java.lang.String |
getIdentity()
The verified identity for which you want to enable or disable the
specified custom MAIL FROM domain.
|
java.lang.String |
getMailFromDomain()
The custom MAIL FROM domain that you want the verified identity to use.
|
int |
hashCode() |
void |
setBehaviorOnMXFailure(BehaviorOnMXFailure behaviorOnMXFailure)
The action that you want Amazon SES to take if it cannot successfully
read the required MX record when you send an email.
|
void |
setBehaviorOnMXFailure(java.lang.String behaviorOnMXFailure)
The action that you want Amazon SES to take if it cannot successfully
read the required MX record when you send an email.
|
void |
setIdentity(java.lang.String identity)
The verified identity for which you want to enable or disable the
specified custom MAIL FROM domain.
|
void |
setMailFromDomain(java.lang.String mailFromDomain)
The custom MAIL FROM domain that you want the verified identity to use.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
SetIdentityMailFromDomainRequest |
withBehaviorOnMXFailure(BehaviorOnMXFailure behaviorOnMXFailure)
The action that you want Amazon SES to take if it cannot successfully
read the required MX record when you send an email.
|
SetIdentityMailFromDomainRequest |
withBehaviorOnMXFailure(java.lang.String behaviorOnMXFailure)
The action that you want Amazon SES to take if it cannot successfully
read the required MX record when you send an email.
|
SetIdentityMailFromDomainRequest |
withIdentity(java.lang.String identity)
The verified identity for which you want to enable or disable the
specified custom MAIL FROM domain.
|
SetIdentityMailFromDomainRequest |
withMailFromDomain(java.lang.String mailFromDomain)
The custom MAIL FROM domain that you want the verified identity to use.
|
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public java.lang.String getIdentity()
The verified identity for which you want to enable or disable the specified custom MAIL FROM domain.
The verified identity for which you want to enable or disable the specified custom MAIL FROM domain.
public void setIdentity(java.lang.String identity)
The verified identity for which you want to enable or disable the specified custom MAIL FROM domain.
identity
- The verified identity for which you want to enable or disable the specified custom MAIL FROM domain.
public SetIdentityMailFromDomainRequest withIdentity(java.lang.String identity)
The verified identity for which you want to enable or disable the specified custom MAIL FROM domain.
Returns a reference to this object so that method calls can be chained together.
identity
- The verified identity for which you want to enable or disable the specified custom MAIL FROM domain.
public java.lang.String getMailFromDomain()
The custom MAIL FROM domain that you want the verified identity to use.
The MAIL FROM domain must 1) be a subdomain of the verified identity, 2)
not be used in a "From" address if the MAIL FROM domain is the
destination of email feedback forwarding (for more information, see the
Amazon SES Developer Guide), and 3) not be used to receive emails. A
value of null
disables the custom MAIL FROM setting for the
identity.
The custom MAIL FROM domain that you want the verified identity
to use. The MAIL FROM domain must 1) be a subdomain of the
verified identity, 2) not be used in a "From" address if the MAIL
FROM domain is the destination of email feedback forwarding (for
more information, see the Amazon SES Developer Guide), and 3) not be used to receive
emails. A value of null
disables the custom MAIL
FROM setting for the identity.
public void setMailFromDomain(java.lang.String mailFromDomain)
The custom MAIL FROM domain that you want the verified identity to use.
The MAIL FROM domain must 1) be a subdomain of the verified identity, 2)
not be used in a "From" address if the MAIL FROM domain is the
destination of email feedback forwarding (for more information, see the
Amazon SES Developer Guide), and 3) not be used to receive emails. A
value of null
disables the custom MAIL FROM setting for the
identity.
mailFromDomain
-
The custom MAIL FROM domain that you want the verified
identity to use. The MAIL FROM domain must 1) be a subdomain
of the verified identity, 2) not be used in a "From" address
if the MAIL FROM domain is the destination of email feedback
forwarding (for more information, see the Amazon SES Developer Guide), and 3) not be used to
receive emails. A value of null
disables the
custom MAIL FROM setting for the identity.
public SetIdentityMailFromDomainRequest withMailFromDomain(java.lang.String mailFromDomain)
The custom MAIL FROM domain that you want the verified identity to use.
The MAIL FROM domain must 1) be a subdomain of the verified identity, 2)
not be used in a "From" address if the MAIL FROM domain is the
destination of email feedback forwarding (for more information, see the
Amazon SES Developer Guide), and 3) not be used to receive emails. A
value of null
disables the custom MAIL FROM setting for the
identity.
Returns a reference to this object so that method calls can be chained together.
mailFromDomain
-
The custom MAIL FROM domain that you want the verified
identity to use. The MAIL FROM domain must 1) be a subdomain
of the verified identity, 2) not be used in a "From" address
if the MAIL FROM domain is the destination of email feedback
forwarding (for more information, see the Amazon SES Developer Guide), and 3) not be used to
receive emails. A value of null
disables the
custom MAIL FROM setting for the identity.
public java.lang.String getBehaviorOnMXFailure()
The action that you want Amazon SES to take if it cannot successfully
read the required MX record when you send an email. If you choose
UseDefaultValue
, Amazon SES will use amazonses.com (or a
subdomain of that) as the MAIL FROM domain. If you choose
RejectMessage
, Amazon SES will return a
MailFromDomainNotVerified
error and not send the email.
The action specified in BehaviorOnMXFailure
is taken when
the custom MAIL FROM domain setup is in the Pending
,
Failed
, and TemporaryFailure
states.
Constraints:
Allowed Values: UseDefaultValue, RejectMessage
The action that you want Amazon SES to take if it cannot
successfully read the required MX record when you send an email.
If you choose UseDefaultValue
, Amazon SES will use
amazonses.com (or a subdomain of that) as the MAIL FROM domain.
If you choose RejectMessage
, Amazon SES will return
a MailFromDomainNotVerified
error and not send the
email.
The action specified in BehaviorOnMXFailure
is taken
when the custom MAIL FROM domain setup is in the
Pending
, Failed
, and
TemporaryFailure
states.
BehaviorOnMXFailure
public void setBehaviorOnMXFailure(java.lang.String behaviorOnMXFailure)
The action that you want Amazon SES to take if it cannot successfully
read the required MX record when you send an email. If you choose
UseDefaultValue
, Amazon SES will use amazonses.com (or a
subdomain of that) as the MAIL FROM domain. If you choose
RejectMessage
, Amazon SES will return a
MailFromDomainNotVerified
error and not send the email.
The action specified in BehaviorOnMXFailure
is taken when
the custom MAIL FROM domain setup is in the Pending
,
Failed
, and TemporaryFailure
states.
Constraints:
Allowed Values: UseDefaultValue, RejectMessage
behaviorOnMXFailure
-
The action that you want Amazon SES to take if it cannot
successfully read the required MX record when you send an
email. If you choose UseDefaultValue
, Amazon SES
will use amazonses.com (or a subdomain of that) as the MAIL
FROM domain. If you choose RejectMessage
, Amazon
SES will return a MailFromDomainNotVerified
error
and not send the email.
The action specified in BehaviorOnMXFailure
is
taken when the custom MAIL FROM domain setup is in the
Pending
, Failed
, and
TemporaryFailure
states.
BehaviorOnMXFailure
public SetIdentityMailFromDomainRequest withBehaviorOnMXFailure(java.lang.String behaviorOnMXFailure)
The action that you want Amazon SES to take if it cannot successfully
read the required MX record when you send an email. If you choose
UseDefaultValue
, Amazon SES will use amazonses.com (or a
subdomain of that) as the MAIL FROM domain. If you choose
RejectMessage
, Amazon SES will return a
MailFromDomainNotVerified
error and not send the email.
The action specified in BehaviorOnMXFailure
is taken when
the custom MAIL FROM domain setup is in the Pending
,
Failed
, and TemporaryFailure
states.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: UseDefaultValue, RejectMessage
behaviorOnMXFailure
-
The action that you want Amazon SES to take if it cannot
successfully read the required MX record when you send an
email. If you choose UseDefaultValue
, Amazon SES
will use amazonses.com (or a subdomain of that) as the MAIL
FROM domain. If you choose RejectMessage
, Amazon
SES will return a MailFromDomainNotVerified
error
and not send the email.
The action specified in BehaviorOnMXFailure
is
taken when the custom MAIL FROM domain setup is in the
Pending
, Failed
, and
TemporaryFailure
states.
BehaviorOnMXFailure
public void setBehaviorOnMXFailure(BehaviorOnMXFailure behaviorOnMXFailure)
The action that you want Amazon SES to take if it cannot successfully
read the required MX record when you send an email. If you choose
UseDefaultValue
, Amazon SES will use amazonses.com (or a
subdomain of that) as the MAIL FROM domain. If you choose
RejectMessage
, Amazon SES will return a
MailFromDomainNotVerified
error and not send the email.
The action specified in BehaviorOnMXFailure
is taken when
the custom MAIL FROM domain setup is in the Pending
,
Failed
, and TemporaryFailure
states.
Constraints:
Allowed Values: UseDefaultValue, RejectMessage
behaviorOnMXFailure
-
The action that you want Amazon SES to take if it cannot
successfully read the required MX record when you send an
email. If you choose UseDefaultValue
, Amazon SES
will use amazonses.com (or a subdomain of that) as the MAIL
FROM domain. If you choose RejectMessage
, Amazon
SES will return a MailFromDomainNotVerified
error
and not send the email.
The action specified in BehaviorOnMXFailure
is
taken when the custom MAIL FROM domain setup is in the
Pending
, Failed
, and
TemporaryFailure
states.
BehaviorOnMXFailure
public SetIdentityMailFromDomainRequest withBehaviorOnMXFailure(BehaviorOnMXFailure behaviorOnMXFailure)
The action that you want Amazon SES to take if it cannot successfully
read the required MX record when you send an email. If you choose
UseDefaultValue
, Amazon SES will use amazonses.com (or a
subdomain of that) as the MAIL FROM domain. If you choose
RejectMessage
, Amazon SES will return a
MailFromDomainNotVerified
error and not send the email.
The action specified in BehaviorOnMXFailure
is taken when
the custom MAIL FROM domain setup is in the Pending
,
Failed
, and TemporaryFailure
states.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: UseDefaultValue, RejectMessage
behaviorOnMXFailure
-
The action that you want Amazon SES to take if it cannot
successfully read the required MX record when you send an
email. If you choose UseDefaultValue
, Amazon SES
will use amazonses.com (or a subdomain of that) as the MAIL
FROM domain. If you choose RejectMessage
, Amazon
SES will return a MailFromDomainNotVerified
error
and not send the email.
The action specified in BehaviorOnMXFailure
is
taken when the custom MAIL FROM domain setup is in the
Pending
, Failed
, and
TemporaryFailure
states.
BehaviorOnMXFailure
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.