@hyperbytes/wappler-imap-manager 1.0.0

package/server_connect/modules/imapflag.hjson

@@ -0,0 +1,153 @@
+[{
+  type: 'imapflag-imapflag',
+  module : 'imapflag',
+  action : 'imapflag',
+  groupTitle : 'Mailer',
+groupIcon : 'fas fa-envelope comp-general',
+  title : 'IMAP flag by UID',
+  icon : 'fas fa-solid fa-flag comp-exec',
+  dataPickObject: true,
+  usedModules : {
+    node: {
+      'imap' : '^8.8.19',
+       'mailparser' : '^3.7.2'
+    }
+      },
+        dataScheme: [
+          { type: "text",name: "uid"},
+          { type: "text",name: "mailbox"},
+          { type: "text",name: "flag"},
+          { type: "text",name: "status"}
+        ],
+  properties : [
+    {
+      group: 'IMAP Inputs',
+      variables: [
+
+{ name: 'actionName', 
+        optionName: 'name', 
+        title: 'Name', 
+        type: 'text', 
+        required: true, 
+        baseName: "imap"
+        },
+        { name: 'selector', optionName: 'selector', title: 'IAMP Settings Selection', 
+  type: 'droplist', 
+  values: [
+    {title: 'Use ENV ', value: 'ENV' ,show:[],hide:['imap_msg','imap_host','imap_user','imap_password','imap_port','imap_tls']},
+    {title: 'Enable Manual Overrides', value: 'MANUAL',hide:[],show:['imap_msg','imap_host','imap_user','imap_password','imap_port','imap_tls'] },
+
+
+  ], 
+  defaultValue: 'ENV',
+	help: 'Choose your TLS settings.',
+  initValue: "ENV"
+},
+
+         {name: 'imap_msg', 
+          optionName: 'imap_msg', 
+          title: 'IMAP password', 
+          type: 'static', 
+           help: 'IMAP .ENV OVERRIDE SETTINGS'
+           },
+           
+           {name: 'imap_host', 
+          optionName: 'imap_host', 
+          title: 'IMAP Host', 
+          type: 'text', 
+          defaultValue: "", initDisplay: 'none',
+          serverDataBindings: true,
+           help: 'The IMAP Host Server'
+           },
+          {name: 'imap_user', 
+          optionName: 'imap_user', 
+          title: 'IMAP User', 
+          type: 'text', 
+          defaultValue: "", initDisplay: 'none',
+          serverDataBindings: true,
+           help: 'The IMAP user'
+           },
+
+          {name: 'imap_password', 
+          optionName: 'imap_password', 
+          title: 'IMAP password', 
+          type: 'text', 
+          defaultValue: "", initDisplay: 'none',
+          serverDataBindings: true,
+           help: 'The IMAP password'
+           },
+          {name: 'imap_port', 
+          optionName: 'imap_port', 
+          title: 'IMAP Port', 
+          type: 'text', 
+          defaultValue: "", initDisplay: 'none',
+          serverDataBindings: true,
+           help: 'The IMAP port'
+           },
+           { name: 'imap_tls', optionName: 'imap_tls', title: 'TLS Settings', 
+  type: 'droplist', 
+  values: [
+    {title: 'Use ENV if available', value: 'ENV' },
+    {title: 'True', value: 'True' },
+    {title: 'False', value: 'False' },
+
+  ], 
+  defaultValue: 'ENV',   initDisplay: 'none',
+	help: 'Choose your TLS settings.',
+  initValue: "ENV"
+},
+
+          {name: 'imap_msg2', 
+          optionName: 'imap_msg2', 
+          title: '', 
+          type: 'static', 
+           help: 'API ACTION SETTINGS'
+           },
+         { name: 'uid', 
+          optionName: 'uid', 
+          title: 'uid', 
+          type: 'text', 
+          required: true,
+          defaultValue: "0", 
+          serverDataBindings: true,
+           help: 'The uid of the email'
+           },
+          { name: 'uidvalidity', 
+          optionName: 'uidvalidity', 
+          title: 'uidValidity', 
+          type: 'text', 
+          required: true,
+          defaultValue: "0", 
+          serverDataBindings: true,
+           help: 'The uidValidity key of the email'
+           },
+          { name: 'mailbox', 
+          optionName: 'mailbox', 
+          title: 'mailbox', 
+          type: 'text', 
+          required: true,
+          defaultValue: "INBOX", 
+          serverDataBindings: true,
+           help: 'The mailbox containing the email'
+           },
+           {name: 'imapflag', 
+          optionName: 'imapflag', 
+          title: 'Flag', 
+          type: 'text', 
+          required: true,
+          defaultValue: "\\Seen", 
+          serverDataBindings: true,
+           help: 'The flag to add to email'
+           },
+          { name: 'output', 
+          optionName: 'output', 
+          title: 'Output', 
+          type: 'boolean', 
+          defaultValue: false 
+          }
+      ]
+    },
+    
+  ]
+}
+]

