org.simplejavamail.mailer.config

Class ProxyConfig

java.lang.Object

org.simplejavamail.mailer.internal.socks.SocksProxyConfig

org.simplejavamail.mailer.config.ProxyConfig

public class ProxyConfig
extends SocksProxyConfig

The proxy configuration that indicates whether the connections should be routed through a proxy.

In case a proxy is required, the properties "mail.smtp.socks.host" and "mail.smtp.socks.port" will be set.

As the underlying JavaMail framework only support anonymous SOCKS proxy servers for non-ssl connections, authenticated SOCKS5 proxy is made possible using an intermediary anonymous proxy server which relays the connection through an authenticated remote proxy server. Anonymous proxies are still handled by JavaMail's own time-tested proxy client implementation.

Attempting to use a proxy and SSL SMTP authentication will result in an error, as the underlying JavaMail framework ignores any proxy settings for SSL connections.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PROXY_BRIDGE_PORT The temporary intermediary SOCKS5 relay server bridge is a server that sits in between JavaMail and the remote proxy.

Fields inherited from class org.simplejavamail.mailer.internal.socks.SocksProxyConfig

password, proxyBridgePort, remoteProxyHost, remoteProxyPort, username

Constructor Summary

Constructors

Constructor and Description
ProxyConfig() 'Skip proxy' constructor short-cut.
ProxyConfig(String remoteProxyHost, Integer remoteProxyPort) 'Anonymous proxy' constructor short-cut.
ProxyConfig(String remoteProxyHost, Integer remoteProxyPort, String username, String password) Creates an proxy configuration, which can be anonymous or authenticated.

Method Summary

Modifier and Type	Method and Description
String	getPassword()
int	getProxyBridgePort()
String	getRemoteProxyHost()
Integer	getRemoteProxyPort()
String	getUsername()
boolean	requiresAuthentication() If a username was provided, we will need to authenticate with the proxy.
boolean	requiresProxy() If a host was provided then proxy is required.
void	setProxyBridgePort(int proxyBridgePort)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PROXY_BRIDGE_PORT

public static final int DEFAULT_PROXY_BRIDGE_PORT

The temporary intermediary SOCKS5 relay server bridge is a server that sits in between JavaMail and the remote proxy. Default port is 1081.

See Also:

Constant Field Values

Constructor Detail

ProxyConfig

public ProxyConfig()

'Skip proxy' constructor short-cut.

See Also:

ProxyConfig(String, Integer, String, String)

ProxyConfig

public ProxyConfig(String remoteProxyHost,
                   Integer remoteProxyPort)

'Anonymous proxy' constructor short-cut.

Parameters:

remoteProxyHost - The host of the remote proxy.

remoteProxyPort - The port of the remote proxy.

See Also:

ProxyConfig(String, Integer, String, String)

ProxyConfig

public ProxyConfig(String remoteProxyHost,
                   Integer remoteProxyPort,
                   String username,
                   String password)

Creates an proxy configuration, which can be anonymous or authenticated. Host and port are required and either both or none of username and password should be provided. All arguments can be empty if the related properties are configured in a config file.

Parameters:

remoteProxyHost - The host of the remote proxy.

remoteProxyPort - The port of the remote proxy.

username - Username is mandatory when authentication is required.

password - Password is mandatory when authentication is required.

Method Detail

requiresProxy

public boolean requiresProxy()

If a host was provided then proxy is required.

requiresAuthentication

public boolean requiresAuthentication()

If a username was provided, we will need to authenticate with the proxy.

toString

public String toString()

Overrides:

toString in class Object

getProxyBridgePort

public int getProxyBridgePort()

setProxyBridgePort

public void setProxyBridgePort(int proxyBridgePort)

Parameters:

proxyBridgePort - Port override for the temporary intermediary SOCKS5 relay server bridge (default is 1081).

getRemoteProxyHost

public String getRemoteProxyHost()

getRemoteProxyPort

public Integer getRemoteProxyPort()

getUsername

public String getUsername()

getPassword

public String getPassword()