roschaefer / strapi-provider-email-nodemailer

Strapi nodemailer plugin that should work with Strapi 3.0.0+

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

strapi-provider-email-nodemailer-v3

Forked from strapi-provider-email-nodemailer

Should work with Strapi 3.0.0+

Installation

npm i strapi-provider-email-nodemailer-v3

Configuration

In your config/plugins.js file:

module.exports = ({ env }) => ({
  email: {
    provider: 'nodemailer-v3',
    providerOptions: {
      host: env('SMTP_HOST', 'smtp.example.com'),
      port: env('SMTP_PORT', 587),
      username: env('SMTP_USERNAME'),
      password: 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/

You can override the default configurations for specific environments. E.g. for NODE_ENV=development in config/env/development/plugins.js:

module.exports = ({ env }) => ({
  email: {
    provider: 'nodemailer-v3',
    providerOptions: {
      host: 'localhost',
      port: 1025,
      ignoreTLS: true,
    },
  },
});

The above setting is useful for local development with maildev.

Usage

To send an email from anywhere inside Strapi:

await strapi.plugins['email'].services.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
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

port: 465,
secure: true

try using

port: 587,
secure: false

to test if it works correctly.

Links

Resources

About

Strapi nodemailer plugin that should work with Strapi 3.0.0+

License:MIT License


Languages

Language:JavaScript 100.0%