package/server_connect/modules/imapflag.js

@@ -0,0 +1,81 @@
+const Imap = require('imap');
+
+exports.imapflag = async function (options, name) {
+    const IMAP_HOST = this.parseOptional(options.imap_host, '*', process.env.IMAP_HOST);
+    const IMAP_PASSWORD = this.parseOptional(options.imap_password, '*', process.env.IMAP_PASSWORD);
+    const IMAP_USER = this.parseOptional(options.imap_usesr, '*', process.env.IMAP_USER);
+    const IMAP_PORT = this.parseOptional(options.imap_port, '*', process.env.IMAP_PORT);
+    const imap_tlsstring = this.parseOptional(options.imap_tls, '*', process.env.IMAP_TLS).toLowerCase();
+    const IMAP_TLS = (imap_tlsstring == 'true');
+
+    console.log(options.uid);
+    console.log(options.imapflag);
+
+    const uid = this.parseRequired(options.uid, '*', "No message UID specified");
+    const uidvalidity = this.parseRequired(options.uidvalidity, '*', "No message UIDValidity specified");
+    const mailbox = this.parseRequired(options.mailbox, '*', "No mailbox specified");
+    const flag = normalizeBackslash(this.parseRequired(options.imapflag, '*', "No Flag specified"));
+
+    function flagEmail(config, emailUID, mailboxName, expectedUidvalidity) {
+        return new Promise((resolve) => {
+            const imap = new Imap(config);
+
+            function openMailbox(cb) {
+                imap.openBox(mailboxName, false, function (err, box) {
+                    if (err) {
+                        imap.end();
+                        return resolve({ uid: null, mailbox: mailboxName, flag: null, status: 401 });
+                    }
+
+                    if (Number(box.uidvalidity) !== Number(expectedUidvalidity)) {
+                        imap.end();
+                        return resolve({ uid: null, mailbox: mailboxName, flag: null, status: 401 });
+                    }
+
+                    imap.addFlags(emailUID, [flag], function (err) {
+                        if (err) {
+                            imap.end();
+                            return resolve({ uid: emailUID, mailbox: mailboxName, flag: flag, status: 401 });
+                        }
+
+                        console.log(`Email UID ${emailUID} in ${mailboxName} flagged with ${flag}.`);
+                        imap.end();
+                        resolve({ uid: emailUID, mailbox: mailboxName, flag: flag, status: 200 });
+                    });
+                });
+            }
+
+            imap.once('ready', function () {
+                openMailbox();
+            });
+
+            imap.once('error', function () {
+                resolve({ uid: null, mailbox: mailboxName, flag: null, status: 401 });
+            });
+
+            imap.once('end', function () {
+                console.log('IMAP Connection ended');
+            });
+
+            imap.connect();
+        });
+    }
+
+    // Config setup
+    const config = {
+        user: IMAP_USER,
+        password: IMAP_PASSWORD,
+        host: IMAP_HOST,
+        port: IMAP_PORT,
+        tls: IMAP_TLS
+    };
+
+    return flagEmail(config, uid, mailbox, uidvalidity);
+};
+
+function normalizeBackslash(inputString) {
+    if (inputString.startsWith("\\\\")) {
+        return inputString.replace(/^\\\\/, "\\");
+    }
+    return inputString;
+}

package/server_connect/modules/imapflag.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace modules;
+
+use \lib\core\Module;
+
+class custom extends Module
+{
+  public function imapflag($options, $name) {
+
+    $myObj->response = "This function is not yet available in PHP";
+
+    return json_encode($myObj);
+  }
+}
+
+?>

package/server_connect/modules/imapgetattachments.hjson

