nodemailer 6.4.18 → 6.6.2

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # CHANGELOG
 
+## 6.6.1 2021-05-23
+
+-   Fixed address formatting issue where newlines in an email address, if provided via address object, were not properly removed. Reported by tmazeika (#1289)
+
+## 6.6.0 2021-04-28
+
+-   Added new option `newline` for MailComposer
+-   aws ses connection verification (Ognjen Jevremovic)
+
+## 6.5.0 2021-02-26
+
+-   Pass through textEncoding to subnodes
+-   Added support for AWS SES v3 SDK
+-   Fixed tests
+
 ## 6.4.18 2021-02-11
 
 -   Updated README

package/README.md

@@ -2,8 +2,6 @@
 
 [![Nodemailer](https://raw.githubusercontent.com/nodemailer/nodemailer/master/assets/nm_logo_200x136.png)](https://nodemailer.com/about/)
 
-> Sponsored by [Forward Email](https://forwardemail.net/?ref=nodemailer) – free email forwarding + custom domains + 100% open-source!
-
 Send e-mails from Node.js – easy as cake! 🍰✉️
 
 [![NPM](https://nodei.co/npm/nodemailer.png?downloads=true&downloadRank=true&stars=true)](https://nodemailer.com/about/)
@@ -30,8 +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.
-* 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.
+-   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/mail-composer/index.js

@@ -31,7 +31,7 @@ class MailComposer {
 
         // Compose MIME tree
         if (this.mail.raw) {
-            this.message = new MimeNode().setRaw(this.mail.raw);
+            this.message = new MimeNode('message/rfc822', { newline: this.mail.newline }).setRaw(this.mail.raw);
         } else if (this._useMixed) {
             this.message = this._createMixed();
         } else if (this._useAlternative) {
@@ -345,13 +345,15 @@ class MailComposer {
                 boundaryPrefix: this.mail.boundaryPrefix,
                 disableUrlAccess: this.mail.disableUrlAccess,
                 disableFileAccess: this.mail.disableFileAccess,
-                normalizeHeaderKey: this.mail.normalizeHeaderKey
+                normalizeHeaderKey: this.mail.normalizeHeaderKey,
+                newline: this.mail.newline
             });
         } else {
             node = parentNode.createChild('multipart/mixed', {
                 disableUrlAccess: this.mail.disableUrlAccess,
                 disableFileAccess: this.mail.disableFileAccess,
-                normalizeHeaderKey: this.mail.normalizeHeaderKey
+                normalizeHeaderKey: this.mail.normalizeHeaderKey,
+                newline: this.mail.newline
             });
         }
 
@@ -391,13 +393,15 @@ class MailComposer {
                 boundaryPrefix: this.mail.boundaryPrefix,
                 disableUrlAccess: this.mail.disableUrlAccess,
                 disableFileAccess: this.mail.disableFileAccess,
-                normalizeHeaderKey: this.mail.normalizeHeaderKey
+                normalizeHeaderKey: this.mail.normalizeHeaderKey,
+                newline: this.mail.newline
             });
         } else {
             node = parentNode.createChild('multipart/alternative', {
                 disableUrlAccess: this.mail.disableUrlAccess,
                 disableFileAccess: this.mail.disableFileAccess,
-                normalizeHeaderKey: this.mail.normalizeHeaderKey
+                normalizeHeaderKey: this.mail.normalizeHeaderKey,
+                newline: this.mail.newline
             });
         }
 
@@ -428,13 +432,15 @@ class MailComposer {
                 boundaryPrefix: this.mail.boundaryPrefix,
                 disableUrlAccess: this.mail.disableUrlAccess,
                 disableFileAccess: this.mail.disableFileAccess,
-                normalizeHeaderKey: this.mail.normalizeHeaderKey
+                normalizeHeaderKey: this.mail.normalizeHeaderKey,
+                newline: this.mail.newline
             });
         } else {
             node = parentNode.createChild('multipart/related; type="text/html"', {
                 disableUrlAccess: this.mail.disableUrlAccess,
                 disableFileAccess: this.mail.disableFileAccess,
-                normalizeHeaderKey: this.mail.normalizeHeaderKey
+                normalizeHeaderKey: this.mail.normalizeHeaderKey,
+                newline: this.mail.newline
             });
         }
 
@@ -470,14 +476,17 @@ class MailComposer {
                 boundaryPrefix: this.mail.boundaryPrefix,
                 disableUrlAccess: this.mail.disableUrlAccess,
                 disableFileAccess: this.mail.disableFileAccess,
-                normalizeHeaderKey: this.mail.normalizeHeaderKey
+                normalizeHeaderKey: this.mail.normalizeHeaderKey,
+                newline: this.mail.newline
             });
         } else {
             node = parentNode.createChild(element.contentType, {
                 filename: element.filename,
+                textEncoding: this.mail.textEncoding,
                 disableUrlAccess: this.mail.disableUrlAccess,
                 disableFileAccess: this.mail.disableFileAccess,
-                normalizeHeaderKey: this.mail.normalizeHeaderKey
+                normalizeHeaderKey: this.mail.normalizeHeaderKey,
+                newline: this.mail.newline
             });
         }
 

