org.simplejavamail.api.mailer.config

Interface ProxyConfig

public interface ProxyConfig

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

In case a proxy is required, the properties "mail.smtp(s).socks.host" and "mail.smtp(s).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.

NOTE: 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.

Method Summary

Modifier and Type	Method and Description
@Nullable String	getPassword()
@Nullable Integer	getProxyBridgePort()
@Nullable String	getRemoteProxyHost()
@Nullable Integer	getRemoteProxyPort()
@Nullable String	getUsername()
boolean	requiresAuthentication()
boolean	requiresProxy()
String	toString()

Method Detail

requiresProxy

boolean requiresProxy()

Returns:

true if remoteProxyHost isn't empty.

requiresAuthentication

boolean requiresAuthentication()

Returns:

true if username isn't empty.

toString

String toString()

Overrides:

toString in class Object

getProxyBridgePort

@Nullable
@Nullable Integer getProxyBridgePort()

See Also:

MailerGenericBuilder.withProxyBridgePort(Integer)

getRemoteProxyHost

@Nullable
@Nullable String getRemoteProxyHost()

See Also:

MailerGenericBuilder.withProxyHost(String)

getRemoteProxyPort

@Nullable
@Nullable Integer getRemoteProxyPort()

See Also:

MailerGenericBuilder.withProxyPort(Integer)

getUsername

@Nullable
@Nullable String getUsername()

See Also:

MailerGenericBuilder.withProxyUsername(String)

getPassword

@Nullable
@Nullable String getPassword()

See Also:

MailerGenericBuilder.withProxyPassword(String)