Updating badges for org-apache-sling-commons-messaging
[sling-org-apache-sling-commons-messaging.git] / README.md
1 [<img src="http://sling.apache.org/res/logos/sling.png"/>](http://sling.apache.org)
2
3  [![Build Status](https://builds.apache.org/buildStatus/icon?job=sling-org-apache-sling-commons-messaging-1.8)](https://builds.apache.org/view/S-Z/view/Sling/job/sling-org-apache-sling-commons-messaging-1.8) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
4
5 # Apache Sling Commons Messaging
6
7 This module is part of the [Apache Sling](https://sling.apache.org) project.
8
9 Simple API for sending *message*​s to *recipient*​s.
10
11 `MessageService`
12 ----------------
13   * `send(String, String)` - takes a *message*​ and a *recipient*, e.g.
14     * send("A Message to You, Rudy", "rudy@ghosttown") - send a mail to Rudy in Ghost Town
15     * send("Hello Apache!", "+1.919.573.9199") - send a fax to the ASF
16   * `send(String, String, Map)` - takes a *message*, a *recipient* and additional *data* useful for the underlying implementation to process and/or send the message
17
18 `Result<T>`
19 -----------
20   * `getMessage():T` - should return a serialized form of the sent *message*