package/lib/mime-node/index.js

@@ -16,6 +16,9 @@ const addressparser = require('../addressparser');
 const fetch = require('../fetch');
 const LastNewline = require('./last-newline');
 
+const LeWindows = require('./le-windows');
+const LeUnix = require('./le-unix');
+
 /**
  * Creates a new mime tree node. Assumes 'multipart/*' as the content type
  * if it is a branch, anything else counts as leaf. If rootNode is missing from
@@ -92,6 +95,11 @@ class MimeNode {
          */
         this.hostname = options.hostname;
 
+        /**
+         * If set to 'win' then uses \r\n, if 'linux' then \n. If not set (or `raw` is used) then newlines are kept as is.
+         */
+        this.newline = options.newline;
+
         /**
          * An array for possible child nodes
          */
@@ -451,7 +459,7 @@ class MimeNode {
                         transferEncoding = this._getTextEncoding(this.content) === 'Q' ? 'quoted-printable' : 'base64';
                     } else {
                         // we can not check content for a stream, so either use preferred encoding or fallback to QP
-                        transferEncoding = this.transferEncoding === 'B' ? 'base64' : 'quoted-printable';
+                        transferEncoding = this.textEncoding === 'B' ? 'base64' : 'quoted-printable';
                     }
                 } else if (!/^(multipart|message)\//i.test(contentType)) {
                     transferEncoding = transferEncoding || 'base64';
@@ -626,6 +634,15 @@ class MimeNode {
             outputStream = transform(outputStream);
         }
 
+        if (this.newline) {
+            const winbreak = ['win', 'windows', 'dos', '\r\n'].includes(this.newline.toString().toLowerCase());
+            const newlineTransform = winbreak ? new LeWindows() : new LeUnix();
+
+            const stream = outputStream.pipe(newlineTransform);
+            outputStream.on('error', err => stream.emit('error', err));
+            return stream;
+        }
+
         return outputStream;
     }
 
@@ -1130,9 +1147,9 @@ class MimeNode {
                 address.address = this._normalizeAddress(address.address);
 
                 if (!address.name) {
-                    values.push(address.address);
+                    values.push(address.address.indexOf(' ') >= 0 ? `<${address.address}>` : `${address.address}`);
                 } else if (address.name) {
-                    values.push(this._encodeAddressName(address.name) + ' <' + address.address + '>');
+                    values.push(`${this._encodeAddressName(address.name)} <${address.address}>`);
                 }
 
                 if (address.address) {
@@ -1141,9 +1158,8 @@ class MimeNode {
                     }
                 }
             } else if (address.group) {
-                values.push(
-                    this._encodeAddressName(address.name) + ':' + (address.group.length ? this._convertAddresses(address.group, uniqueList) : '').trim() + ';'
-                );
+                let groupListAddresses = (address.group.length ? this._convertAddresses(address.group, uniqueList) : '').trim();
+                values.push(`${this._encodeAddressName(address.name)}:${groupListAddresses};`);
             }
         });
 
