Apache Sling Commons Messaging Mail

Clone this repo:
  1. 5d7cc5d SLING-11709 - Set up Jira autolinks to all Sling Github projects by Robert Munteanu · 9 weeks ago master
  2. 5fe9c19 suppress warnings for rule java:S3077 by Oliver Lietz · 3 months ago
  3. 64a6fbc suppress warnings for rule java:S1117 by Oliver Lietz · 3 months ago
  4. 12add23 style by Oliver Lietz · 3 months ago
  5. 4f55f88 update test dependencies by Oliver Lietz · 3 months ago

Apache Sling

Build Status Test Status Coverage Sonarcloud Status JavaDoc Maven Central License

Apache Sling Commons Messaging Mail

This module is part of the Apache Sling project.

This module provides a simple layer on top of Jakarta Mail 2.0 (package jakarta.mail) including a message builder and a service to send mails via SMTPS.

  • Mail Service: sends MIME messages
  • Message Builder: builds plain text and HTML messages with attachments and inline images
  • Message ID Provider: allows overwriting default message IDs by custom ones




Example factory configuration (SimpleMailServiceConfiguration) for SimpleMailService:

  "mail.smtps.from": "envelope-from@example.org",
  "mail.smtps.host": "smtp.example.org",
  "mail.smtps.port": 465,
  "username": "SMTP-USERNAME-PLAIN",
  "messageIdProvider.target": "(names=hostname)"

Optional MessageIdProvider

Example factory configuration (SimpleMessageIdProviderConfiguration) for optional SimpleMessageIdProvider:

  "names": [
  "host": "author.cms.example.org"


Create a multipart MIME message with an attachment (filename: song.flac) where the HTML part contains an inline image (cid: ska) and send it:

    MailService mailService;

    String subject = "Rudy, A Message to You";
    String text = "Stop your messing around\nBetter think of your future\nTime you straighten right out\nCreating problems in town\n…";
    String html = […];
    byte[] attachment = […];
    byte[] inline = […];

    MimeMessage message = mailService.getMessageBuilder()
        .from("dandy.livingstone@kingston.jamaica.example.net", "Dandy Livingstone")
        .to("the.specials@coventry.england.example.net", "The Specials")
        .attachment(attachment, "audio/flac", "song.flac")
        .inline(inline, "image/png", "ska")



Integration Tests

Integration tests require a running SMTP server. By default a GreenMail server is started.

An external SMTP server for validating messages with real mail clients can be used by setting required properties:

mvn clean install\
  -Dsling.test.mail.from.name=From\ Sender\
  -Dsling.test.mail.to.name=To\ Recipient\
  -Dsling.test.mail.replyTo.name=Reply\ To