Class BouncedRecipientInfo

java.lang.Object
software.amazon.awssdk.services.ses.model.BouncedRecipientInfo
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<BouncedRecipientInfo.Builder,BouncedRecipientInfo>
@Generated("software.amazon.awssdk:codegen") public final class BouncedRecipientInfo extends Object implements SdkPojo, Serializable, ToCopyableBuilder<BouncedRecipientInfo.Builder,BouncedRecipientInfo>

Recipient-related information to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.

For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.

See Also:

  • Method Details

    • recipient

      public final String recipient()

      The email address of the recipient of the bounced email.

      Returns:
      The email address of the recipient of the bounced email.

    • recipientArn

      public final String recipientArn()

      This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to receive email for the recipient of the bounced email. For more information about sending authorization, see the Amazon SES Developer Guide.

      Returns:
      This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to receive email for the recipient of the bounced email. For more information about sending authorization, see the Amazon SES Developer Guide.

    • bounceType

      public final BounceType bounceType()

      The reason for the bounce. You must provide either this parameter or RecipientDsnFields.

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

      Returns:
      The reason for the bounce. You must provide either this parameter or RecipientDsnFields.
      See Also:

    • bounceTypeAsString

      public final String bounceTypeAsString()

      The reason for the bounce. You must provide either this parameter or RecipientDsnFields.

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

      Returns:
      The reason for the bounce. You must provide either this parameter or RecipientDsnFields.
      See Also:

    • recipientDsnFields

      public final RecipientDsnFields recipientDsnFields()

      Recipient-related DSN fields, most of which would normally be filled in automatically when provided with a BounceType. You must provide either this parameter or BounceType.

      Returns:
      Recipient-related DSN fields, most of which would normally be filled in automatically when provided with a BounceType. You must provide either this parameter or BounceType.

    • toBuilder

      public BouncedRecipientInfo.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<BouncedRecipientInfo.Builder,BouncedRecipientInfo>
      Returns:
      a builder for type T

    • builder

      public static BouncedRecipientInfo.Builder builder()

    • serializableBuilderClass

      public static Class<? extends BouncedRecipientInfo.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.