org.simplejavamail.mailer.internal.mailsender

Class MailSender

java.lang.Object

org.simplejavamail.mailer.internal.mailsender.MailSender

public class MailSender
extends Object

Class that performs the actual javax.mail SMTP integration.

Refer to send(Email, boolean) for details.

On a technical note, this is the most complex class in the library (aside from the SOCKS5 bridging server), because it deals with optional asynchronous mailing requests and an optional proxy server that needs to be started and stopped on the fly depending on how many emails are (still) being sent. Especially the combination of asynchronous emails and synchronous emails needs to be managed properly.

Constructor Summary

Constructors

Constructor and Description
MailSender(javax.mail.Session session, ProxyConfig proxyConfig, TransportStrategy transportStrategy) Configures proxy: configureSessionWithProxy(ProxyConfig, Session, TransportStrategy)(ProxyConfig, Session, TransportStrategy)

Method Summary

Modifier and Type	Method and Description
void	applyProperties(Properties properties)
javax.mail.Session	getSession() For emergencies, when a client really wants access to the internally created Session instance.
boolean	isTransportModeLoggingOnly()
void	send(Email email, boolean async) Processes an Email instance into a completely configured Message.
void	setDebug(boolean debug) Refer to SessionSession.setDebug(boolean)
void	setSessionTimeout(int sessionTimeout)
void	setThreadPoolSize(int threadPoolSize)
void	setTransportModeLoggingOnly(boolean transportModeLoggingOnly) Sets the transport mode for this mail sender to logging only, which means no mail will be actually sent out.
void	trustAllHosts(boolean trustAllHosts) Configures the current session to trust all hosts and don't validate any SSL keys.
void	trustHosts(String... hosts) Configures the current session to white list all provided hosts and don't validate SSL keys for them.

Methods inherited from class java.lang.Object

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

Constructor Detail

MailSender

public MailSender(javax.mail.Session session,
                  ProxyConfig proxyConfig,
                  TransportStrategy transportStrategy)

Configures proxy: configureSessionWithProxy(ProxyConfig, Session, TransportStrategy)(ProxyConfig, Session, TransportStrategy)

Also initializes:

• sessionTimeout from properties or default DEFAULT_SESSION_TIMEOUT_MILLIS
• threadPoolSize from properties or default DEFAULT_POOL_SIZE
• transportModeLoggingOnly from properties or default DEFAULT_MODE_LOGGING_ONLY

Method Detail

send

public final void send(Email email,
                       boolean async)

Processes an Email instance into a completely configured Message.

Sends the Sun JavaMail Message object using Session.getTransport(). It will call Service.connect() assuming all connection details have been configured in the provided Session instance and finally Transport.sendMessage(Message, Address[]).

Performs a call to Message.saveChanges() as the Sun JavaMail API indicates it is needed to configure the message headers and providing a message id.

If the email should be sent asynchrounously - perhaps as part of a batch, then a new thread is started using the executor for threadpooling.

If the email should go through an authenticated proxy server, then the SOCKS proxy bridge is started if not already running. When the last email in a batch has finished, the proxy bridging server is shut down.

Parameters:

email - The information for the email to be sent.

async - If false, this method blocks until the mail has been processed completely by the SMTP server. If true, a new thread is started to send the email and this method returns immediately.

Throws:

MailException - Can be thrown if an email isn't validating correctly, or some other problem occurs during connection, sending etc.

See Also:

Executors.newFixedThreadPool(int)

setDebug

public void setDebug(boolean debug)

Refer to SessionSession.setDebug(boolean)

trustAllHosts

public void trustAllHosts(boolean trustAllHosts)

Configures the current session to trust all hosts and don't validate any SSL keys. The property "mail.smtp.ssl.trust" is set to "*".

Refer to https://javamail.java.net/nonav/docs/api/com/sun/mail/smtp/package-summary.html#mail.smtp.ssl.trust

trustHosts

public void trustHosts(String... hosts)

Configures the current session to white list all provided hosts and don't validate SSL keys for them. The property "mail.smtp.ssl.trust" is set to a comma separated list.

Refer to https://javamail.java.net/nonav/docs/api/com/sun/mail/smtp/package-summary.html#mail.smtp.ssl.trust

applyProperties

public void applyProperties(Properties properties)

Parameters:

properties - Properties which will be added to the current Session instance.

getSession

public javax.mail.Session getSession()

For emergencies, when a client really wants access to the internally created Session instance.

setThreadPoolSize

public void setThreadPoolSize(int threadPoolSize)

Parameters:

threadPoolSize - The maximum number of threads when sending emails in async fashion.

See Also:

ConfigLoader.Property.DEFAULT_POOL_SIZE

setSessionTimeout

public void setSessionTimeout(int sessionTimeout)

Parameters:

sessionTimeout - The timeout to use when sending emails (affects socket connect-, read- and write timeouts).

See Also:

ConfigLoader.Property.DEFAULT_SESSION_TIMEOUT_MILLIS

setTransportModeLoggingOnly

public void setTransportModeLoggingOnly(boolean transportModeLoggingOnly)

Sets the transport mode for this mail sender to logging only, which means no mail will be actually sent out.

isTransportModeLoggingOnly

public boolean isTransportModeLoggingOnly()

Returns:

transportModeLoggingOnly