@5minds/node-red-contrib-processcube-tools 1.0.1 → 1.0.2-develop-e3d5d9-mfm8oea8

package/email-sender/email-sender.html

@@ -0,0 +1,306 @@
+<script type="text/javascript">
+    RED.nodes.registerType('email-sender', {
+        category: 'ProcessCube Tools',
+        color: '#02AFD6',
+        defaults: {
+            name: { value: '' },
+            // Mail fields
+            sender: {
+                value: 'Stoelting Ticket-System',
+                required: true,
+                validate: RED.validators.typedInput('senderType'),
+            },
+            senderType: { value: 'str' },
+            address: { value: '', required: true, validate: RED.validators.typedInput('addressType') },
+            addressType: { value: 'str' },
+            to: { value: '', required: true, validate: RED.validators.typedInput('toType') },
+            toType: { value: 'str' },
+            cc: { value: '', validate: RED.validators.typedInput('ccType') },
+            ccType: { value: 'str' },
+            bcc: { value: '', validate: RED.validators.typedInput('bccType') },
+            bccType: { value: 'str' },
+            replyTo: { value: '', validate: RED.validators.typedInput('replyToType') },
+            replyToType: { value: 'str' },
+            subject: { value: '', required: true, validate: RED.validators.typedInput('subjectType') },
+            subjectType: { value: 'str' },
+            htmlContent: { value: '', required: true, validate: RED.validators.typedInput('htmlContentType') },
+            htmlContentType: { value: 'str' },
+            attachments: { value: '', required: false },
+            attachmentsType: { value: 'msg' },
+
+            // SMTP-Fields
+            host: { value: '', required: true, validate: RED.validators.typedInput('hostType') },
+            hostType: { value: 'str' },
+            port: { value: '', required: true, validate: RED.validators.typedInput('portType') },
+            portType: { value: 'num' },
+            user: { value: '', required: true, validate: RED.validators.typedInput('userType') },
+            userType: { value: 'str' },
+            password: { value: '', required: true, type: 'password' },
+            passwordType: { value: 'env', required: true },
+            secure: { value: '', required: true, validate: RED.validators.typedInput('secureType') },
+            secureType: { value: 'bool' },
+            rejectUnauthorized: {
+                value: '',
+                required: true,
+                validate: RED.validators.typedInput('rejectUnauthorizedType'),
+            },
+            rejectUnauthorizedType: { value: 'bool' },
+        },
+        inputs: 1,
+        outputs: 1,
+        icon: 'font-awesome/fa-paper-plane',
+        label: function () {
+            return this.name || 'E-Mail Sender';
+        },
+        oneditprepare: function () {
+            // Mail Fields
+            $('#node-input-sender').typedInput({
+                default: 'str',
+                types: ['str', 'msg', 'flow', 'global', 'env'],
+                typeField: '#node-input-senderType',
+            });
+            $('#node-input-address').typedInput({
+                default: 'str',
+                types: ['str', 'msg', 'flow', 'global', 'env'],
+                typeField: '#node-input-addressType',
+            });
+            $('#node-input-to').typedInput({
+                default: 'str',
+                types: ['str', 'msg', 'flow', 'global', 'env'],
+                typeField: '#node-input-toType',
+            });
+            $('#node-input-cc').typedInput({
+                default: 'str',
+                types: ['str', 'msg', 'flow', 'global', 'env'],
+                typeField: '#node-input-ccType',
+            });
+            $('#node-input-bcc').typedInput({
+                default: 'str',
+                types: ['str', 'msg', 'flow', 'global', 'env'],
+                typeField: '#node-input-bccType',
+            });
+            $('#node-input-replyTo').typedInput({
+                default: 'str',
+                types: ['str', 'msg', 'flow', 'global', 'env'],
+                typeField: '#node-input-replyToType',
+            });
+            $('#node-input-subject').typedInput({
+                default: 'str',
+                types: ['str', 'msg', 'flow', 'global', 'env'],
+                typeField: '#node-input-subjectType',
+            });
+            $('#node-input-htmlContent').typedInput({
+                default: 'str',
+                types: ['str', 'msg', 'flow', 'global', 'json'],
+                typeField: '#node-input-htmlContentType',
+            });
+            $('#node-input-attachments').typedInput({
+                default: 'msg',
+                types: ['msg', 'flow', 'global'],
+                typeField: '#node-input-attachmentsType',
+            });
+
+            // SMTP Fields
+            $('#node-input-host').typedInput({
+                default: 'str',
+                types: ['str', 'msg', 'flow', 'global', 'env'],
+                typeField: '#node-input-hostType',
+            });
+            $('#node-input-port').typedInput({
+                default: 'num',
+                types: ['num', 'msg', 'flow', 'global', 'env'],
+                typeField: '#node-input-portType',
+            });
+            $('#node-input-user').typedInput({
+                default: 'str',
+                types: ['str', 'msg', 'flow', 'global', 'env'],
+                typeField: '#node-input-userType',
+            });
+            $('#node-input-password').typedInput({
+                default: 'env',
+                types: ['msg', 'flow', 'global', 'env'],
+                typeField: '#node-input-passwordType',
+            });
+            $('#node-input-secure').typedInput({
+                default: 'bool',
+                types: ['bool', 'msg', 'flow', 'global', 'env'],
+                typeField: '#node-input-secureType',
+            });
+            $('#node-input-rejectUnauthorized').typedInput({
+                default: 'bool',
+                types: ['bool', 'msg', 'flow', 'global', 'env'],
+                typeField: '#node-input-rejectUnauthorizedType',
+            });
+        },
+    });
+</script>
+
+<script type="text/html" data-template-name="email-sender">
+    <div class="form-row">
+        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+        <input type="text" id="node-input-name" placeholder="Name" />
+    </div>
+
+    <h3>Mail Configuration</h3>
+    <div class="form-row">
+        <label for="node-input-sender"><i class="fa fa-user"></i> Sender</label>
+        <input type="text" id="node-input-sender" placeholder="John Doe" />
+        <input type="hidden" id="node-input-senderType" />
+    </div>
+    <div class="form-row">
+        <label for="node-input-address"><i class="fa fa-envelope"></i> Address</label>
+        <input type="text" id="node-input-address" placeholder="john.doe@example.com" />
+        <input type="hidden" id="node-input-addressType" />
+    </div>
+    <div class="form-row">
+        <label for="node-input-to"><i class="fa fa-user"></i> To</label>
+        <input type="text" id="node-input-to" placeholder="my.test@example.com" />
+        <input type="hidden" id="node-input-toType" />
+    </div>
+    <div class="form-row">
+        <label for="node-input-cc"><i class="fa fa-user-plus"></i> CC</label>
+        <input type="text" id="node-input-cc" />
+        <input type="hidden" id="node-input-ccType" />
+    </div>
+    <div class="form-row">
+        <label for="node-input-bcc"><i class="fa fa-user-secret"></i> BCC</label>
+        <input type="text" id="node-input-bcc" />
+        <input type="hidden" id="node-input-bccType" />
+    </div>
+    <div class="form-row">
+        <label for="node-input-replyTo"><i class="fa fa-mail-reply"></i> Reply To</label>
+        <input type="text" id="node-input-replyTo" />
+        <input type="hidden" id="node-input-replyToType" />
+    </div>
+    <div class="form-row">
+        <label for="node-input-subject"><i class="fa fa-info-circle"></i> Subject</label>
+        <input type="text" id="node-input-subject" />
+        <input type="hidden" id="node-input-subjectType" />
+    </div>
+    <div class="form-row">
+        <label for="node-input-htmlContent"><i class="fa fa-file-code-o"></i> HTML Content</label>
+        <input type="text" id="node-input-htmlContent" />
+        <input type="hidden" id="node-input-htmlContentType" />
+    </div>
+    <div class="form-row">
+        <label for="node-input-attachments"><i class="fa fa-paperclip"></i> Attachments</label>
+        <input type="text" id="node-input-attachments" />
+        <input type="hidden" id="node-input-attachmentsType" />
+    </div>
+
+    <h3>SMTP Configuration</h3>
+    <div class="form-row">
+        <label for="node-input-host"><i class="fa fa-server"></i> Host</label>
+        <input type="text" id="node-input-host" placeholder="smtp.gmail.com" />
+        <input type="hidden" id="node-input-hostType" />
+    </div>
+    <div class="form-row">
+        <label for="node-input-port"><i class="fa fa-plug"></i> Port</label>
+        <input type="text" id="node-input-port" placeholder="587" />
+        <input type="hidden" id="node-input-portType" />
+    </div>
+    <div class="form-row">
+        <label for="node-input-user"><i class="fa fa-user"></i> User</label>
+        <input type="text" id="node-input-user" placeholder="test.user@config.com" />
+        <input type="hidden" id="node-input-userType" />
+    </div>
+    <div class="form-row">
+        <label for="node-input-password"><i class="fa fa-lock"></i> Password</label>
+        <input type="password" id="node-input-password" />
+        <input type="hidden" id="node-input-passwordType" />
+    </div>
+    <div class="form-row">
+        <label for="node-input-secure"><i class="fa fa-shield"></i> SSL/TLS (Secure)</label>
+        <input type="text" id="node-input-secure" />
+        <input type="hidden" id="node-input-secureType" />
+    </div>
+    <div class="form-row">
+        <label for="node-input-rejectUnauthorized"><i class="fa fa-ban"></i> Reject Unauthorized</label>
+        <input type="text" id="node-input-rejectUnauthorized" />
+        <input type="hidden" id="node-input-rejectUnauthorizedType" />
+    </div>
+</script>
+
+<script type="text/html" data-help-name="email-sender">
+    <p>
+        A custom node to send emails using an SMTP server. The configuration for each field can be sourced from a fixed
+        value, or from a <code>msg</code>, <code>flow</code>, <code>global</code>, or <code>env</code> variable.
+    </p>
+
+    <h3>Configuration</h3>
+    <p>
+        Every field on the configuration panel is a <b>typed input</b>. Use the dropdown menu next to each field to
+        select the source of its value. Note that <b>Sender</b>, <b>Address</b>, <b>To</b>, <b>Subject</b>, and
+        <b>HTML Content</b> are required fields and must be configured before the node can be deployed.
+    </p>
+
+    <h4>Mail Configuration</h4>
+    <dl class="message-properties">
+        <dt>Sender <span class="property-type">string | variable</span></dt>
+        <dd>The name of the sender, as displayed to the recipient.</dd>
+
+        <dt>Address <span class="property-type">string | variable</span></dt>
+        <dd>The sender's email address.</dd>
+
+        <dt>To <span class="property-type">string | variable</span></dt>
+        <dd>The primary recipient's email address. Separate multiple addresses with a comma.</dd>
+
+        <dt>CC <span class="property-type">string | variable</span></dt>
+        <dd>Addresses to be carbon-copied on the email.</dd>
+
+        <dt>BCC <span class="property-type">string | variable</span></dt>
+        <dd>Addresses to be blind-carbon-copied on the email.</dd>
+
+        <dt>Reply To <span class="property-type">string | variable</span></dt>
+        <dd>Address that is being set as the that will be set, if the user presses the reply button.
+            Can be different than the email, that has sent the email.</dd>
+
+        <dt>Subject <span class="property-type">string | variable</span></dt>
+        <dd>The subject line of the email.</dd>
+
+        <dt>HTML Content <span class="property-type">string | variable</span></dt>
+        <dd>The HTML body of the email.</dd>
+
+        <dt>Attachments <span class="property-type">array | variable</span></dt>
+        <dd>A list of file attachments. This should be a variable containing an array of attachment objects.</dd>
+    </dl>
+
+    <h4>SMTP Configuration</h4>
+    <dl class="message-properties">
+        <dt>Host <span class="property-type">string | variable</span></dt>
+        <dd>The hostname or IP address of the SMTP server.</dd>
+
+        <dt>Port <span class="property-type">number | variable</span></dt>
+        <dd>The port number of the SMTP server.</dd>
+
+        <dt>User <span class="property-type">string | variable</span></dt>
+        <dd>The username for SMTP authentication.</dd>
+
+        <dt>Password <span class="property-type">string | variable</span></dt>
+        <dd>The password for SMTP authentication.</dd>
+
+        <dt>SSL/TLS (Secure) <span class="property-type">boolean | variable</span></dt>
+        <dd>
+            Use a secure connection. Set to <code>true</code> for SSL/TLS, <code>false</code> for a non-secure
+            connection.
+        </dd>
+
+        <dt>Reject Unauthorized <span class="property-type">boolean | variable</span></dt>
+        <dd>If <code>true</code>, the server's certificate is rejected if it's not authorized by a trusted CA.</dd>
+    </dl>
+
+    <h3>Usage</h3>
+    <p>
+        Inject a message to trigger the node and send an email.<br />
+        Credentials and other properties can be provided via message properties, flow/global context, or environment
+        variables.<br />
+        The node supports sending HTML emails and attachments.
+    </p>
+
+    <h3>Tips</h3>
+    <p>
+        <b>HTML Content Creation:</b><br />
+        To generate or format HTML content for your email, you can use a <b>template node</b> before the email-sender
+        node. This allows you to create dynamic and customized email bodies.
+    </p>
+</script>

