org.codice.ddf.platform.email.impl

Class SmtpClientImpl

java.lang.Object

org.codice.ddf.platform.email.impl.SmtpClientImpl

All Implemented Interfaces:

SmtpClient

public class SmtpClientImpl
extends Object
implements SmtpClient

Supports unauthenticated connections to a mail server and username/password authenticated connections over TLS. If the username is not blank and the password is not empty, then auth/tls will be used.

The method send(Message) will exceute asynchronously in a single thread. The number of operations awaiting execution is unbounded.

This code is experimental. While this interface is functional and tested, it may change or be removed in a future version of the library.

Constructor Summary

Constructors

Constructor and Description
SmtpClientImpl()

Method Summary

Modifier and Type	Method and Description
javax.mail.Session	createSession() Create a session object that is pre-populated with the connection related parameters.
Future<Void>	send(javax.mail.Message message) Send the message.
void	setHostName(String hostName)
void	setPassword(String password) Set the password for the email server.
void	setPortNumber(Integer portNumber)
void	setUserName(String userName) Set the username for the email server.

Methods inherited from class java.lang.Object

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

Constructor Detail

SmtpClientImpl

public SmtpClientImpl()

Method Detail

setUserName

public void setUserName(@Nullable
                        String userName)

Set the username for the email server.

Parameters:

userName - the username of the email server

setPassword

public void setPassword(@Nullable
                        String password)

Set the password for the email server.

Parameters:

password - the password for the email server

setHostName

public void setHostName(String hostName)

Parameters:

hostName - must be non-empty

setPortNumber

public void setPortNumber(Integer portNumber)

Parameters:

portNumber - must be non-null and >0

createSession

public javax.mail.Session createSession()

Description copied from interface: SmtpClient

Create a session object that is pre-populated with the connection related parameters.

Specified by:

createSession in interface SmtpClient

Returns:

session object

send

public Future<Void> send(javax.mail.Message message)
                  throws javax.mail.MessagingException

Description copied from interface: SmtpClient

Send the message. May be sent synchronously or asynchronously.

Specified by:

send in interface SmtpClient

Returns:

a future that the caller can use to determine when the operation completes

Throws:

javax.mail.MessagingException

See Also:

javax.mail.Transport.send(Message)