jodd.mail

Class SmtpServer<T extends SmtpServer>

java.lang.Object

jodd.mail.SmtpServer<T>

All Implemented Interfaces:

SendMailSessionProvider

Direct Known Subclasses:

SmtpSslServer

public class SmtpServer<T extends SmtpServer>
extends java.lang.Object
implements SendMailSessionProvider

Represents simple plain SMTP server for sending emails.

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.mail.Authenticator	authenticator
protected static int	DEFAULT_SMTP_PORT
protected java.lang.String	host
static java.lang.String	MAIL_HOST
static java.lang.String	MAIL_SMTP_AUTH
static java.lang.String	MAIL_SMTP_CONNECTIONTIMEOUT
static java.lang.String	MAIL_SMTP_FROM
static java.lang.String	MAIL_SMTP_HOST
static java.lang.String	MAIL_SMTP_PORT
static java.lang.String	MAIL_SMTP_TIMEOUT
static java.lang.String	MAIL_SMTP_WRITETIMEOUT
static java.lang.String	MAIL_TRANSPORT_PROTOCOL
protected int	port
protected static java.lang.String	PROTOCOL_SMTP
protected int	timeout

Constructor Summary

Constructors

Constructor and Description
SmtpServer(java.lang.String host) SMTP server defined with its host and default port.
SmtpServer(java.lang.String host, int port) SMTP server defined with its host and port.

Method Summary

Methods

Modifier and Type	Method and Description
T	authenticateWith(javax.mail.Authenticator authenticator)
T	authenticateWith(java.lang.String username, java.lang.String password)
static SmtpServer	create(java.lang.String host)
static SmtpServer	create(java.lang.String host, int port)
SendMailSession	createSession() Creates new sending mail session.
protected java.util.Properties	createSessionProperties() Creates mail session properties.
javax.mail.Authenticator	getAuthenticator() Returns authenticator.
java.lang.String	getHost() Returns SMTP host address.
int	getPort() Returns current port.
int	getTimeout() Returns timeout in milliseconds.
protected javax.mail.Transport	getTransport(javax.mail.Session session) Returns mail transport.
T	properties(java.util.Properties properties)
T	property(java.lang.String name, java.lang.String value)
T	timeout(int timeout) Defines timeout value in milliseconds for all mail-related operations.

Methods inherited from class java.lang.Object

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

Field Detail

MAIL_HOST

public static final java.lang.String MAIL_HOST

See Also:

Constant Field Values

MAIL_SMTP_HOST

public static final java.lang.String MAIL_SMTP_HOST

See Also:

Constant Field Values

MAIL_SMTP_PORT

public static final java.lang.String MAIL_SMTP_PORT

See Also:

Constant Field Values

MAIL_SMTP_AUTH

public static final java.lang.String MAIL_SMTP_AUTH

See Also:

Constant Field Values

MAIL_TRANSPORT_PROTOCOL

public static final java.lang.String MAIL_TRANSPORT_PROTOCOL

See Also:

Constant Field Values

MAIL_SMTP_FROM

public static final java.lang.String MAIL_SMTP_FROM

See Also:

Constant Field Values

MAIL_SMTP_CONNECTIONTIMEOUT

public static final java.lang.String MAIL_SMTP_CONNECTIONTIMEOUT

See Also:

Constant Field Values

MAIL_SMTP_TIMEOUT

public static final java.lang.String MAIL_SMTP_TIMEOUT

See Also:

Constant Field Values

MAIL_SMTP_WRITETIMEOUT

public static final java.lang.String MAIL_SMTP_WRITETIMEOUT

See Also:

Constant Field Values

PROTOCOL_SMTP

protected static final java.lang.String PROTOCOL_SMTP

See Also:

Constant Field Values

DEFAULT_SMTP_PORT

protected static final int DEFAULT_SMTP_PORT

See Also:

Constant Field Values

host

protected final java.lang.String host

port

protected final int port

authenticator

protected javax.mail.Authenticator authenticator

timeout

protected int timeout

Constructor Detail

SmtpServer

public SmtpServer(java.lang.String host)

SMTP server defined with its host and default port.

SmtpServer

public SmtpServer(java.lang.String host,
          int port)

SMTP server defined with its host and port.

Method Detail

create

public static SmtpServer create(java.lang.String host)

create

public static SmtpServer create(java.lang.String host,
                int port)

authenticateWith

public T authenticateWith(java.lang.String username,
                 java.lang.String password)

authenticateWith

public T authenticateWith(javax.mail.Authenticator authenticator)

timeout

public T timeout(int timeout)

Defines timeout value in milliseconds for all mail-related operations.

properties

public T properties(java.util.Properties properties)

property

public T property(java.lang.String name,
         java.lang.String value)

createSessionProperties

protected java.util.Properties createSessionProperties()

Creates mail session properties.

createSession

public SendMailSession createSession()

Creates new sending mail session.

Specified by:

createSession in interface SendMailSessionProvider

getTransport

protected javax.mail.Transport getTransport(javax.mail.Session session)
                                     throws javax.mail.NoSuchProviderException

Returns mail transport.

Throws:

javax.mail.NoSuchProviderException

getHost

public java.lang.String getHost()

Returns SMTP host address.

getAuthenticator

public javax.mail.Authenticator getAuthenticator()

Returns authenticator.

getPort

public int getPort()

Returns current port.

getTimeout

public int getTimeout()

Returns timeout in milliseconds.