Class RecipientDsnFields

    • Constructor Detail

      • RecipientDsnFields

        public RecipientDsnFields()
    • Method Detail

      • setFinalRecipient

        public void setFinalRecipient​(String finalRecipient)

        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 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.
        Parameters:
        finalRecipient - 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 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.
      • getFinalRecipient

        public String 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 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 to which the message was ultimately delivered. This corresponds to the Final-Recipient in the DSN. If not specified, FinalRecipient will be 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.
      • withFinalRecipient

        public RecipientDsnFields withFinalRecipient​(String finalRecipient)

        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 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.
        Parameters:
        finalRecipient - 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 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:
        Returns a reference to this object so that method calls can be chained together.
      • setAction

        public void setAction​(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. 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:
        DsnAction
      • getAction

        public String 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:
        DsnAction
      • withAction

        public RecipientDsnFields 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. 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:
        DsnAction
      • setAction

        public void setAction​(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.

        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:
        DsnAction
      • withAction

        public RecipientDsnFields 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. 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:
        DsnAction
      • setRemoteMta

        public 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). 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

        public String 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

        public RecipientDsnFields 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). 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

        public void setStatus​(String status)

        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

        public String 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

        public RecipientDsnFields withStatus​(String status)

        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

        public void setDiagnosticCode​(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.

        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

        public String 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

        public RecipientDsnFields withDiagnosticCode​(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.

        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

        public void setLastAttemptDate​(Date lastAttemptDate)

        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

        public Date 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

        public RecipientDsnFields withLastAttemptDate​(Date lastAttemptDate)

        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

        public List<ExtensionField> getExtensionFields()

        Additional X-headers to include in the DSN.

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

        public void setExtensionFields​(Collection<ExtensionField> extensionFields)

        Additional X-headers to include in the DSN.

        Parameters:
        extensionFields - Additional X-headers to include in the DSN.
      • withExtensionFields

        public RecipientDsnFields withExtensionFields​(Collection<ExtensionField> extensionFields)

        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

        public String toString()
        Returns a string representation of this object; useful for testing and debugging.
        Overrides:
        toString in class Object
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object