com.googlecode.kevinarpe.papaya.java_mail

Class JavaMailSessionBuilderImp

java.lang.Object

com.googlecode.kevinarpe.papaya.java_mail.JavaMailSessionBuilderImp

All Implemented Interfaces:

JavaMailSessionBuilder

public final class JavaMailSessionBuilderImp
extends Object
implements JavaMailSessionBuilder

Author:

Kevin Connor ARPE (kevinarpe@gmail.com) See: EmailMessageBuilderImpTest

See Also:

JavaMailSessionBuilderFactory.INSTANCE

Field Summary

Fields

Modifier and Type	Field and Description
static String	MAIL_SMTP_AUTH
static String	MAIL_SMTP_HOST
static String	MAIL_SMTP_PASSWORD
static String	MAIL_SMTP_PORT
static String	MAIL_SMTP_SSL_TRUST
static String	MAIL_SMTP_STARTTLS_ENABLE
static String	MAIL_SMTP_USER

Constructor Summary

Constructors

Constructor and Description
JavaMailSessionBuilderImp()

Method Summary

Modifier and Type	Method and Description
JavaMailSession	build() Builds a new Session object and returns wrapper.
JavaMailSessionBuilder	customPort(int port) Sets a standard port number for SMTP gateway.
JavaMailSessionBuilder	host(String host, AlwaysTrustSSL alwaysTrustSSL) Sets the hostname of SMTP gateway.
JavaMailSessionBuilder	port(SmtpPort smtpPort) Sets a standard port number for SMTP gateway.
Properties	properties() Optional: Directly access Properties collection used to build final Session object.
JavaMailSessionBuilder	usernameAndPassword(String username, String password) Optional: Sets the username and password to authenticate with SMTP gateway.

Methods inherited from class java.lang.Object

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

Field Detail

MAIL_SMTP_STARTTLS_ENABLE

public static final String MAIL_SMTP_STARTTLS_ENABLE

See Also:

Constant Field Values

MAIL_SMTP_HOST

public static final String MAIL_SMTP_HOST

See Also:

Constant Field Values

MAIL_SMTP_SSL_TRUST

public static final String MAIL_SMTP_SSL_TRUST

See Also:

Constant Field Values

MAIL_SMTP_PORT

public static final String MAIL_SMTP_PORT

See Also:

Constant Field Values

MAIL_SMTP_USER

public static final String MAIL_SMTP_USER

See Also:

Constant Field Values

MAIL_SMTP_PASSWORD

public static final String MAIL_SMTP_PASSWORD

See Also:

Constant Field Values

MAIL_SMTP_AUTH

public static final String MAIL_SMTP_AUTH

See Also:

Constant Field Values

Constructor Detail

JavaMailSessionBuilderImp

public JavaMailSessionBuilderImp()

Method Detail

host

public JavaMailSessionBuilder host(String host,
                                   AlwaysTrustSSL alwaysTrustSSL)

Sets the hostname of SMTP gateway.

Specified by:

host in interface JavaMailSessionBuilder

Parameters:

host - hostname of SMTP gateway, e.g., "smtp.gmail.com"
must not be empty or all whitespace

alwaysTrustSSL - set this option if you have trouble with SSL certificates

Returns:

self for fluent interface / method chaining

See Also:

JavaMailSessionBuilder.port(SmtpPort)

port

public JavaMailSessionBuilder port(SmtpPort smtpPort)

Sets a standard port number for SMTP gateway. For non-standard ports, see: JavaMailSessionBuilder.customPort(int).

Specified by:

port in interface JavaMailSessionBuilder

Returns:

self for fluent interface / method chaining

See Also:

JavaMailSessionBuilder.customPort(int)

customPort

public JavaMailSessionBuilder customPort(int port)

Sets a standard port number for SMTP gateway. For standard ports, see: JavaMailSessionBuilder.port(SmtpPort).

Specified by:

customPort in interface JavaMailSessionBuilder

Parameters:

port - must not be zero or negative

Returns:

self for fluent interface / method chaining

See Also:

JavaMailSessionBuilder.port(SmtpPort)

usernameAndPassword

public JavaMailSessionBuilder usernameAndPassword(String username,
                                                  String password)

Optional: Sets the username and password to authenticate with SMTP gateway. This is frequently required for external SMTP gateways, but may not be required for internal (corporate) SMTP gateways.

Specified by:

usernameAndPassword in interface JavaMailSessionBuilder

Parameters:

username - must not be empty or all whitespace

password - must not be empty or all whitespace

Returns:

self for fluent interface / method chaining

properties

public Properties properties()

Optional: Directly access Properties collection used to build final Session object.

Use this method if you need to customise properties before calling JavaMailSessionBuilder.build().

Specified by:

properties in interface JavaMailSessionBuilder

build

public JavaMailSession build()

Builds a new Session object and returns wrapper.

Specified by:

build in interface JavaMailSessionBuilder

See Also:

Session.getInstance(Properties)