@hyperbytes/wappler-imap-manager 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,4 @@
+all details are at:
+
+https://community.wappler.io/t/custom-modules-imap-email-magement-node-build-you-own-webmail/62897
+

package/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Brian English
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.T

package/README.md

@@ -0,0 +1,10 @@
+all support can be found here.
+
+https://community.wappler.io/t/custom-modules-imap-email-magement-node-build-you-own-webmail/62897
+
+This package currently only supports Node.js however PHP version is currently being evaluated
+
+Next release will add management of drafts and nested folders
+
+
+

package/package.json

@@ -0,0 +1,22 @@
+{
+    "name": "@hyperbytes/wappler-imap-manager",
+    "version": "1.0.0",
+    "description": "IMAP eMail Management for Wappler",
+    "license": "MIT",
+    "author": {
+        "name": "Brian English - @hyperbytes"
+    },
+    "keywords": [
+        "wappler-extension",
+        "server-connect",
+        "IMAP",
+        "email"
+    ],
+    "dependencies": {
+        "imap": "^8.8.19",
+        "mailparser": "^3.7.2",
+        "imap-simple": "^5.1.0",
+        "mailtrap": "^4.1.0",
+        "mailcomposer": "^1.0.0"
+    }
+}

package/server_connect/modules/imapcount.hjson

@@ -0,0 +1,126 @@
+[{
+  type: 'imapcount-imapcount',
+  module : 'imapcount',
+  action : 'imapcount',
+  groupTitle : 'Mailer',
+ groupIcon : 'fas fa-envelope comp-general',
+  title : 'IMAP Count eMails',
+  icon : 'fas fa-solid fa-calculator comp-exec',
+  dataPickObject: true,
+  usedModules : {
+    node: {
+      'imap' : '^8.8.19',
+       'mailparser' : '^3.7.2'
+    }
+      },
+        dataScheme: [
+          { type:"text", name: "mailbox"},
+          { type: "number",name: "count"},
+          {type: "number", 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: 'mailbox', 
+          optionName: 'mailbox', 
+          title: 'Mailbox', 
+          type: 'text', 
+          required: true,
+          defaultValue: "INBOX", 
+          serverDataBindings: true,
+           help: 'The Mailbox in which to count emails'
+           },
+          { name: 'output', 
+          optionName: 'output', 
+          title: 'Output', 
+          type: 'boolean', 
+          defaultValue: false 
+          }
+
+      ]
+    },
+    
+  ]
+}
+]

package/server_connect/modules/imapcount.js

@@ -0,0 +1,53 @@
+const Imap = require('imap');
+const { inspect } = require('util');
+
+exports.imapcount = 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');
+
+    // Retrieve mailbox name from options, default to 'INBOX' if not provided
+    const mailbox = this.parseRequired(options.mailbox, '*', "No Mailbox specified");
+
+    function getEmailCount(config, mailbox) {
+        return new Promise((resolve) => {
+            const imap = new Imap(config);
+
+            imap.once('ready', function () {
+                imap.openBox(mailbox, true, function (err, box) {
+                    if (err) {
+                        imap.end();
+                        return resolve({ mailbox: mailbox, count: 0, status: 401 });
+                    }
+                    console.log(`Mailbox ${mailbox} contains ${box.messages.total} emails.`);
+                    resolve({ mailbox: mailbox, count: box.messages.total, status: 200 });
+                    imap.end();
+                });
+            });
+
+            imap.once('error', function () {
+                resolve({ mailbox: mailbox, count: 0, 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 getEmailCount(config, mailbox);
+};

package/server_connect/modules/imapcount.php

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

package/server_connect/modules/imapcreatefolder.hjson

@@ -0,0 +1,124 @@
+[{
+  type: 'imapcreatefolder-imapcreatefolder',
+  module : 'imapcreatefolder',
+  action : 'imapcreatefolder',
+  groupTitle : 'Mailer',
+ groupIcon : 'fas fa-envelope comp-general',
+  title : 'IMAP Create Folder',
+  icon : 'fas fa-solid fa-calculator 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: "", 
+          serverDataBindings: true,
+           help: 'The IMAP Host Server'
+           },
+          {name: 'imap_user', 
+          optionName: 'imap_user', 
+          title: 'IMAP User', 
+          type: 'text', 
+          defaultValue: "", 
+          serverDataBindings: true,
+           help: 'The IMAP user'
+           },
+
+          {name: 'imap_password', 
+          optionName: 'imap_password', 
+          title: 'IMAP password', 
+          type: 'text', 
+          defaultValue: "", 
+          serverDataBindings: true,
+           help: 'The IMAP password'
+           },
+          {name: 'imap_port', 
+          optionName: 'imap_port', 
+          title: 'IMAP Port', 
+          type: 'text', 
+          defaultValue: "", 
+          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',
+	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: '',
+         help: 'The folder to create'
+
+        },
+          { name: 'output', 
+          optionName: 'output', 
+          title: 'Output', 
+          type: 'boolean', 
+          defaultValue: false 
+          }
+
+      ]
+    },
+    
+  ]
+}
+]

package/server_connect/modules/imapcreatefolder.js

@@ -0,0 +1,46 @@
+const Imap = require('imap');
+
+
+
+exports.imapcreatefolder = async function (options) {
+    // Load IMAP credentials from environment variables
+    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 IMAP_TLS = true
+    const imapfolder = this.parseRequired(options.imapfolder, '*', "No folder specified'")
+    const separator = process.env.IMAP_SUB_SEPARATOR || '/';
+    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 + imapfolder;
+            imap.addBox(folderPath, (err) => {
+                if (err) {
+                    reject({ status: 400, message: `Error: ${err.message}` });
+                } else {
+                    resolve({ status: 200, message: `Folder "${folderPath}" created successfully.` });
+                }
+                imap.end();
+            });
+        });
+
+        imap.once('error', (err) => {
+            reject({ status: 401, message: `Connection error: ${err.message}` });
+        });
+
+        imap.once('end', () => {
+            console.log('IMAP connection closed.');
+        });
+    });
+};

