Class BounceAction
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<BounceAction.Builder,
BounceAction>
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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic BounceAction.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
message()
Human-readable text to include in the bounce message.final String
sender()
The email address of the sender of the bounced email.static Class
<? extends BounceAction.Builder> final String
The SMTP reply code, as defined by RFC 5321.final String
The SMTP enhanced status code, as defined by RFC 3463.Take this object and create a builder that contains all of the current property values of this object.final String
topicArn()
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
topicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.
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. You can
find the ARN of a topic by using the ListTopics operation in Amazon
SNS.
For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
-
smtpReplyCode
The SMTP reply code, as defined by RFC 5321.
- Returns:
- The SMTP reply code, as defined by RFC 5321.
-
statusCode
The SMTP enhanced status code, as defined by RFC 3463.
- Returns:
- The SMTP enhanced status code, as defined by RFC 3463.
-
message
Human-readable text to include in the bounce message.
- Returns:
- Human-readable text to include in the bounce message.
-
sender
The email address of the sender of the bounced email. This is the address from which the bounce message is sent.
- Returns:
- The email address of the sender of the bounced email. This is the address from which the bounce message is sent.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<BounceAction.Builder,
BounceAction> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-