Class RecipientDsnFields

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

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

    • finalRecipient

      public final String finalRecipient()

      The email address that the message was ultimately delivered to. This corresponds to the Final-Recipient in the DSN. If not specified, FinalRecipient is set to the Recipient specified in the BouncedRecipientInfo structure. Either FinalRecipient or the recipient in BouncedRecipientInfo must be a recipient of the original bounced message.

      Do not prepend the FinalRecipient email address with rfc 822;, as described in RFC 3798.

      Returns:
      The email address that the message was ultimately delivered to. This corresponds to the Final-Recipient in the DSN. If not specified, FinalRecipient is set to the Recipient specified in the BouncedRecipientInfo structure. Either FinalRecipient or the recipient in BouncedRecipientInfo must be a recipient of the original bounced message.

      Do not prepend the FinalRecipient email address with rfc 822;, as described in RFC 3798.

    • action

      public final DsnAction action()

      The action performed by the reporting mail transfer agent (MTA) as a result of its attempt to deliver the message to the recipient address. This is required by RFC 3464.

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

      Returns:
      The action performed by the reporting mail transfer agent (MTA) as a result of its attempt to deliver the message to the recipient address. This is required by RFC 3464.
      See Also:

    • actionAsString

      public final String actionAsString()

      The action performed by the reporting mail transfer agent (MTA) as a result of its attempt to deliver the message to the recipient address. This is required by RFC 3464.

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

      Returns:
      The action performed by the reporting mail transfer agent (MTA) as a result of its attempt to deliver the message to the recipient address. This is required by RFC 3464.
      See Also:

    • remoteMta

      public final String remoteMta()

      The MTA to which the remote MTA attempted to deliver the message, formatted as specified in RFC 3464 (mta-name-type; mta-name). This parameter typically applies only to propagating synchronous bounces.

      Returns:
      The MTA to which the remote MTA attempted to deliver the message, formatted as specified in RFC 3464 (mta-name-type; mta-name). This parameter typically applies only to propagating synchronous bounces.

    • status

      public final String status()

      The status code that indicates what went wrong. This is required by RFC 3464.

      Returns:
      The status code that indicates what went wrong. This is required by RFC 3464.

    • diagnosticCode

      public final String diagnosticCode()

      An extended explanation of what went wrong; this is usually an SMTP response. See RFC 3463 for the correct formatting of this parameter.

      Returns:
      An extended explanation of what went wrong; this is usually an SMTP response. See RFC 3463 for the correct formatting of this parameter.

    • lastAttemptDate

      public final Instant lastAttemptDate()

      The time the final delivery attempt was made, in RFC 822 date-time format.

      Returns:
      The time the final delivery attempt was made, in RFC 822 date-time format.

    • hasExtensionFields

      public final boolean hasExtensionFields()
      For responses, this returns true if the service returned a value for the ExtensionFields property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • extensionFields

      public final List<ExtensionField> extensionFields()

      Additional X-headers to include in the DSN.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasExtensionFields() method.

      Returns:
      Additional X-headers to include in the DSN.

    • toBuilder

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

    • builder

      public static RecipientDsnFields.Builder builder()

    • serializableBuilderClass

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