Class JavaMailSenderImpl

java.lang.Object
org.springframework.mail.javamail.JavaMailSenderImpl
All Implemented Interfaces:
JavaMailSender, MailSender
public class JavaMailSenderImpl extends Object implements JavaMailSender
Production implementation of the JavaMailSender interface, supporting both JavaMail MimeMessages and Spring SimpleMailMessages. Can also be used as a 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 added value in setting a pre-configured Session.

Since:
10.09.2003
Author:
Dmitriy Kopylenko, Juergen Hoeller
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DEFAULT_PORT
    The default port: -1.
    static final String
    DEFAULT_PROTOCOL
    The default protocol: 'smtp'.

  • Constructor Summary

    Constructors
    Constructor
    Description
    JavaMailSenderImpl()
    Create a new instance of the JavaMailSenderImpl class.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected jakarta.mail.Transport
    connectTransport()
    Obtain and connect a Transport from the underlying JavaMail Session, passing in the specified host, port, username, and password.
    jakarta.mail.internet.MimeMessage
    createMimeMessage()
    This implementation creates a SmartMimeMessage, holding the specified default encoding and default FileTypeMap.
    jakarta.mail.internet.MimeMessage
    createMimeMessage(InputStream contentStream)
    Create a new JavaMail MimeMessage for the underlying JavaMail Session of this sender, using the given input stream as the message source.
    protected void
    doSend(jakarta.mail.internet.MimeMessage[] mimeMessages, Object @Nullable [] originalMessages)
    Actually send the given array of MimeMessages via JavaMail.
    @Nullable String
    getDefaultEncoding()
    Return the default encoding for MimeMessages, or null if none.
    @Nullable jakarta.activation.FileTypeMap
    getDefaultFileTypeMap()
    Return the default Java Activation FileTypeMap for MimeMessages, or null if none.
    @Nullable String
    getHost()
    Return the mail server host.
    Properties
    getJavaMailProperties()
    Allow Map access to the JavaMail properties of this sender, with the option to add or override specific entries.
    @Nullable String
    getPassword()
    Return the password for the account at the mail host.
    int
    getPort()
    Return the mail server port.
    @Nullable String
    getProtocol()
    Return the mail protocol.
    jakarta.mail.Session
    getSession()
    Return the JavaMail Session, lazily initializing it if it hasn't been specified explicitly.
    protected jakarta.mail.Transport
    getTransport(jakarta.mail.Session session)
    Obtain a Transport object from the given JavaMail Session, using the configured protocol.
    @Nullable String
    getUsername()
    Return the username for the account at the mail host.
    void
    send(jakarta.mail.internet.MimeMessage... mimeMessages)
    Send the given array of JavaMail MIME messages in batch.
    void
    send(SimpleMailMessage... simpleMessages)
    Send the given array of simple mail messages in batch.
    void
    setDefaultEncoding(@Nullable String defaultEncoding)
    Set the default encoding to use for MimeMessages created by this instance.
    void
    setDefaultFileTypeMap(@Nullable jakarta.activation.FileTypeMap defaultFileTypeMap)
    Set the default Java Activation FileTypeMap to use for MimeMessages created by this instance.
    void
    setHost(@Nullable String host)
    Set the mail server host, typically an SMTP host.
    void
    setJavaMailProperties(Properties javaMailProperties)
    Set JavaMail properties for the Session.
    void
    setPassword(@Nullable 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(@Nullable String protocol)
    Set the mail protocol.
    void
    setSession(jakarta.mail.Session session)
    Set the JavaMail Session, possibly pulled from JNDI.
    void
    setUsername(@Nullable String username)
    Set the username for the account at the mail host, if any.
    void
    testConnection()
    Validate that this instance can connect to the server that it is configured for.

    Methods inherited from class Object

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

    Methods inherited from interface JavaMailSender

    send, send, send

    Methods inherited from interface MailSender

    send

  • Field Details

  • Constructor Details

  • Method Details

    • setJavaMailProperties

      public void setJavaMailProperties(Properties javaMailProperties)
      Set JavaMail properties for the Session.

      A new Session will be created with those properties. Use either this method or setSession(Session), but not both.

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

    • getJavaMailProperties

      public Properties getJavaMailProperties()
      Allow Map access to the JavaMail properties of this sender, with the option to add or override specific entries.

      Useful for specifying entries directly, for example via javaMailProperties[mail.smtp.auth].

    • setSession

      public void setSession(jakarta.mail.Session session)
      Set the JavaMail Session, possibly pulled from JNDI.

      Default is a new Session without defaults, that is completely configured via this instance's properties.

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

      See Also:

    • getSession

      public jakarta.mail.Session getSession()
      Return the JavaMail Session, lazily initializing it if it hasn't been specified explicitly.

    • setProtocol

      public void setProtocol(@Nullable String protocol)
      Set the mail protocol. Default is "smtp".

    • getProtocol

      public @Nullable String getProtocol()
      Return the mail protocol.

    • setHost

      public void setHost(@Nullable String host)
      Set the mail server host, typically an SMTP host.

      Default is the default host of the underlying JavaMail Session.

    • getHost

      public @Nullable String getHost()
      Return the mail server host.

    • setPort

      public void setPort(int port)
      Set the mail server port.

      Default is DEFAULT_PORT, letting JavaMail use the default SMTP port (25).

    • getPort

      public int getPort()
      Return the mail server port.

    • setUsername

      public void setUsername(@Nullable String username)
      Set the username for the account at the mail host, if any.

      Note that the underlying JavaMail Session has to be configured with the property "mail.smtp.auth" set to true, else the specified username will not be sent to the mail server by the JavaMail runtime. If you are not explicitly passing in a Session to use, simply specify this setting via setJavaMailProperties(Properties).

      See Also:

    • getUsername

      public @Nullable String getUsername()
      Return the username for the account at the mail host.

    • setPassword

      public void setPassword(@Nullable String password)
      Set the password for the account at the mail host, if any.

      Note that the underlying JavaMail Session has to be configured with the property "mail.smtp.auth" set to true, else the specified password will not be sent to the mail server by the JavaMail runtime. If you are not explicitly passing in a Session to use, simply specify this setting via setJavaMailProperties(Properties).

      See Also:

    • getPassword

      public @Nullable String getPassword()
      Return the password for the account at the mail host.

    • setDefaultEncoding

      public void setDefaultEncoding(@Nullable String defaultEncoding)
      Set the default encoding to use for MimeMessages created by this instance.

      Such an encoding will be auto-detected by MimeMessageHelper.

    • getDefaultEncoding

      public @Nullable String getDefaultEncoding()
      Return the default encoding for MimeMessages, or null if none.

    • setDefaultFileTypeMap

      public void setDefaultFileTypeMap(@Nullable jakarta.activation.FileTypeMap defaultFileTypeMap)
      Set the default Java Activation FileTypeMap to use for MimeMessages created by this instance.

      A FileTypeMap specified here will be autodetected by MimeMessageHelper, avoiding the need to specify the FileTypeMap for each MimeMessageHelper instance.

      For example, you can specify a custom instance of Spring's ConfigurableMimeFileTypeMap here. If not explicitly specified, a default ConfigurableMimeFileTypeMap will be used, containing an extended set of MIME type mappings (as defined by the mime.types file contained in the Spring jar).

      See Also:

    • getDefaultFileTypeMap

      public @Nullable jakarta.activation.FileTypeMap getDefaultFileTypeMap()
      Return the default Java Activation FileTypeMap for MimeMessages, or null if none.

    • 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 - the messages to send
      Throws:
      MailException

    • createMimeMessage

      public jakarta.mail.internet.MimeMessage createMimeMessage()
      This implementation creates a SmartMimeMessage, holding the specified default encoding and default FileTypeMap. This special defaults-carrying message will be autodetected by MimeMessageHelper, which will use the carried encoding and FileTypeMap unless explicitly overridden.
      Specified by:
      createMimeMessage in interface JavaMailSender
      Returns:
      the new MimeMessage instance
      See Also:

    • createMimeMessage

      public jakarta.mail.internet.MimeMessage createMimeMessage(InputStream contentStream) throws MailException
      Description copied from interface: JavaMailSender
      Create a new JavaMail MimeMessage for the underlying JavaMail Session of this sender, using the given input stream as the message source.
      Specified by:
      createMimeMessage in interface JavaMailSender
      Parameters:
      contentStream - the raw MIME input stream for the message
      Returns:
      the new MimeMessage instance
      Throws:
      MailException

    • send

      public void send(jakarta.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 JavaMailSender.createMimeMessage().
      Specified by:
      send in interface JavaMailSender
      Parameters:
      mimeMessages - messages to send
      Throws:
      MailException
      See Also:

    • testConnection

      public void testConnection() throws jakarta.mail.MessagingException
      Validate that this instance can connect to the server that it is configured for. Throws a MessagingException if the connection attempt failed.
      Throws:
      jakarta.mail.MessagingException

    • doSend

      protected void doSend(jakarta.mail.internet.MimeMessage[] mimeMessages, Object @Nullable [] originalMessages) throws MailException
      Actually send the given array of MimeMessages via JavaMail.
      Parameters:
      mimeMessages - the MimeMessage objects to send
      originalMessages - corresponding original message objects that the MimeMessages have been created from (with same array length and indices as the "mimeMessages" array), if any
      Throws:
      MailAuthenticationException - in case of authentication failure
      MailSendException - in case of failure when sending a message
      MailException

    • connectTransport

      protected jakarta.mail.Transport connectTransport() throws jakarta.mail.MessagingException
      Obtain and connect a Transport from the underlying JavaMail Session, passing in the specified host, port, username, and password.
      Returns:
      the connected Transport object
      Throws:
      jakarta.mail.MessagingException - if the connect attempt failed
      Since:
      4.1.2
      See Also:

    • getTransport

      protected jakarta.mail.Transport getTransport(jakarta.mail.Session session) throws jakarta.mail.NoSuchProviderException
      Obtain a Transport object from the given JavaMail Session, using the configured protocol.

      Can be overridden in subclasses, for example, to return a mock Transport object.

      Throws:
      jakarta.mail.NoSuchProviderException
      See Also: