Build and send responsive e-mails from Node.js.
npm install @openagenda/mailsBuild and send responsive e-mails from Node.js.
MJML + EJS + Nodemailer = :heart:
This project allows you to send mails from templates.
``bash
yarn add @openagenda/mails
$3
Before using it you must initialize the service, the configuration needs to know where to find the templates, how to send them and optionally the default values for each send (for example: _domain_, _lang_).
js
const createMails = require('@openagenda/mails');/ Default configuration /
const config = {
// Templating
templatesDir:
process.env.MAILS_TEMPLATES_DIR || path.join(process.cwd(), 'templates'),
mjmlConfigPath: process.cwd(),
// Mailing
transport: {
pool: true,
host: '127.0.0.1',
port: '1025', // Mailcatcher port
maxMessages: Infinity,
maxConnections: 20,
rateLimit: 14, // 14 emails/second max
rateDelta: 1000,
},
defaults: {},
// Queuing
disableVerify: false,
};
const mails = await createMails(config).catch((error) => {
console.log('Error on initializing service mails', error);
throw error;
});
console.log('Service mails initialized');
`More details on the options in the API section.
$3
js
const { results, errors } = await mails.send({
template: 'helloWorld',
to: {
address: 'user@example.com',
data: { username: 'bertho' },
lang: 'fr',
},
});
`$3
#### Structure
Each template has a folder with its name, in there must be at least one file
and fixtures.js (or a fixtures folder with some js files).index.mjml is the entry point of your template, it can be split into different partials (see
include of EJS).
text.ejs is the text version of your template.
subject.ejs is the subject of the mail corresponding to your template.
fixtures.js exports data that are used in the template to preview as in production.
locales folder with %lang%.json files, where %lang% is the language code (en.json, fr.json, etc).The structure of your templates folder can look like this:
`
/templates
/helloWorld
fixtures.js
index.mjml
text.ejs
subject.ejs
/accountActivation
/locales
en.json
fr.json
/fixtures
fixture1.js
fixture2.js
index.mjml
text.ejs
subject.ejs
API
$3
####
Usage
js
const createMails = require('@openagenda/mails');/ Dafault values /
const mails = await createMails({
// Templating
templatesDir:
process.env.MAILS_TEMPLATES_DIR || path.join(process.cwd(), 'templates'),
mjmlConfigPath: process.cwd(),
// Mailing
transport: {
pool: true,
host: '127.0.0.1',
port: '1025',
maxMessages: Infinity,
maxConnections: 20,
rateLimit: 14, // 14 emails/second max
rateDelta: 1000,
},
defaults: {},
// Queuing
queue: BullMQ.Queue,
createWorker: (jobProcessor) => BullMQ.Worker,
});
`Arguments
| Name | Type | Description |
| --------- | :------: | ---------------------------------------- |
|
| Object | The options to initializing the service. |options
| Value | Required | Description |
| ---------------- | :------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
templatesDir | \* | The folder path containing your templates. |
| mjmlConfigPath | | Uses the .mjmlconfig file in the specified path or directory to include custom components. |
| transport | \* | An object that defines connection data, it's the first argument of nodemailer.createTransport (SMTP or other). |
| defaults | | An object that is going to be merged into every message object. This allows you to specify shared options, for example to set the same _from_ address for every message. It's the second argument of nodemailer.createTransport. |
| queue | \* | A BullMQ queue. |
| createWorker | \* | A function that take a jobProcessor as argument and return a BullMQ worker. |
| disableVerify | | A Boolean that allows to disable the verification of the transporter connection, it is done in the init. |
| logger | | An object for the method setModuleConfig of @openagenda/logs |During initialization a
transporter is added to the config, you can use it raw from anywhere with a require of @openagenda/mails/config.$3
####
send(options)This is the main method, this function returns a Promise with one of these values:
- an array of BullMQ jobs if the queue is activated
- an array of nodemailer
results if the queue is disabledThis is a nodemailer
sendMail overload with some notable differences:- You can use a template.
- The email addresses are validated before sending.
- The sending of emails is never grouped, the recipients of the messages are always separated, which makes it possible to attach data by recipient.
- Emails can be stored in an external queue while waiting for their turn.
Usage
`js
await mails({
template: 'helloWorld',
to: {
address: 'user@example.com',
data: { username: 'bertho' },
lang: 'fr',
},
queue: false,
});
`Arguments
| Name | Type | Description |
| --------- | :------: | -------------------------------- |
|
| Object | The options to sending email(s). |_Options_
| Value | Required | Description |
| -------- | :------: | ----------------------------------------------------------------------------------------------------------------------------------- |
| template | | A string that is the name of the template, is equal to the folder name. |
| data | | An object that contains the data to passed to the template, this can be overloaded for each recipient. |
| lang | | A string that defines the default language that will be applied to all recipients without lang. |
| to | \* | A recipient or array of recipients. |
| queue | | A Boolean, if false do not queue job and execute directly. |
| ... | | All other nodemailer options are normally handled by nodemailer, see the other options here. |
_Error handling_
sendMail does not throw an error in case of problem, it returns an object { results, errors }.
It allows not to block the sending of emails for all when there is only a malformed email address in the batch, for example._Recipients_
You will find more information on the nodemailer documention (https://nodemailer.com/message/addresses/).
The main difference is that the email is sent separately to each recipient, one mail/one recipient.
If you want to add specific data to a recipient for the template (for example: its name, age, role, etc.) you must use an object with the data key, the language of the recipient can be in the lang key:
`js
{
address: 'user@example.com',
data: { username: 'bertho' },
lang: 'fr'
}
`_Defaults_
It's an object that is going to be merged into every message object. This allows you to specify shared options, for example to set a default _from_ address for every message.
_Data order_
The data come from several sources, they are
ed in this order:-
data from the send options
- data from the current recipient (recipient.data)
- data from defaults.data lastly for conserve values like _domain_, etc_Language_
As for data, the language can be overloaded in several places, in this order:
-
{ lang } from defaults.
- lang from the send options
- lang from the current recipient (recipient.lang)The
__ and lang values are passed to the template.####
task()If you can send a lot of messages it is better to use the BullMQ queue rather than the memory.
To use a
you will need to boot a transport with the pool: true option.
Learn more at Delivering bulk mail and Pooled SMTPMake sure to run the task before sending any email, just after the initialization looks correct.
task returns a promise that should not be waited.Usage
`js
mails.task();
`> ProTip: You can disable the queue for all email sends by setting
to initialization.$3
The
render and compile methods allow you to use your MJML templates, coupled with EJS for replacing variables and loops, among others.These methods add
__ method in the data for use the translations in the templates (json files in locales directory).The
opts argument corresponds to the EJS argument described here.####
render(templateName [, data = {}, opts = {}])Returns a Promise that resolves an Object containing three strings:
-
-
- .Arguments
| Name | Type | Description |
| -------------- | :------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
templateName | string | The name of the template, is equal to the folder name. |
| data | object | An object that contains the data to passed to the template. |
| options | Object | The opts argument corresponds to the EJS argument described here.
With the ability to add disableHtml, disableText and disableSubject, all three booleans. |Options
| Value | Required | Description |
| -------------- | :------: | ------------------------------------------------------------------------------------------------------------------------ |
| disableHtml | | A Boolean, if true then
html is not rendered and is equal null. |
| disableText | | A Boolean, if true then text is not rendered and is equal null. |
| disableSubject | | A Boolean, if true then subject is not rendered and is equal null. |
| ... | | All other EJS options are normally handled by EJS, see the other options here. |####
compile(templateName [, opts = {}])Returns a Promise that resolves an Object containing three functions:
-
-
- .Arguments
| Name | Type | Description |
| -------------- | :------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
templateName | string | The name of the template, is equal to the folder name. |
| options | Object | The opts argument corresponds to the EJS argument described here.
With the ability to add disableHtml, disableText and disableSubject, all three booleans. |Options
| Value | Required | Description |
| -------------- | :------: | ------------------------------------------------------------------------------------------------------------------------ |
| disableHtml | | A Boolean, if true then
html is not compiled and is equal null. |
| disableText | | A Boolean, if true then text is not compiled and is equal null. |
| disableSubject | | A Boolean, if true then subject is not compiled and is equal null. |
| ... | | All other EJS options are normally handled by EJS, see the other options here. |Testing
$3
For a single run of all suites of tests:
`
yarn test
You can add the
option to watch the tests related to the files you modify, or --watchAll to run all tests with each change.--coverage` option is available to indicates that test coverage information should be collected and reported in the output.These options are the most common, but you can use other Jest CLI options.
If you want to create your own tests, you can refer to the Testing SMTP section on the nodemailer documentation.