public class BounceAction
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
When included in a receipt rule, this action rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
For information about sending a bounce message in response to a received email, see the Amazon SES Developer Guide.
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
message
Human-readable text to include in the bounce message.
|
private java.lang.String |
sender
The email address of the sender of the bounced email.
|
private java.lang.String |
smtpReplyCode
The SMTP reply code, as defined by RFC 5321.
|
private java.lang.String |
statusCode
The SMTP enhanced status code, as defined by RFC 3463.
|
private java.lang.String |
topicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the
bounce action is taken.
|
Constructor and Description |
---|
BounceAction() |
Modifier and Type | Method and Description |
---|---|
BounceAction |
clone() |
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getMessage()
Human-readable text to include in the bounce message.
|
java.lang.String |
getSender()
The email address of the sender of the bounced email.
|
java.lang.String |
getSmtpReplyCode()
The SMTP reply code, as defined by RFC 5321.
|
java.lang.String |
getStatusCode()
The SMTP enhanced status code, as defined by RFC 3463.
|
java.lang.String |
getTopicArn()
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the
bounce action is taken.
|
int |
hashCode() |
void |
setMessage(java.lang.String message)
Human-readable text to include in the bounce message.
|
void |
setSender(java.lang.String sender)
The email address of the sender of the bounced email.
|
void |
setSmtpReplyCode(java.lang.String smtpReplyCode)
The SMTP reply code, as defined by RFC 5321.
|
void |
setStatusCode(java.lang.String statusCode)
The SMTP enhanced status code, as defined by RFC 3463.
|
void |
setTopicArn(java.lang.String topicArn)
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the
bounce action is taken.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
BounceAction |
withMessage(java.lang.String message)
Human-readable text to include in the bounce message.
|
BounceAction |
withSender(java.lang.String sender)
The email address of the sender of the bounced email.
|
BounceAction |
withSmtpReplyCode(java.lang.String smtpReplyCode)
The SMTP reply code, as defined by RFC 5321.
|
BounceAction |
withStatusCode(java.lang.String statusCode)
The SMTP enhanced status code, as defined by RFC 3463.
|
BounceAction |
withTopicArn(java.lang.String topicArn)
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the
bounce action is taken.
|
private java.lang.String topicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the
bounce action is taken. An example of an Amazon SNS topic ARN is
arn:aws:sns:us-west-2:123456789012:MyTopic
. For more
information about Amazon SNS topics, see the Amazon
SNS Developer Guide.
private java.lang.String smtpReplyCode
The SMTP reply code, as defined by RFC 5321.
private java.lang.String statusCode
The SMTP enhanced status code, as defined by RFC 3463.
private java.lang.String message
Human-readable text to include in the bounce message.
private java.lang.String sender
The email address of the sender of the bounced email. This is the address from which the bounce message will be sent.
public void setTopicArn(java.lang.String topicArn)
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the
bounce action is taken. An example of an Amazon SNS topic ARN is
arn:aws:sns:us-west-2:123456789012:MyTopic
. For more
information about Amazon SNS topics, see the Amazon
SNS Developer Guide.
topicArn
- The Amazon Resource Name (ARN) of the Amazon SNS topic to notify
when the bounce action is taken. An example of an Amazon SNS topic
ARN is arn:aws:sns:us-west-2:123456789012:MyTopic
.
For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.public java.lang.String getTopicArn()
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the
bounce action is taken. An example of an Amazon SNS topic ARN is
arn:aws:sns:us-west-2:123456789012:MyTopic
. For more
information about Amazon SNS topics, see the Amazon
SNS Developer Guide.
arn:aws:sns:us-west-2:123456789012:MyTopic
. For more
information about Amazon SNS topics, see the Amazon SNS Developer Guide.public BounceAction withTopicArn(java.lang.String topicArn)
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the
bounce action is taken. An example of an Amazon SNS topic ARN is
arn:aws:sns:us-west-2:123456789012:MyTopic
. For more
information about Amazon SNS topics, see the Amazon
SNS Developer Guide.
topicArn
- The Amazon Resource Name (ARN) of the Amazon SNS topic to notify
when the bounce action is taken. An example of an Amazon SNS topic
ARN is arn:aws:sns:us-west-2:123456789012:MyTopic
.
For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.public void setSmtpReplyCode(java.lang.String smtpReplyCode)
The SMTP reply code, as defined by RFC 5321.
smtpReplyCode
- The SMTP reply code, as defined by RFC 5321.public java.lang.String getSmtpReplyCode()
The SMTP reply code, as defined by RFC 5321.
public BounceAction withSmtpReplyCode(java.lang.String smtpReplyCode)
The SMTP reply code, as defined by RFC 5321.
smtpReplyCode
- The SMTP reply code, as defined by RFC 5321.public void setStatusCode(java.lang.String statusCode)
The SMTP enhanced status code, as defined by RFC 3463.
statusCode
- The SMTP enhanced status code, as defined by RFC 3463.public java.lang.String getStatusCode()
The SMTP enhanced status code, as defined by RFC 3463.
public BounceAction withStatusCode(java.lang.String statusCode)
The SMTP enhanced status code, as defined by RFC 3463.
statusCode
- The SMTP enhanced status code, as defined by RFC 3463.public void setMessage(java.lang.String message)
Human-readable text to include in the bounce message.
message
- Human-readable text to include in the bounce message.public java.lang.String getMessage()
Human-readable text to include in the bounce message.
public BounceAction withMessage(java.lang.String message)
Human-readable text to include in the bounce message.
message
- Human-readable text to include in the bounce message.public void setSender(java.lang.String sender)
The email address of the sender of the bounced email. This is the address from which the bounce message will be sent.
sender
- The email address of the sender of the bounced email. This is the
address from which the bounce message will be sent.public java.lang.String getSender()
The email address of the sender of the bounced email. This is the address from which the bounce message will be sent.
public BounceAction withSender(java.lang.String sender)
The email address of the sender of the bounced email. This is the address from which the bounce message will be sent.
sender
- The email address of the sender of the bounced email. This is the
address from which the bounce message will be sent.public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public BounceAction clone()
clone
in class java.lang.Object