com.foreach.common.spring.mail

Class BasicMailService

java.lang.Object

com.foreach.common.spring.mail.BasicMailService

All Implemented Interfaces:

MailService

public class BasicMailService
extends Object
implements MailService

MailService sends smtp mails with optional attachments.

By default, a MailService instance will send mails synchronously, but you can alter this behaviour by changing the executorService.

If you want the option of sending mails both synchronously and asynchronously, you should create two MailService instances.

In most cases, you will have the BasicMailService configured as a bean in an xml file. If you want to use annotation in combination with a component scanner, you have to subclass BasicMailService and annotate the subclass.

Example spring configuration with a shared javaMailSender and a private asynchronous executorService:

 
  <bean id="sharedMailSender" class="org.springframework.mail.javamail.JavaMailSenderImpl">
      <property name="host" value="localhost"/>
      <property name="defaultEncoding" value="UTF-8"/>
      <property name="javaMailProperties">
          <props>
              <prop key="mail.smtp.connectiontimeout">30000</prop>
              <prop key="mail.smtp.timeout">30000</prop>
          </props>
      </property>
  </bean>

  <bean id="mailService" class="com.foreach.spring.mail.BasicMailService">
      <property name="originator" value="noreply@foo.bar"/>
      <property name="executorService">
          <bean class="java.util.concurrent.ScheduledThreadPoolExecutor" destroy-method="shutdown">
              <constructor-arg index="0" type="int" value="2"/>
          </bean>
      </property>
      <property name="javaMailSender" ref="sharedMailSender"/>
  </bean>
 
 

Constructor Summary

Constructors

Constructor and Description
BasicMailService()

Method Summary

Modifier and Type	Method and Description
ExecutorService	getExecutorService() Get the current ExecutorService being used.
protected org.slf4j.Logger	getLogger() Get the logger
String	getServiceBccRecipients()
Future<MailStatus>	sendMimeMail(String from, String to, String bccs, String subject, String body, Map<String,File> attachments) Send a mail message with optional attachments.
void	setExecutorService(ExecutorService executorService) Set the executorService used to send messages through the javaMailSender.
void	setJavaMailSender(org.springframework.mail.javamail.JavaMailSender javaMailSender) Set the JavaMailSender to be used.
protected void	setLogger(org.slf4j.Logger logger)
void	setOriginator(String originator) Set the default originator to be used to send messages through the javaMailSender.
void	setServiceBccRecipients(String serviceBccRecipients) Set the default bcc: recipients for this service.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicMailService

public BasicMailService()

Method Detail

setLogger

protected final void setLogger(org.slf4j.Logger logger)

getLogger

protected final org.slf4j.Logger getLogger()

Get the logger

Returns:

Logger

setJavaMailSender

public final void setJavaMailSender(org.springframework.mail.javamail.JavaMailSender javaMailSender)

Set the JavaMailSender to be used.

setOriginator

public final void setOriginator(String originator)

Set the default originator to be used to send messages through the javaMailSender.

Parameters:

originator - the email address of the default originator. This value can be overridden on a per message basis.

setServiceBccRecipients

public final void setServiceBccRecipients(String serviceBccRecipients)

Set the default bcc: recipients for this service.

Parameters:

serviceBccRecipients - a comma or semicolon separated list of email adresses. This value can be overridden on a per message basis.

getServiceBccRecipients

public final String getServiceBccRecipients()

setExecutorService

public final void setExecutorService(ExecutorService executorService)

Set the executorService used to send messages through the javaMailSender.

Parameters:

executorService - By default, a synchronous TaskExecutoService is configured.

getExecutorService

public final ExecutorService getExecutorService()

Get the current ExecutorService being used.

sendMimeMail

public final Future<MailStatus> sendMimeMail(String from,
                                             String to,
                                             String bccs,
                                             String subject,
                                             String body,
                                             Map<String,File> attachments)

Send a mail message with optional attachments.

Specified by:

sendMimeMail in interface MailService

Parameters:

from - the email address of the originator.

to - the email address(es) of the intended recipient(s).

bccs - the email address(es) of other intended recipient(s).

subject - the subject of the mail message.

body - the body of the mail message.

attachments - a map of included files.

Returns:

A future containing the MailStatus object. The status of sending is dependent on the actual MailSender used. If success it usually means the message was successfully delivered to the MSA or MTA.

See Also:

RFC 2476.