{"id":18030288,"url":"https://github.com/screamz/kuzzle-plugin-mailer","last_synced_at":"2025-06-12T19:33:06.962Z","repository":{"id":88071069,"uuid":"71178837","full_name":"ScreamZ/kuzzle-plugin-mailer","owner":"ScreamZ","description":"A NodeMailer bridge for Kuzzle, allowing to send e-mail.","archived":false,"fork":false,"pushed_at":"2016-10-17T21:01:00.000Z","size":8,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-13T00:25:47.344Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/ScreamZ.png","metadata":{"files":{"readme":"README.md","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":"2016-10-17T20:34:24.000Z","updated_at":"2019-07-08T06:13:34.000Z","dependencies_parsed_at":"2023-03-04T15:30:25.426Z","dependency_job_id":null,"html_url":"https://github.com/ScreamZ/kuzzle-plugin-mailer","commit_stats":{"total_commits":2,"total_committers":2,"mean_commits":1.0,"dds":0.5,"last_synced_commit":"cc46a0e0c92ad4dd55316f6bda5c1533335c55cd"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ScreamZ%2Fkuzzle-plugin-mailer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ScreamZ%2Fkuzzle-plugin-mailer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ScreamZ%2Fkuzzle-plugin-mailer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ScreamZ%2Fkuzzle-plugin-mailer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ScreamZ","download_url":"https://codeload.github.com/ScreamZ/kuzzle-plugin-mailer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247249544,"owners_count":20908212,"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":[],"created_at":"2024-10-30T09:13:55.587Z","updated_at":"2025-04-04T21:16:07.431Z","avatar_url":"https://github.com/ScreamZ.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Kuzzle Plugin Mailer\n\nThis plugin extends the Kuzzle API allowing to send mail from a new exposed controller. It acts as a bridge between the \"Node Mailer\" library and the Kuzzle backend.\n\n# Configuration\n\nYou must define some configuration before start.\n\n## SMTP Server \u0026 Proxy\n\nJust provide an `smtpConfig` key with your config SMTP configuration: [Here is the list of available config options](https://github.com/nodemailer/nodemailer#set-up-smtp).\n\n**The only option you can't define on your own is `options.pool`** because this will depend on the controller action you are using.\nAt the moment the bulk action is not supported but in the future this will be taken in consideration.\n\n## From contact\n\nDefine a fromContact key with format \"User\" \u003caddress@adress.com\u003e\n\nSee NodeMailer documentation\n\n# Documentation\nThis plugin exposes different API that you should use depending on your needs.\n\nIn all case you can look at this documentation to understand the e-mail format : [NodeMailer mail format](https://github.com/nodemailer/nodemailer#e-mail-message-fields)\n\n## Sending e-mail API (Small amount of mail)\n\nYou can call the HTTP route : \n\nPOST - /api/1.0/_plugin/kuzzle-plugin-mailer/send-email\n\nJust provide a single Mail object with some of given option : [NodeMailer mail format](https://github.com/nodemailer/nodemailer#e-mail-message-fields)\n\n\n## Bulk e-mail API (Large amount of mail)\n\nNot supported yet. See you further.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscreamz%2Fkuzzle-plugin-mailer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscreamz%2Fkuzzle-plugin-mailer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscreamz%2Fkuzzle-plugin-mailer/lists"}