com.googlecode.kevinarpe.papaya.java_mail

Interface JavaMailSessionBuilder

All Known Implementing Classes:

JavaMailSessionBuilderImp

public interface JavaMailSessionBuilder

Author:

Kevin Connor ARPE (kevinarpe@gmail.com)

See Also:

JavaMailSessionBuilderFactory.INSTANCE

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.

Method Detail

host

JavaMailSessionBuilder host(String host,
                            AlwaysTrustSSL alwaysTrustSSL)

Sets the hostname of SMTP gateway.

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

Throws:

IllegalArgumentException - if host is empty or all whitespace

See Also:

port(SmtpPort)

port

JavaMailSessionBuilder port(SmtpPort smtpPort)

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

Returns:

self for fluent interface / method chaining

See Also:

customPort(int)

customPort

JavaMailSessionBuilder customPort(int port)

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

Parameters:

port - must not be zero or negative

Returns:

self for fluent interface / method chaining

Throws:

IllegalArgumentException - if port is invalid

See Also:

port(SmtpPort)

usernameAndPassword

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.

Parameters:

username - must not be empty or all whitespace

password - must not be empty or all whitespace

Returns:

self for fluent interface / method chaining

Throws:

IllegalArgumentException - if username or password is empty or all whitespace

properties

Properties properties()

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

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

build

JavaMailSession build()

Builds a new Session object and returns wrapper.

See Also:

Session.getInstance(Properties)