@postalsys/email-text-tools 1.0.0 → 1.1.0

package/examples/mime-html.js

@@ -0,0 +1,53 @@
+'use strict';
+
+const mimeHtml = require('../lib/mime-html');
+const fs = require('fs');
+
+const type = process.argv[3] || 'html';
+const file = fs.readFileSync(process.argv[2]);
+
+const HTML_TEMPLATE = `<html>
+<head>
+<meta charset="utf-8">
+<title>test email</title>
+
+<style>
+
+body {
+    background: white;
+}
+
+.body-container {
+    max-width: 840px;
+    margin: 30px auto;
+    padding: 20px;
+    background: #fafafa;
+}
+
+.email-container {
+    padding: 20px;
+    border: 1px solid #ccc;
+    background: white;
+}
+
+</style>
+
+<head>
+<body>
+
+<div class="body-container">
+
+<h1>Email message</h1>
+
+<div class="email-container">
+HTML_BODY
+</div>
+
+<p>Footer text</p>
+
+</div>
+
+</body>
+</html>`;
+
+console.log(HTML_TEMPLATE.replace(/HTML_BODY/g, mimeHtml({ [type]: file })));

package/index.js

@@ -4,5 +4,6 @@ const textToHtml = require('./lib/text-to-html');
 const htmlToText = require('./lib/html-to-text');
 const inlineHtml = require('./lib/inline-html');
 const inlineText = require('./lib/inline-text');
+const mimeHtml = require('./lib/mime-html');
 
-module.exports = { textToHtml, htmlToText, inlineHtml, inlineText };
+module.exports = { textToHtml, htmlToText, inlineHtml, inlineText, mimeHtml };

package/lib/mime-html.js

@@ -0,0 +1,100 @@
+'use strict';
+
+const createDOMPurify = require('dompurify');
+const { JSDOM } = require('jsdom');
+const juice = require('juice');
+const he = require('he');
+
+const textToHtml = require('./text-to-html');
+
+// define styles for plaintext emails
+const INLINE_STYLE_BLOCK = `<style>
+
+body, td, th, p {
+    font-family: sans-serif;
+    font-size: 12px;
+}
+
+blockquote {
+    border-left-width: 2px;
+    border-left-style: solid;
+    
+    border-left-color: darkblue;
+    color: darkblue;
+
+    margin: 1rem 0;
+    padding-left: 1rem;
+}
+
+blockquote blockquote{
+    border-left-color: royalblue;
+    color: royalblue;
+}
+
+blockquote blockquote blockquote{
+    border-left-color: dodgerblue;
+    color: dodgerblue;
+}
+
+blockquote blockquote blockquote blockquote{
+    border-left-color: darkblue;
+    color: darkblue;
+}
+
+</style>`;
+
+function mimeHtml(message) {
+    let html = message.html;
+    if (!html && message.text) {
+        html = textToHtml(message.text) || '';
+        if (html) {
+            html = INLINE_STYLE_BLOCK + html;
+        }
+    }
+
+    try {
+        //inline styles
+        //html = juice(html);
+    } catch (err) {
+        // should log?
+    }
+
+    const window = new JSDOM('').window;
+    const DOMPurify = createDOMPurify(window);
+
+    // first pass, outputs a fixed HTML page
+    html = DOMPurify.sanitize(html, { WHOLE_DOCUMENT: true, FORCE_BODY: false, FORBID_TAGS: ['title', 'link', 'meta'] });
+
+    try {
+        //inline styles
+        html = juice(html);
+    } catch (err) {
+        // not so important, so we'll ignore if style inlining fails
+        // should log?
+    }
+
+    // second pass, outputs a BODY DOM element
+    const dom = DOMPurify.sanitize(html, { RETURN_DOM: true, WHOLE_DOCUMENT: false, FORCE_BODY: true, FORBID_TAGS: ['style', 'title', 'link', 'meta'] });
+
+    // mark all links to be opened in a new window
+    for (let elm of dom.querySelectorAll('a')) {
+        elm.setAttribute('target', '_blank');
+    }
+
+    dom.style.overflow = 'auto';
+
+    // return <BODY> HTML
+
+    dom.style.removeProperty('width');
+    dom.style.removeProperty('min-width');
+    dom.style.removeProperty('max-width');
+    dom.style.removeProperty('height');
+    dom.style.removeProperty('min-height');
+    dom.style.removeProperty('max-height');
+    let bodyStyles = (dom.getAttribute('style') || '').toString().trim();
+
+    // embed into a styled container
+    return `<div style="${he.encode(bodyStyles)}">${dom.innerHTML.trim()}</div>`;
+}
+
+module.exports = mimeHtml;

package/lib/text-to-html.js

@@ -101,9 +101,10 @@ function linkifyAndHtmlEscape(text) {
             return parts
                 .map(part => {
                     switch (part.type) {
-                        case 'text':
+                        case 'text': {
                             // normal text, escape HTML
                             return he.encode(part.content, { useNamedReferences: true });
+                        }
                         case 'link':
                             // URL with html escaped text content and URL
                             return `<a href="${he.encode(part.url, { useNamedReferences: true })}">${he.encode(part.text, {
@@ -132,9 +133,18 @@ function textLinesToHtml(lines) {
                 textparts.push('</p><p>');
             }
         } else if (i < lines.length - 1 && lines[i + 1].trim()) {
-            textparts.push(`${linkifyAndHtmlEscape(line)}<br />`);
+            let escaped = linkifyAndHtmlEscape(line);
+            if (/^[ \t]*[-_]+[ \t]*$/.test(escaped)) {
+                textparts.push(`<hr />`);
+            } else {
+                textparts.push(`${escaped}<br />`);
+            }
         } else {
-            textparts.push(`${linkifyAndHtmlEscape(line)}`);
+            let escaped = linkifyAndHtmlEscape(line);
+            if (/^[ \t]*[-_]+[ \t]*$/.test(escaped)) {
+                escaped = `<hr />`;
+            }
+            textparts.push(escaped);
         }
     }
 
@@ -142,6 +152,7 @@ function textLinesToHtml(lines) {
 }
 
 function textToHtml(text) {
+    text = (text || '').toString();
     let tree = generateQuotedTree(text);
 
     let blockQuoteCounter = 0;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@postalsys/email-text-tools",
-    "version": "1.0.0",
+    "version": "1.1.0",
     "description": "Email text tools",
     "main": "index.js",
     "scripts": {
@@ -22,13 +22,16 @@
         "eslint-config-prettier": "8.5.0"
     },
     "dependencies": {
+        "dompurify": "3.0.1",
         "handlebars": "4.7.7",
         "he": "1.2.0",
-        "html-to-text": "8.2.0",
-        "js-beautify": "1.14.4",
+        "html-to-text": "8.2.1",
+        "js-beautify": "1.14.7",
+        "jsdom": "21.1.0",
+        "juice": "8.1.0",
         "linkify-it": "4.0.1",
-        "moment-timezone": "0.5.34",
-        "node-html-parser": "5.3.3",
-        "tlds": "1.231.0"
+        "moment-timezone": "0.5.39",
+        "node-html-parser": "6.1.4",
+        "tlds": "1.233.0"
     }
 }