https://github.com/curityio/emailer-rest-plugin

Emailer plugin that uses a REST service to deliver an email message for a recipient
https://github.com/curityio/emailer-rest-plugin

email-sender plugin rest

Last synced: about 1 year ago
JSON representation

Emailer plugin that uses a REST service to deliver an email message for a recipient

• Host: GitHub
• URL: https://github.com/curityio/emailer-rest-plugin
• Owner: curityio
• License: apache-2.0
• Created: 2018-06-14T14:21:33.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2020-12-21T12:36:08.000Z (over 5 years ago)
• Last Synced: 2025-01-30T13:31:41.729Z (over 1 year ago)
• Topics: email-sender, plugin, rest
• Language: Java
• Homepage: https://curity.io/resources/learn/restful-emailer/
• Size: 20.5 KB
• Stars: 2
• Watchers: 5
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
REST Emailer Plug-in

====================

  

.. image:: https://img.shields.io/badge/quality-production-green

    :target: https://curity.io/resources/code-examples/status/

.. image:: https://img.shields.io/badge/availability-bundled-green

    :target: https://curity.io/resources/code-examples/status/

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

~~~~~~~~~~~~~~~~~~~

* Curity Identity Server 3.1.0 and `its 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.