software.amazon.awssdk.services.ses.model

Class BounceAction

java.lang.Object

software.amazon.awssdk.services.ses.model.BounceAction

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<BounceAction.Builder,BounceAction>

@Generated(value="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 and Description
static interface	BounceAction.Builder

Method Summary

Modifier and Type	Method and 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. 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.

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 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.

toBuilder

public BounceAction.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BounceAction.Builder,BounceAction>

builder

public static BounceAction.Builder builder()

serializableBuilderClass

public static Class<? extends BounceAction.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo