mail-time 1.2.5 → 1.3.1

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2020, dr.dimitru (Dmitry A.; Veliov Group, LLC)
+Copyright (c) 2022, dr.dimitru (Dmitry A.; Veliov Group, LLC)
 All rights reserved.
 
 Redistribution and use in source and binary forms, 

package/README.md

@@ -1,3 +1,4 @@
+[![support](https://img.shields.io/badge/support-GitHub-white)](https://github.com/sponsors/dr-dimitru)
 [![support](https://img.shields.io/badge/support-PayPal-white)](https://paypal.me/veliovgroup)
 <a href="https://ostr.io/info/built-by-developers-for-developers">
   <img src="https://ostr.io/apple-touch-icon-60x60.png" height="20">
@@ -13,23 +14,28 @@ Every `MailTime` instance can be configured to be a *Server* or *Client*.
 Main difference of *Server* from *Client* - *Server* handles queue and actually sends email.
 While *Client* is only put emails into the queue.
 
+"Mail-Time" is a micro-service package for mail queue, with *Server* and *Client* APIs. Build on top of the [`nodemailer`](https://github.com/nodemailer/nodemailer) package.
+
+Every `MailTime` instance can get configured as *Server* or *Client*.
+
+The main difference between *Server* and *Client* modes is that the *Server* handles the queue and __sends__ email. While the *Client* only __adds__ emails into the queue.
+
 ## ToC
 
-- [How it works?](https://github.com/VeliovGroup/Mail-Time#how-it-works)
-  - [With single SMTP](https://github.com/VeliovGroup/Mail-Time#single-point-of-failure)
-  - [With multiple SMTP](https://github.com/VeliovGroup/Mail-Time#multiple-smtp-providers)
-  - [As Micro-Service](https://github.com/VeliovGroup/Mail-Time#cluster-issue)
-- [Features](https://github.com/VeliovGroup/Mail-Time#features)
-- [Installation](https://github.com/VeliovGroup/Mail-Time#installation)
-- [Meteor.js Installation](https://github.com/VeliovGroup/Mail-Time#installation--import-via-npm): as [NPM Package](https://www.npmjs.com/package/mail-time)
-- [Meteor.js Installation](https://github.com/VeliovGroup/Mail-Time#installation--import-via-atmosphere): as [Atmosphere package](https://atmospherejs.com/ostrio/mailer)
-- [Usage example](https://github.com/VeliovGroup/Mail-Time#basic-usage)
-- [API](https://github.com/VeliovGroup/Mail-Time#api)
-  - [*Constructor*](https://github.com/VeliovGroup/Mail-Time#new-mailtimeopts-constructor)
-  - [`.send()`](https://github.com/VeliovGroup/Mail-Time#sendmailopts--callback)
-  - [Default Template](https://github.com/VeliovGroup/Mail-Time#static-mailtimetemplate)
-- [Custom Templates](https://github.com/VeliovGroup/Mail-Time#template-example)
-- [~92% tests coverage](https://github.com/VeliovGroup/Mail-Time#testing)
+- [How it works?](https://github.com/veliovgroup/mail-time#how-it-works)
+  - [With single SMTP](https://github.com/veliovgroup/mail-time#single-point-of-failure)
+  - [With multiple SMTP](https://github.com/veliovgroup/mail-time#multiple-smtp-providers)
+  - [As Micro-Service](https://github.com/veliovgroup/mail-time#cluster-issue)
+- [Features](https://github.com/veliovgroup/mail-time#features)
+- [Installation](https://github.com/veliovgroup/mail-time#installation)
+- [Meteor.js usage](https://github.com/veliovgroup/mail-time/blob/master/docs/meteor.md)
+- [Usage example](https://github.com/veliovgroup/mail-time#basic-usage)
+- [API](https://github.com/veliovgroup/mail-time#api)
+  - [*Constructor*](https://github.com/veliovgroup/mail-time#new-mailtimeopts-constructor)
+  - [`.send()`](https://github.com/veliovgroup/mail-time#sendmailopts--callback)
+  - [Default Template](https://github.com/veliovgroup/mail-time#static-mailtimetemplate)
+- [Custom Templates](https://github.com/veliovgroup/mail-time#template-example)
+- [~92% tests coverage](https://github.com/veliovgroup/mail-time#testing)
 
 ## Main features:
 
@@ -38,11 +44,13 @@ While *Client* is only put emails into the queue.
 - 🏢 Synchronize email queue across multiple servers;
 - 💪 Bulletproof design, built-in retries.
 
-## How does it work?:
+## How does it work?
+
+Redundant solution for email transmission.
 
 ### Single point of failure
 
-Issue - classic solution with the single point of failure:
+Issue - classic solution with a single point of failure:
 
 ```ascii
 |----------------|         |------|         |------------------|
@@ -90,11 +98,11 @@ Backup scheme with multiple SMTP providers
 
 ### Cluster issue
 
-Let's say you have an app which is growing fast. At some point, you've decided to create a "Cluster" of servers to balance the load and add durability layer.
+It is common to create a "Cluster" of servers to balance the load and add a durability layer for horizontal scaling of quickly growing applications.
 
-Also, your application has scheduled emails, for example, once a day with recent news. While you have had single server emails was sent by some daily interval. So, after you made a "Cluster" of servers - each server has its own timer and going to send a daily email to our user. In such case - users will receive 3 emails, sounds not okay.
+Most modern application has scheduled or recurring emails. For example, once a day — with recent news and updates. It won't be an issue with a single server setup — the server would send emails at a daily interval via timer or CRON. While in "Cluster" implementation — each server will attempt to send the same email. In such cases, users will receive multiple emails with the same content. We built MailTime to address this and other similar issues.
 
-Here is how we solve this issue:
+Here is how this issue is solved by using MailTime:
 
 ```ascii
 |===================THE=CLUSTER===================| |=QUEUE=| |===Mail=Time===|
@@ -114,17 +122,17 @@ Here is how we solve this issue:
 
 ## Features
 
-- Queue - Managed via MongoDB, and will survive server reboots and failures
+- Queue - Managed via MongoDB, will survive server reboots and failures
 - Support for multiple server setups - "Cluster", Phusion Passenger instances, Load Balanced solutions, etc.
-- Emails concatenation by addressee email - Reduce amount of sent email to single user with concatenation, and avoid mistakenly doubled emails
-- When concatenation is enabled - Same emails wouldn't be sent twice, if for any reason, due to bad logic or application failure emails is sent twice or more times - here is solution to solve this annoying behavior
-- Balancing for multiple nodemailer's transports, two modes - `backup` and `balancing`. Most useful feature - allows to reduce the cost of SMTP services and add durability. So, if any of used transports are failing to send an email it will switch to next one
+- Emails concatenation by addressee email - Reduce amount of sent emails to a single user with concatenation, and avoid mistakenly doubled emails
+- When concatenation is enabled - Same emails won't be sent twice, if for any reason, due to bad logic or application failure emails are sent twice or more times - this is solution to solve this annoying behavior
+- Balancing for multiple nodemailer's transports, two modes - `backup` and `balancing`. This is the most useful feature — allowing to reduce the cost of SMTP services and add extra layer of durability. If one transport failing to send an email `mail-time` will switch to the next one
 - Sending retries for network and other failures
-- Template support with Mustache-like placeholders
+- Templating support with [Mustache](https://mustache.github.io/)-like placeholders
 
 ## Installation
 
-If you're working on Server functionality - first you will need `nodemailer`, although this package is meant to be used with `nodemailer`, it's not added as the dependency, as it not needed by Client, and you're free to choose `nodemailer`'s version to fit your needs:
+To implement Server functionality — as a first step install `nodemailer`, although this package meant to be used with `nodemailer`, it's not added as the dependency, as `nodemailer` not needed by Client, and you're free to choose `nodemailer`'s version to fit your project needs:
 
 ```shell
 npm install --save nodemailer
@@ -148,14 +156,14 @@ Require package:
 const MailTime = require('mail-time');
 ```
 
-Create nodemailer's transports (see [nodemailer docs](https://github.com/nodemailer/nodemailer/tree/v2#setting-up)):
+Create nodemailer's transports (see [`nodemailer` docs](https://github.com/nodemailer/nodemailer/tree/v2#setting-up)):
 
 ```js
 const transports = [];
 const nodemailer = require('nodemailer');
 
 // Use DIRECT transport
-// To enable sending email from localhost
+// and enable sending email from localhost
 // install "nodemailer-direct-transport" NPM package:
 const directTransport = require('nodemailer-direct-transport');
 const directTransportOpts = {
@@ -165,8 +173,8 @@ const directTransportOpts = {
   from: 'no-reply@example.com',
 };
 transports.push(nodemailer.createTransport(directTransport(directTransportOpts)));
-// IMPORTANT: Copy-paste passed options from directTransport() to
-// transport's "options" property, to make sure it's available to MailTime package:
+// IMPORTANT: Add `.options` to a newly created transport,
+// this is necessary to make sure options are available to MailTime package:
 transports[0].options = directTransportOpts;
 
 // Private SMTP
@@ -201,16 +209,15 @@ transports.push(nodemailer.createTransport({
 }));
 ```
 
-Create `mail-time` *Server*, it is able to send and add emails to the queue.
-We will need connect to MongoDB first:
+As the next step initiate `mail-time` in the *Server* mode, it will be able to __send__ and __add__ emails to the queue. Connecting to a MongoDB before initiating `new MailTime` instance:
 
 ```js
+const MailTime = require('mail-time');
 const MongoClient = require('mongodb').MongoClient;
-const MailTime    = require('mail-time');
-const dbName      = 'DatabaseName';
 
-// We're using environment variable MONGO_URL
-// to store connection string to MongoDB
+const dbName = 'databaseName';
+
+// Use MONGO_URL environment variable to store connection string to MongoDB
 // example: "MONGO_URL=mongodb://127.0.0.1:27017/myapp node mail-micro-service.js"
 MongoClient.connect(process.env.MONGO_URL, (error, client) => {
   const db = client.db(dbName);
@@ -223,7 +230,7 @@ MongoClient.connect(process.env.MONGO_URL, (error, client) => {
     from(transport) {
       // To pass spam-filters `from` field should be correctly set
       // for each transport, check `transport` object for more options
-      return '"Awesome App" <' + transport.options.from + '>';
+      return `"Awesome App" <${transport.options.from}>`;
     },
     concatEmails: true, // Concatenate emails to the same addressee
     concatDelimiter: '<h1>{{{subject}}}</h1>', // Start each concatenated email with it's own subject
@@ -232,12 +239,13 @@ MongoClient.connect(process.env.MONGO_URL, (error, client) => {
 });
 ```
 
-Create the *Client* to add emails to queue from other application units, like UI unit:
+Only __one__ `MailTime` *Server* instance required to send email. In the other parts of an app (like UI units or in sub-apps) use `mail-time` in the *Client* mode to __add__ emails to queue:
 
 ```js
+const MailTime = require('mail-time');
 const MongoClient = require('mongodb').MongoClient;
-const MailTime    = require('mail-time');
-const dbName      = 'DatabaseName';
+
+const dbName = 'databaseName';
 
 MongoClient.connect(process.env.MONGO_URL, (error, client) => {
   const db = client.db(dbName);
@@ -251,7 +259,7 @@ MongoClient.connect(process.env.MONGO_URL, (error, client) => {
 });
 ```
 
-Send email:
+Send email example:
 
 ```js
 mailQueue.sendMail({
@@ -262,79 +270,80 @@ mailQueue.sendMail({
 });
 ```
 
-## Meteor.js usage:
-
-### Meteor.js Installation:
-
-#### Installation & Import (*via NPM*):
-
-Install NPM *MailTime* package:
-
-```shell
-meteor npm install --save mail-time
-```
+### Two `MailTime` instances usage example
 
-ES6 Import:
+Create two `MailTime` instances with different settings.
 
 ```js
-import MailTime from 'mail-time';
-```
+// CREATE mailQueue FOR NON-URGENT EMAILS WHICH IS OKAY TO CONCATENATE
+const mailQueue = new MailTime({
+  db: db,
+  interval: 35,
+  strategy: 'backup',
+  failsToNext: 1,
+  concatEmails: true,
+  concatThrottling: 16,
+  zombieTime: 120000
+});
 
-#### Installation & Import (*via Atmosphere*):
+// CREATE mailInstantQueue FOR TRANSACTIONAL EMAILS AND ALERTS
+const mailInstantQueue = new MailTime({
+  db: db,
+  prefix: 'instant',
+  interval: 2,
+  strategy: 'backup',
+  failsToNext: 1,
+  concatEmails: false,
+  zombieTime: 20000
+});
 
-Install Atmosphere *ostrio:mailer* package:
+mailQueue.sendMail({
+  to: 'user@gmail.com',
+  subject: 'You\'ve got an email!',
+  text: 'Plain text message',
+  html: '<h1>HTML</h1><p>Styled message</p>'
+});
 
-```shell
-meteor add ostrio:mailer
+mailInstantQueue.sendMail({
+  to: 'user@gmail.com',
+  subject: 'Sign in request',
+  text: 'Your OTP login code: xxxx:',
+  html: '<h1>Code:</h1><code>XXXX</code>'
+});
 ```
 
-ES6 Import:
-
-```js
-import MailTime from 'meteor/ostrio:mailer';
-```
+### Passing variables to the template
 
-### Usage:
+All options passed to the `.sendMail()` method is available inside `text`, `html`, and global templates
 
 ```js
-import { MongoInternals } from 'meteor/mongo';
-
-import MailTime from 'mail-time';
-import nodemailer from 'nodemailer';
-// Use DIRECT transport
-// To enable sending email from localhost
-// install "nodemailer-direct-transport" NPM package:
-import directTransport from 'nodemailer-direct-transport';
-
-const transports = [];
-const directTransportOpts = {
-  pool: false,
-  direct: true,
-  name: 'mail.example.com',
-  from: 'no-reply@example.com',
+const templates = {
+  global: '<html xmlns="http://www.w3.org/1999/xhtml"><head><title>{{subject}}</title></head><body>{{{html}}}<footer>Message sent to @{{username}} user ({{to}})</footer></body></html>',
+  signInCode: {
+    text: 'Hello @{{username}}! Here\'s your login code: {{code}}',
+    html: `<h1>Sign-in request</h1><p>Hello @{{username}}! <p>Copy your login code below:</p> <pre><code>{{code}}</code></pre>`
+  }
 };
-transports.push(nodemailer.createTransport(directTransport(directTransportOpts)));
-// IMPORTANT: Copy-paste passed options from directTransport() to
-// transport's "options" property, to make sure it's available to MailTime package:
-transports[0].options = directTransportOpts;
-
-////////////////////////
-// For more transports example see sections above and read nodemailer's docs
-////////////////////////
 
 const mailQueue = new MailTime({
-  db: MongoInternals.defaultRemoteCollectionDriver().mongo.db, // MongoDB
-  transports,
-  from(transport) {
-    // To pass spam-filters `from` field should be correctly set
-    // for each transport, check `transport` object for more options
-    return '"Awesome App" <' + transport.options.from + '>';
-  }
+  db: db,
+  template: templates.global
+});
+
+mailQueue.sendMail({
+  to: 'user@gmail.com',
+  subject: 'Sign-in request',
+  username: 'johndoe',
+  code: 'XXXXX-YY',
+  text: templates.signInCode.text,
+  html: templates.signInCode.html
 });
 ```
 
 ## API
 
+All available constructor options and `.sendMail()` method API overview
+
 ### `new MailTime(opts)` constructor
 
 - `opts` {*Object*} - Configuration object
@@ -347,15 +356,15 @@ const mailQueue = new MailTime({
 - `opts.prefix` {*String*} - [Optional] Use unique prefixes to create multiple `MailTime` instances on same MongoDB
 - `opts.maxTries` {*Number*} - [Optional] How many times resend failed emails, default - `60`
 - `opts.interval` {*Number*} - [Optional] Interval in *seconds* between send re-tries, default - `60`
-- `opts.zombieTime` {*Number*} - [Optional] Time in *milliseconds*, after this period - pending email will be interpreted as "*zombie*". This parameter allows to rescue pending email from "*zombie* mode" in case when: server was rebooted, exception during runtime was thrown, or caused by bad logic, default - `32786`. This option is used by package itself and passed directly to [`JoSk` package](https://github.com/VeliovGroup/josk#api)
+- `opts.zombieTime` {*Number*} - [Optional] Time in *milliseconds*, after this period - pending email will be interpreted as "*zombie*". This parameter allows to rescue pending email from "*zombie* mode" in case when: server was rebooted, exception during runtime was thrown, or caused by bad logic, default - `32786`. This option is used by package itself and passed directly to [`JoSk` package](https://github.com/veliovgroup/josk#api)
 - `opts.keepHistory` {*Boolean*} - [Optional] By default sent emails not stored in the database. Set `{ keepHistory: true }` to keep queue task as it is in the database, default - `false`
 - `opts.concatEmails` {*Boolean*} - [Optional] Concatenate email by `to` field, default - `false`
 - `opts.concatSubject` {*String*} - [Optional] Email subject used in concatenated email, default - `Multiple notifications`
 - `opts.concatDelimiter` {*String*} - [Optional] HTML or plain string delimiter used between concatenated email, default - `<hr>`
 - `opts.concatThrottling` {*Number*} - [Optional] Time in *seconds* while emails are waiting to be concatenated, default - `60`
 - `opts.revolvingInterval` {*Number*} - [Optional] Interval in *milliseconds* in between queue checks, default - `256`. Recommended value — between `opts.minRevolvingDelay` and `opts.maxRevolvingDelay`
-- `opts.minRevolvingDelay` {*Number*} - [Optional] Minimum revolving delay — the minimum delay between tasks executions in *milliseconds*, default - `64`. This option is passed directly to [`JoSk` package](https://github.com/VeliovGroup/josk#api)
-- `opts.maxRevolvingDelay` {*Number*} - [Optional] Maximum revolving delay — the maximum delay between tasks executions in *milliseconds*, default - `256`. This option is passed directly to [`JoSk` package](https://github.com/VeliovGroup/josk#api)
+- `opts.minRevolvingDelay` {*Number*} - [Optional] Minimum revolving delay — the minimum delay between tasks executions in *milliseconds*, default - `64`. This option is passed directly to [`JoSk` package](https://github.com/veliovgroup/josk#api)
+- `opts.maxRevolvingDelay` {*Number*} - [Optional] Maximum revolving delay — the maximum delay between tasks executions in *milliseconds*, default - `256`. This option is passed directly to [`JoSk` package](https://github.com/veliovgroup/josk#api)
 - `opts.template` {*String*} - [Optional] Mustache-like template, default - `{{{html}}}`, all options passed to `sendMail` is available in Template, like `to`, `subject`, `text`, `html` or any other custom option. Use `{{opt}}` for string placeholders and `{{{opt}}}` for html placeholders
 
 ### `sendMail(opts [, callback])`
@@ -365,15 +374,15 @@ const mailQueue = new MailTime({
 - `opts.sendAt` {*Date*} - When email should be sent, default - `new Date()` use with caution on multi-server setup at different location with the different time-zones
 - `opts.template` - Email specific template, this will override default template passed to `MailTime` constructor
 - `opts.concatSubject` - Email specific concatenation subject, this will override default concatenation subject passed to `MailTime` constructor
-- `opts[key]` {*Mix*} - Other custom and NodeMailer specific options, like `text`, `html` and `to`, see more [here](https://github.com/nodemailer/nodemailer/tree/v2#e-mail-message-fields). Note `attachments` should work only via `path`, and file must exists on all micro-services servers
+- `opts[key]` {*Mix*} - Other custom and NodeMailer specific options, like `text`, `html` and `to`, [learn more here](https://github.com/nodemailer/nodemailer/tree/v2#e-mail-message-fields). Note `attachments` should work only via `path`, and file must exists on all micro-services servers
 - `callback` {*Function*} - Callback called after the email was sent or failed to be sent. __Do not use on multi-server setup__
 
 ### `static MailTime.Template`
 
-Simple and bulletproof HTML template, see its [source](https://github.com/VeliovGroup/Mail-Time/blob/master/template.html). Usage:
+Simple and bulletproof HTML template, see [its source](https://github.com/veliovgroup/mail-time/blob/master/template.html). Usage example:
 
 ```js
-const MailTime  = require('mail-time');
+const MailTime = require('mail-time');
 // Make it default
 const mailQueue = new MailTime({
   db: db, // MongoDB
@@ -391,6 +400,8 @@ mailQueue.sendMail({
 
 ### Template Example
 
+Pass custom template via `template` property to `.sendMail()` method
+
 ```js
 mailQueue.sendMail({
   to: 'user@gmail.com',
@@ -438,5 +449,10 @@ DEBUG="true" EMAIL_DOMAIN="example.com" MONGO_URL="mongodb://127.0.0.1:27017/met
 
 ## Support this project:
 
-- [Support via PayPal](https://paypal.me/veliovgroup) — support my open source contributions once or on regular basis
+- Star on [GitHub](https://github.com/veliovgroup/mail-time)
+- Star on [NPM](https://www.npmjs.com/package/mail-time)
+- Star on [Atmosphere](https://atmospherejs.com/ostrio/mailer)
+- [Sponsor maintainer via GitHub](https://github.com/sponsors/dr-dimitru) — support open source with one-time contribution or on a regular basis
+- [Sponsor veliovgroup via GitHub](https://github.com/sponsors/veliovgroup) — support company behind this package
+- [Support via PayPal](https://paypal.me/veliovgroup) — support our open source contributions
 - Use [ostr.io](https://ostr.io) — [Monitoring](https://snmp-monitoring.com), [Analytics](https://ostr.io/info/web-analytics), [WebSec](https://domain-protection.info), [Web-CRON](https://web-cron.info) and [Pre-rendering](https://prerendering.com) for a website

package/index.js

@@ -1,6 +1,6 @@
-const JoSk   = require('josk');
-const NoOp   = () =>  {};
-const merge  = require('deepmerge');
+const JoSk = require('josk');
+const noop = () =>  {};
+const merge = require('deepmerge');
 const _debug = (isDebug, ...args) => {
   if (isDebug) {
     console.info.call(console, '[DEBUG] [mail-time]', `${new Date}`, ...args);
@@ -17,12 +17,6 @@ const mongoErrorHandler = (error) => {
   }
 };
 
-const defaultWriteConcern = {
-  w: 1,
-  j: true,
-  wtimeout: 10240
-};
-
 let equals;
 equals = (a, b) => {
   let i;
@@ -108,13 +102,13 @@ module.exports = class MailTime {
       throw new Error('[mail-time] MongoDB database {db} option is required, like returned from `MongoClient.connect`');
     }
 
-    this.callbacks  = {};
-    this.type       = (!opts.type || (opts.type !== 'client' && opts.type !== 'server')) ? 'server' : opts.type;
-    this.debug      = (opts.debug !== true) ? false : true;
-    this.prefix     = opts.prefix || '';
-    this.maxTries   = ((opts.maxTries && !isNaN(opts.maxTries)) ? parseInt(opts.maxTries) : 59) + 1;
-    this.interval   = ((opts.interval && !isNaN(opts.interval)) ? parseInt(opts.interval) : 60) * 1000;
-    this.template   = (typeof opts.template === 'string') ? opts.template : '{{{html}}}';
+    this.callbacks = {};
+    this.type = (!opts.type || (opts.type !== 'client' && opts.type !== 'server')) ? 'server' : opts.type;
+    this.debug = (opts.debug !== true) ? false : true;
+    this.prefix = opts.prefix || '';
+    this.maxTries = ((opts.maxTries && !isNaN(opts.maxTries)) ? parseInt(opts.maxTries) : 59) + 1;
+    this.interval = ((opts.interval && !isNaN(opts.interval)) ? parseInt(opts.interval) : 60) * 1000;
+    this.template = (typeof opts.template === 'string') ? opts.template : '{{{html}}}';
     this.zombieTime = opts.zombieTime || 32786;
     this.keepHistory = opts.keepHistory || false;
 
@@ -130,11 +124,11 @@ module.exports = class MailTime {
       this.zombieTime = 8192;
     }
 
-    this.strategy    = (opts.strategy === 'backup' || opts.strategy === 'balancer') ? opts.strategy : 'backup';
     this.failsToNext = (opts.failsToNext && !isNaN(opts.failsToNext)) ? parseInt(opts.failsToNext) : 4;
-    this.transports  = opts.transports || [];
-    this.transport   = 0;
-    this.from        = (() => {
+    this.strategy = (opts.strategy === 'backup' || opts.strategy === 'balancer') ? opts.strategy : 'backup';
+    this.transports = opts.transports || [];
+    this.transport = 0;
+    this.from = (() => {
       if (typeof opts.from === 'string') {
         return () => {
           return opts.from;
@@ -148,9 +142,9 @@ module.exports = class MailTime {
       return false;
     })();
 
-    this.concatEmails     = (opts.concatEmails !== true) ? false : true;
-    this.concatSubject    = (opts.concatSubject && typeof opts.concatSubject === 'string') ? opts.concatSubject : 'Multiple notifications';
-    this.concatDelimiter  = (opts.concatDelimiter && typeof opts.concatDelimiter === 'string') ? opts.concatDelimiter : '<hr>';
+    this.concatEmails = (opts.concatEmails !== true) ? false : true;
+    this.concatSubject = (opts.concatSubject && typeof opts.concatSubject === 'string') ? opts.concatSubject : 'Multiple notifications';
+    this.concatDelimiter = (opts.concatDelimiter && typeof opts.concatDelimiter === 'string') ? opts.concatDelimiter : '<hr>';
     this.concatThrottling = ((opts.concatThrottling && !isNaN(opts.concatThrottling)) ? parseInt(opts.concatThrottling) : 60) * 1000;
 
     if (this.concatThrottling < 2048) {
@@ -169,7 +163,7 @@ module.exports = class MailTime {
     }
 
     this.collection = opts.db.collection('__mailTimeQueue__' + this.prefix);
-    this.collection.createIndex({ to: 1, isSent: 1 }, (indexError) => {
+    this.collection.createIndex({ to: 1, isSent: 1, sendAt: 1 }, (indexError) => {
       if (indexError) {
         _logError('[createIndex]', indexError);
       }
@@ -198,7 +192,7 @@ module.exports = class MailTime {
     // mailOptions.Other nodeMailer `sendMail` options...
 
     if (this.type === 'server') {
-      this.scheduler = new JoSk({
+      const scheduler = new JoSk({
         db: opts.db,
         debug: this.debug,
         prefix: `mailTimeQueue${this.prefix}`,
@@ -208,7 +202,7 @@ module.exports = class MailTime {
         maxRevolvingDelay: this.maxRevolvingDelay
       });
 
-      this.scheduler.setInterval(this.___send.bind(this), this.revolvingInterval, `mailTimeQueue${this.prefix}`);
+      scheduler.setInterval(this.___send.bind(this), this.revolvingInterval, `mailTimeQueue${this.prefix}`);
     }
   }
 
@@ -278,14 +272,13 @@ module.exports = class MailTime {
     return _mailOpts;
   }
 
-  /*
-   @memberOf MailTime
-   @name ___send
-   @param ready {Function} - See JoSk NPM package
-   @returns {void}
+  /**
+   * @memberOf MailTime
+   * @name ___send
+   * @param ready {Function} - See JoSk NPM package
+   * @returns {void}
    */
   ___send(ready) {
-    let finished = 0;
     const cursor = this.collection.find({
       isSent: false,
       sendAt: {
@@ -305,110 +298,96 @@ module.exports = class MailTime {
       }
     });
 
-    cursor.count((countError, count) => {
-      if (countError) {
-        ready();
-        _logError('[___send] [count] [countError]', countError);
-        return;
-      }
-
-      if (count) {
-        cursor.forEach((task) => {
-          this.collection.updateOne({
-            _id: task._id
-          }, {
-            $set: {
-              isSent: true
-            },
-            $inc: {
-              tries: 1
-            }
-          }, defaultWriteConcern, (updateError) => {
-            if (count === ++finished) {
-              ready();
+    cursor.forEach((task) => {
+      this.collection.updateOne({
+        _id: task._id
+      }, {
+        $set: {
+          isSent: true
+        },
+        $inc: {
+          tries: 1
+        }
+      }, (updateError) => {
+        if (updateError) {
+          this.___handleError(task, updateError, {});
+        } else {
+          let transport;
+          let transportIndex;
+          if (this.strategy === 'balancer') {
+            this.transport = this.transport + 1;
+            if (this.transport >= this.transports.length) {
+              this.transport = 0;
             }
+            transportIndex = this.transport;
+            transport = this.transports[transportIndex];
+          } else {
+            transportIndex = task.transport;
+            transport = this.transports[transportIndex];
+          }
 
-            if (updateError) {
-              this.___handleError(task, updateError, {});
-            } else {
-              let transport;
-              let transportIndex;
-              if (this.strategy === 'balancer') {
-                this.transport = this.transport + 1;
-                if (this.transport >= this.transports.length) {
-                  this.transport = 0;
-                }
-                transportIndex = this.transport;
-                transport = this.transports[this.transport];
-              } else {
-                transportIndex = task.transport;
-                transport = this.transports[task.transport];
+          try {
+            const _mailOpts = this.___compileMailOpts(transport, task);
+
+            _debug(this.debug, '[sendMail] [sending] To:', _mailOpts.to);
+            transport.sendMail(_mailOpts, (error, info) => {
+              if (error) {
+                this.___handleError(task, error, info);
+                return;
               }
 
-              try {
-                const _mailOpts = this.___compileMailOpts(transport, task);
-
-                _debug(this.debug, '[sendMail] [sending] To:', _mailOpts.to);
-                transport.sendMail(_mailOpts, (error, info) => {
-                  if (error) {
-                    this.___handleError(task, error, info);
-                    return;
-                  }
-
-                  if (info.accepted && !info.accepted.length) {
-                    this.___handleError(task, 'Message not accepted or Greeting never received', info);
-                    return;
-                  }
-
-                  _debug(this.debug, `email successfully sent, attempts: #${task.tries}, transport #${transportIndex} to: `, _mailOpts.to);
-                  if (this.keepHistory) {
-                    this.___triggerCallbacks(void 0, task, info);
-                  } else {
-                    this.collection.deleteOne({ _id: task._id }, defaultWriteConcern, () => {
-                      this.___triggerCallbacks(void 0, task, info);
-                    });
-                  }
-
-                  return;
+              if (info.accepted && !info.accepted.length) {
+                this.___handleError(task, 'Message not accepted or Greeting never received', info);
+                return;
+              }
+
+              _debug(this.debug, `email successfully sent, attempts: #${task.tries}, transport #${transportIndex} to: `, _mailOpts.to);
+              if (this.keepHistory) {
+                this.___triggerCallbacks(void 0, task, info);
+              } else {
+                this.collection.deleteOne({ _id: task._id }, () => {
+                  this.___triggerCallbacks(void 0, task, info);
                 });
-              } catch (e) {
-                _logError('Exception during runtime:', e);
-                this.___handleError(task, e, {});
               }
-            }
-          });
-        }, (forEachError) => {
-          if (forEachError) {
-            _logError('[___send] [forEach] [forEachError]', forEachError);
+
+              return;
+            });
+          } catch (e) {
+            _logError('Exception during runtime:', e);
+            this.___handleError(task, e, {});
           }
-        });
-      } else {
-        ready();
+        }
+      });
+    }, (forEachError) => {
+      ready();
+      cursor.close();
+      if (forEachError) {
+        _logError('[___send] [forEach] [forEachError]', forEachError);
       }
     });
   }
 
-  /*
-   @memberOf MailTime
-   @name send
-   @description alias of `sendMail`
-   @returns {void}
+  /**
+   * @memberOf MailTime
+   * @name send
+   * @description alias of `sendMail`
+   * @returns {void}
    */
   send(opts, callback) {
     this.sendMail(opts, callback);
   }
 
-  /*
-   @memberOf MailTime
-   @name sendMail
-   @param opts          {Object}   - Letter options with next properties:
-   @param opts.sendAt   {Date}     - When email should be sent
-   @param opts.template {String}   - Template string
-   @param opts[key]     {mix}      - Other MailOptions according to NodeMailer lib documentation
-   @param callback      {Function} - [OPTIONAL] Callback function
-   @returns {void}
+  /**
+   * @memberOf MailTime
+   * @name sendMail
+   * @param opts          {Object}   - Letter options with next properties:
+   * @param opts.sendAt   {Date}     - When email should be sent
+   * @param opts.template {String}   - Template string
+   * @param opts[key]     {mix}      - Other MailOptions according to NodeMailer lib documentation
+   * @param callback      {Function} - [OPTIONAL] Callback function
+   * @returns {void}
    */
-  sendMail(opts = {}, callback = NoOp) {
+  sendMail(opts = {}, callback = noop) {
     _debug(this.debug, '[sendMail] [attempt] To:', opts.to);
     if (!opts.html && !opts.text) {
       throw new Error('`html` nor `text` field is presented, at least one of those fields is required');
@@ -426,8 +405,8 @@ module.exports = class MailTime {
       opts.concatSubject = false;
     }
 
-    let _sendAt          = opts.sendAt;
-    const _template      = opts.template;
+    let _sendAt = opts.sendAt;
+    const _template = opts.template;
     const _concatSubject = opts.concatSubject;
     delete opts.sendAt;
     delete opts.template;
@@ -440,7 +419,10 @@ module.exports = class MailTime {
     if (this.concatEmails) {
       this.collection.findOne({
         to: opts.to,
-        isSent: false
+        isSent: false,
+        sendAt: {
+          $lte: new Date(+_sendAt + this.concatThrottling)
+        }
       }, {
         projection: {
           _id: 1,
@@ -503,13 +485,13 @@ module.exports = class MailTime {
     return;
   }
 
-  /*
-   @memberOf MailTime
-   @name ___handleError
-   @param task  {Object} - Email task record form Mongo
-   @param error {mix}    - Error String/Object/Error
-   @param info  {Object} - Info object returned from nodemailer
-   @returns {void}
+  /**
+   * @memberOf MailTime
+   * @name ___handleError
+   * @param task  {Object} - Email task record form Mongo
+   * @param error {mix}    - Error String/Object/Error
+   * @param info  {Object} - Info object returned from nodemailer
+   * @returns {void}
    */
   ___handleError(task, error, info) {
     if (!task) {
@@ -517,12 +499,14 @@ module.exports = class MailTime {
     }
 
     if (task.tries >= this.maxTries) {
-      this.collection.deleteOne({
-        _id: task._id
-      }, (deleteError) => {
-        _debug(this.debug, `Giving up trying send email after ${task.tries} attempts to: `, task.mailOptions[0].to, error, deleteError);
-        this.___triggerCallbacks(error, task, info);
-      });
+      if (!this.keepHistory) {
+        this.collection.deleteOne({
+          _id: task._id
+        }, (deleteError) => {
+          _debug(this.debug, `Giving up trying send email after ${task.tries} attempts to: `, task.mailOptions[0].to, error, deleteError);
+          this.___triggerCallbacks(error, task, info);
+        });
+      }
     } else {
       let transportIndex = task.transport;
 
@@ -547,16 +531,16 @@ module.exports = class MailTime {
     }
   }
 
-  /*
-   @memberOf MailTime
-   @name ___addToQueue
-   @param opts               {Object}   - Letter options with next properties:
-   @param opts.sendAt        {Date}     - When email should be sent
-   @param opts.template      {String}   - Email template
-   @param opts.mailOptions   {Object}   - MailOptions according to NodeMailer lib
-   @param opts.concatSubject {String}   - Email subject used when sending multiple concatenated emails
-   @param callback           {Function} - [OPTIONAL] Callback function
-   @returns {void}
+  /**
+   * @memberOf MailTime
+   * @name ___addToQueue
+   * @param opts               {Object}   - Letter options with next properties:
+   * @param opts.sendAt        {Date}     - When email should be sent
+   * @param opts.template      {String}   - Email template
+   * @param opts.mailOptions   {Object}   - MailOptions according to NodeMailer lib
+   * @param opts.concatSubject {String}   - Email subject used when sending multiple concatenated emails
+   * @param callback           {Function} - [OPTIONAL] Callback function
+   * @returns {void}
    */
   ___addToQueue(opts, callback) {
     _debug(this.debug, '[sendMail] [adding to queue] To:', opts.mailOptions.to);
@@ -590,16 +574,16 @@ module.exports = class MailTime {
     });
   }
 
-  /*
-   @memberOf MailTime
-   @name ___render
-   @param string       {String} - Template with Spacebars/Blaze/Mustache-like placeholders
-   @param replacements {Object} - Blaze/Mustache-like helpers Object
-   @returns {String}
+  /**
+   * @memberOf MailTime
+   * @name ___render
+   * @param string       {String} - Template with Spacebars/Blaze/Mustache-like placeholders
+   * @param replacements {Object} - Blaze/Mustache-like helpers Object
+   * @returns {String}
    */
   ___render(_string, replacements) {
     let i;
-    let string      = _string;
+    let string = _string;
     const matchHTML = string.match(/\{{3}\s?([a-zA-Z0-9\-\_]+)\s?\}{3}/g);
     if (matchHTML) {
       for (i = 0; i < matchHTML.length; i++) {
@@ -609,7 +593,7 @@ module.exports = class MailTime {
       }
     }
 
-    const matchStr  = string.match(/\{{2}\s?([a-zA-Z0-9\-\_]+)\s?\}{2}/g);
+    const matchStr = string.match(/\{{2}\s?([a-zA-Z0-9\-\_]+)\s?\}{2}/g);
     if (matchStr) {
       for (i = 0; i < matchStr.length; i++) {
         if (replacements[matchStr[i].replace('{{', '').replace('}}', '').trim()]) {
@@ -620,13 +604,13 @@ module.exports = class MailTime {
     return string;
   }
 
-  /*
-   @memberOf MailTime
-   @name ___triggerCallbacks
-   @param error  {mix}    - Error thrown during sending email
-   @param task   {Object} - Task record from mongodb
-   @param info   {Object} - Info object returned from NodeMailer's `sendMail` method
-   @returns {void 0}
+  /**
+   * @memberOf MailTime
+   * @name ___triggerCallbacks
+   * @param error  {mix}    - Error thrown during sending email
+   * @param task   {Object} - Task record from mongodb
+   * @param info   {Object} - Info object returned from NodeMailer's `sendMail` method
+   * @returns {void 0}
    */
   ___triggerCallbacks(error, task, info) {
     const _id = task._id.toHexString();

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mail-time",
-  "version": "1.2.5",
-  "description": "Bulletproof email queue on top of NodeMailer with support of multiple clusters and servers setup",
+  "version": "1.3.1",
+  "description": "Bulletproof email queue on top of NodeMailer for a single and multi-server setups",
   "main": "index.js",
   "scripts": {
     "test": "mocha ./test/npm.js"
@@ -36,12 +36,12 @@
   ],
   "repository": {
     "type": "git",
-    "url": "git://github.com/VeliovGroup/Mail-Time.git"
+    "url": "git://github.com/veliovgroup/mail-time.git"
   },
   "bugs": {
-    "url": "https://github.com/VeliovGroup/Mail-Time/issues"
+    "url": "https://github.com/veliovgroup/mail-time/issues"
   },
-  "homepage": "https://github.com/VeliovGroup/Mail-Time",
+  "homepage": "https://github.com/veliovgroup/mail-time",
   "author": "dr.dimitru (https://veliovgroup.com)",
   "license": "BSD-3-Clause",
   "engines": {
@@ -49,15 +49,15 @@
   },
   "dependencies": {
     "deepmerge": "^4.2.2",
-    "josk": "^2.3.0"
+    "josk": "^3.0.0"
   },
   "devDependencies": {
-    "bson": "^4.1.0",
-    "bson-ext": "^2.0.5",
-    "chai": "^4.2.0",
-    "mocha": "^8.1.3",
-    "mongodb": "^3.6.2",
-    "nodemailer": "^6.4.11",
-    "nodemailer-direct-transport": "^3.3.2"
+    "bson": "^4.6.4",
+    "bson-ext": "^4.0.2",
+    "chai": "^4.3.6",
+    "mocha": "^10.0.0",
+    "mongodb": "^4.6.0",
+    "nodemailer": "^6.7.5",
+    "nodemailer-direct-transport": "^3.0.7"
   }
 }

package/CHANGELOG.md

@@ -1 +0,0 @@
-For full changelog see [releases](https://github.com/VeliovGroup/Mail-Time/releases) in GitHub

package/HISTORY.md

@@ -1 +0,0 @@
-For full history see [releases](https://github.com/VeliovGroup/Mail-Time/releases) in GitHub