Getting started

Introduction

Mail is a Sails hook for sending email through configured transports such as SMTP, Resend, Mailtrap, or the log transport.

It exposes a send helper and template support so actions and helpers can send transactional email through one API.

Installation

Prerequisites

• Node.js version 18 or higher
• Sails version 1 or higher

To install Mail, simply run the following command in your Sails project:

$ npm install sails-hook-mail

Usage

Mail exposes a send helper that you can call in Sails actions or anywhere else you have access to helpers.

For example we can send an email verification email when a user signs up successfully via a user/signup.js action:

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

The send helper accepts additional options for templates, transports, sender configuration, and scheduling.

Next, review the transport and configuration pages for the provider you want to use.