com.amazonaws.services.pinpointemail.model

Class MailFromAttributes

java.lang.Object

com.amazonaws.services.pinpointemail.model.MailFromAttributes

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class MailFromAttributes
extends Object
implements Serializable, Cloneable, StructuredPojo

A list of attributes that are associated with a MAIL FROM domain.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
MailFromAttributes()

Method Summary

Modifier and Type	Method and Description
MailFromAttributes	clone()
boolean	equals(Object obj)
String	getBehaviorOnMxFailure() The action that Amazon Pinpoint to takes if it can't read the required MX record for a custom MAIL FROM domain.
String	getMailFromDomain() The name of a domain that an email identity uses as a custom MAIL FROM domain.
String	getMailFromDomainStatus() The status of the MAIL FROM domain.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setBehaviorOnMxFailure(String behaviorOnMxFailure) The action that Amazon Pinpoint to takes if it can't read the required MX record for a custom MAIL FROM domain.
void	setMailFromDomain(String mailFromDomain) The name of a domain that an email identity uses as a custom MAIL FROM domain.
void	setMailFromDomainStatus(String mailFromDomainStatus) The status of the MAIL FROM domain.
String	toString() Returns a string representation of this object.
MailFromAttributes	withBehaviorOnMxFailure(BehaviorOnMxFailure behaviorOnMxFailure) The action that Amazon Pinpoint to takes if it can't read the required MX record for a custom MAIL FROM domain.
MailFromAttributes	withBehaviorOnMxFailure(String behaviorOnMxFailure) The action that Amazon Pinpoint to takes if it can't read the required MX record for a custom MAIL FROM domain.
MailFromAttributes	withMailFromDomain(String mailFromDomain) The name of a domain that an email identity uses as a custom MAIL FROM domain.
MailFromAttributes	withMailFromDomainStatus(MailFromDomainStatus mailFromDomainStatus) The status of the MAIL FROM domain.
MailFromAttributes	withMailFromDomainStatus(String mailFromDomainStatus) The status of the MAIL FROM domain.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MailFromAttributes

public MailFromAttributes()

Method Detail

setMailFromDomain

public void setMailFromDomain(String mailFromDomain)

The name of a domain that an email identity uses as a custom MAIL FROM domain.

Parameters:

mailFromDomain - The name of a domain that an email identity uses as a custom MAIL FROM domain.

getMailFromDomain

public String getMailFromDomain()

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.

withMailFromDomain

public MailFromAttributes withMailFromDomain(String mailFromDomain)

The name of a domain that an email identity uses as a custom MAIL FROM domain.

Parameters:

mailFromDomain - The name of a domain that an email identity uses as a custom MAIL FROM domain.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMailFromDomainStatus

public void setMailFromDomainStatus(String mailFromDomainStatus)

The status of the MAIL FROM domain. This status can have the following values:

• PENDING – Amazon Pinpoint hasn't started searching for the MX record yet.

• SUCCESS – Amazon Pinpoint detected the required MX record for the MAIL FROM domain.

• FAILED – Amazon Pinpoint can't find the required MX record, or the record no longer exists.

• TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon Pinpoint from determining the status of the MAIL FROM domain.

Parameters:

mailFromDomainStatus - The status of the MAIL FROM domain. This status can have the following values:

• PENDING – Amazon Pinpoint hasn't started searching for the MX record yet.

• SUCCESS – Amazon Pinpoint detected the required MX record for the MAIL FROM domain.

• FAILED – Amazon Pinpoint can't find the required MX record, or the record no longer exists.

• TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon Pinpoint from determining the status of the MAIL FROM domain.

See Also:

MailFromDomainStatus

getMailFromDomainStatus

public String getMailFromDomainStatus()

The status of the MAIL FROM domain. This status can have the following values:

• PENDING – Amazon Pinpoint hasn't started searching for the MX record yet.

• SUCCESS – Amazon Pinpoint detected the required MX record for the MAIL FROM domain.

• FAILED – Amazon Pinpoint can't find the required MX record, or the record no longer exists.

• TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon Pinpoint from determining the status of the MAIL FROM domain.

Returns:

The status of the MAIL FROM domain. This status can have the following values:

• PENDING – Amazon Pinpoint hasn't started searching for the MX record yet.

• SUCCESS – Amazon Pinpoint detected the required MX record for the MAIL FROM domain.

• FAILED – Amazon Pinpoint can't find the required MX record, or the record no longer exists.

• TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon Pinpoint from determining the status of the MAIL FROM domain.

See Also:

MailFromDomainStatus

withMailFromDomainStatus

public MailFromAttributes withMailFromDomainStatus(String mailFromDomainStatus)

The status of the MAIL FROM domain. This status can have the following values:

• PENDING – Amazon Pinpoint hasn't started searching for the MX record yet.

• SUCCESS – Amazon Pinpoint detected the required MX record for the MAIL FROM domain.

• FAILED – Amazon Pinpoint can't find the required MX record, or the record no longer exists.

• TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon Pinpoint from determining the status of the MAIL FROM domain.

Parameters:

mailFromDomainStatus - The status of the MAIL FROM domain. This status can have the following values:

• PENDING – Amazon Pinpoint hasn't started searching for the MX record yet.

• SUCCESS – Amazon Pinpoint detected the required MX record for the MAIL FROM domain.

• FAILED – Amazon Pinpoint can't find the required MX record, or the record no longer exists.

• TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon Pinpoint from determining the status of the MAIL FROM domain.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MailFromDomainStatus

withMailFromDomainStatus

public MailFromAttributes withMailFromDomainStatus(MailFromDomainStatus mailFromDomainStatus)

The status of the MAIL FROM domain. This status can have the following values:

• PENDING – Amazon Pinpoint hasn't started searching for the MX record yet.

• SUCCESS – Amazon Pinpoint detected the required MX record for the MAIL FROM domain.

• FAILED – Amazon Pinpoint can't find the required MX record, or the record no longer exists.

• TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon Pinpoint from determining the status of the MAIL FROM domain.

Parameters:

mailFromDomainStatus - The status of the MAIL FROM domain. This status can have the following values:

• PENDING – Amazon Pinpoint hasn't started searching for the MX record yet.

• SUCCESS – Amazon Pinpoint detected the required MX record for the MAIL FROM domain.

• FAILED – Amazon Pinpoint can't find the required MX record, or the record no longer exists.

• TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon Pinpoint from determining the status of the MAIL FROM domain.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MailFromDomainStatus

setBehaviorOnMxFailure

public void setBehaviorOnMxFailure(String behaviorOnMxFailure)

The action that Amazon Pinpoint to takes if it can't read the required MX record for a custom MAIL FROM domain. When you set this value to UseDefaultValue, Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, Amazon Pinpoint 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.

Parameters:

behaviorOnMxFailure - The action that Amazon Pinpoint to takes if it can't read the required MX record for a custom MAIL FROM domain. When you set this value to UseDefaultValue, Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, Amazon Pinpoint 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:

BehaviorOnMxFailure

getBehaviorOnMxFailure

public String getBehaviorOnMxFailure()

The action that Amazon Pinpoint to takes if it can't read the required MX record for a custom MAIL FROM domain. When you set this value to UseDefaultValue, Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, Amazon Pinpoint 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.

Returns:

The action that Amazon Pinpoint to takes if it can't read the required MX record for a custom MAIL FROM domain. When you set this value to UseDefaultValue, Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, Amazon Pinpoint 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:

BehaviorOnMxFailure

withBehaviorOnMxFailure

public MailFromAttributes withBehaviorOnMxFailure(String behaviorOnMxFailure)

The action that Amazon Pinpoint to takes if it can't read the required MX record for a custom MAIL FROM domain. When you set this value to UseDefaultValue, Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, Amazon Pinpoint 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.

Parameters:

behaviorOnMxFailure - The action that Amazon Pinpoint to takes if it can't read the required MX record for a custom MAIL FROM domain. When you set this value to UseDefaultValue, Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, Amazon Pinpoint 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BehaviorOnMxFailure

withBehaviorOnMxFailure

public MailFromAttributes withBehaviorOnMxFailure(BehaviorOnMxFailure behaviorOnMxFailure)

The action that Amazon Pinpoint to takes if it can't read the required MX record for a custom MAIL FROM domain. When you set this value to UseDefaultValue, Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, Amazon Pinpoint 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.

Parameters:

behaviorOnMxFailure - The action that Amazon Pinpoint to takes if it can't read the required MX record for a custom MAIL FROM domain. When you set this value to UseDefaultValue, Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, Amazon Pinpoint 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BehaviorOnMxFailure

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public MailFromAttributes clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.