Class BounceAction
- java.lang.Object
-
- software.amazon.awssdk.services.ses.model.BounceAction
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<BounceAction.Builder,BounceAction>
@Generated("software.amazon.awssdk:codegen") public final class BounceAction extends Object implements SdkPojo, Serializable, 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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
BounceAction.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static BounceAction.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
String
message()
Human-readable text to include in the bounce message.List<SdkField<?>>
sdkFields()
String
sender()
The email address of the sender of the bounced email.static Class<? extends BounceAction.Builder>
serializableBuilderClass()
String
smtpReplyCode()
The SMTP reply code, as defined by RFC 5321.String
statusCode()
The SMTP enhanced status code, as defined by RFC 3463.BounceAction.Builder
toBuilder()
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.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
topicArn
public final String 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
public final String smtpReplyCode()
The SMTP reply code, as defined by RFC 5321.
- Returns:
- The SMTP reply code, as defined by RFC 5321.
-
statusCode
public final String statusCode()
The SMTP enhanced status code, as defined by RFC 3463.
- Returns:
- The SMTP enhanced status code, as defined by RFC 3463.
-
message
public final String message()
Human-readable text to include in the bounce message.
- Returns:
- Human-readable text to include in the bounce message.
-
sender
public final String 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
public BounceAction.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<BounceAction.Builder,BounceAction>
-
builder
public static BounceAction.Builder builder()
-
serializableBuilderClass
public static Class<? extends BounceAction.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String 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.
-
-