package/email-sender/email-sender.js

@@ -0,0 +1,174 @@
+module.exports = function (RED) {
+    'use strict';
+    const nodemailer = require('nodemailer');
+
+    function EmailSenderNode(config) {
+        RED.nodes.createNode(this, config);
+        var node = this;
+
+        node.on('input', function (msg, send, done) {
+            send =
+                send ||
+                function () {
+                    node.send.apply(node, arguments);
+                };
+            done =
+                done ||
+                function (err) {
+                    if (err) node.error(err, msg);
+                };
+
+            // Retrieve and evaluate mail configuration values
+            const sender = RED.util.evaluateNodeProperty(config.sender, config.senderType, node, msg);
+            const address = RED.util.evaluateNodeProperty(config.address, config.addressType, node, msg);
+            const to = RED.util.evaluateNodeProperty(config.to, config.toType, node, msg);
+            const cc = RED.util.evaluateNodeProperty(config.cc, config.ccType, node, msg) || '';
+            const bcc = RED.util.evaluateNodeProperty(config.bcc, config.bccType, node, msg) || '';
+            const replyTo = RED.util.evaluateNodeProperty(config.replyTo, config.replyToType, node, msg) || '';
+            const subject =
+                RED.util.evaluateNodeProperty(config.subject, config.subjectType, node, msg) ||
+                msg.topic ||
+                'Message from Node-RED';
+            const htmlContent = RED.util.evaluateNodeProperty(config.htmlContent, config.htmlContentType, node, msg);
+            const attachments = safeEvaluatePropertyAttachment(config, node, msg);
+
+            // Retrieve and evaluate SMTP configuration values
+            const host = RED.util.evaluateNodeProperty(config.host, config.hostType, node, msg);
+            const port = RED.util.evaluateNodeProperty(config.port, config.portType, node, msg);
+            const user = RED.util.evaluateNodeProperty(config.user, config.userType, node, msg);
+            const password = RED.util.evaluateNodeProperty(config.password, config.passwordType, node, msg);
+            const secure = RED.util.evaluateNodeProperty(config.secure, config.secureType, node, msg);
+            const rejectUnauthorized = RED.util.evaluateNodeProperty(
+                config.rejectUnauthorized,
+                config.rejectUnauthorizedType,
+                node,
+                msg,
+            );
+
+            // Handle attachments and format them for Nodemailer
+            let processedAttachments = [];
+
+            let parsedAttachments = config.attachments;
+
+            if (config.attachmentsType === 'json' && typeof parsedAttachments === 'string') {
+                try {
+                    parsedAttachments = JSON.parse(parsedAttachments);
+                } catch (e) {
+                    node.error('Failed to parse attachments JSON: ' + e.message);
+                    return;
+                }
+            }
+
+            if (parsedAttachments) {
+                // Check if it's a single attachment or an array
+                const attachmentArray = Array.isArray(parsedAttachments) ? parsedAttachments : [parsedAttachments];
+
+                for (const attachment of attachmentArray) {
+                    try {
+                        // Assuming the attachment object has a 'filename' and 'content' property
+                        if (attachment.filename && attachment.content) {
+                            processedAttachments.push({
+                                filename: attachment.filename,
+                                content: attachment.content,
+                            });
+                        } else {
+                            node.status({ fill: 'red', shape: 'dot', text: 'attachment error' });
+                            node.error("Attachment object is missing 'filename' or 'content' property.");
+                            return;
+                        }
+                    } catch (e) {
+                        node.error('Failed to process attachment: ' + e.message);
+                    }
+                }
+            }
+
+            // Create SMTP transporter
+            const transporter = nodemailer.createTransport({
+                host: host,
+                port: port,
+                secure: secure,
+                auth: {
+                    user: user,
+                    pass: password,
+                },
+                tls: {
+                    rejectUnauthorized: rejectUnauthorized,
+                },
+            });
+
+            // Create email object
+            const mailOptions = {
+                from: {
+                    name: sender,
+                    address: address,
+                },
+                to: to,
+                cc: cc,
+                bcc: bcc,
+                replyTo: replyTo,
+                subject: subject,
+                html: Buffer.from(htmlContent, 'utf-8'),
+                attachments: processedAttachments,
+            };
+
+            // Send email
+            transporter.sendMail(mailOptions, (error, info) => {
+                if (error) {
+                    node.status({ fill: 'red', shape: 'dot', text: 'error sending' });
+                    if (
+                        error.message &&
+                        error.message.includes('SSL routines') &&
+                        error.message.includes('wrong version number')
+                    ) {
+                        // Improved error message for SSL/TLS issues
+                        done(
+                            new Error(
+                                'SSL/TLS connection failed: Wrong version number. ' +
+                                    'This usually means the wrong port or security settings are used. ' +
+                                    'For SMTP: use port 587 with secure=false (STARTTLS) or port 465 with secure=true (SSL/TLS).',
+                            ),
+                        );
+                    } else {
+                        done(error);
+                    }
+                } else {
+                    node.log('Email sent: ' + info.response);
+                    msg.payload = info;
+
+                    if (msg.payload.accepted && msg.payload.accepted.length > 0) {
+                        msg.payload = msg.input;
+                        node.status({ fill: 'green', shape: 'dot', text: 'sent' });
+                        send(msg);
+                        done();
+                    } else if (msg.payload.rejected && msg.payload.rejected.length > 0) {
+                        msg.error = { result: msg.payload.rejected };
+                        node.status({ fill: 'red', shape: 'dot', text: 'rejected' });
+                        done(new Error('Email rejected: ' + msg.payload.rejected.join(', ')));
+                    } else if (msg.payload.pending && msg.payload.pending.length > 0) {
+                        msg.error = { result: msg.payload.pending };
+                        node.status({ fill: 'yellow', shape: 'dot', text: 'pending' });
+                        done(new Error('Email pending: ' + msg.payload.pending.join(', ')));
+                    } else {
+                        node.status({ fill: 'red', shape: 'dot', text: 'unknown error' });
+                        done(new Error('Unknown error while sending email.'));
+                    }
+                }
+            });
+        });
+    }
+
+    RED.nodes.registerType('email-sender', EmailSenderNode);
+
+    function safeEvaluatePropertyAttachment(config, node, msg) {
+        if (config.attachments && config.attachments.trim() !== '') {
+            try {
+                return RED.util.evaluateNodeProperty(config.attachments, config.attachmentsType, node, msg);
+            } catch (e) {
+                node.error('Failed to evaluate attachments property: ' + e.message, msg);
+                return null;
+            }
+        }
+
+        return null;
+    }
+};