@@ -1157,13 +1173,17 @@ class MimeNode {
      * @return {String} address string
      */
     _normalizeAddress(address) {
-        address = (address || '').toString().trim();
+        address = (address || '')
+            .toString()
+            .replace(/[\x00-\x1F<>]+/g, ' ') // remove unallowed characters
+            .trim();
 
         let lastAt = address.lastIndexOf('@');
         if (lastAt < 0) {
             // Bare username
             return address;
         }
+
         let user = address.substr(0, lastAt);
         let domain = address.substr(lastAt + 1);
 
@@ -1172,7 +1192,24 @@ class MimeNode {
         // 'jõgeva.ee' will be converted to 'xn--jgeva-dua.ee'
         // non-unicode domains are left as is
 
-        return user + '@' + punycode.toASCII(domain.toLowerCase());
+        let encodedDomain;
+
+        try {
+            encodedDomain = punycode.toASCII(domain.toLowerCase());
+        } catch (err) {
+            // keep as is?
+        }
+
+        if (user.indexOf(' ') >= 0) {
+            if (user.charAt(0) !== '"') {
+                user = '"' + user;
+            }
+            if (user.substr(-1) !== '"') {
+                user = user + '"';
+            }
+        }
+
+        return `${user}@${encodedDomain}`;
     }
 
     /**

package/lib/sendmail-transport/index.js

@@ -2,8 +2,6 @@
 
 const spawn = require('child_process').spawn;
 const packageData = require('../../package.json');
-const LeWindows = require('./le-windows');
-const LeUnix = require('./le-unix');
 const shared = require('../shared');
 
 /**
@@ -68,7 +66,6 @@ class SendmailTransport {
         let args;
         let sendmail;
         let returned;
-        let transform;
 
         const hasInvalidAddresses = []
             .concat(envelope.from || [])
@@ -187,10 +184,8 @@ class SendmailTransport {
                 recipients.join(', ')
             );
 
-            transform = this.winbreak ? new LeWindows() : new LeUnix();
             let sourceStream = mail.message.createReadStream();
-
-            transform.once('error', err => {
+            sourceStream.once('error', err => {
                 this.logger.error(
                     {
                         err,
@@ -205,8 +200,7 @@ class SendmailTransport {
                 callback(err);
             });
 
-            sourceStream.once('error', err => transform.emit('error', err));
-            sourceStream.pipe(transform).pipe(sendmail.stdin);
+            sourceStream.pipe(sendmail.stdin);
         } else {
             return callback(new Error('sendmail was not found'));
         }

package/lib/ses-transport/index.js

@@ -3,7 +3,7 @@
 const EventEmitter = require('events');
 const packageData = require('../../package.json');
 const shared = require('../shared');
-const LeWindows = require('../sendmail-transport/le-windows');
+const LeWindows = require('../mime-node/le-windows');
 
 /**
  * Generates a Transport object for AWS SES
@@ -239,36 +239,64 @@ class SESTransport extends EventEmitter {
                     sesMessage[key] = mail.data.ses[key];
                 });
 
-                this.ses.sendRawEmail(sesMessage, (err, data) => {
-                    if (err) {
-                        this.logger.error(
-                            {
-                                err,
-                                tnx: 'send'
-                            },
-                            'Send error for %s: %s',
-                            messageId,
-                            err.message
-                        );
-                        statObject.pending = false;
-                        return callback(err);
+                let ses = (this.ses.aws ? this.ses.ses : this.ses) || {};
+                let aws = this.ses.aws || {};
+
+                let getRegion = cb => {
+                    if (ses.config && typeof ses.config.region === 'function') {
+                        // promise
+                        return ses.config
+                            .region()
+                            .then(region => cb(null, region))
+                            .catch(err => cb(err));
                     }
+                    return cb(null, (ses.config && ses.config.region) || 'us-east-1');
+                };
 
-                    let region = (this.ses.config && this.ses.config.region) || 'us-east-1';
-                    if (region === 'us-east-1') {
-                        region = 'email';
+                getRegion((err, region) => {
+                    if (err || !region) {
+                        region = 'us-east-1';
                     }
 
-                    statObject.pending = false;
-                    callback(null, {
-                        envelope: {
-                            from: envelope.from,
-                            to: envelope.to
-                        },
-                        messageId: '<' + data.MessageId + (!/@/.test(data.MessageId) ? '@' + region + '.amazonses.com' : '') + '>',
-                        response: data.MessageId,
-                        raw
-                    });
+                    let sendPromise;
+                    if (typeof ses.send === 'function' && aws.SendRawEmailCommand) {
+                        // v3 API
+                        sendPromise = ses.send(new aws.SendRawEmailCommand(sesMessage));
+                    } else {
+                        // v2 API
+                        sendPromise = ses.sendRawEmail(sesMessage).promise();
+                    }
+
+                    sendPromise
+                        .then(data => {
+                            if (region === 'us-east-1') {
+                                region = 'email';
+                            }
+
+                            statObject.pending = false;
+                            callback(null, {
+                                envelope: {
+                                    from: envelope.from,
+                                    to: envelope.to
+                                },
+                                messageId: '<' + data.MessageId + (!/@/.test(data.MessageId) ? '@' + region + '.amazonses.com' : '') + '>',
+                                response: data.MessageId,
+                                raw
+                            });
+                        })
+                        .catch(err => {
+                            this.logger.error(
+                                {
+                                    err,
+                                    tnx: 'send'
+                                },
+                                'Send error for %s: %s',
+                                messageId,
+                                err.message
+                            );
+                            statObject.pending = false;
+                            callback(err);
+                        });
                 });
             })
         );
@@ -281,6 +309,23 @@ class SESTransport extends EventEmitter {
      */
     verify(callback) {
         let promise;
+        let ses = (this.ses.aws ? this.ses.ses : this.ses) || {};
+        let aws = this.ses.aws || {};
+
+        const sesMessage = {
+            RawMessage: {
+                // required
+                Data: 'From: invalid@invalid\r\nTo: invalid@invalid\r\n Subject: Invalid\r\n\r\nInvalid'
+            },
+            Source: 'invalid@invalid',
+            Destinations: ['invalid@invalid']
+        };
+        const cb = err => {
+            if (err && err.code !== 'InvalidParameterValue') {
+                return callback(err);
+            }
+            return callback(null, true);
+        };
 
         if (!callback) {
             promise = new Promise((resolve, reject) => {
@@ -288,22 +333,13 @@ class SESTransport extends EventEmitter {
             });
         }
 
-        this.ses.sendRawEmail(
-            {
-                RawMessage: {
-                    // required
-                    Data: 'From: invalid@invalid\r\nTo: invalid@invalid\r\n Subject: Invalid\r\n\r\nInvalid'
-                },
-                Source: 'invalid@invalid',
-                Destinations: ['invalid@invalid']
-            },
-            err => {
-                if (err && err.code !== 'InvalidParameterValue') {
-                    return callback(err);
-                }
-                return callback(null, true);
-            }
-        );
+        if (typeof ses.send === 'function' && aws.SendRawEmailCommand) {
+            // v3 API
+            ses.send(new aws.SendRawEmailCommand(sesMessage), cb);
+        } else {
+            // v2 API
+            ses.sendRawEmail(sesMessage, cb).promise();
+        }
 
         return promise;
     }

package/lib/shared/index.js

@@ -327,7 +327,11 @@ module.exports.resolveContent = (data, key, callback) => {
                 }
                 // we can't stream twice the same content, so we need
                 // to replace the stream object with the streaming result
-                data[key] = value;
+                if (data[key].content) {
+                    data[key].content = value;
+                } else {
+                    data[key] = value;
+                }
                 callback(null, value);
             });
         } else if (/^https?:\/\//i.test(content.path || content.href)) {

package/lib/smtp-connection/index.js

@@ -873,16 +873,21 @@ class SMTPConnection extends EventEmitter {
         });
 
         this.upgrading = true;
