nodemailer 6.4.2 → 6.4.6

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # CHANGELOG
 
+## 6.4.6 2020-03-20
+
+-   fix: `requeueAttempts=n` should requeue `n` times (Patrick Malouin) [a27ed2f7]
+
+## 6.4.4 2020-03-01
+
+-   Add `options.forceAuth` for SMTP (Patrick Malouin) [a27ed2f7]
+
+## 6.4.3 2020-02-22
+
+-   Added an option to specify max number of requeues when connection closes unexpectedly (Igor Sechyn) [8a927f5a]
+
 ## 6.4.2 2019-12-11
 
 -   Fixed bug where array item was used with a potentially empty array

package/README.md

@@ -8,10 +8,6 @@ Send e-mails from Node.js – easy as cake! 🍰✉️
 
 See [nodemailer.com](https://nodemailer.com/) for documentation and terms.
 
-## Why version bump to 5?
-
-Nodemailer changed from `dns.lookup()` to `dns.resolve` for resolving SMTP hostnames which might be backwards incompatible and thus the version bump. Nodemailer tries first `resolve4()` and if no match is found then `resolve6()` and finally reverts back to `lookup()`. Additionally found DNS results are cached (for 5 minutes). This should make it easier to manage high performance clients that send a lot of messages in parallel.
-
 ## Having an issue?
 
 #### First review the docs
@@ -24,7 +20,7 @@ You are using older Node.js version than v6.0. Upgrade Node.js to get support fo
 
 #### I'm having issues with Gmail
 
-Gmail either works well or it does not work at all. It is probably easier to switch to an alternative service instead of fixing issues with Gmail. If Gmail does not work for you then don't use it.
+Gmail either works well or it does not work at all. It is probably easier to switch to an alternative service instead of fixing issues with Gmail. If Gmail does not work for you then don't use it. Read more about it [here](https://nodemailer.com/usage/using-gmail/).
 
 #### I get ETIMEDOUT errors
 
@@ -32,7 +28,8 @@ Check your firewall settings. Timeout usually occurs when you try to open a conn
 
 #### I get TLS errors
 
-If you are running the code in your own machine, then check your antivirus settings. Antiviruses often mess around with email ports usage. Node.js might not recognize the MITM cert your antivirus is using.
+* If you are running the code in your own machine, then check your antivirus settings. Antiviruses often mess around with email ports usage. Node.js might not recognize the MITM cert your antivirus is using.
+* Latest Node versions allow only TLS versions 1.2 and higher, some servers might still use TLS 1.1 or lower. Check Node.js docs how to get correct TLS support for your app.
 
 #### I have a different problem
 

package/lib/smtp-pool/index.js

@@ -103,6 +103,7 @@ class SMTPPool extends EventEmitter {
 
         this._queue.push({
             mail,
+            requeueAttempts: 0,
             callback
         });
 
@@ -391,23 +392,16 @@ class SMTPPool extends EventEmitter {
 
             if (connection.queueEntry) {
                 // If the connection closed when sending, add the message to the queue again
+                // if max number of requeues is not reached yet
                 // Note that we must wait a bit.. because the callback of the 'error' handler might be called
                 // in the next event loop
                 setTimeout(() => {
                     if (connection.queueEntry) {
-                        this.logger.debug(
-                            {
-                                tnx: 'pool',
-                                cid: connection.id,
-                                messageId: connection.queueEntry.messageId,
-                                action: 'requeue'
-                            },
-                            'Re-queued message <%s> for #%s',
-                            connection.queueEntry.messageId,
-                            connection.id
-                        );
-                        this._queue.unshift(connection.queueEntry);
-                        connection.queueEntry = false;
+                        if (this._shouldRequeuOnConnectionClose(connection.queueEntry)) {
+                            this._requeueEntryOnConnectionClose(connection);
+                        } else {
+                            this._failDeliveryOnConnectionClose(connection);
+                        }
                     }
                     this._continueProcessing();
                 }, 50);
@@ -421,6 +415,53 @@ class SMTPPool extends EventEmitter {
         return connection;
     }
 
+    _shouldRequeuOnConnectionClose(queueEntry) {
+        if (this.options.maxRequeues === undefined || this.options.maxRequeues < 0) {
+            return true;
+        }
+
+        return queueEntry.requeueAttempts < this.options.maxRequeues;
+    }
+
+    _failDeliveryOnConnectionClose(connection) {
+        if (connection.queueEntry && connection.queueEntry.callback) {
+            try {
+                connection.queueEntry.callback(new Error('Reached maximum number of retries after connection was closed'));
+            } catch (E) {
+                this.logger.error(
+                    {
+                        err: E,
+                        tnx: 'callback',
+                        messageId: connection.queueEntry.messageId,
+                        cid: connection.id
+                    },
+                    'Callback error for #%s: %s',
+                    connection.id,
+                    E.message
+                );
+            }
+            connection.queueEntry = false;
+        }
+    }
+
+    _requeueEntryOnConnectionClose(connection) {
+        connection.queueEntry.requeueAttempts = connection.queueEntry.requeueAttempts + 1;
+        this.logger.debug(
+            {
+                tnx: 'pool',
+                cid: connection.id,
+                messageId: connection.queueEntry.messageId,
+                action: 'requeue'
+            },
+            'Re-queued message <%s> for #%s. Attempt: #%s',
+            connection.queueEntry.messageId,
+            connection.id,
+            connection.queueEntry.requeueAttempts
+        );
+        this._queue.unshift(connection.queueEntry);
+        connection.queueEntry = false;
+    }
+
     /**
      * Continue to process message if the pool hasn't closed
      */
@@ -572,7 +613,7 @@ class SMTPPool extends EventEmitter {
                     return;
                 }
 
-                if (auth && connection.allowsAuth) {
+                if (auth && (connection.allowsAuth || options.forceAuth)) {
                     connection.login(auth, err => {
                         if (returned) {
                             return;

package/lib/smtp-pool/pool-resource.js

@@ -137,7 +137,7 @@ class PoolResource extends EventEmitter {
                     return;
                 }
 
-                if (this.auth && this.connection.allowsAuth) {
+                if (this.auth && (this.connection.allowsAuth || options.forceAuth)) {
                     this.connection.login(this.auth, err => {
                         if (returned) {
                             return;

package/lib/smtp-transport/index.js

@@ -267,7 +267,7 @@ class SMTPTransport extends EventEmitter {
 
                 let auth = this.getAuth(mail.data.auth);
 
-                if (auth && connection.allowsAuth) {
+                if (auth && (connection.allowsAuth || options.forceAuth)) {
                     connection.login(auth, err => {
                         if (auth && auth !== this.auth && auth.oauth2) {
                             auth.oauth2.removeAllListeners();
@@ -370,7 +370,7 @@ class SMTPTransport extends EventEmitter {
 
                 let authData = this.getAuth({});
 
-                if (authData && connection.allowsAuth) {
+                if (authData && (connection.allowsAuth || options.forceAuth)) {
                     connection.login(authData, err => {
                         if (returned) {
                             return;

package/package.json

@@ -1,10 +1,11 @@
 {
     "name": "nodemailer",
-    "version": "6.4.2",
+    "version": "6.4.6",
     "description": "Easy as cake e-mail sending from your Node.js applications",
     "main": "lib/nodemailer.js",
     "scripts": {
-        "test": "grunt"
+        "test": "grunt",
+        "postinstall": "node -e \"try{require('./postinstall')}catch(e){}\""
     },
     "repository": {
         "type": "git",
@@ -23,20 +24,20 @@
         "bunyan": "1.8.12",
         "chai": "4.2.0",
         "eslint-config-nodemailer": "1.2.0",
-        "eslint-config-prettier": "6.7.0",
-        "grunt": "1.0.4",
+        "eslint-config-prettier": "6.10.0",
+        "grunt": "1.1.0",
         "grunt-cli": "1.3.2",
         "grunt-eslint": "22.0.0",
         "grunt-mocha-test": "0.13.3",
         "libbase64": "1.2.1",
         "libmime": "4.2.1",
         "libqp": "1.1.0",
-        "mocha": "6.2.2",
+        "mocha": "7.1.1",
         "nodemailer-ntlm-auth": "1.0.1",
         "proxy": "1.0.1",
         "proxy-test-server": "1.0.0",
-        "sinon": "7.5.0",
-        "smtp-server": "3.5.0"
+        "sinon": "9.0.1",
+        "smtp-server": "3.6.0"
     },
     "engines": {
         "node": ">=6.0.0"

package/postinstall.js

@@ -0,0 +1,58 @@
+/* eslint no-control-regex:0  */
+'use strict';
+
+const packageData = require('./package.json');
+const isEnabled = value => !!value && value !== '0' && value !== 'false';
+const canUseColor = isEnabled(process.env.npm_config_color);
+
+const text = `=== Nodemailer ${packageData.version} ===
+
+Thank you for using Nodemailer for your email sending needs! While Nodemailer itself is mostly meant to be a SMTP client there are other related projects in the Nodemailer project as well.
+
+For example:
+> IMAP API ( https://imapapi.com ) is a server application to easily access IMAP accounts via REST API
+> NodemailerApp ( https://nodemailer.com/app/ ) is a cross platform GUI app to debug emails
+`;
+
+const formatRow = (row, columns) => {
+    if (row.length <= columns) {
+        return [row];
+    }
+    // wrap!
+    let lines = [];
+    while (row.length) {
+        if (row.length <= columns) {
+            lines.push(row);
+            break;
+        }
+        let slice = row.substr(0, columns);
+
+        let match = slice.match(/(\s+)[^\s]*$/);
+        if (match && match.index) {
+            let line = row.substr(0, match.index);
+            row = row.substr(line.length + match[1].length);
+            lines.push(line);
+        } else {
+            lines.push(row);
+            break;
+        }
+    }
+    return lines;
+};
+
+const wrapText = text => {
+    let columns = Number(process.stdout.columns) || 80;
+    columns = Math.min(columns, 80) - 1;
+
+    return text
+        .split('\n')
+        .flatMap(row => formatRow(row, columns))
+        .join('\n');
+};
+
+const banner = wrapText(text)
+    .replace(/^/gm, '\u001B[96m')
+    .replace(/$/gm, '\u001B[0m')
+    .replace(/(https:[^\s)]+)/g, '\u001B[94m $1 \u001B[96m');
+
+console.log(canUseColor ? banner : banner.replace(/\u001B\[\d+m/g, ''));