sailscastshq / sails-hook-mail

The simple elegant way to send emails from a Sails application

Mail

The simple elegant way to send emails from a Sails application

Getting Started

npm i sails-hook-mail --save

Usage

In your Sails action you can use the send helper like so:

await sails.helpers.mail.send.with({
  subject: 'Verify your email',
  template: 'email-verify-account',
  to: user.email,
  templateData: {
    token: user.emailProofToken,
    fullName: user.fullName
  }
})

Mailers

Mail supports a couple of mailers including:

• log
• SMTP

To use Mail, create a config/mail.js and specify your default mailer as well as the mailers you'd like to support in your Sails application like so:

module.exports.mail = {
  default: process.env.MAIL_MAILER || 'log',
  mailers: {
    smtp: {
      transport: 'smtp'
    },
    log: {
      transport: 'log'
    }
  },
  from: {
    address: process.env.MAIL_FROM_ADDRESS || '[email protected]',
    name: process.env.MAIL_FROM_NAME || 'The Boring JavaScript Stack'
  }
}

log

To use the log mailer, set the default property of config/mail.js to log and make sure you have a log mailer under the mailers object.

Sails will log your email to the console

SMTP

To use SMTP as a mailer set it as the default in config/mail.js and also install the peer dependency nodemailer:

npm i nodemailer --save

Then in your config/local.js you can provide the SMTP credentials like so:

// config/local.js
smtp: {
  host: 'HOST',
  username: 'USERNAME',
  password: 'PASSWORD'
}

sails-hook-mail's Issues

Change lookup other for credentials

Add cc and bcc support to SMTP transport

is lack of cc and attachments for this library

Make configuration in local.js match config/mail.js

Since configs in locals.js gets merged into other configs, it makes more sense not to deviate from how mailers are being configured in config/mail.js. Currently we have:

mailer: 'nodemailer',
mailer: {
   nodemailer: {}
}

But we can however follow same configuration signature in config/mail.js and eliminate the checks in getting what mailer to use in production or development all together. With this change setting up an email mailer in local will look similar to that in config/mails.js.

mail: {
 default: 'nodemailer',
 mailers: {
    nodemailer: {}
}
}

This simplifies things.

• update code to reflect this decision
• update docs

Fix fetching 'from address'

A typo was noticed when sails-hook-mail tries to fetch the from address in the user's env file.

What is:
process.env.MAIL_FROM_ADRESS

What should be:
process.env.MAIL_FROM_ADDRESS

Add ability to set mailer in local.js

A user should be able to set a mailer to use in config/local.js like so:

module.exports = {
  mailer: 'log'
}

Switch credential look up order

Currently the credential look up order starts with env. It should start with local.js, mailers options, and finally env.

TypeError: Cannot read properties of undefined (reading 'host')

Add attachment support to SMTP transport

Implement Resend transport

A repeat of typo fix in send.js file

Currently:

 from: {
      description:
        'An override for the default "from" email that\'s been configured.',
      example: '[email protected]',
      isEmail: true,
      defaultsTo: process.env.MAIL_FROM_ADRESS || sails.config.mail.from.address
    },

Should be:

 from: {
      description:
        'An override for the default "from" email that\'s been configured.',
      example: '[email protected]',
      isEmail: true,
      defaultsTo: process.env.MAIL_FROM_ADDRESS || sails.config.mail.from.address
    },

Implement SendGrid transport