Package org.apache.commons.net.smtp

# Class RelayPath

java.lang.Object
org.apache.commons.net.smtp.RelayPath

public final class RelayPath extends Object
A class used to represent forward and reverse relay paths. The SMTP MAIL command requires a reverse relay path while the SMTP RCPT command requires a forward relay path. See RFC 821 for more details. In general, you will not have to deal with relay paths.

See Also:
  - `SMTPClient`

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `RelayPath(String emailAddress)`
  Create a relay path with the specified email address as the ultimate destination.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `addRelay(String hostname)`
  Add a mail relay host to the relay path.
  `String`
  `toString()`
  Return the properly formatted string representation of the relay path.

  ### Methods inherited from class java.lang.Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- ## Constructor Details

  - ### RelayPath

    public RelayPath(String emailAddress)
    Create a relay path with the specified email address as the ultimate destination.
    Parameters:
      `emailAddress` - The destination email address.

- ## Method Details

  - ### addRelay

    public void addRelay(String hostname)
    Add a mail relay host to the relay path. Hosts are added left to right. For example, the following will create the path `< @bar.com,@foo.com:foobar@foo.com >`

         path = new RelayPath("foobar@foo.com");
         path.addRelay("bar.com");
         path.addRelay("foo.com");

    Parameters:
      `hostname` - The host to add to the relay path.

  - ### toString

    public String toString()
    Return the properly formatted string representation of the relay path.
    Overrides:
      `toString` in class `Object`
    Returns:
      The properly formatted string representation of the relay path.