@hyperbytes/wappler-imap-manager 1.0.0

package/server_connect/modules/imapdeletefolder.hjson

@@ -0,0 +1,125 @@
+[{
+  type: 'imapdeletefolder-imapdeletefolder',
+  module : 'imapdeletefolder',
+  action : 'imapdeletefolder',
+  groupTitle : 'Mailer',
+ groupIcon : 'fas fa-envelope comp-general',
+  title : 'IMAP Delete Folder',
+  icon : 'fas fa-solid fa-folder-minus comp-exec',
+  dataPickObject: true,
+  usedModules : {
+    node: {
+      'imap' : '^8.8.19',
+       'mailparser' : '^3.7.2'
+    }
+      },
+        dataScheme: [
+          { type: "number",name: "status"},
+           { type: "text",name: "message"}
+        ]
+  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: 'imapfolder', 
+        optionName: 'imapfolder', 
+        title: 'IMAP Folder', 
+        type: 'text', 
+        required: true, 
+        serverDataBindings: true,
+        defaultValue: 'INBOX',
+         help: 'The folder to delete'
+
+        },
+          { name: 'output', 
+          optionName: 'output', 
+          title: 'Output', 
+          type: 'boolean', 
+          defaultValue: false 
+          }
+
+      ]
+    },
+    
+  ]
+}
+]

package/server_connect/modules/imapdeletefolder.js

@@ -0,0 +1,65 @@
+const Imap = require('imap');
+
+
+
+exports.imapdeletefolder = async function (options) {
+    // Load IMAP credentials from environment variables
+    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');
+    let folder = this.parseRequired(options.imapfolder, '*', 'Folder to delete not specified');
+    const separator = process.env.IMAP_SUB_SEPARATOR || '/';
+    folder = folder.startsWith("INBOX/") ? folder.substring(6) : folder;
+    console.log('folder is: ' + folder)
+    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.connect();
+
+        imap.once('ready', () => {
+            const folderPath = 'INBOX' + separator + folder;
+            imap.delBox(folderPath, (err) => {
+                if (err) {
+                    reject({ status: 400, message: `Error: ${err.message}` });
+                } else {
+                    resolve({ status: 200, message: `Folder "${folderPath}" deleted successfully.` });
+                }
+                imap.end();
+            });
+        });
+
+        imap.once('error', (err) => {
+            reject({ status: 401, message: `Connection error: ${err.message}` });
+        });
+
+        imap.once('end', () => {
+            console.log('IMAP connection closed.');
+        });
+    });
+};
+
+// Example usage:
+(async () => {
+    try {
+        const createResult = await exports.imapcount({
+            imapfolder: folder
+        });
+        console.log(createResult);
+
+        const deleteResult = await exports.deleteFolder({
+            imapfolder: folder
+        });
+        console.log(deleteResult);
+    } catch (err) {
+        console.error(err);
+    }
+});

package/server_connect/modules/imapdeletefolder.php

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

package/server_connect/modules/imapdirlist.hjson

@@ -0,0 +1,122 @@
+[{
+  type: 'imapdirlist-imapdirlist',
+  module : 'imapdirlist',
+  action : 'imapdirlist',
+  groupTitle : 'Mailer',
+ groupIcon : 'fas fa-envelope comp-general',
+  title : 'IMAP list 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/imapdirlist.js

@@ -0,0 +1,57 @@
+const Imap = require('imap');
+
+exports.imapdirlist = 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.getBoxes((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/imapdirlist.php

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

package/server_connect/modules/imapexpunge.hjson

@@ -0,0 +1,115 @@
+[{
+  type: 'imapexpunge-imapexpunge',
+  module : 'imapexpunge',
+  action : 'imapexpunge',
+  groupTitle : 'Mailer',
+groupIcon : 'fas fa-envelope comp-general',
+  title : 'IMAP Empty Trash',
+  icon : 'fas fa-solid fa-eraser comp-exec',
+  dataPickObject: true,
+  usedModules : {
+    node: {
+      'imap' : '^8.8.19',
+       'mailparser' : '^3.7.2'
+    }
+      },
+
+  properties : [
+    {
+      group: 'IMAP Expunge',
+      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/imapexpunge.js

@@ -0,0 +1,63 @@
+const Imap = require('imap');
+
+exports.imapexpunge = 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');
+
+    function expungeEmail(config) {
+        return new Promise((resolve) => {
+            const imap = new Imap(config);
+
+            function openInbox(cb) {
+                imap.openBox('INBOX', false, cb);
+            }
+
+            imap.once('ready', function () {
+                openInbox(function (err) {
+                    if (err) {
+                        imap.end();
+                        return resolve({ mailbox: 'INBOX', status: 401 });
+                    }
+
+                    imap.expunge(function (err) {
+                        if (err) {
+                            imap.end();
+                            return resolve({ mailbox: 'INBOX', status: 401 });
+                        }
+
+                        console.log(`Expunged emails from server.`);
+                        imap.end();
+                        resolve({ status: 200 });
+                    });
+                });
+            });
+
+            imap.once('error', function () {
+                resolve({ 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 expungeEmail(config);
+};
+
+

package/server_connect/modules/imapexpunge.php

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