org.springframework.mail.javamail
Class JavaMailSenderImpl

java.lang.Object
  org.springframework.mail.javamail.JavaMailSenderImpl

All Implemented Interfaces:

JavaMailSender, MailSender

public class JavaMailSenderImpl

extends java.lang.Object

implements JavaMailSender

Implementation of the JavaMailSender interface. Can also be used as plain MailSender implementation.

Allows for defining all settings locally as bean properties. Alternatively, a pre-configured JavaMail Session can be specified, possibly pulled from an application server's JNDI environment.

Non-default properties in this object will always override the settings in the JavaMail Session. Note that if overriding all values locally, there is no value in setting a pre-configured Session.

Since:

10.09.2003

Version:

$Id: JavaMailSenderImpl.java,v 1.12 2004/03/18 02:46:14 trisberg Exp $

Author:

Dmitriy Kopylenko, Juergen Hoeller

See Also:

JavaMailSender, MailSender

Field Summary

static int	DEFAULT_PORT
static java.lang.String	DEFAULT_PROTOCOL
protected org.apache.commons.logging.Log	logger

Constructor Summary

JavaMailSenderImpl()

Method Summary

javax.mail.internet.MimeMessage	createMimeMessage() Create a new JavaMail MimeMessage for the underlying JavaMail Session of this sender.
protected javax.mail.Transport	getTransport(javax.mail.Session session) Get a Transport object for the given JavaMail Session.
void	send(javax.mail.internet.MimeMessage mimeMessage) Send the given JavaMail MIME message.
void	send(javax.mail.internet.MimeMessage[] mimeMessages) Send the given array of JavaMail MIME messages in batch.
void	send(javax.mail.internet.MimeMessage[] mimeMessages, java.lang.Object[] originalMessages)
void	send(MimeMessagePreparator mimeMessagePreparator) Send the JavaMail MIME message prepared by the given MimeMessagePreparator.
void	send(MimeMessagePreparator[] mimeMessagePreparators) Send the JavaMail MIME messages prepared by the given MimeMessagePreparators.
void	send(SimpleMailMessage simpleMessage) Send the given simple mail message.
void	send(SimpleMailMessage[] simpleMessages) Send the given array of simple mail messages in batch.
void	setHost(java.lang.String host) Set the mail server host, typically an SMTP host.
void	setJavaMailProperties(java.util.Properties javaMailProperties) Set JavaMail properties for the Session.
void	setPassword(java.lang.String password) Set the password for the account at the mail host, if any.
void	setPort(int port) Set the mail server port.
void	setProtocol(java.lang.String protocol) Set the mail protocol.
void	setSession(javax.mail.Session session) Set the JavaMail Session, possibly pulled from JNDI.
void	setUsername(java.lang.String username) Set the username for the account at the mail host, if any.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PROTOCOL

public static final java.lang.String DEFAULT_PROTOCOL

See Also:

Constant Field Values

DEFAULT_PORT

public static final int DEFAULT_PORT

See Also:

Constant Field Values

logger

protected final org.apache.commons.logging.Log logger

Constructor Detail

JavaMailSenderImpl

public JavaMailSenderImpl()

Method Detail

setSession

public void setSession(javax.mail.Session session)

Set the JavaMail Session, possibly pulled from JNDI. Default is a new Session without defaults, i.e. completely configured via this object's properties.

If using a pre-configured Session, non-default properties in this MailSender will override the settings in the Session.

See Also:

setJavaMailProperties(java.util.Properties)

setJavaMailProperties

public void setJavaMailProperties(java.util.Properties javaMailProperties)

Set JavaMail properties for the Session. A new Session will be created with those properties. Use either this or setSession, not both.

Non-default properties in this MailSender will override given JavaMail properties.

See Also:

setSession(javax.mail.Session)

setProtocol

public void setProtocol(java.lang.String protocol)

Set the mail protocol. Default is SMTP.

setHost

public void setHost(java.lang.String host)

Set the mail server host, typically an SMTP host.

setPort

public void setPort(int port)

Set the mail server port. Default is -1, letting JavaMail use the default SMTP port (25).

setUsername

public void setUsername(java.lang.String username)

Set the username for the account at the mail host, if any.

setPassword

public void setPassword(java.lang.String password)

Set the password for the account at the mail host, if any.

send

public void send(SimpleMailMessage simpleMessage)
          throws MailException

Description copied from interface: MailSender

Send the given simple mail message.

Specified by:

send in interface MailSender

Parameters:

simpleMessage - message to send

Throws:

MailException - in case of message, authentication or send errors

send

public void send(SimpleMailMessage[] simpleMessages)
          throws MailException

Description copied from interface: MailSender

Send the given array of simple mail messages in batch.

Specified by:

send in interface MailSender

Parameters:

simpleMessages - messages to send

Throws:

MailException - in case of message, authentication or send errors

createMimeMessage

public javax.mail.internet.MimeMessage createMimeMessage()

Description copied from interface: JavaMailSender

Create a new JavaMail MimeMessage for the underlying JavaMail Session of this sender. Needs to be called to create MimeMessage instances that can be prepared by the client and passed to send(MimeMessage).

Specified by:

createMimeMessage in interface JavaMailSender

Returns:

the new MimeMessage instance

See Also:

JavaMailSender.send(MimeMessage), JavaMailSender.send(MimeMessage[])

send

public void send(javax.mail.internet.MimeMessage mimeMessage)
          throws MailException

Description copied from interface: JavaMailSender

Send the given JavaMail MIME message. The message needs to have been created with createMimeMessage.

Specified by:

send in interface JavaMailSender

Parameters:

mimeMessage - message to send

Throws:

MailException - in case of message, authentication or send errors

See Also:

JavaMailSender.createMimeMessage()

send

public void send(javax.mail.internet.MimeMessage[] mimeMessages)
          throws MailException

Description copied from interface: JavaMailSender

Send the given array of JavaMail MIME messages in batch. The messages need to have been created with createMimeMessage.

Specified by:

send in interface JavaMailSender

Parameters:

mimeMessages - messages to send

Throws:

MailException - in case of message, authentication or send errors

See Also:

JavaMailSender.createMimeMessage()

send

public void send(javax.mail.internet.MimeMessage[] mimeMessages,
                 java.lang.Object[] originalMessages)
          throws MailException

Throws:

MailException

send

public void send(MimeMessagePreparator mimeMessagePreparator)
          throws MailException

Description copied from interface: JavaMailSender

Send the JavaMail MIME message prepared by the given MimeMessagePreparator. Alternative way to prepare MimeMessage instances, instead of createMimeMessage and send(MimeMessage) calls. Takes care of proper exception conversion.

Specified by:

send in interface JavaMailSender

Parameters:

mimeMessagePreparator - the preparator to use

Throws:

MailException - in case of message, authentication or send errors

send

public void send(MimeMessagePreparator[] mimeMessagePreparators)
          throws MailException

Description copied from interface: JavaMailSender

Send the JavaMail MIME messages prepared by the given MimeMessagePreparators. Alternative way to prepare MimeMessage instances, instead of createMimeMessage and send(MimeMessage[]) calls. Takes care of proper exception conversion.

Specified by:

send in interface JavaMailSender

Parameters:

mimeMessagePreparators - the preparator to use

Throws:

MailException - in case of message, authentication or send errors

getTransport

protected javax.mail.Transport getTransport(javax.mail.Session session)
                                     throws javax.mail.NoSuchProviderException

Get a Transport object for the given JavaMail Session. Can be overridden in subclasses, e.g. to return a mock Transport object.

Throws:

javax.mail.NoSuchProviderException