Class BounceAction
- java.lang.Object
-
- com.amazonaws.services.simpleemail.model.BounceAction
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class BounceAction extends Object implements 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:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description BounceAction()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BounceAction
clone()
boolean
equals(Object obj)
String
getMessage()
Human-readable text to include in the bounce message.String
getSender()
The email address of the sender of the bounced email.String
getSmtpReplyCode()
The SMTP reply code, as defined by RFC 5321.String
getStatusCode()
The SMTP enhanced status code, as defined by RFC 3463.String
getTopicArn()
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
setSender(String sender)
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.String
toString()
Returns a string representation of this object; useful for testing and debugging.BounceAction
withMessage(String message)
Human-readable text to include in the bounce message.BounceAction
withSender(String sender)
The email address of the sender of the bounced email.BounceAction
withSmtpReplyCode(String smtpReplyCode)
The SMTP reply code, as defined by RFC 5321.BounceAction
withStatusCode(String statusCode)
The SMTP enhanced status code, as defined by RFC 3463.BounceAction
withTopicArn(String topicArn)
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken.
-
-
-
Method Detail
-
setTopicArn
public void setTopicArn(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.- 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
public 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.- 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
public BounceAction withTopicArn(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.- 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
public void setSmtpReplyCode(String smtpReplyCode)
The SMTP reply code, as defined by RFC 5321.
- Parameters:
smtpReplyCode
- The SMTP reply code, as defined by RFC 5321.
-
getSmtpReplyCode
public String getSmtpReplyCode()
The SMTP reply code, as defined by RFC 5321.
- Returns:
- The SMTP reply code, as defined by RFC 5321.
-
withSmtpReplyCode
public BounceAction withSmtpReplyCode(String smtpReplyCode)
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
public void setStatusCode(String statusCode)
The SMTP enhanced status code, as defined by RFC 3463.
- Parameters:
statusCode
- The SMTP enhanced status code, as defined by RFC 3463.
-
getStatusCode
public String getStatusCode()
The SMTP enhanced status code, as defined by RFC 3463.
- Returns:
- The SMTP enhanced status code, as defined by RFC 3463.
-
withStatusCode
public BounceAction withStatusCode(String statusCode)
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
public void setMessage(String message)
Human-readable text to include in the bounce message.
- Parameters:
message
- Human-readable text to include in the bounce message.
-
getMessage
public String getMessage()
Human-readable text to include in the bounce message.
- Returns:
- Human-readable text to include in the bounce message.
-
withMessage
public BounceAction withMessage(String message)
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
public void setSender(String sender)
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
public String 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
public BounceAction withSender(String sender)
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
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public BounceAction clone()
-
-