-        this._socket = tls.connect(opts, () => {
-            this.secure = true;
-            this.upgrading = false;
-            this._socket.on('data', this._onSocketData);
+        // tls.connect is not an asynchronous function however it may still throw errors and requires to be wrapped with try/catch
+        try {
+            this._socket = tls.connect(opts, () => {
+                this.secure = true;
+                this.upgrading = false;
+                this._socket.on('data', this._onSocketData);
 
-            socketPlain.removeListener('close', this._onSocketClose);
-            socketPlain.removeListener('end', this._onSocketEnd);
+                socketPlain.removeListener('close', this._onSocketClose);
+                socketPlain.removeListener('end', this._onSocketEnd);
 
-            return callback(null, true);
-        });
+                return callback(null, true);
+            });
+        } catch (err) {
+            return callback(err);
+        }
 
         this._socket.on('error', this._onSocketError);
         this._socket.once('close', this._onSocketClose);

package/lib/stream-transport/index.js

@@ -2,8 +2,6 @@
 
 const packageData = require('../../package.json');
 const shared = require('../shared');
-const LeWindows = require('../sendmail-transport/le-windows');
-const LeUnix = require('../sendmail-transport/le-unix');
 
 /**
  * Generates a Transport object for streaming
@@ -61,15 +59,10 @@ class StreamTransport {
         );
 
         setImmediate(() => {
-            let sourceStream;
             let stream;
-            let transform;
 
             try {
-                transform = this.winbreak ? new LeWindows() : new LeUnix();
-                sourceStream = mail.message.createReadStream();
-                stream = sourceStream.pipe(transform);
-                sourceStream.on('error', err => stream.emit('error', err));
+                stream = mail.message.createReadStream();
             } catch (E) {
                 this.logger.error(
                     {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "nodemailer",
-    "version": "6.4.18",
+    "version": "6.6.2",
     "description": "Easy as cake e-mail sending from your Node.js applications",
     "main": "lib/nodemailer.js",
     "scripts": {
@@ -21,25 +21,24 @@
     "homepage": "https://nodemailer.com/",
     "devDependencies": {
         "bunyan": "1.8.15",
-        "chai": "4.3.0",
+        "chai": "4.3.4",
         "eslint-config-nodemailer": "1.2.0",
-        "eslint-config-prettier": "7.2.0",
-        "grunt": "1.3.0",
-        "grunt-cli": "1.3.2",
+        "eslint-config-prettier": "8.3.0",
+        "grunt": "1.4.1",
+        "grunt-cli": "1.4.3",
         "grunt-eslint": "23.0.0",
         "grunt-mocha-test": "0.13.3",
         "libbase64": "1.2.1",
         "libmime": "5.0.0",
         "libqp": "1.1.0",
-        "mocha": "8.2.1",
+        "mocha": "9.0.0",
         "nodemailer-ntlm-auth": "1.0.1",
         "proxy": "1.0.2",
         "proxy-test-server": "1.0.0",
-        "sinon": "9.2.4",
-        "smtp-server": "3.8.0"
+        "sinon": "11.1.1",
+        "smtp-server": "3.9.0"
     },
     "engines": {
         "node": ">=6.0.0"
-    },
-    "dependencies": {}
+    }
 }