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:

  • Method Details

    • 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()
      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 interface ToCopyableBuilder<BounceAction.Builder,BounceAction>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.