com.amazonaws.services.simpleemail.model

Class SendBounceRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simpleemail.model.SendBounceRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SendBounceRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Generates and sends a bounce message to the sender of an email you received through Amazon SES. You can only use this API on an email up to 24 hours after you receive it.

You cannot use this API to send generic bounces for mail that was not received by Amazon SES.

For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SendBounceRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.util.List<BouncedRecipientInfo>	getBouncedRecipientInfoList() A list of recipients of the bounced message, including the information required to create the Delivery Status Notifications (DSNs) for the recipients.
java.lang.String	getBounceSender() The address to use in the "From" header of the bounce message.
java.lang.String	getBounceSenderArn() This parameter is used only for sending authorization.
java.lang.String	getExplanation() Human-readable text for the bounce message to explain the failure.
MessageDsn	getMessageDsn() Message-related DSN fields.
java.lang.String	getOriginalMessageId() The message ID of the message to be bounced.
int	hashCode()
void	setBouncedRecipientInfoList(java.util.Collection<BouncedRecipientInfo> bouncedRecipientInfoList) A list of recipients of the bounced message, including the information required to create the Delivery Status Notifications (DSNs) for the recipients.
void	setBounceSender(java.lang.String bounceSender) The address to use in the "From" header of the bounce message.
void	setBounceSenderArn(java.lang.String bounceSenderArn) This parameter is used only for sending authorization.
void	setExplanation(java.lang.String explanation) Human-readable text for the bounce message to explain the failure.
void	setMessageDsn(MessageDsn messageDsn) Message-related DSN fields.
void	setOriginalMessageId(java.lang.String originalMessageId) The message ID of the message to be bounced.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
SendBounceRequest	withBouncedRecipientInfoList(BouncedRecipientInfo... bouncedRecipientInfoList) A list of recipients of the bounced message, including the information required to create the Delivery Status Notifications (DSNs) for the recipients.
SendBounceRequest	withBouncedRecipientInfoList(java.util.Collection<BouncedRecipientInfo> bouncedRecipientInfoList) A list of recipients of the bounced message, including the information required to create the Delivery Status Notifications (DSNs) for the recipients.
SendBounceRequest	withBounceSender(java.lang.String bounceSender) The address to use in the "From" header of the bounce message.
SendBounceRequest	withBounceSenderArn(java.lang.String bounceSenderArn) This parameter is used only for sending authorization.
SendBounceRequest	withExplanation(java.lang.String explanation) Human-readable text for the bounce message to explain the failure.
SendBounceRequest	withMessageDsn(MessageDsn messageDsn) Message-related DSN fields.
SendBounceRequest	withOriginalMessageId(java.lang.String originalMessageId) The message ID of the message to be bounced.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SendBounceRequest

public SendBounceRequest()

Method Detail

getOriginalMessageId

public java.lang.String getOriginalMessageId()

The message ID of the message to be bounced.

Returns:

The message ID of the message to be bounced.

setOriginalMessageId

public void setOriginalMessageId(java.lang.String originalMessageId)

The message ID of the message to be bounced.

Parameters:

originalMessageId -

The message ID of the message to be bounced.

withOriginalMessageId

public SendBounceRequest withOriginalMessageId(java.lang.String originalMessageId)

The message ID of the message to be bounced.

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

Parameters:

originalMessageId -

The message ID of the message to be bounced.

Returns:

A reference to this updated object so that method calls can be chained together.

getBounceSender

public java.lang.String getBounceSender()

The address to use in the "From" header of the bounce message. This must be an identity that you have verified with Amazon SES.

Returns:

The address to use in the "From" header of the bounce message. This must be an identity that you have verified with Amazon SES.

setBounceSender

public void setBounceSender(java.lang.String bounceSender)

The address to use in the "From" header of the bounce message. This must be an identity that you have verified with Amazon SES.

Parameters:

bounceSender -

The address to use in the "From" header of the bounce message. This must be an identity that you have verified with Amazon SES.

withBounceSender

public SendBounceRequest withBounceSender(java.lang.String bounceSender)

The address to use in the "From" header of the bounce message. This must be an identity that you have verified with Amazon SES.

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

Parameters:

bounceSender -

The address to use in the "From" header of the bounce message. This must be an identity that you have verified with Amazon SES.

Returns:

A reference to this updated object so that method calls can be chained together.

getExplanation

public java.lang.String getExplanation()

Human-readable text for the bounce message to explain the failure. If not specified, the text will be auto-generated based on the bounced recipient information.

Returns:

Human-readable text for the bounce message to explain the failure. If not specified, the text will be auto-generated based on the bounced recipient information.

setExplanation

public void setExplanation(java.lang.String explanation)

