Class BounceAction
- All Implemented Interfaces:
Serializable
,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.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
Human-readable text to include in the bounce message.The email address of the sender of the bounced email.The SMTP reply code, as defined by RFC 5321.The SMTP enhanced status code, as defined by RFC 3463.The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken.int
hashCode()
void
setMessage
(String message) Human-readable text to include in the bounce message.void
The email address of the sender of the bounced email.void
setSmtpReplyCode
(String smtpReplyCode) The SMTP reply code, as defined by RFC 5321.void
setStatusCode
(String statusCode) The SMTP enhanced status code, as defined by RFC 3463.void
setTopicArn
(String topicArn) The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken.toString()
Returns a string representation of this object; useful for testing and debugging.withMessage
(String message) Human-readable text to include in the bounce message.withSender
(String sender) The email address of the sender of the bounced email.withSmtpReplyCode
(String smtpReplyCode) The SMTP reply code, as defined by RFC 5321.withStatusCode
(String statusCode) The SMTP enhanced status code, as defined by RFC 3463.withTopicArn
(String topicArn) The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken.
-
Constructor Details
-
BounceAction
public BounceAction()
-
-
Method Details
-
setTopicArn
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.- Parameters:
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 isarn:aws:sns:us-west-2:123456789012:MyTopic
. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
-
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.- Returns:
- 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.
-
withTopicArn
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.- Parameters:
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 isarn:aws:sns:us-west-2:123456789012:MyTopic
. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSmtpReplyCode
The SMTP reply code, as defined by RFC 5321.
- Parameters:
smtpReplyCode
- The SMTP reply code, as defined by RFC 5321.
-
getSmtpReplyCode
The SMTP reply code, as defined by RFC 5321.
- Returns:
- The SMTP reply code, as defined by RFC 5321.
-
withSmtpReplyCode
The SMTP reply code, as defined by RFC 5321.
- Parameters:
smtpReplyCode
- The SMTP reply code, as defined by RFC 5321.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStatusCode
The SMTP enhanced status code, as defined by RFC 3463.
- Parameters:
statusCode
- The SMTP enhanced status code, as defined by RFC 3463.
-
getStatusCode
The SMTP enhanced status code, as defined by RFC 3463.
- Returns:
- The SMTP enhanced status code, as defined by RFC 3463.
-
withStatusCode
The SMTP enhanced status code, as defined by RFC 3463.
- Parameters:
statusCode
- The SMTP enhanced status code, as defined by RFC 3463.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMessage
Human-readable text to include in the bounce message.
- Parameters:
message
- Human-readable text to include in the bounce message.
-
getMessage
Human-readable text to include in the bounce message.
- Returns:
- Human-readable text to include in the bounce message.
-
withMessage
Human-readable text to include in the bounce message.
- Parameters:
message
- Human-readable text to include in the bounce message.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSender
The email address of the sender of the bounced email. This is the address from which the bounce message will be sent.
- Parameters:
sender
- The email address of the sender of the bounced email. This is the address from which the bounce message will be sent.
-
getSender
The email address of the sender of the bounced email. This is the address from which the bounce message will be sent.
- Returns:
- The email address of the sender of the bounced email. This is the address from which the bounce message will be sent.
-
withSender
The email address of the sender of the bounced email. This is the address from which the bounce message will be sent.
- Parameters:
sender
- The email address of the sender of the bounced email. This is the address from which the bounce message will be sent.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-