{"id":22268185,"url":"https://github.com/curityio/send-email-action","last_synced_at":"2025-07-15T15:33:24.353Z","repository":{"id":45382793,"uuid":"269639201","full_name":"curityio/send-email-action","owner":"curityio","description":"Authentication action plugin which sends e-mail notifications to users.","archived":false,"fork":false,"pushed_at":"2023-02-07T15:03:57.000Z","size":198,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-07T03:35:49.447Z","etag":null,"topics":["authentication-action","email","plugin"],"latest_commit_sha":null,"homepage":"https://curity.io/resources/learn/send-email-action/","language":"Groovy","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":"2020-06-05T13:09:02.000Z","updated_at":"2023-04-26T16:32:37.000Z","dependencies_parsed_at":"2023-02-11T21:16:38.260Z","dependency_job_id":null,"html_url":"https://github.com/curityio/send-email-action","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/curityio/send-email-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/curityio%2Fsend-email-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/curityio%2Fsend-email-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/curityio%2Fsend-email-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/curityio%2Fsend-email-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/curityio","download_url":"https://codeload.github.com/curityio/send-email-action/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/curityio%2Fsend-email-action/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265443424,"owners_count":23766407,"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":["authentication-action","email","plugin"],"created_at":"2024-12-03T11:11:50.374Z","updated_at":"2025-07-15T15:33:24.330Z","avatar_url":"https://github.com/curityio.png","language":"Groovy","funding_links":[],"categories":[],"sub_categories":[],"readme":"SendEmailAction Authentication Action Plugin\n=============================================\n\n.. image:: https://img.shields.io/badge/quality-demo-red\n   :target: https://curity.io/resources/code-examples/status/\n   :alt: Quality\n\n.. image:: https://img.shields.io/badge/availability-source-blue\n   :target: https://curity.io/resources/code-examples/status/\n   :alt: Availability\n\n\nA custom authentication action plugin for the Curity Identity Server. You can add the action to any authenticator to send\nan e-mail to the user whenever the given authenticator is used in the login or SSO flow. The e-mail will contain the\nusername, time of login, the user-agent used to log in and, optionally, the IP address from which the login was initiated.\n\nBuilding the Plugin\n~~~~~~~~~~~~~~~~~~~\n\nBuild the plugin by issuing the command ``mvn package``. This will produce a JAR file in the ``target`` directory,\nwhich can be installed.\n\nInstalling the Plugin\n~~~~~~~~~~~~~~~~~~~~~\n\nTo install the plugin, copy the compiled JAR (and all of its dependencies) into the :file:`${IDSVR_HOME}/usr/share/plugins/${pluginGroup}`\non each node, including the admin node. For more information about installing plugins, refer to `curity.io/plugins`_.\n\nRequired Dependencies\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nYou need at least version 7.3. of the Curity Identity Server to use this plugin.\n\nFor a list of the dependencies and their versions, run ``mvn dependency:list``. Ensure that all of these are installed in\nthe plugin group. Otherwise, they will not be accessible to this plug-in and run-time errors will result.\n\nCustomizing the Plugin\n~~~~~~~~~~~~~~~~~~~~~~\n\nIf you want to customize the e-mail sent by the plugin you can change the messages and template files provided in this\nrepository.\n\nThe messages are deployed to :file:`${IDSVR_HOME}/var/.plugins/messages/core/en/sendemailaction/` and the template to template is deployed to :file:`${IDSVR_HOME}/var/.plugins/templates/authentication-action/sendemailaction/email`. Both the messages and the template can be edited in these locations after the plugin is deployed.\n\nRefer to `curity.io/templates`_ for more information on overriding templates.\n\nConfiguring the Plugin\n~~~~~~~~~~~~~~~~~~~~~~\n\nThere are a few options you can configure for the plugin:\n\n.. image:: docs/configuration.png\n  :alt: Configuration in the admin UI\n\n- Account Manager: You can provide an account manager which will be used to retrieve the user's email address. If you omit\n  this option the plugin will assume that you use e-mails as usernames and will use the username as the recipients address.\n\n- Email Sender: You must provide a valid e-mail sender which will be responsible for sending the e-mails.\n\n- Always send e-mail notification: If `on` then the plugin will always send an e-mail notification for the given authenticator.\n  If `off` then the plugin will look for a parameter `sendemailaction-should-send-email`, and send the e-mail only if its\n  value is `true` (you can set this parameter using other actions).\n\n- Do Not Send Ip Address in Email: When `on` will _not_ include the user's IP address in the notification e-mail. By default\n  the IP address is included in the e-mail.\n\nMore Information\n~~~~~~~~~~~~~~~~\n\nPlease visit `curity.io`_ for more information about the Curity Identity Server.\n\n.. _curity.io/plugins: https://developer.curity.io/docs/latest/developer-guide/plugins/index.html#plugin-installation\n.. _curity.io: https://curity.io/\n.. _curity.io/templates: https://developer.curity.io/docs/latest/developer-guide/front-end-development/overview.html#understanding-the-templating-system\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcurityio%2Fsend-email-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcurityio%2Fsend-email-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcurityio%2Fsend-email-action/lists"}