Package org.bluezoo.gumdrop.smtp

Class DSNEnvelopeParameters

java.lang.Object
org.bluezoo.gumdrop.smtp.DSNEnvelopeParameters
public class DSNEnvelopeParameters extends Object
DSN envelope parameters from the MAIL FROM command.

This class holds the DSN-related parameters specified in the MAIL FROM command as defined in RFC 3461:

  • RET - What to return in DSN (FULL or HDRS)
  • ENVID - Envelope identifier for correlation

Example MAIL FROM with DSN parameters: 

 MAIL FROM:<sender@example.com> RET=HDRS ENVID=QQ314159

The ENVID is transmitted as xtext (RFC 3461 Section 4) and is automatically decoded when parsed.

Author:
Chris Burdess
See Also:

  • Constructor Details

    • DSNEnvelopeParameters

      public DSNEnvelopeParameters(DSNReturn ret, String envid)
      Creates new DSN envelope parameters.
      Parameters:
      ret - the return type (FULL or HDRS), may be null
      envid - the envelope ID, may be null

  • Method Details

    • getRet

      public DSNReturn getRet()
      Returns the RET parameter value.

      This indicates how much of the original message should be included in any DSN that is generated.

      Returns:
      the return type, or null if not specified

    • getEnvid

      public String getEnvid()
      Returns the ENVID parameter value.

      This is an opaque identifier assigned by the sender that can be used to correlate DSN responses with the original message.

      Returns:
      the envelope ID, or null if not specified

    • hasParameters

      public boolean hasParameters()
      Returns true if any DSN parameters were specified.
      Returns:
      true if RET or ENVID is set

    • toString

      public String toString()
      Overrides:
      toString in class Object