Class BounceAction

java.lang.Object
software.amazon.awssdk.services.mailmanager.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>

The action to send a bounce response for the email. When executed, this action generates a non-delivery report (bounce) back to the sender.

See Also:

  • Method Details

    • actionFailurePolicy

      public final ActionFailurePolicy actionFailurePolicy()

      A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the caller does not have the permissions to call the SendBounce API.

      If the service returns an enum value that is not available in the current SDK version, actionFailurePolicy will return ActionFailurePolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionFailurePolicyAsString().

      Returns:
      A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the caller does not have the permissions to call the SendBounce API.
      See Also:

    • actionFailurePolicyAsString

      public final String actionFailurePolicyAsString()

      A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the caller does not have the permissions to call the SendBounce API.

      If the service returns an enum value that is not available in the current SDK version, actionFailurePolicy will return ActionFailurePolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionFailurePolicyAsString().

      Returns:
      A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the caller does not have the permissions to call the SendBounce API.
      See Also:

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of the IAM role to use to send the bounce message.

      Returns:
      The Amazon Resource Name (ARN) of the IAM role to use to send the bounce message.

    • sender

      public final String sender()

      The sender email address of the bounce message.

      Returns:
      The sender email address of the bounce message.

    • statusCode

      public final String statusCode()

      The enhanced status code for the bounce, in the format of x.y.z (e.g. 5.1.1).

      Returns:
      The enhanced status code for the bounce, in the format of x.y.z (e.g. 5.1.1).

    • smtpReplyCode

      public final String smtpReplyCode()

      The SMTP reply code for the bounce, as defined by RFC 5321.

      Returns:
      The SMTP reply code for the bounce, as defined by RFC 5321.

    • diagnosticMessage

      public final String diagnosticMessage()

      The diagnostic message included in the Diagnostic-Code header of the bounce.

      Returns:
      The diagnostic message included in the Diagnostic-Code header of the bounce.

    • message

      public final String message()

      The human-readable text to include in the bounce message.

      Returns:
      The human-readable text to include in the bounce message.

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