Human-readable text for the bounce message to explain the failure. If not specified, the text will be auto-generated based on the bounced recipient information.

Parameters:

explanation -

Human-readable text for the bounce message to explain the failure. If not specified, the text will be auto-generated based on the bounced recipient information.

withExplanation

public SendBounceRequest withExplanation(java.lang.String explanation)

Human-readable text for the bounce message to explain the failure. If not specified, the text will be auto-generated based on the bounced recipient information.

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

Parameters:

explanation -

Human-readable text for the bounce message to explain the failure. If not specified, the text will be auto-generated based on the bounced recipient information.

Returns:

A reference to this updated object so that method calls can be chained together.

getMessageDsn

public MessageDsn getMessageDsn()

Message-related DSN fields. If not specified, Amazon SES will choose the values.

Returns:

Message-related DSN fields. If not specified, Amazon SES will choose the values.

setMessageDsn

public void setMessageDsn(MessageDsn messageDsn)

Message-related DSN fields. If not specified, Amazon SES will choose the values.

Parameters:

messageDsn -

Message-related DSN fields. If not specified, Amazon SES will choose the values.

withMessageDsn

public SendBounceRequest withMessageDsn(MessageDsn messageDsn)

Message-related DSN fields. If not specified, Amazon SES will choose the values.

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

Parameters:

messageDsn -

Message-related DSN fields. If not specified, Amazon SES will choose the values.

Returns:

A reference to this updated object so that method calls can be chained together.

getBouncedRecipientInfoList

public java.util.List<BouncedRecipientInfo> getBouncedRecipientInfoList()

A list of recipients of the bounced message, including the information required to create the Delivery Status Notifications (DSNs) for the recipients. You must specify at least one BouncedRecipientInfo in the list.

Returns:

A list of recipients of the bounced message, including the information required to create the Delivery Status Notifications (DSNs) for the recipients. You must specify at least one BouncedRecipientInfo in the list.

setBouncedRecipientInfoList

public void setBouncedRecipientInfoList(java.util.Collection<BouncedRecipientInfo> bouncedRecipientInfoList)

A list of recipients of the bounced message, including the information required to create the Delivery Status Notifications (DSNs) for the recipients. You must specify at least one BouncedRecipientInfo in the list.

Parameters:

bouncedRecipientInfoList -

A list of recipients of the bounced message, including the information required to create the Delivery Status Notifications (DSNs) for the recipients. You must specify at least one BouncedRecipientInfo in the list.

withBouncedRecipientInfoList

public SendBounceRequest withBouncedRecipientInfoList(BouncedRecipientInfo... bouncedRecipientInfoList)

A list of recipients of the bounced message, including the information required to create the Delivery Status Notifications (DSNs) for the recipients. You must specify at least one BouncedRecipientInfo in the list.

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

Parameters:

bouncedRecipientInfoList -

A list of recipients of the bounced message, including the information required to create the Delivery Status Notifications (DSNs) for the recipients. You must specify at least one BouncedRecipientInfo in the list.

Returns:

A reference to this updated object so that method calls can be chained together.

withBouncedRecipientInfoList

public SendBounceRequest withBouncedRecipientInfoList(java.util.Collection<BouncedRecipientInfo> bouncedRecipientInfoList)

A list of recipients of the bounced message, including the information required to create the Delivery Status Notifications (DSNs) for the recipients. You must specify at least one BouncedRecipientInfo in the list.

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

Parameters:

bouncedRecipientInfoList -

A list of recipients of the bounced message, including the information required to create the Delivery Status Notifications (DSNs) for the recipients. You must specify at least one BouncedRecipientInfo in the list.

Returns:

A reference to this updated object so that method calls can be chained together.

getBounceSenderArn

public java.lang.String getBounceSenderArn()

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the address in the "From" header of the bounce. For more information about sending authorization, see the Amazon SES Developer Guide.

Returns:

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the address in the "From" header of the bounce. For more information about sending authorization, see the Amazon SES Developer Guide.

setBounceSenderArn

public void setBounceSenderArn(java.lang.String bounceSenderArn)

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the address in the "From" header of the bounce. For more information about sending authorization, see the Amazon SES Developer Guide.

Parameters:

bounceSenderArn -

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the address in the "From" header of the bounce. For more information about sending authorization, see the Amazon SES Developer Guide.

withBounceSenderArn

public SendBounceRequest withBounceSenderArn(java.lang.String bounceSenderArn)

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the address in the "From" header of the bounce. For more information about sending authorization, see the Amazon SES Developer Guide.

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

Parameters:

bounceSenderArn -

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the address in the "From" header of the bounce. For more information about sending authorization, see the Amazon SES Developer Guide.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object