@strapi/provider-email-nodemailer 4.0.0-beta.0

package/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015-present Strapi Solutions SAS
+
+Portions of the Strapi software are licensed as follows:
+
+* All software that resides under an "ee/" directory (the “EE Software”), if that directory exists, is licensed under the license defined in "ee/LICENSE".
+
+* All software outside of the above-mentioned directories or restrictions above is available under the "MIT Expat" license as set forth below.
+
+MIT Expat License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,156 @@
+# strapi-provider-email-nodemailer
+
+## Resources
+
+- [License](LICENSE)
+
+## Links
+
+- [Strapi website](https://strapi.io/)
+- [Strapi community on Slack](https://slack.strapi.io)
+- [Strapi news on Twitter](https://twitter.com/strapijs)
+
+## Prerequisites
+
+You need to have the plugin `strapi-plugin-email` installed in your Strapi project.
+
+## Installation
+
+```bash
+# using yarn
+yarn add strapi-provider-email-nodemailer
+
+# using npm
+npm install strapi-provider-email-nodemailer --save
+```
+
+## Example
+
+**Path -** `config/plugins.js`
+
+```js
+module.exports = ({ env }) => ({
+  email: {
+    provider: 'nodemailer',
+    providerOptions: {
+      host: env('SMTP_HOST', 'smtp.example.com'),
+      port: env('SMTP_PORT', 587),
+      auth: {
+        user: env('SMTP_USERNAME'),
+        pass: env('SMTP_PASSWORD'),
+      },
+      // ... any custom nodemailer options
+    },
+    settings: {
+      defaultFrom: 'hello@example.com',
+      defaultReplyTo: 'hello@example.com',
+    },
+  },
+});
+```
+
+Check out the available options for nodemailer: https://nodemailer.com/about/
+
+### Development mode
+
+You can override the default configurations for specific environments. E.g. for
+`NODE_ENV=development` in **config/env/development/plugins.js**:
+
+```js
+module.exports = ({ env }) => ({
+  email: {
+    provider: 'nodemailer',
+    providerOptions: {
+      host: 'localhost',
+      port: 1025,
+      ignoreTLS: true,
+    },
+  },
+});
+```
+
+The above setting is useful for local development with
+[maildev](https://github.com/maildev/maildev).
+
+### Custom authentication mechanisms
+
+It is also possible to use custom authentication methods.
+Here is an example for a NTLM authentication:
+
+```js
+const nodemailerNTLMAuth = require('nodemailer-ntlm-auth');
+
+module.exports = ({ env }) => ({
+  email: {
+    provider: 'nodemailer',
+    providerOptions: {
+      host: env('SMTP_HOST', 'smtp.example.com'),
+      port: env('SMTP_PORT', 587),
+      auth: {
+        type: 'custom',
+        method: 'NTLM',
+        user: env('SMTP_USERNAME'),
+        pass: env('SMTP_PASSWORD'),
+      },
+      customAuth: {
+        NTLM: nodemailerNTLMAuth,
+      },
+    },
+    settings: {
+      defaultFrom: 'hello@example.com',
+      defaultReplyTo: 'hello@example.com',
+    },
+  },
+});
+```
+
+## Usage
+
+> :warning: The Shipper Email (or defaultfrom) may also need to be changed in the `Email Templates` tab on the admin panel for emails to send properly
+
+To send an email from anywhere inside Strapi:
+
+```js
+await strapi
+  .plugin('email')
+  .service('email')
+  .send({
+    to: 'someone@example.com',
+    from: 'someone2@example.com',
+    subject: 'Hello world',
+    text: 'Hello world',
+    html: `<h4>Hello world</h4>`,
+  });
+```
+
+The following fields are supported:
+
+| Field       | Description                                                       |
+| ----------- | ----------------------------------------------------------------- |
+| from        | Email address of the sender                                       |
+| to          | Comma separated list or an array of recipients                    |
+| replyTo     | Email address to which replies are sent                           |
+| cc          | Comma separated list or an array of recipients                    |
+| bcc         | Comma separated list or an array of recipients                    |
+| subject     | Subject of the email                                              |
+| text        | Plaintext version of the message                                  |
+| html        | HTML version of the message                                       |
+| attachments | Array of objects See: https://nodemailer.com/message/attachments/ |
+
+## Troubleshooting
+
+Check your firewall to ensure that requests are allowed. If it doesn't work with
+
+```js
+port: 465,
+secure: true
+```
+
+try using
+
+```js
+port: 587,
+secure: false
+```
+
+to test if it works correctly.

package/lib/index.js

@@ -0,0 +1,44 @@
+'use strict';
+
+/**
+ * Module dependencies
+ */
+
+const _ = require('lodash');
+const nodemailer = require('nodemailer');
+
+const emailFields = [
+  'from',
+  'replyTo',
+  'to',
+  'cc',
+  'bcc',
+  'subject',
+  'text',
+  'html',
+  'attachments',
+];
+
+module.exports = {
+  provider: 'nodemailer',
+  name: 'Nodemailer',
+
+  init(providerOptions = {}, settings = {}) {
+    const transporter = nodemailer.createTransport(providerOptions);
+
+    return {
+      send(options) {
+        // Default values.
+        const emailOptions = {
+          ..._.pick(options, emailFields),
+          from: options.from || settings.defaultFrom,
+          replyTo: options.replyTo || settings.defaultReplyTo,
+          text: options.text || options.html,
+          html: options.html || options.text,
+        };
+
+        return transporter.sendMail(emailOptions);
+      },
+    };
+  },
+};

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@strapi/provider-email-nodemailer",
+  "version": "4.0.0-beta.0",
+  "description": "Nodemailer provider for Strapi 3",
+  "homepage": "https://strapi.io",
+  "keywords": [
+    "strapi",
+    "email",
+    "provider",
+    "nodemailer"
+  ],
+  "main": "./lib",
+  "directories": {
+    "lib": "./lib"
+  },
+  "dependencies": {
+    "lodash": "4.17.21",
+    "nodemailer": "6.5.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/strapi/strapi.git"
+  },
+  "author": {
+    "name": "Yurii Tykhomyrov"
+  },
+  "strapi": {
+    "isProvider": true
+  },
+  "scripts": {
+    "test": "echo \"no tests yet\""
+  },
+  "contributors": [
+    {
+      "name": "Veit Bjarsch",
+      "email": "vb@poweruplink.com",
+      "url": "https://poweruplink.com"
+    },
+    {
+      "name": "Saunved Mutalik"
+    },
+    {
+      "name": "Robert Schäfer",
+      "email": "git@roschaefer.de"
+    }
+  ],
+  "maintainers": [
+    {
+      "name": "Strapi team",
+      "email": "hi@strapi.io",
+      "url": "https://strapi.io"
+    }
+  ],
+  "license": "SEE LICENSE IN LICENSE",
+  "bugs": {
+    "url": "https://github.com/strapi/strapi/issues"
+  },
+  "engines": {
+    "node": ">=12.x.x <=16.x.x",
+    "npm": ">=6.0.0"
+  },
+  "gitHead": "9807c78cb7ab6373b7abb46da5ecc4980a9ea56c"
+}