{"id":22268217,"url":"https://github.com/curityio/emailer-rest-plugin","last_synced_at":"2025-03-25T14:45:49.507Z","repository":{"id":74437461,"uuid":"137368201","full_name":"curityio/emailer-rest-plugin","owner":"curityio","description":"Emailer plugin that uses a REST service to deliver an email message for a recipient","archived":false,"fork":false,"pushed_at":"2020-12-21T12:36:08.000Z","size":21,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-01-30T13:31:41.729Z","etag":null,"topics":["email-sender","plugin","rest"],"latest_commit_sha":null,"homepage":"https://curity.io/resources/learn/restful-emailer/","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/curityio.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-06-14T14:21:33.000Z","updated_at":"2023-04-26T16:41:03.000Z","dependencies_parsed_at":"2023-02-26T02:30:11.741Z","dependency_job_id":null,"html_url":"https://github.com/curityio/emailer-rest-plugin","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/curityio%2Femailer-rest-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/curityio%2Femailer-rest-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/curityio%2Femailer-rest-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/curityio%2Femailer-rest-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/curityio","download_url":"https://codeload.github.com/curityio/emailer-rest-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245486241,"owners_count":20623239,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["email-sender","plugin","rest"],"created_at":"2024-12-03T11:11:55.903Z","updated_at":"2025-03-25T14:45:49.448Z","avatar_url":"https://github.com/curityio.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"REST Emailer Plug-in\n====================\n  \n.. image:: https://img.shields.io/badge/quality-production-green\n    :target: https://curity.io/resources/code-examples/status/\n\n.. image:: https://img.shields.io/badge/availability-bundled-green\n    :target: https://curity.io/resources/code-examples/status/\n\n\nThis 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.\n\nSystem Requirements\n~~~~~~~~~~~~~~~~~~~\n* Curity Identity Server 3.1.0 and `its system requirements \u003chttps://developer.curity.io/docs/latest/system-admin-guide/system-requirements.html\u003e`_\n\nRequirements for Building from Source\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n* Maven 3\n* Java JDK v. 8\n\nCompiling the Plug-in from Source\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\nThe project can be built using Maven. Use the command ``mvn package`` to find the resulting JARs in the ``target/libs`` directory.\n\nInstallation\n~~~~~~~~~~~~\nTo install the plugin, you need the binary files. You can build these yourself, as described in the previous section, or\nyou can download it from the `releases section of this project's GitHub repository \u003chttps://github.com/curityio/rest-mailer/releases\u003e`_.\n\nTake the resulting JAR-files and copy them into the directory ``${IDSVR_HOME}/usr/share/plugins/restmailer``.\n\nNote that the ``/restmailer`` directory can be named freely; using (a reference to) the name of the plugin just makes it\neasier to find the files later on.\n\nThe plugin will become available after you (re)start the Curity Identity Server.\n\n.. note::\n\n    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.\n\nFor a more detailed explanation of installing plug-ins, refer to the `Curity developer guide \u003chttps://developer.curity.io/docs/latest/developer-guide/plugins/index.html#plugin-installation\u003e`_.\n\nConfiguring the REST Mailer in Curity\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nConfiguration using the Admin UI\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\nOnce 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\nthe ``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.\n\n\nLicense\n~~~~~~~\n\nThis plugin and its associated documentation is listed under the `Apache 2 license \u003cLICENSE\u003e`_.\n\nMore Information\n~~~~~~~~~~~~~~~~\n\nPlease visit `curity.io \u003chttps://curity.io/\u003e`_ for more information about the Curity Identity Server.\n\nCopyright (C) 2018 Curity AB.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcurityio%2Femailer-rest-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcurityio%2Femailer-rest-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcurityio%2Femailer-rest-plugin/lists"}