mail-time 1.3.0 → 1.3.3

package/CHANGELOG.md

@@ -0,0 +1 @@
+For full changelog see [releases](https://github.com/veliovgroup/mail-time/releases) in GitHub

package/HISTORY.md

@@ -0,0 +1 @@
+For full history see [releases](https://github.com/veliovgroup/mail-time/releases) in GitHub

package/README.md

@@ -1,4 +1,4 @@
-[![support](https://img.shields.io/badge/support-GitHub-white)](https://github.com/sponsors/veliovgroup)
+[![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">
@@ -6,37 +6,28 @@
 
 # MailTime
 
-Micro-service package for mail queue, with *Server* and *Client* API.
-Build on top of [`nodemailer`](https://github.com/nodemailer/nodemailer) package.
-
-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*.
+Every `MailTime` instance can get `type` 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.
+The main difference between *Server* and *Client* `type` 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:
 
@@ -174,8 +165,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
@@ -213,12 +204,12 @@ transports.push(nodemailer.createTransport({
 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);
@@ -243,9 +234,10 @@ MongoClient.connect(process.env.MONGO_URL, (error, client) => {
 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);
@@ -275,7 +267,7 @@ mailQueue.sendMail({
 Create two `MailTime` instances with different settings.
 
 ```js
-// USE FOR NON-URGENT EMAILS WHICH IS OKAY TO CONCATENATE
+// CREATE mailQueue FOR NON-URGENT EMAILS WHICH IS OKAY TO CONCATENATE
 const mailQueue = new MailTime({
   db: db,
   interval: 35,
@@ -286,7 +278,7 @@ const mailQueue = new MailTime({
   zombieTime: 120000
 });
 
-// USE FOR TRANSACTIONAL EMAILS AND ALERTS
+// CREATE mailInstantQueue FOR TRANSACTIONAL EMAILS AND ALERTS
 const mailInstantQueue = new MailTime({
   db: db,
   prefix: 'instant',
@@ -318,12 +310,12 @@ All options passed to the `.sendMail()` method is available inside `text`, `html
 
 ```js
 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>',
+  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}}! Copy your login code below <pre><code>{{code}}</code></pre>`
+    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>`
   }
-}
+};
 
 const mailQueue = new MailTime({
   db: db,
@@ -334,85 +326,12 @@ mailQueue.sendMail({
   to: 'user@gmail.com',
   subject: 'Sign-in request',
   username: 'johndoe',
-  code: 'XXXXX-YY'
+  code: 'XXXXX-YY',
   text: templates.signInCode.text,
   html: templates.signInCode.html
 });
 ```
 
-## Meteor.js usage:
-
-Mail-Time package can be installed and used within [Meteor.js](https://docs.meteor.com/) via [NPM](https://www.npmjs.com/package/mail-time) or [Atmosphere](https://atmospherejs.com/ostrio/mailer)
-
-### Installation & Import (*via NPM*):
-
-Install [NPM `mail-time` package](https://www.npmjs.com/package/mail-time):
-
-```shell
-meteor npm install --save mail-time
-```
-
-Meteor.js: ES6 Import NPM package:
-
-```js
-import MailTime from 'mail-time';
-```
-
-### Installation & Import (*via Atmosphere*):
-
-Install [Atmosphere `ostrio:mailer` package](https://atmospherejs.com/ostrio/mailer):
-
-```shell
-meteor add ostrio:mailer
-```
-
-Meteor.js: ES6 Import atmosphere package:
-
-```js
-import MailTime from 'meteor/ostrio:mailer';
-```
-
-### Usage:
-
-`mail-time` package usage examples in Meteor.js
-
-```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',
-};
-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 + '>';
-  }
-});
-```
-
 ## API
 
 All available constructor options and `.sendMail()` method API overview
@@ -447,15 +366,15 @@ All available constructor options and `.sendMail()` method API overview
 - `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 example:
+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
@@ -505,21 +424,6 @@ DEBUG="true" EMAIL_DOMAIN="example.com" MONGO_URL="mongodb://127.0.0.1:27017/npm
 # Be patient, tests are taking around 2 mins
 ```
 
-Test Atmosphere (meteor.js) package:
-
-```shell
-# Default
-EMAIL_DOMAIN="example.com" meteor test-packages ./ --driver-package=meteortesting:mocha
-
-# With custom port
-DEBUG="true" EMAIL_DOMAIN="example.com" meteor test-packages ./ --driver-package=meteortesting:mocha --port 8888
-
-# With local MongoDB and custom port
-DEBUG="true" EMAIL_DOMAIN="example.com" MONGO_URL="mongodb://127.0.0.1:27017/meteor-mail-time-test-001" meteor test-packages ./ --driver-package=meteortesting:mocha --port 8888
-
-# Be patient, tests are taking around 2 mins
-```
-
 ## Support this project:
 
 - Star on [GitHub](https://github.com/veliovgroup/mail-time)

package/index.js

@@ -1,6 +1,6 @@
 const JoSk = require('josk');
 const noop = () =>  {};
-const merge  = require('deepmerge');
+const merge = require('deepmerge');
 const _debug = (isDebug, ...args) => {
   if (isDebug) {
     console.info.call(console, '[DEBUG] [mail-time]', `${new Date}`, ...args);
@@ -102,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;
 
@@ -124,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;
@@ -320,10 +320,10 @@ module.exports = class MailTime {
               this.transport = 0;
             }
             transportIndex = this.transport;
-            transport = this.transports[this.transport];
+            transport = this.transports[transportIndex];
           } else {
             transportIndex = task.transport;
-            transport = this.transports[task.transport];
+            transport = this.transports[transportIndex];
           }
 
           try {
@@ -499,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;
 
@@ -591,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()]) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mail-time",
-  "version": "1.3.0",
+  "version": "1.3.3",
   "description": "Bulletproof email queue on top of NodeMailer for a single and multi-server setups",
   "main": "index.js",
   "scripts": {
@@ -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": "^3.0.0"
+    "josk": "^3.0.2"
   },
   "devDependencies": {
     "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",
+    "mongodb": "^4.7.0",
+    "nodemailer": "^6.7.6",
     "nodemailer-direct-transport": "^3.0.7"
   }
 }