Package software.amazon.awssdk.services.ses.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RecipientDsnFields.Builder

Method Summary

Modifier and Type	Method	Description
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.
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.
static RecipientDsnFields.Builder	builder()
String	diagnosticCode()	An extended explanation of what went wrong; this is usually an SMTP response.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<ExtensionField>	extensionFields()	Additional X-headers to include in the DSN.
String	finalRecipient()	The email address that the message was ultimately delivered to.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasExtensionFields()	For responses, this returns true if the service returned a value for the ExtensionFields property.
int	hashCode()
Instant	lastAttemptDate()	The time the final delivery attempt was made, in RFC 822 date-time format.
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).
List<SdkField<?>>	sdkFields()
static Class<? extends RecipientDsnFields.Builder>	serializableBuilderClass()
String	status()	The status code that indicates what went wrong.
RecipientDsnFields.Builder	toBuilder()
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

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:

DsnAction

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:

DsnAction

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()

Specified by:

toBuilder in interface ToCopyableBuilder<RecipientDsnFields.Builder,RecipientDsnFields>

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)

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