@@ -0,0 +1,159 @@
+[{
+  type: 'imapgetattachments-imapgetattachments',
+  module : 'imapgetattachments',
+  action : 'imapgetattachments',
+  groupTitle : 'Mailer',
+groupIcon : 'fas fa-envelope comp-general',
+  title : 'IMAP Get Attachments by UID',
+  icon : 'fas fa-solid fa-trash comp-exec',
+  dataPickObject: true,
+  usedModules : {
+    node: {
+      'imap' : '^8.8.19',
+       'mailparser' : '^3.7.2'
+    }
+      },
+  dataScheme:[
+        {name: 'savedFiles', type:'array', sub:[
+                  {name: '$value', type:'text'}
+        ]},
+        {name: 'message', type:'text'},
+        {name: 'url', type:'text'},
+        {name: 'path', type:'text'},
+        {name: 'status', type:'text'}
+      ],
+
+  properties : [
+    {
+      group: 'IMAP Inputs',
+      variables: [
+
+
+{ name: 'actionName', 
+        optionName: 'name', 
+        title: 'Name', 
+        type: 'text', 
+        required: true, 
+        baseName: "imap"
+        },
+        { name: 'selector', optionName: 'selector', title: 'IAMP Settings Selection', 
+  type: 'droplist', 
+  values: [
+    {title: 'Use ENV ', value: 'ENV' ,show:[],hide:['imap_msg','imap_host','imap_user','imap_password','imap_port','imap_tls']},
+    {title: 'Enable Manual Overrides', value: 'MANUAL',hide:[],show:['imap_msg','imap_host','imap_user','imap_password','imap_port','imap_tls'] },
+
+
+  ], 
+  defaultValue: 'ENV',
+	help: 'Choose your TLS settings.',
+  initValue: "ENV"
+},
+
+         {name: 'imap_msg', 
+          optionName: 'imap_msg', 
+          title: 'IMAP password', 
+          type: 'static', 
+           help: 'IMAP .ENV OVERRIDE SETTINGS'
+           },
+           
+           {name: 'imap_host', 
+          optionName: 'imap_host', 
+          title: 'IMAP Host', 
+          type: 'text', 
+          defaultValue: "", initDisplay: 'none',
+          serverDataBindings: true,
+           help: 'The IMAP Host Server'
+           },
+          {name: 'imap_user', 
+          optionName: 'imap_user', 
+          title: 'IMAP User', 
+          type: 'text', 
+          defaultValue: "", initDisplay: 'none',
+          serverDataBindings: true,
+           help: 'The IMAP user'
+           },
+
+          {name: 'imap_password', 
+          optionName: 'imap_password', 
+          title: 'IMAP password', 
+          type: 'text', 
+          defaultValue: "", initDisplay: 'none',
+          serverDataBindings: true,
+           help: 'The IMAP password'
+           },
+          {name: 'imap_port', 
+          optionName: 'imap_port', 
+          title: 'IMAP Port', 
+          type: 'text', 
+          defaultValue: "", initDisplay: 'none',
+          serverDataBindings: true,
+           help: 'The IMAP port'
+           },
+           { name: 'imap_tls', optionName: 'imap_tls', title: 'TLS Settings', 
+  type: 'droplist', 
+  values: [
+    {title: 'Use ENV if available', value: 'ENV' },
+    {title: 'True', value: 'True' },
+    {title: 'False', value: 'False' },
+
+  ], 
+  defaultValue: 'ENV',   initDisplay: 'none',
+	help: 'Choose your TLS settings.',
+  initValue: "ENV"
+},
+
+          {name: 'imap_msg2', 
+          optionName: 'imap_msg2', 
+          title: '', 
+          type: 'static', 
+           help: 'API ACTION SETTINGS'
+           },
+         { name: 'uid', 
+          optionName: 'uid', 
+          title: 'uid', 
+          type: 'text', 
+          required: true,
+          defaultValue: "", 
+          serverDataBindings: true,
+           help: 'The uid of the email'
+           },
+                     { name: 'uidvalidity', 
+          optionName: 'uidvalidity', 
+          title: 'uidValidity', 
+          type: 'text', 
+          required: true,
+          defaultValue: "", 
+          serverDataBindings: true,
+           help: 'The uidValidity key of the email'
+           },
+          { name: 'mailbox', 
+          optionName: 'mailbox', 
+          title: 'mailbox', 
+          type: 'text', 
+          required: true,
+          defaultValue: "", 
+          serverDataBindings: true,
+           help: 'The mailbox containing the email'
+           },
+           { name: 'path', 
+          optionName: 'path', 
+          title: 'Path', 
+          type: 'folder', 
+          required: true,
+          serverDataBindings: true,
+           help: 'The folder to save to'
+           },
+    
+          { name: 'output', 
+          optionName: 'output', 
+          title: 'Output', 
+          type: 'boolean', 
+          defaultValue: false 
+          }
+
+      ]
+    },
+    
+  ]
+}
+]

