@hyperbytes/wappler-imap-manager 1.0.0

package/server_connect/modules/imapremoveflag.js

@@ -0,0 +1,72 @@
+const Imap = require('imap');
+
+exports.imapremoveflag = 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 message UIDValidity specified"));
+    const mailbox = this.parseRequired(options.mailbox, '*', "No mailbox specified");
+    let flag = this.parseRequired(options.flag, '*', "No Flag specified");
+    flag = normalizeBackslash(flag);
+
+    const config = {
+        user: IMAP_USER,
+        password: IMAP_PASSWORD,
+        host: IMAP_HOST,
+        port: IMAP_PORT,
+        tls: IMAP_TLS
+    };
+
+    const removeFlagFromEmail = (uid, flagName, mailboxName, expectedUidValidity) => {
+        return new Promise((resolve) => {
+            const imap = new Imap(config);
+
+            imap.once('ready', () => {
+                imap.openBox(mailboxName, false, (err, box) => {
+                    if (err) {
+                        imap.end();
+                        return resolve({ uid: null, mailbox: mailboxName, flag: null, status: 401 });
+                    }
+
+                    // Validate UIDVALIDITY before proceeding
+                    if (Number(box.uidvalidity) !== Number(expectedUidValidity)) {
+                        imap.end();
+                        return resolve({ uid: null, mailbox: mailboxName, flag: null, status: 401 });
+                    }
+
+                    imap.delFlags(uid, flagName, (err) => {
+                        if (err) {
+                            imap.end();
+                            return resolve({ uid: uid, mailbox: mailboxName, flag: flagName, status: 401 });
+                        }
+
+                        console.log(`Successfully removed flag ${flagName} from email UID ${uid} in ${mailboxName}`);
+                        imap.end();
+                        resolve({ uid: uid, mailbox: mailboxName, flag: flagName, status: 200 });
+                    });
+                });
+            });
+
+            imap.once('error', () => resolve({ uid: null, mailbox: mailboxName, flag: null, status: 401 }));
+
+            imap.once('end', () => console.log('IMAP connection closed'));
+
+            imap.connect();
+        });
+    };
+
+    return removeFlagFromEmail(uid, flag, mailbox, uidvalidity);
+};
+
+function normalizeBackslash(inputString) {
+    if (inputString.startsWith("\\\\")) {
+        return inputString.replace(/^\\\\/, "\\");
+    }
+    return inputString;
+}
+

package/server_connect/modules/imapremoveflag.php

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

package/server_connect/modules/imapsaveasdraft.hjson

@@ -0,0 +1,202 @@
+[{
+  type: 'imapsaveasdraft-imapsaveasdraft',
+  module : 'imapsaveasdraft',
+  action : 'imapsaveasdraft',
+  groupTitle : 'Mailer',
+groupIcon : 'fas fa-envelope comp-general',
+  title : 'IMAP Save as Draft (not funtional)',
+  icon : 'fas fa-solid fa-pen comp-exec',
+  dataPickObject: true,
+  usedModules : {
+    node: {
+      'imap' : '^8.8.19',
+      'mailparser' : '^3.7.2',
+      'imap-simple' : '^5.1.0',
+      'mailtrap' : '^4.1.0',
+      'mailcomposer':'^1.0.0'
+    }
+      },
+        dataScheme: [
+          { type:"number", name: "status"},
+          { type:"text", name: "message"},
+          { type:"number", name: "uid"},
+          { type:"text", name: "folder"}
+        ],
+  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: false,
+          defaultValue: "", 
+          serverDataBindings: true,
+           help: 'The uid of the original draft'
+           },
+           { name: 'from', 
+          optionName: 'from', 
+          title: 'From', 
+          type: 'text', 
+          required: false,
+          defaultValue: "", 
+          serverDataBindings: true,
+           help: 'The from email'
+           },
+          { name: 'to', 
+          optionName: 'to', 
+          title: 'To', 
+          type: 'text', 
+          required: false,
+          defaultValue: "", 
+          serverDataBindings: true,
+           help: 'The to email'
+           },
+          { name: 'cc', 
+          optionName: 'cc', 
+          title: 'CC', 
+          type: 'text', 
+          required: false,
+          defaultValue: "", 
+          serverDataBindings: true,
+           help: 'The cc email'
+           },
+                     { name: 'bcc', 
+          optionName: 'bcc', 
+          title: 'Bcc', 
+          type: 'text', 
+          required: false,
+          defaultValue: "", 
+          serverDataBindings: true,
+           help: 'The BCC email'
+           },
+          { name: 'mailsubject', 
+          optionName: 'mailsubject', 
+          title: 'Subject', 
+          type: 'text', 
+          required: false,
+          defaultValue: "", 
+          serverDataBindings: true,
+           help: 'The subject of the email'
+           },
+          { name: 'body', 
+          optionName: 'body', 
+          title: 'Body', 
+          type: 'textarea', 
+          required: false,
+          defaultValue: "", 
+          serverDataBindings: true,
+           help: 'The body of the email'
+           },
+          { name: 'attachments', 
+          optionName: 'attachments', 
+          title: 'Attachments Path', 
+          type: 'textarea', 
+          required: false,
+          defaultValue: "", 
+          serverDataBindings: true,
+           help: 'The attachments file upload content'
+           },
+          { name: 'mailbox', 
+          optionName: 'mailbox', 
+          title: 'Move to mailbox', 
+          type: 'text', 
+          required: false,
+          defaultValue: 'Drafts', 
+          serverDataBindings: true,
+           help: 'Mailbox for the saved email'
+           },
+          { name: 'output', 
+          optionName: 'output', 
+          title: 'Output', 
+          type: 'boolean', 
+          defaultValue: false 
+          }
+
+      ]
+    },
+    
+  ]
+}
+]

package/server_connect/modules/imapsaveasdraft.js

@@ -0,0 +1,184 @@
+const Imap = require('imap-simple');
+const nodemailer = require('nodemailer');
+const mailcomposer = require('mailcomposer');
+const { simpleParser } = require('mailparser'); // Used for debugging email content
+
+exports.imapsaveasdraft = async function (options) {
+    console.log('Starting IMAP draft save process...');
+
+    // Parse IMAP configuration
+    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_user, '*', 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');
+
+    // Validate essential IMAP configuration
+    if (!IMAP_HOST || !IMAP_USER || !IMAP_PASSWORD) {
+        console.error('IMAP host, user, or password not configured.');
+        return {
+            status: 401,
+            message: 'IMAP configuration incomplete.',
+            error: 'IMAP host, user, or password not configured.',
+            uid: '',
+            folder: this.parseOptional(options.mailbox, '*', 'Drafts')
+        };
+    }
+
+    // Parse email details
+    const to = this.parseOptional(options.to, "*", "");
+    console.log('To: ' + to);
+    const mailfrom = this.parseOptional(options.from, "*", "");
+    console.log('From: ' + mailfrom);
+    const cc = this.parseOptional(options.cc, "*", "");
+    console.log('CC: ' + cc);
+    const bcc = this.parseOptional(options.bcc, "*", "");
+    console.log('BCC: ' + bcc);
+    const subject = this.parseOptional(options.mailsubject, "*", "default subject");
+    console.log('Subject: ' + subject);
+    const body = this.parseOptional(options.body, "*", ""); // Assuming this is HTML body
+    console.log('Body: ' + body);
+    const attachments = this.parseOptional(options.attachments, '*', []);
+    console.log('Attachments: ' + attachments);
+    let folder = this.parseOptional(options.mailbox, '*', 'Drafts'); // Default to 'Drafts'
+    console.log('Folder: ' + folder);
+
+    // Check if a UID is provided – meaning the draft is to be updated
+    const providedUid = this.parseOptional(options.uid, "*", "");
+    console.log('UID: ' + providedUid);
+    console.log(`Attempting to save draft to folder: ${folder}`);
+
+    const imapConfig = {
+        imap: {
+            user: IMAP_USER,
+            password: IMAP_PASSWORD,
+            host: IMAP_HOST,
+            port: IMAP_PORT,
+            tls: IMAP_TLS,
+            tlsOptions: { rejectUnauthorized: false },
+            authTimeout: 5000
+        }
+    };
+
+    let connection;
+
+    try {
+        // 1. Construct the email message using mailcomposer
+        const mailOptions = {
+            from: mailfrom,
+            to: to,
+            cc: cc,
+            bcc: bcc,
+            subject: subject,
+            html: body, // Use 'text' if it's plain text
+            attachments: attachments
+        };
+
+        const mail = mailcomposer(mailOptions);
+
+        const rawEmail = await new Promise((resolve, reject) => {
+            mail.build((err, message) => {
+                if (err) {
+                    console.error('Error building email:', err);
+                    return {
+                        status: 400,
+                        message: 'Error building email.',
+                        uid: '',
+                        folder: folder
+                    };
+                }
+                resolve(message);
+            });
+        });
+
+        console.log('Raw email constructed.');
+
+        // Debug: Parse the raw email to verify its content
+        const parsedEmail = await simpleParser(rawEmail);
+        console.log('Parsed Email Content:', {
+            subject: parsedEmail.subject,
+            text: parsedEmail.text,
+            html: parsedEmail.html,
+            headers: parsedEmail.headers
+        });
+
+        // 2. Connect to IMAP server
+        console.log(`Connecting to IMAP server ${IMAP_HOST}:${IMAP_PORT}...`);
+        connection = await Imap.connect(imapConfig);
+        console.log('Successfully connected to IMAP server.');
+
+        // 3. Open the target mailbox
+        await connection.openBox(folder);
+        console.log(`Mailbox "${folder}" opened.`);
+        // Retrieve UID validity of the destination mailbox (if available)
+
+
+        // 4. If a UID is provided, update the existing draft; otherwise, append a new one.
+        if (providedUid) {
+            console.log(`UID provided (${providedUid}). Updating existing draft...`);
+            // Attempt to delete the existing draft for that UID
+            try {
+                await connection.deleteMessage(providedUid);
+                console.log(`Existing draft with UID ${providedUid} deleted.`);
+            } catch (delErr) {
+                console.warn(`Could not delete existing draft with UID ${providedUid}: ${delErr}`);
+                // You might decide to abort here if deletion is mandatory
+            }
+            // Append the new draft (note: the server will normally assign a new UID,
+            // but we are returning the provided UID per the requirement).
+            console.log(`Appending updated draft to folder: ${folder}...`);
+            const updateAppendResult = await connection.append(rawEmail, {
+                mailbox: folder,
+                flags: ['\\Draft']
+            });
+            console.log('Updated draft appended.', updateAppendResult);
+
+            return {
+                status: 200,
+                message: 'Draft updated successfully.',
+                uid: providedUid,
+                folder: folder
+            };
+        } else {
+            console.log(`Appending email as a draft to folder: ${folder}...`);
+            const appendResult = await connection.append(rawEmail, {
+                mailbox: folder,
+                flags: ['\\Draft']
+            });
+            console.log('Email appended to drafts folder.', appendResult);
+
+            // Retrieve UID of the saved message
+            const searchResult = await connection.search(['ALL'], { bodies: ['HEADER.FIELDS (MESSAGE-ID)'] });
+            const uid = searchResult.length > 0 ? searchResult[searchResult.length - 1].attributes.uid : '';
+
+            return {
+                status: 200,
+                message: 'Draft saved successfully.',
+                uid: uid,
+                folder: folder
+            };
+        }
+
+    } catch (err) {
+        console.error('IMAP draft save failed:', err);
+        return {
+            status: 400,
+            message: 'Failed to save draft.',
+            error: err.toString(),
+            uid: '',
+            folder: folder
+        };
+    } finally {
+        if (connection) {
+            try {
+                await connection.end();
+                console.log('IMAP connection closed.');
+            } catch (endErr) {
+                console.error('Error ending IMAP connection:', endErr);
+            }
+        }
+    }
+};
+
+

