org.apache.commons.net.smtp

Class RelayPath

java.lang.Object

org.apache.commons.net.smtp.RelayPath

public final class RelayPath
extends java.lang.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

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.lang.String	_emailAddress
(package private) java.util.Vector<java.lang.String>	_path

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addRelay(java.lang.String hostname) Add a mail relay host to the relay path.
java.lang.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

Field Detail

_path

java.util.Vector<java.lang.String> _path

_emailAddress

java.lang.String _emailAddress

Constructor Detail

RelayPath

public RelayPath(java.lang.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(java.lang.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 java.lang.String toString()

Return the properly formatted string representation of the relay path.

Overrides:

toString in class java.lang.Object

Returns:

The properly formatted string representation of the relay path.