Class RecipientDsnFields
- All Implemented Interfaces:
Serializable
,Cloneable
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:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
The action performed by the reporting mail transfer agent (MTA) as a result of its attempt to deliver the message to the recipient address.An extended explanation of what went wrong; this is usually an SMTP response.Additional X-headers to include in the DSN.The email address to which the message was ultimately delivered.The time the final delivery attempt was made, in RFC 822 date-time format.The MTA to which the remote MTA attempted to deliver the message, formatted as specified in RFC 3464 (mta-name-type; mta-name
).The status code that indicates what went wrong.int
hashCode()
void
The action performed by the reporting mail transfer agent (MTA) as a result of its attempt to deliver the message to the recipient address.void
The action performed by the reporting mail transfer agent (MTA) as a result of its attempt to deliver the message to the recipient address.void
setDiagnosticCode
(String diagnosticCode) An extended explanation of what went wrong; this is usually an SMTP response.void
setExtensionFields
(Collection<ExtensionField> extensionFields) Additional X-headers to include in the DSN.void
setFinalRecipient
(String finalRecipient) The email address to which the message was ultimately delivered.void
setLastAttemptDate
(Date lastAttemptDate) The time the final delivery attempt was made, in RFC 822 date-time format.void
setRemoteMta
(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
).void
The status code that indicates what went wrong.toString()
Returns a string representation of this object; useful for testing and debugging.withAction
(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.withAction
(String 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.withDiagnosticCode
(String diagnosticCode) An extended explanation of what went wrong; this is usually an SMTP response.withExtensionFields
(ExtensionField... extensionFields) Additional X-headers to include in the DSN.withExtensionFields
(Collection<ExtensionField> extensionFields) Additional X-headers to include in the DSN.withFinalRecipient
(String finalRecipient) The email address to which the message was ultimately delivered.withLastAttemptDate
(Date lastAttemptDate) The time the final delivery attempt was made, in RFC 822 date-time format.withRemoteMta
(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
).withStatus
(String status) The status code that indicates what went wrong.
-
Constructor Details
-
RecipientDsnFields
public RecipientDsnFields()
-
-
Method Details
-
setFinalRecipient
The email address to which the message was ultimately delivered. This corresponds to the
Final-Recipient
in the DSN. If not specified,FinalRecipient
will be set to theRecipient
specified in theBouncedRecipientInfo
structure. EitherFinalRecipient
or the recipient inBouncedRecipientInfo
must be a recipient of the original bounced message.Do not prepend the FinalRecipient
email address withrfc 822;
, as described in RFC 3798.- Parameters:
finalRecipient
- The email address to which the message was ultimately delivered. This corresponds to theFinal-Recipient
in the DSN. If not specified,FinalRecipient
will be set to theRecipient
specified in theBouncedRecipientInfo
structure. EitherFinalRecipient
or the recipient inBouncedRecipientInfo
must be a recipient of the original bounced message.Do not prepend the FinalRecipient
email address withrfc 822;
, as described in RFC 3798.
-
getFinalRecipient
The email address to which the message was ultimately delivered. This corresponds to the
Final-Recipient
in the DSN. If not specified,FinalRecipient
will be set to theRecipient
specified in theBouncedRecipientInfo
structure. EitherFinalRecipient
or the recipient inBouncedRecipientInfo
must be a recipient of the original bounced message.Do not prepend the FinalRecipient
email address withrfc 822;
, as described in RFC 3798.- Returns:
- The email address to which the message was ultimately delivered.
This corresponds to the
Final-Recipient
in the DSN. If not specified,FinalRecipient
will be set to theRecipient
specified in theBouncedRecipientInfo
structure. EitherFinalRecipient
or the recipient inBouncedRecipientInfo
must be a recipient of the original bounced message.Do not prepend the FinalRecipient
email address withrfc 822;
, as described in RFC 3798.
-
withFinalRecipient
The email address to which the message was ultimately delivered. This corresponds to the
Final-Recipient
in the DSN. If not specified,FinalRecipient
will be set to theRecipient
specified in theBouncedRecipientInfo
structure. EitherFinalRecipient
or the recipient inBouncedRecipientInfo
must be a recipient of the original bounced message.Do not prepend the FinalRecipient
email address withrfc 822;
, as described in RFC 3798.- Parameters:
finalRecipient
- The email address to which the message was ultimately delivered. This corresponds to theFinal-Recipient
in the DSN. If not specified,FinalRecipient
will be set to theRecipient
specified in theBouncedRecipientInfo
structure. EitherFinalRecipient
or the recipient inBouncedRecipientInfo
must be a recipient of the original bounced message.Do not prepend the FinalRecipient
email address withrfc 822;
, as described in RFC 3798.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAction
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.
- Parameters:
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.- See Also:
-
getAction
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.
- 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:
-
withAction
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setAction
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.
- Parameters:
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.- See Also:
-
withAction
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setRemoteMta
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.- Parameters:
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.
-
getRemoteMta
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.
-
withRemoteMta
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.- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
setStatus
The status code that indicates what went wrong. This is required by RFC 3464.
- Parameters:
status
- The status code that indicates what went wrong. This is required by RFC 3464.
-
getStatus
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.
-
withStatus
The status code that indicates what went wrong. This is required by RFC 3464.
- Parameters:
status
- The status code that indicates what went wrong. This is required by RFC 3464.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDiagnosticCode
An extended explanation of what went wrong; this is usually an SMTP response. See RFC 3463 for the correct formatting of this parameter.
- Parameters:
diagnosticCode
- An extended explanation of what went wrong; this is usually an SMTP response. See RFC 3463 for the correct formatting of this parameter.
-
getDiagnosticCode
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.
-
withDiagnosticCode
An extended explanation of what went wrong; this is usually an SMTP response. See RFC 3463 for the correct formatting of this parameter.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
setLastAttemptDate
The time the final delivery attempt was made, in RFC 822 date-time format.
- Parameters:
lastAttemptDate
- The time the final delivery attempt was made, in RFC 822 date-time format.
-
getLastAttemptDate
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.
-
withLastAttemptDate
The time the final delivery attempt was made, in RFC 822 date-time format.
- Parameters:
lastAttemptDate
- The time the final delivery attempt was made, in RFC 822 date-time format.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getExtensionFields
Additional X-headers to include in the DSN.
- Returns:
- Additional X-headers to include in the DSN.
-
setExtensionFields
Additional X-headers to include in the DSN.
- Parameters:
extensionFields
- Additional X-headers to include in the DSN.
-
withExtensionFields
Additional X-headers to include in the DSN.
NOTE: This method appends the values to the existing list (if any). Use
setExtensionFields(java.util.Collection)
orwithExtensionFields(java.util.Collection)
if you want to override the existing values.- Parameters:
extensionFields
- Additional X-headers to include in the DSN.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withExtensionFields
Additional X-headers to include in the DSN.
- Parameters:
extensionFields
- Additional X-headers to include in the DSN.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-