libmime 2.1.0 → 3.0.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## v3.0.0 2016-12-08
+
+  * Updated encoded-word generation. Previously a minimal value was encoded, so it was possible to have multiple encoded words in a string separated by non encoded-words. This was an issue with some webmail clients that stripped out the non-encoded parts between encoded-words so the updated method uses wide match by encoding from the first word with unicode characters to the last word. "a =?b?= c =?d?= e" -> "a =?bcd?= e"
+
+## v2.1.3 2016-12-08
+
+  * Revert dot as a special symbol
+
+## v2.1.2 2016-11-21
+
+  * Quote special symbols as defined in RFC (surajwy)
+
+## v2.1.1 2016-11-15
+
+  * Fixed issue with special symbols in attachment filenames
+
 ## v2.1.0 2016-07-24
 
   * Changed handling of base64 encoded mime words where multiple words are joined together if possible. This fixes issues with multi byte characters getting split into different mime words (against the RFC but occurs)

package/lib/libmime.js

@@ -184,7 +184,15 @@ var libmime = module.exports = {
         fromCharset = match[1].split('*').shift();
 
         encoding = (match[2] || 'Q').toString().toUpperCase();
-        str = (match[3] || '').replace(/_/g, ' ').replace(/ $/, '=20');
+        str = (match[3] || '');
+
+        if (encoding === 'Q') {
+            // remove spaces between = and hex char, this might indicate invalidly applied line splitting
+            str = str.replace(/=\s+([0-9a-fA-F])/, '=$1');
+        }
+
+        // convert all underscores to spaces
+        str = str.replace(/_/g, ' ').replace(/ $/, '=20');
 
         if (encoding === 'B') {
             return libcharset.decode(libbase64.decode(str), fromCharset);
@@ -212,12 +220,27 @@ var libmime = module.exports = {
 
         maxLength = maxLength || 0;
 
-        var decodedValue = libcharset.decode(libcharset.convert((data || ''), fromCharset)),
-            encodedValue;
+        var decodedValue = libcharset.decode(libcharset.convert((data || ''), fromCharset));
+        var encodedValue;
 
-        encodedValue = decodedValue.replace(/([^\s\u0080-\uFFFF]*[\u0080-\uFFFF]+[^\s\u0080-\uFFFF]*(?:\s+[^\s\u0080-\uFFFF]*[\u0080-\uFFFF]+[^\s\u0080-\uFFFF]*\s*)?)+(?=\s|$)/g, function (match) {
-            return match.length ? libmime.encodeWord(match, mimeWordEncoding || 'Q', maxLength) : '';
-        });
+        var firstMatch = decodedValue.match(/(?:^|\s)([^\s]*[\u0080-\uFFFF])/);
+        if (!firstMatch) {
+            return decodedValue;
+        }
+        var lastMatch = decodedValue.match(/([\u0080-\uFFFF][^\s]*)[^\u0080-\uFFFF]*$/);
+        if (!lastMatch) {
+            // should not happen
+            return decodedValue;
+        }
+        var startIndex = firstMatch.index + (firstMatch[0].match(/[^\s]/) || {
+            index: 0
+        }).index;
+        var endIndex = lastMatch.index + (lastMatch[1] || '').length;
+
+        encodedValue =
+            (startIndex ? decodedValue.substr(0, startIndex) : '') +
+            libmime.encodeWord(decodedValue.substring(startIndex, endIndex), mimeWordEncoding || 'Q', maxLength) +
+            (endIndex < decodedValue.length ? decodedValue.substr(endIndex) : '');
 
         return encodedValue;
     },
@@ -234,7 +257,18 @@ var libmime = module.exports = {
         // find base64 words that can be joined
         replace(/(=\?([^?]+)\?[Bb]\?[^?]+[^^=]\?=)\s*(?==\?([^?]+)\?[Bb]\?[^?]+\?=)/g,
             function (match, left, chLeft, chRight) {
-                // only mark to b64 chunks to be joined if charsets match
+                // only mark b64 chunks to be joined if charsets match
+                if (libcharset.normalizeCharset(chLeft || '').toLowerCase().trim() === libcharset.normalizeCharset(chRight || '').toLowerCase().trim()) {
+                    // set a joiner marker
+                    return left + '__\x00JOIN\x00__';
+                }
+                return match;
+            }).
+
+        // find QP words that can be joined
+        replace(/(=\?([^?]+)\?[Qq]\?[^?]+\?=)\s*(?==\?([^?]+)\?[Qq]\?[^?]+\?=)/g,
+            function (match, left, chLeft, chRight) {
+                // only mark QP chunks to be joined if charsets match
                 if (libcharset.normalizeCharset(chLeft || '').toLowerCase().trim() === libcharset.normalizeCharset(chRight || '').toLowerCase().trim()) {
                     // set a joiner marker
                     return left + '__\x00JOIN\x00__';
@@ -243,7 +277,7 @@ var libmime = module.exports = {
             }).
 
         // join base64 encoded words
-        replace(/(\?=)?__\x00JOIN\x00__(=\?([^?]+)\?[Bb]\?)?/g, '').
+        replace(/(\?=)?__\x00JOIN\x00__(=\?([^?]+)\?[QqBb]\?)?/g, '').
 
         // remove spaces between mime encoded words
         replace(/(=\?[^?]+\?[QqBb]\?[^?]+\?=)\s+(?==\?[^?]+\?[QqBb]\?[^?]+\?=)/g, '$1').
@@ -308,7 +342,8 @@ var libmime = module.exports = {
 
     /**
      * Joins parsed header value together as 'value; param1=value1; param2=value2'
-     *
+     * PS: We are following RFC 822 for the list of special characters that we need to keep in quotes.
+     *      Refer: https://www.w3.org/Protocols/rfc1341/4_Content-Type.html
      * @param {Object} structured Parsed header value
      * @return {String} joined header value
      */
@@ -320,13 +355,13 @@ var libmime = module.exports = {
             var value = structured.params[param];
             if (!libmime.isPlainText(value) || value.length >= 75) {
                 libmime.buildHeaderParam(param, value, 50).forEach(function (encodedParam) {
-                    if (!/[\s"\\;\/=]|^[\-']|'$/.test(encodedParam.value) || encodedParam.key.substr(-1) === '*') {
+                    if (!/[\s"\\;:\/=\(\),<>@\[\]\?]|^[\-']|'$/.test(encodedParam.value) || encodedParam.key.substr(-1) === '*') {
                         paramsArray.push(encodedParam.key + '=' + encodedParam.value);
                     } else {
                         paramsArray.push(encodedParam.key + '=' + JSON.stringify(encodedParam.value));
                     }
                 });
-            } else if (/[\s'"\\;\/=]|^\-/.test(value)) {
+            } else if (/[\s'"\\;:\/=\(\),<>@\[\]\?]|^\-/.test(value)) {
                 paramsArray.push(param + '=' + JSON.stringify(value));
             } else {
                 paramsArray.push(param + '=' + value);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "libmime",
   "description": "Encode and decode quoted printable and base64 strings",
-  "version": "2.1.0",
+  "version": "3.0.0",
   "main": "lib/libmime",
   "homepage": "https://github.com/andris9/libmime",
   "repository": {
@@ -19,7 +19,7 @@
     "test": "grunt mochaTest"
   },
   "dependencies": {
-    "iconv-lite": "0.4.13",
+    "iconv-lite": "0.4.15",
     "libbase64": "0.1.0",
     "libqp": "1.1.0"
   },
@@ -28,7 +28,7 @@
     "grunt": "^1.0.1",
     "grunt-cli": "^1.2.0",
     "grunt-eslint": "^19.0.0",
-    "grunt-mocha-test": "^0.12.7",
-    "mocha": "^3.0.2"
+    "grunt-mocha-test": "^0.13.2",
+    "mocha": "^3.2.0"
   }
 }