1.0.2 • Published 4 years ago

strapi-provider-email-nodemailer-v3 v1.0.2

Weekly downloads
168
License
MIT
Repository
github
Last release
4 years ago

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: {},
        settings: {
            host: 'smtp.example.com',
            port: 587,
            username: 'username@example.com',
            password: 'password',
            secure: false
        }
    }
})
FieldDescription
nodemailer_default_fromDefault sender address if none is provided
nodemailer_default_reply_toDefault responder address if none is provided
hosthostname or IP address to connect to (smtp.your-server.com)
portport to connect to (in most cases: 587, 465 or 25)
usernameauthorization username
passwordauthorization password
secureif true the connection will use TLS when connecting to server. If false (the default) then TLS is used if server supports the STARTTLS extension. In most cases set this value to true if you are connecting to port 465. For port 587 or 25, keep it false
auth_methodcurrently there are 2 Authentication Methods available:SMTP (Plain and Login) and NLMT

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:

FieldDescription
fromEmail address of the sender
toComma separated list or an array of recipients
ccComma separated list or an array of recipients
bccComma separated list or an array of recipients
subjectSubject of the email
textPlaintext version of the message
htmlHTML version of the message
attachmentsArray 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