Class SendBounceRequest

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

public class SendBounceRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
See Also:
  • Constructor Details

    • SendBounceRequest

      public SendBounceRequest()
  • Method Details

    • setOriginalMessageId

      public void setOriginalMessageId(String originalMessageId)

      The message ID of the message to be bounced.

      Parameters:
      originalMessageId - The message ID of the message to be bounced.
    • getOriginalMessageId

      public String getOriginalMessageId()

      The message ID of the message to be bounced.

      Returns:
      The message ID of the message to be bounced.
    • withOriginalMessageId

      public SendBounceRequest withOriginalMessageId(String originalMessageId)

      The message ID of the message to be bounced.

      Parameters:
      originalMessageId - The message ID of the message to be bounced.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setBounceSender

      public void setBounceSender(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.
    • getBounceSender

      public 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.
    • withBounceSender

      public SendBounceRequest withBounceSender(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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setExplanation

      public void setExplanation(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.
    • getExplanation

      public 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.
    • withExplanation

      public SendBounceRequest withExplanation(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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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.
    • 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.
    • withMessageDsn

      public SendBounceRequest withMessageDsn(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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • getBouncedRecipientInfoList

      public 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(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.

      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.

      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:
      Returns a reference to this object so that method calls can be chained together.
    • withBouncedRecipientInfoList

      public 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. 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setBounceSenderArn

      public void setBounceSenderArn(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.
    • getBounceSenderArn

      public 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.
    • withBounceSenderArn

      public SendBounceRequest withBounceSenderArn(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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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

      public SendBounceRequest clone()
      Description copied from class: AmazonWebServiceRequest
      Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
      Overrides:
      clone in class AmazonWebServiceRequest
      See Also: