@hyperbytes/wappler-imap-manager 1.0.0

package/server_connect/modules/imapsubscribedlist.hjson

@@ -0,0 +1,122 @@
+[{
+  type: 'imapsubscribedlist-imapsubscribedlist',
+  module : 'imapsubscribedlist',
+  action : 'imapsubscribedlist',
+  groupTitle : 'Mailer',
+ groupIcon : 'fas fa-envelope comp-general',
+  title : 'IMAP List Subscribed Mailboxes',
+  icon : 'fas fa-solid fa-list comp-exec',
+  dataPickObject: true,
+  usedModules : {
+    node: {
+      'imap' : '^8.8.19',
+       'mailparser' : '^3.7.2'
+    }
+      },
+        dataScheme: [
+          {
+                type: "array",
+                name: "mailboxes",
+                sub: [
+                  {
+                    type: "text", name: "$value"
+                  }
+                ]
+              },
+        ],
+  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: 'output', 
+          optionName: 'output', 
+          title: 'Output', 
+          type: 'boolean', 
+          defaultValue: false 
+          }
+
+      ]
+    },
+    
+  ]
+}
+]

package/server_connect/modules/imapsubscribedlist.js

@@ -0,0 +1,57 @@
+const Imap = require('imap');
+
+exports.imapsubscribedlist = async function (options) {
+    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');
+
+    return new Promise((resolve, reject) => {
+        const imap = new Imap({
+            user: IMAP_USER,
+            password: IMAP_PASSWORD,
+            host: IMAP_HOST,
+            port: IMAP_PORT,
+            tls: IMAP_TLS
+        });
+
+        imap.once('ready', () => {
+            imap.getSubscribedBoxes((err, boxes) => {
+                if (err) {
+                    imap.end();
+                    return reject({ code: 400, error: `Error retrieving mailboxes: ${err.message}` });
+                }
+
+                const mailboxList = [];
+
+                // Function to recursively extract subfolders
+                function extractMailboxes(boxes, prefix = '') {
+                    for (let name in boxes) {
+                        const fullName = prefix ? `${prefix}/${name}` : name;
+                        mailboxList.push(fullName);
+                        if (boxes[name].children) {
+                            extractMailboxes(boxes[name].children, fullName);
+                        }
+                    }
+                }
+
+                extractMailboxes(boxes);
+
+                imap.end();
+                resolve({ mailboxes: mailboxList });
+            });
+        });
+
+        imap.once('error', (err) => {
+            reject({ code: 401, error: `Connection error: ${err.message}` });
+        });
+
+        imap.once('end', () => {
+            console.log('IMAP connection closed.');
+        });
+
+        imap.connect();
+    });
+};

package/server_connect/modules/imapsubscribedlist.php

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

package/server_connect/modules/imaptrashperms.hjson

@@ -0,0 +1,115 @@
+[{
+  type: 'imaptrashperms-imaptrashperms',
+  module : 'imaptrashperms',
+  action : 'imaptrashperms',
+  groupTitle : 'Mailer',
+ groupIcon : 'fas fa-envelope comp-general',
+  title : 'IMAP Trash folder permissions',
+  icon : 'fas fa-solid fa-check comp-exec',
+  dataPickObject: true,
+  usedModules : {
+    node: {
+      'imap' : '^8.8.19',
+       'mailparser' : '^3.7.2'
+    }
+      },
+        dataScheme: [
+          { type: "number",name: "count"}
+        ],
+  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: 'output', 
+          optionName: 'output', 
+          title: 'Output', 
+          type: 'boolean', 
+          defaultValue: false 
+          }
+
+      ]
+    },
+    
+  ]
+}
+]

package/server_connect/modules/imaptrashperms.js

@@ -0,0 +1,51 @@
+const Imap = require('imap');
+require('dotenv').config(); // Load environment variables
+
+exports.imaptrashperms = async function () {
+    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');
+    return new Promise((resolve, reject) => {
+        const imap = new Imap({
+            user: IMAP_USER,
+            password: IMAP_PASSWORD,
+            host: IMAP_HOST,
+            port: IMAP_PORT,
+            tls: IMAP_TLS
+        });
+
+        imap.once('ready', () => {
+            const trashFolder = process.env.IMAP_TRASH_NAME || 'Trash'; // Default folder
+
+            imap.getBoxes((err, boxes) => {
+                if (err) return reject({ code: 400, error: err });
+                if (!boxes[trashFolder]) return reject({ code: 404, error: 'Trash folder not found' });
+
+                imap.openBox(trashFolder, true, (err, box) => { // Try opening in read-write mode
+                    if (err) return reject({ code: 400, error: err });
+
+                    resolve({
+                        name: trashFolder,
+                        readOnly: !box.writeable, // Corrected method
+                        messagesTotal: box.messages.total,
+                        unseenCount: box.messages.unseen,
+                        recentCount: box.messages.recent,
+                        uidValidity: box.uidvalidity,
+                        uidNext: box.uidnext
+                    });
+
+                    imap.end();
+                });
+            });
+        });
+
+        imap.once('error', err => reject({ code: 401, error: err }));
+
+        imap.once('end', () => console.log('IMAP connection closed.'));
+
+        imap.connect();
+    });
+};

