Simple Java Mail Modules

Simple Java Mail core features can be used without any external libraries, but you can add some features by depending on additional modules, which bring in some additional dependencies of their own.

To enable support for async / batch mode sending using connection pooling, and clustering (see Configuration), include the following library:

<dependency>
    <groupId>org.simplejavamail</groupId>
    <artifactId>batch-module</artifactId>
</dependency>

This adds the following 3rd party dependencies:

• simple-java-mail:smtp-connection-pool

This allows you to send emails asynchronous with configuration options for thread management and SMTP connection pooling. See configuration for more details.

Note that with the batch-module enabled, the JVM won't shut down by itself anymore, as the connection pool stays alive until shutdown manually. To do this, just call mailer.shutdownConnectionPool() (repeat with each mailer you might have in a cluster).

To enable support for authenticated SOCKS proxy servers (see Features), include the following library:

<dependency>
    <groupId>org.simplejavamail</groupId>
    <artifactId>authenticated-socks-module</artifactId>
</dependency>

This adds no additional 3rd party dependencies.

To enable support for parsing Outlook messages (see Features), include the following library:

<dependency>
    <groupId>org.simplejavamail</groupId>
    <artifactId>outlook-module</artifactId>
</dependency>

This adds the following 3rd party dependencies:

• com.esotericsoftware:kryo
• de.javakaffee:kryo-serializers
• org.simplejavamail:outlook-message-parser
• Of which that last in turn adds:
• org.apache.poi:poi
• org.apache.poi:poi-scratchpad

To enable support for DKIM signing (see Features), include the following library:

<dependency>
    <groupId>org.simplejavamail</groupId>
    <artifactId>dkim-module</artifactId>
</dependency>

This adds the following 3rd party dependencies:

• net.markenwerk:utils-mail-dkim

To enable support for sending and reading S/MIME signed / encrypted email, (see Features), include the following library:

<dependency>
    <groupId>org.simplejavamail</groupId>
    <artifactId>smime-module</artifactId>
</dependency>

This adds the following 3rd party dependencies:

• net.markenwerk:utils-mail-smime

Normally, you would not need the CLI module on the class path, unless you wish to invoke the static void main method from Java (see also how to use CLI). To do so, include the following module:

<dependency>
    <groupId>org.simplejavamail</groupId>
    <artifactId>cli-module</artifactId>
</dependency>

This adds the following 3rd party dependencies:

• info.picocli:picocli
• com.github.therapi:therapi-runtime-javadoc
• com.github.bbottema:java-reflection

Note: Simple Java Mail core has a 'provided' dependency on com.github.therapi:therapi-runtime-javadoc-scribe which burns Javadoc into Simple Java Mail at compile time. This cannot be made optional. If this is a real concern, an option could be to provide two versions of Simple Java Mail: one with embedded Javadoc and one without (incompatible with the Cli Module). This is currently not in scope.

To enable Spring support (see Configuration), include the following module:

<dependency>
    <groupId>org.simplejavamail</groupId>
    <artifactId>spring-module</artifactId>
</dependency>

This adds the Spring core dependency, which is assumed to be on the classpath already.

To enable Apache Karaf support, include the following module:

<dependency>
    <groupId>org.simplejavamail</groupId>
    <artifactId>karaf-module</artifactId>
</dependency>

NOTE: the artifact is currently temporarily named: 'simplejavamail-karaf-feature'. It will be named correctly in the next release.