{"id":21002516,"url":"https://github.com/pimatic/pimatic-mail","last_synced_at":"2025-08-11T22:35:04.677Z","repository":{"id":15970958,"uuid":"18713752","full_name":"pimatic/pimatic-mail","owner":"pimatic","description":"Mail notifications from pimatic","archived":false,"fork":false,"pushed_at":"2016-05-23T07:12:33.000Z","size":105,"stargazers_count":3,"open_issues_count":1,"forks_count":3,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-11-07T16:59:36.055Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"CoffeeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pimatic.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}},"created_at":"2014-04-12T20:23:46.000Z","updated_at":"2017-03-28T21:13:17.000Z","dependencies_parsed_at":"2022-07-20T22:54:51.472Z","dependency_job_id":null,"html_url":"https://github.com/pimatic/pimatic-mail","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/pimatic%2Fpimatic-mail","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pimatic%2Fpimatic-mail/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pimatic%2Fpimatic-mail/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pimatic%2Fpimatic-mail/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pimatic","download_url":"https://codeload.github.com/pimatic/pimatic-mail/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225316760,"owners_count":17455312,"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-11-19T08:18:59.339Z","updated_at":"2024-11-19T08:19:00.043Z","avatar_url":"https://github.com/pimatic.png","language":"CoffeeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"pimatic mail plugin\n=======================\n\n\nProvides an action handler to send mails from pimatic rules. It uses \n [nodemailer v0.7](https://github.com/andris9/Nodemailer/blob/0.7/README.md) which supports all common mail transports.\n\nConfiguration\n-------------\nYou can load the backend by editing your `config.json` to include:\n\n    {\n      \"plugin\": \"mail\",\n      \"transport\": \"SMTP\",\n      \"transportOptions\": {\n        \"service\": \"Gmail\", // sets automatically host, port and connection security settings\n        \"auth\": {\n            \"user\": \"gmail.user@gmail.com\",\n            \"pass\": \"userpass\"\n        }\n      },\n      \"to\": \"gmail.user@gmail.com\"\n    }\n\nin the `plugins` section. For all configuration options see [mail-config-schema](mail-config-schema.html). The \n transport options are transport dependent and listed at \n [nodemailer v0.7](https://github.com/andris9/Nodemailer/blob/0.7/README.md).\n \nAdvanced Configuration Example for GMX\n--------------------------------------\n\nIf your mail service provider is not on nodemailer's list of\n [well known services](https://github.com/andris9/Nodemailer/blob/0.7/README.md#well-known-services-for-smtp)\n an advanced transport configuration is required. Below, an example configuration for GMX is provided. This\n configuration deals with some issues which may also apply to other mail service providers:\n \n* Host and Port of the mail service. You can obtain this information from your mail service provider.\n* The GMX SMTP mailer is picky about encryption ciphers used and, thus, the cipher suite used for pimatic\n  must be set to 'SSLv3'\n* The \"from\" address must be set explicitly to your mailbox address. Otherwise, the mail will be rejected \n  with error 550 which is provides a measure against misuse of mail addresses. You should set \n  the 'from' address as part of the plugin configuration.\n\nExample:\n\n    {\n      \"plugin\": \"mail\",\n      \"transport\": \"SMTP\",\n      \"transportOptions\": {\n        \"host\": \"mail.gmx.com\",\n        \"port\": 587,\n        \"tls\": {\n          \"ciphers\": \"SSLv3\"\n        },\n        \"auth\": {\n          \"user\": \"Zaphod.Beeblebrox@gmx.de\",\n          \"pass\": \"TopSecret\"\n        },\n        \"maxConnections\": 5\n      },\n      \"from\": \"Zaphod.Beeblebrox@gmx.de\"\n    }\t\n\n\nUsage\n-----\n\nYou can send mail messages as part of rule actions. The \"send mail\" action supports the following \nmodifiers:\n\n* **to:** The mail recipient's address\n* **from:** The mail sender's address\n* **text:** An Unicode string containing the plaintext version of the message body. If, both, **text** \n and **html** modifiers are absent, the default text will be used as defined by the plugin configuration\n* **html:** An Unicode string containing the HTML version of the message body. If, both, **text** \n and **html** modifiers are present, an e-mail with a multi-part body will be generated containing the \n plain text and the HTML text\n* **file:** A path to a file which will be attached to the mail\n\nGenerally, each modifier can only by applied once per mail action. For **to:** and **file:** modifiers, multiple \n occurrences are supported.\n\nExample Rule\n------------\n\n    IF it is 08:00 THEN send mail to:\"gmail.user@gmail.com\" subject:\"Good morning!\" text:\"Good morning Dave!\"\n    \n\nCredits\n-------\n\n\u003cdiv\u003eIcon made by \u003ca href=\"http://www.unocha.org\" title=\"OCHA\"\u003eOCHA\u003c/a\u003e is licensed under \n \u003ca href=\"http://creativecommons.org/licenses/by/3.0/\" title=\"Creative Commons BY 3.0\"\u003eCC BY 3.0\u003c/a\u003e\u003c/div\u003e\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpimatic%2Fpimatic-mail","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpimatic%2Fpimatic-mail","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpimatic%2Fpimatic-mail/lists"}