package/server_connect/modules/imaptrashperms.php

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

package/server_connect/modules/imapunsubscribedlist.hjson

@@ -0,0 +1,122 @@
+[{
+  type: 'imapunsubscribedlist-imapunsubscribedlist',
+  module : 'imapunsubscribedlist',
+  action : 'imapunsubscribedlist',
+  groupTitle : 'Mailer',
+ groupIcon : 'fas fa-envelope comp-general',
+  title : 'IMAP List UnSubscribed Mailboxes',
+  icon : 'fas fa-solid fa-list comp-exec',
+  dataPickObject: true,
+  usedModules : {
+    node: {
+      'imap' : '^8.8.19',
+       'mailparser' : '^3.7.2'
+    }
+      },
+        dataScheme: [
+          {
+                type: "array",
+                name: "mailboxes",
+                sub: [
+                  {
+                    type: "text", name: "$value"
+                  }
+                ]
+              },
+        ],
+  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: 'output', 
+          optionName: 'output', 
+          title: 'Output', 
+          type: 'boolean', 
+          defaultValue: false 
+          }
+
+      ]
+    },
+    
+  ]
+}
+]

package/server_connect/modules/imapunsubscribedlist.js

@@ -0,0 +1,80 @@
+const Imap = require('imap');
+
+exports.imapunsubscribedlist = async function (options) {
+    const IMAP_HOST = options.imap_host || process.env.IMAP_HOST;
+    const IMAP_PASSWORD = options.imap_password || process.env.IMAP_PASSWORD;
+    const IMAP_USER = options.imap_user || process.env.IMAP_USER;
+    const IMAP_PORT = options.imap_port || process.env.IMAP_PORT;
+    const IMAP_TLS = (options.imap_tls || process.env.IMAP_TLS || 'true').toLowerCase() === 'true';
+
+    return new Promise((resolve, reject) => {
+        const imap = new Imap({
+            user: IMAP_USER,
+            password: IMAP_PASSWORD,
+            host: IMAP_HOST,
+            port: IMAP_PORT,
+            tls: IMAP_TLS
+        });
+
+        imap.once('ready', () => {
+            let allMailboxes = [];
+            let subscribedMailboxes = [];
+
+            // Fetch all mailboxes
+            imap.getBoxes((err, boxes) => {
+                if (err) {
+                    imap.end();
+                    return reject({ code: 400, error: `Error retrieving all mailboxes: ${err.message}` });
+                }
+
+                function extractMailboxes(boxes, prefix = '') {
+                    for (let name in boxes) {
+                        const fullName = prefix ? `${prefix}/${name}` : name;
+                        allMailboxes.push(fullName);
+                        if (boxes[name].children) {
+                            extractMailboxes(boxes[name].children, fullName);
+                        }
+                    }
+                }
+
+                extractMailboxes(boxes);
+
+                // Fetch subscribed mailboxes
+                imap.getSubscribedBoxes((err, boxes) => {
+                    if (err) {
+                        imap.end();
+                        return reject({ code: 400, error: `Error retrieving subscribed mailboxes: ${err.message}` });
+                    }
+
+                    function extractSubscribedMailboxes(boxes, prefix = '') {
+                        for (let name in boxes) {
+                            const fullName = prefix ? `${prefix}/${name}` : name;
+                            subscribedMailboxes.push(fullName);
+                            if (boxes[name].children) {
+                                extractSubscribedMailboxes(boxes[name].children, fullName);
+                            }
+                        }
+                    }
+
+                    extractSubscribedMailboxes(boxes);
+
+                    // Filter out subscribed mailboxes
+                    const nonSubscribedMailboxes = allMailboxes.filter(box => !subscribedMailboxes.includes(box));
+
+                    imap.end();
+                    resolve({ mailboxes: nonSubscribedMailboxes });
+                });
+            });
+        });
+
+        imap.once('error', (err) => {
+            reject({ code: 401, error: `Connection error: ${err.message}` });
+        });
+
+        imap.once('end', () => {
+            console.log('IMAP connection closed.');
+        });
+
+        imap.connect();
+    });
+};;

package/server_connect/modules/imapunsubscribedlist.php

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