package/server_connect/modules/imapcreatefolder.php

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

package/server_connect/modules/imapdelete.hjson

@@ -0,0 +1,148 @@
+[{
+  type: 'imapdelete-imapdelete',
+  module : 'imapdelete',
+  action : 'imapdelete',
+  groupTitle : 'Mailer',
+groupIcon : 'fas fa-envelope comp-general',
+  title : 'IMAP Delete message by UID',
+  icon : 'fas fa-solid fa-trash comp-exec',
+  dataPickObject: true,
+  usedModules : {
+    node: {
+      'imap' : '^8.8.19',
+       'mailparser' : '^3.7.2'
+    }
+      },
+        dataScheme: [
+          { type:"number", name: "uid"},
+          { type:"text", name: "mailbox"},
+          { type: "number",name: "count"},
+          {type: "text", name: "destination"},
+          { type: "number",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: 'output', 
+          optionName: 'output', 
+          title: 'Output', 
+          type: 'boolean', 
+          defaultValue: false 
+          }
+
+      ]
+    },
+    
+  ]
+}
+]

package/server_connect/modules/imapdelete.js

@@ -0,0 +1,73 @@
+const Imap = require('imap');
+
+exports.imapdelete = 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');
+
+    const uid = this.parseRequired(options.uid, '*', "No message UID specified");
+    const uidvalidity = Number(this.parseRequired(options.uidvalidity, '*', "No UIDVALIDITY specified"));
+    const mailbox = this.parseRequired(options.mailbox, '*', "No Mailbox specified");
+    const flagonly = this.parseOptional(options.flagonly, '*', false);
+
+    function deleteEmail(config, emailUID, uidvalidity) {
+        return new Promise((resolve) => {
+            const imap = new Imap(config);
+
+            function openMailbox(cb) {
+                imap.openBox(mailbox, false, cb);
+            }
+
+            imap.once('ready', function () {
+                openMailbox(function (err, box) {
+                    if (err) {
+                        imap.end();
+                        return resolve({ uid: null, mailbox: mailbox, status: 401 });
+                    }
+
+                    if (box.uidvalidity !== uidvalidity) {
+                        imap.end();
+                        return resolve({ uid: null, mailbox: mailbox, status: 401 });
+                    }
+
+                    imap.addFlags(emailUID, ['\\Deleted'], function (err) {
+                        if (err) {
+                            imap.end();
+                            return resolve({ uid: emailUID, mailbox: mailbox, status: 401 });
+                        }
+
+                        console.log(`Email UID ${emailUID} marked for deletion.`);
+
+
+                        imap.end();
+                        resolve({ uid: emailUID, mailbox: mailbox, expunged: !flagonly, status: 200 });
+                    });
+                });
+            });
+
+            imap.once('error', function () {
+                resolve({ uid: null, mailbox: mailbox, 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 deleteEmail(config, uid, uidvalidity);
+};

package/server_connect/modules/imapdelete.php

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