package/server_connect/modules/imapsaveflag.php

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

package/server_connect/modules/imapsendmail.hjson

@@ -0,0 +1,190 @@
+[{
+  type: 'imapsendmail-imapsendmail',
+  module : 'imapsendmail',
+  action : 'imapsendmail',
+  groupTitle : 'Mailer',
+ groupIcon : 'fas fa-envelope comp-general',
+  title : 'IMAP Send Email',
+  icon : 'fas fa-solid fa-paper-plane comp-exec',
+  dataPickObject: true,
+  usedModules : {
+    node: {
+      'imap' : '^8.8.19',
+       'mailparser' : '^3.7.2',
+       'nodemailer' : '^6.10.1'
+    }
+      },
+        dataScheme: [
+          { type: "number",name: "status"},
+           { type: "text",name: "messageId"}
+        ]
+  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: 'smtp_file', 
+          optionName: 'smtp_file', 
+          title: 'SMTP Global Config', 
+          type: 'text', 
+          required: true,
+          defaultValue: "", 
+          serverDataBindings: true,
+           help: 'The name of the Mailer send config setting'
+           },
+          { name: 'from', 
+          optionName: 'from', 
+          title: 'From eMail address', 
+          type: 'text', 
+          required: true,
+          defaultValue: "", 
+          serverDataBindings: true,
+           help: 'The address email will come from'
+           },
+          { name: 'to', 
+          optionName: 'to', 
+          title: 'To eMail address', 
+          type: 'text', 
+          required: true,
+          defaultValue: "", 
+          serverDataBindings: true,
+           help: 'The address email will go to'
+           },
+          { name: 'cc', 
+          optionName: 'cc', 
+          title: 'cc eMail address', 
+          type: 'text', 
+          defaultValue: "", 
+          serverDataBindings: true,
+           help: 'The address email will go to'
+           },
+          { name: 'bcc', 
+          optionName: 'bcc', 
+          title: ' bcc eMail address', 
+          type: 'text', 
+          defaultValue: "", 
+          serverDataBindings: true,
+           help: 'The address email will go to'
+           },
+          { name: 'subject', 
+          optionName: 'subject', 
+          title: 'eMail Subject', 
+          type: 'text', 
+          defaultValue: "", 
+          serverDataBindings: true,
+           help: 'The  email subject'
+           },
+                     { name: 'body', 
+          optionName: 'body', 
+          title: 'The eMail body', 
+          type: 'text', 
+          required: true,
+          defaultValue: "", 
+          serverDataBindings: true,
+           help: 'The email body'
+           },
+          { name: 'attachments', 
+          optionName: 'attachments', 
+          title: 'The eMail attachments', 
+          type: 'text', 
+          defaultValue: "", 
+          serverDataBindings: true,
+           help: 'The email attachments'
+           },
+          { name: 'save_to_send', 
+          optionName: 'save_to_send', 
+          title: 'Save To Sent items', 
+          type: 'boolean', 
+          defaultValue: false },
+          { name: 'output', 
+          optionName: 'output', 
+          title: 'Output', 
+          type: 'boolean', 
+          defaultValue: false 
+          }
+
+      ]
+    },
+    
+  ]
+}
+]