org.apache.commons.net.smtp

Class 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.

Author: Daniel F. Savarese

See Also:

Constructor Summary
RelayPath(String emailAddress)
Create a relay path with the specified email address as the ultimate destination.
Method Summary
voidaddRelay(String hostname)
Add a mail relay host to the relay path.
StringtoString()
Return the properly formatted string representation of the relay path.

Constructor Detail

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 Detail

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.

Returns: The properly formatted string representation of the relay path.