package/server_connect/modules/imapgetattachments.js

@@ -0,0 +1,94 @@
+const Imap = require('imap');
+const fs = require('fs');
+const { simpleParser } = require('mailparser');
+const path = require('path');
+const { toSystemPath } = require("../../../lib/core/path");
+
+exports.imapgetattachments = async function (options, name) {
+    const IMAP_USER = process.env.IMAP_USER;
+    const IMAP_PASSWORD = process.env.IMAP_PASSWORD;
+    const IMAP_HOST = process.env.IMAP_HOST;
+    const IMAP_PORT = process.env.IMAP_PORT;
+
+    const uid = this.parseRequired(options.uid, '*', 'No UID Specified');
+    const uidvalidity = this.parseRequired(options.uidvalidity, '*', "No message UIDValidity specified");
+    const mailbox = this.parseRequired(options.mailbox, '*', "No mailbox specified");
+    let sentPath = this.parseRequired(options.path, '*', 'No path Specified');
+    const returnPath = sentPath.split('/').slice(2).join('/');
+    savePath = toSystemPath(sentPath);
+
+    // Ensure the directory exists or create it
+    if (!fs.existsSync(savePath)) {
+        fs.mkdirSync(savePath, { recursive: true });
+    }
+
+    return new Promise((resolve) => {
+        const imap = new Imap({
+            user: IMAP_USER,
+            password: IMAP_PASSWORD,
+            host: IMAP_HOST,
+            port: IMAP_PORT,
+            tls: true
+        });
+
+        imap.once('ready', () => {
+            imap.openBox(mailbox, false, (err, box) => {
+                if (err) {
+                    imap.end();
+                    return resolve({ savedFiles: [], message: "Mailbox Auth Failure", url: '', path: '', status: 401 });
+                }
+
+                // Validate UIDVALIDITY before proceeding
+                if (Number(box.uidvalidity) !== Number(uidvalidity)) {
+                    imap.end();
+                    return resolve({ savedFiles: [], message: "UID Validity mismatch", url: '', path: '', status: 401 });
+                }
+
+                const fetch = imap.fetch(uid, { bodies: '', struct: true });
+
+                fetch.on('message', (msg) => {
+                    let buffer = '';
+
+                    msg.on('body', (stream) => {
+                        stream.on('data', (chunk) => buffer += chunk.toString('utf8'));
+                        stream.on('end', async () => {
+                            try {
+                                const parsed = await simpleParser(buffer);
+
+                                if (!parsed.attachments || parsed.attachments.length === 0) {
+                                    imap.end();
+                                    return resolve({ savedFiles: [], message: "No Attachments Found", url: returnPath, path: sentPath, status: 200 });
+                                }
+
+                                const savedFiles = [];
+                                parsed.attachments.forEach(att => {
+                                    const filePath = path.join(savePath, att.filename);
+                                    fs.writeFileSync(filePath, att.content);
+                                    savedFiles.push(att.filename);
+                                    console.log(`Saved attachment: ${filePath}`);
+                                });
+
+                                imap.end();
+                                resolve({ savedFiles, message: savedFiles.join(", "), url: returnPath, path: sentPath, status: 200 });
+
+                            } catch (parseError) {
+                                imap.end();
+                                resolve({ savedFiles: [], message: "Parse Failure", url: '', path: '', status: 400 });
+                            }
+                        });
+                    });
+                });
+
+                fetch.once('end', () => {
+                    imap.end();
+                });
+            });
+        });
+
+        imap.once('error', () => {
+            resolve({ savedFiles: [], message: "Error Opening Mailbox", url: "", path: "", status: 401 });
+        });
+
+        imap.connect();
+    });
+};

