Emailer plugin that uses a REST service to deliver an email message for a recipient
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src/main
.gitignore
.travis.yml
README.rst
pom.xml

README.rst

REST Emailer Plug-in

https://travis-ci.org/curityio/emailer-rest-plugin.svg?branch=dev

This project provides an open source email plugin for the Curity Identity Server. It is provided purely as an example without support to show how you can create a tailor made plugin that handles email delivery by calling a REST API.

System Requirements

Requirements for Building from Source

  • Maven 3
  • Java JDK v. 8

Compiling the Plug-in from Source

The project can be built using Maven. Use the command mvn package to find the resulting JARs in the target/libs directory.

Installation

To install the plugin, you need the binary files. You can build these yourself, as described in the previous section, or you can download it from the releases section of this project's GitHub repository.

Take the resulting JAR-files and copy them into the directory ${IDSVR_HOME}/usr/share/plugins/restmailer.

Note that the /restmailer directory can be named freely; using (a reference to) the name of the plugin just makes it easier to find the files later on.

The plugin will become available after you (re)start the Curity Identity Server.

Note

The JAR file needs to be deployed to each run-time node and the admin node. For simple test deployments where the admin node is a run-time node, the JAR file only needs to be copied to one location.

For a more detailed explanation of installing plug-ins, refer to the Curity developer guide.

Configuring the REST Mailer in Curity

Configuration using the Admin UI

Once installed, the REST mailer becomes available as email provider. An email provider is configured as a facility. To configure an email provider, open the facilities through the Facilities-button on the top right and look for the Email heading. When editing an Email provider, the type rest-mailer will configure the REST Emailer plugin.

License

This plugin and its associated documentation is listed under the Apache 2 license.

More Information

Please visit curity.io for more information about the Curity Identity Server.

Copyright (C) 2018 Curity AB.