package/package.json

@@ -1,10 +1,11 @@
 {
     "name": "@5minds/node-red-contrib-processcube-tools",
-    "version": "1.0.1",
+    "version": "1.0.2-develop-e3d5d9-mfm8oea8",
     "license": "MIT",
     "description": "Node-RED tools nodes for ProcessCube",
     "scripts": {
-        "lint": "prettier --write --config ./.prettierrc.json \"**/*.{html,js}\""
+        "lint": "prettier --write --config ./.prettierrc.json \"**/*.{html,js}\"",
+        "test": "mocha test/unit/ test/integration"
     },
     "authors": [
         {
@@ -14,6 +15,10 @@
         {
             "name": "Robin Lenz",
             "email": "Robin.Lenz@5Minds.de"
+        },
+        {
+            "name": "Diana Stefan",
+            "email": "Diana.Stefan@5Minds.de"
         }
     ],
     "repository": {
@@ -31,12 +36,28 @@
     "node-red": {
         "version": ">=3.1.9",
         "nodes": {
-            "HtmlToText": "processcube-html-to-text.js"
+            "EmailReceiver": "email-receiver/email-receiver.js",
+            "EmailSender": "email-sender/email-sender.js",
+            "HtmlToText": "processcube-html-to-text/processcube-html-to-text.js"
         },
         "examples": "examples"
     },
     "dependencies": {
-        "html-to-text": "^9.0.5"
+        "html-to-text": "^9.0.5",
+        "mailparser": "^3.6.8",
+        "node-imap": "^0.9.6",
+        "nodemailer": "^7.0.6",
+        "utf7": "^1.0.2"
+    },
+    "devDependencies": {
+        "chai": "^4.3.4",
+        "mocha": "^11.7.2",
+        "node-red": "^4.0.9",
+        "node-red-node-test-helper": "^0.3.5"
+    },
+    "overrides": {
+        "semver": ">=7.5.2",
+        "axios": ">=1.12.0"
     },
     "keywords": [
         "node-red",

package/{processcube-html-to-text.html → processcube-html-to-text/processcube-html-to-text.html}

@@ -22,20 +22,20 @@
 </script>
 
 <script type="text/markdown" data-help-name="processcube-google-docs-mail-template">
-# Html 2 Text
+    # Html 2 Text
 
-## Inputs
+    ## Inputs
 
-: payload (String) : html content to convert to text
+    : payload (String) : html content to convert to text
 
-## Outputs
+    ## Outputs
 
-: payload (String) : text content
+    : payload (String) : text content
 
----
+    ---
 
-## References
+    ## References
 
-- [The ProcessCube Developer Network](https://processcube.io) – All documentation for the ProcessCube&copy; platform  
-- [Node-RED Integration in ProcessCube&copy;](https://processcube.io/docs/node-red) – Node-RED integration in ProcessCube&copy;
+    - [The ProcessCube Developer Network](https://processcube.io) – All documentation for the ProcessCube&copy; platform
+    - [Node-RED Integration in ProcessCube&copy;](https://processcube.io/docs/node-red) – Node-RED integration in ProcessCube&copy;
 </script>

package/{processcube-html-to-text.js → processcube-html-to-text/processcube-html-to-text.js}

@@ -1,5 +1,4 @@
 module.exports = function (RED) {
-
     const { compile } = require('html-to-text');
 
     function ProcesscubeHtmlToText(config) {
@@ -12,9 +11,7 @@ module.exports = function (RED) {
         };
         const compiledConvert = compile(options); // options passed here
 
-
         node.on('input', async function (msg) {
-
             msg.payload = compiledConvert(msg.payload);
 
             node.send(msg);