package/server_connect/modules/imapgetattachments.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace modules;
+
+use \lib\core\Module;
+
+class custom extends Module
+{
+  public function imapgetattachments($options, $name) {
+
+    $myObj->response = "This function is not yet available in PHP";
+
+    return json_encode($myObj);
+  }
+}
+
+?>

package/server_connect/modules/imapgetrawheaders.hjson

@@ -0,0 +1,120 @@
+[{
+  type: 'imapgetrawheaders-imapgetrawheaders',
+  module : 'imapgetrawheaders',
+  action : 'imapgetrawheaders',
+  groupTitle : 'Mailer',
+groupIcon : 'fas fa-envelope comp-general',
+  title : 'IMAP Get Raw Headers',
+  icon : 'fas fa-solid fa-list comp-general',
+  dataPickObject: true,
+  usedModules : {
+    node: {
+      'imap' : '^8.8.19',
+       'mailparser' : '^3.7.2'
+    }
+      },
+
+  properties : [
+    {
+      group: 'IMAP Inputs',
+      variables: [
+
+
+{ name: 'actionName', 
+        optionName: 'name', 
+        title: 'Name', 
+        type: 'text', 
+        required: true, 
+        baseName: "imap"
+        },
+        { name: 'selector', optionName: 'selector', title: 'IAMP Settings Selection', 
+  type: 'droplist', 
+  values: [
+    {title: 'Use ENV ', value: 'ENV' ,show:[],hide:['imap_msg','imap_host','imap_user','imap_password','imap_port','imap_tls']},
+    {title: 'Enable Manula Overrides', value: 'MANUAL',hide:[],show:['imap_msg','imap_host','imap_user','imap_password','imap_port','imap_tls'] },
+
+
+  ], 
+  defaultValue: 'ENV',
+	help: 'Choose your TLS settings.',
+  initValue: "ENV"
+},
+
+         {name: 'imap_msg', 
+          optionName: 'imap_msg', 
+          title: 'IMAP password', 
+          type: 'static', 
+           help: 'IMAP .ENV OVERRIDE SETTINGS'
+           },
+           
+           {name: 'imap_host', 
+          optionName: 'imap_host', 
+          title: 'IMAP Host', 
+          type: 'text', 
+          defaultValue: "", initDisplay: 'none',
+          serverDataBindings: true,
+           help: 'The IMAP Host Server'
+           },
+          {name: 'imap_user', 
+          optionName: 'imap_user', 
+          title: 'IMAP User', 
+          type: 'text', 
+          defaultValue: "", initDisplay: 'none',
+          serverDataBindings: true,
+           help: 'The IMAP user'
+           },
+
+          {name: 'imap_password', 
+          optionName: 'imap_password', 
+          title: 'IMAP password', 
+          type: 'text', 
+          defaultValue: "", initDisplay: 'none',
+          serverDataBindings: true,
+           help: 'The IMAP password'
+           },
+          {name: 'imap_port', 
+          optionName: 'imap_port', 
+          title: 'IMAP Port', 
+          type: 'text', 
+          defaultValue: "", initDisplay: 'none',
+          serverDataBindings: true,
+           help: 'The IMAP port'
+           },
+           { name: 'imap_tls', optionName: 'imap_tls', title: 'TLS Settings', 
+  type: 'droplist', 
+  values: [
+    {title: 'Use ENV if available', value: 'ENV' },
+    {title: 'True', value: 'True' },
+    {title: 'False', value: 'False' },
+
+  ], 
+  defaultValue: 'ENV',   initDisplay: 'none',
+	help: 'Choose your TLS settings.',
+  initValue: "ENV"
+},
+
+          {name: 'imap_msg2', 
+          optionName: 'imap_msg2', 
+          title: '', 
+          type: 'static', 
+           help: 'API ACTION SETTINGS'
+           },
+                     {name: 'mailbox', 
+          optionName: 'mailbox', 
+          title: 'IMAP Mailbox', 
+          type: 'text', 
+          defaultValue: "", 
+          serverDataBindings: true,
+           help: 'The IMAP Mailbox'
+           },
+   
+          { name: 'output', 
+          optionName: 'output', 
+          title: 'Output', 
+          type: 'boolean', 
+          defaultValue: false 
+          }
+
+      ]
+    },
+  ]}]