Apache Sling Commons Messaging Mail

Clone this repo:
  1. 3a09837 use Sling Bundle Parent 39-SNAPSHOT during release vote by Oliver Lietz · 4 days ago master
  2. d4708db [maven-release-plugin] prepare for next development iteration by Oliver Lietz · 4 days ago
  3. 789de2d [maven-release-plugin] prepare release org.apache.sling.commons.messaging.mail-1.0.0 by Oliver Lietz · 4 days ago org.apache.sling.commons.messaging.mail-1.0.0
  4. ffae94d SLING-9082 Update to Sling Bundle Parent 38 by Oliver Lietz · 4 days ago
  5. 0720c5e add missing badges by Oliver Lietz · 5 days ago

Build Status Test Status Maven Central JavaDocs 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 (former JavaMail) 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


    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, "image/png", "attachment.png")
        .inline(inline, "image/png", "inline")


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