public class SendBounceRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
SendBounce operation
.
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.
NOTE: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 .
This action is throttled at one request per second.
NOOP
Constructor and Description |
---|
SendBounceRequest() |
Modifier and Type | Method and Description |
---|---|
SendBounceRequest |
clone() |
boolean |
equals(Object obj) |
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.
|
String |
getBounceSender()
The address to use in the "From" header of the bounce message.
|
String |
getBounceSenderArn()
This parameter is used only for sending authorization.
|
String |
getExplanation()
Human-readable text for the bounce message to explain the failure.
|
MessageDsn |
getMessageDsn()
Message-related DSN fields.
|
String |
getOriginalMessageId()
The message ID of the message to be bounced.
|
int |
hashCode() |
void |
setBouncedRecipientInfoList(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(String bounceSender)
The address to use in the "From" header of the bounce message.
|
void |
setBounceSenderArn(String bounceSenderArn)
This parameter is used only for sending authorization.
|
void |
setExplanation(String explanation)
Human-readable text for the bounce message to explain the failure.
|
void |
setMessageDsn(MessageDsn messageDsn)
Message-related DSN fields.
|
void |
setOriginalMessageId(String originalMessageId)
The message ID of the message to be bounced.
|
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(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(String bounceSender)
The address to use in the "From" header of the bounce message.
|
SendBounceRequest |
withBounceSenderArn(String bounceSenderArn)
This parameter is used only for sending authorization.
|
SendBounceRequest |
withExplanation(String explanation)
Human-readable text for the bounce message to explain the failure.
|
SendBounceRequest |
withMessageDsn(MessageDsn messageDsn)
Message-related DSN fields.
|
SendBounceRequest |
withOriginalMessageId(String originalMessageId)
The message ID of the message to be bounced.
|
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public String getOriginalMessageId()
public void setOriginalMessageId(String originalMessageId)
originalMessageId
- The message ID of the message to be bounced.public SendBounceRequest withOriginalMessageId(String originalMessageId)
Returns a reference to this object so that method calls can be chained together.
originalMessageId
- The message ID of the message to be bounced.public String getBounceSender()
public void setBounceSender(String bounceSender)
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.public SendBounceRequest withBounceSender(String bounceSender)
Returns a reference to this object so that method calls can be chained together.
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.public String getExplanation()
public void setExplanation(String explanation)
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.public SendBounceRequest withExplanation(String explanation)
Returns a reference to this object so that method calls can be chained together.
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.public MessageDsn getMessageDsn()
public void setMessageDsn(MessageDsn messageDsn)
messageDsn
- Message-related DSN fields. If not specified, Amazon SES will choose
the values.public SendBounceRequest withMessageDsn(MessageDsn messageDsn)
Returns a reference to this object so that method calls can be chained together.
messageDsn
- Message-related DSN fields. If not specified, Amazon SES will choose
the values.public List<BouncedRecipientInfo> getBouncedRecipientInfoList()
BouncedRecipientInfo
in the list.BouncedRecipientInfo
in the list.public void setBouncedRecipientInfoList(Collection<BouncedRecipientInfo> bouncedRecipientInfoList)
BouncedRecipientInfo
in the list.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.public SendBounceRequest withBouncedRecipientInfoList(BouncedRecipientInfo... bouncedRecipientInfoList)
BouncedRecipientInfo
in the list.
NOTE: This method appends the values to the existing list (if
any). Use setBouncedRecipientInfoList(java.util.Collection)
or withBouncedRecipientInfoList(java.util.Collection)
if you
want to override the existing values.
Returns a reference to this object so that method calls can be chained together.
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.public SendBounceRequest withBouncedRecipientInfoList(Collection<BouncedRecipientInfo> bouncedRecipientInfoList)
BouncedRecipientInfo
in the list.
Returns a reference to this object so that method calls can be chained together.
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.public String getBounceSenderArn()
public void setBounceSenderArn(String bounceSenderArn)
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.public SendBounceRequest withBounceSenderArn(String bounceSenderArn)
Returns a reference to this object so that method calls can be chained together.
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.public String toString()
toString
in class Object
Object.toString()
public SendBounceRequest clone()
clone
in class AmazonWebServiceRequest
Copyright © 2015. All rights reserved.