@hyperbytes/wappler-imap-manager 1.0.0

package/server_connect/modules/imapmailheaders.js

@@ -0,0 +1,184 @@
+const Imap = require('imap');
+
+exports.imapmailheaders = 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 offset = this.parseOptional(options.offset, '*', 0);
+    const payload = this.parseOptional(options.payload, '*', 25);
+    const mailbox = this.parseOptional(options.mailbox, '*', 'INBOX');
+
+    return new Promise((resolve) => {
+        const imap = new Imap({
+            user: IMAP_USER,
+            password: IMAP_PASSWORD,
+            host: IMAP_HOST,
+            port: IMAP_PORT,
+            tls: IMAP_TLS,
+        });
+
+        const messages = [];
+
+        function openInbox(cb) {
+            imap.openBox(mailbox, true, cb);
+        }
+
+        imap.once('ready', function () {
+            openInbox(function (err, box) {
+                if (err) {
+                    imap.end();
+                    return resolve({ data: [], status: 401 });
+                }
+
+                if (box.messages.total === 0) {
+                    imap.end();
+                    return resolve({ data: [], status: 200 });
+                }
+
+                const totalMessages = box.messages.total;
+                let end = Math.max(totalMessages - (offset * payload), 1);
+                let start = Math.max(end - payload, 1);
+
+                if (start > end || start < 1) {
+                    imap.end();
+                    return resolve({ data: [], status: 400 });
+                }
+
+                const tofetch = `${start}:${end}`;
+
+                const f = imap.seq.fetch(tofetch, {
+                    bodies: 'HEADER.FIELDS (FROM TO CC BCC SUBJECT DATE MESSAGE-ID RECEIVED)',
+                    struct: true,
+                });
+
+                f.on('message', function (msg, seqno) {
+                    let messageData = {
+                        id: seqno,
+                        uid: null,
+                        headers: {},
+                        flags: [],
+                        attachmentCount: 0,
+                        uidvalidity: box.uidvalidity,
+                        mailbox: mailbox
+
+                    };
+
+                    msg.on('body', function (stream) {
+                        let buffer = '';
+                        stream.on('data', function (chunk) {
+                            buffer += chunk.toString('utf8');
+                        });
+                        stream.once('end', function () {
+                            let headers = Imap.parseHeader(buffer);
+
+                            console.log("Extracted headers:", headers);
+
+                            if (headers.date) {
+                                headers.messagedate = new Intl.DateTimeFormat('en-GB', {
+                                    year: 'numeric',
+                                    month: '2-digit',
+                                    day: '2-digit',
+                                    hour: '2-digit',
+                                    minute: '2-digit',
+                                    second: '2-digit',
+                                    timeZone: 'UTC',
+                                }).format(new Date(headers.date));
+
+                                delete headers.Date;
+                            } else if (headers.received && headers.received.length > 0) {
+                                console.log("Checking Received headers for fallback date...");
+
+                                const receivedTimestamps = headers.received.map(receivedHeader => {
+                                    const match = receivedHeader.match(/\b(\w{3}, )?\d{1,2} \w{3} \d{4} \d{2}:\d{2}:\d{2} (\w+|\+\d{4})\b/);
+                                    return match ? match[0] : null;
+                                }).filter(Boolean);
+
+                                if (receivedTimestamps.length > 0) {
+                                    headers.messagedate = new Intl.DateTimeFormat('en-GB', {
+                                        year: 'numeric',
+                                        month: '2-digit',
+                                        day: '2-digit',
+                                        hour: '2-digit',
+                                        minute: '2-digit',
+                                        second: '2-digit',
+                                        timeZone: 'UTC',
+                                    }).format(new Date(receivedTimestamps[receivedTimestamps.length - 1]));
+                                } else {
+                                    headers.messagedate = 'Unknown Date';
+                                }
+                            }
+
+                            messageData.headers = {
+                                from: headers['from'],
+                                to: headers['to'],
+                                cc: headers['cc'] || [],
+                                bcc: headers['bcc'] || [],
+                                subject: headers['subject'],
+                                'message-id': headers['message-id'],
+                                messagedate: headers.messagedate
+                            };
+                        });
+                    });
+
+                    msg.once('attributes', function (attrs) {
+                        messageData.flags = attrs.flags;
+                        messageData.uid = attrs.uid;
+
+                        if (!messageData.headers.messagedate && attrs.date) {
+                            messageData.headers.messagedate = new Intl.DateTimeFormat('en-GB', {
+                                year: 'numeric',
+                                month: '2-digit',
+                                day: '2-digit',
+                                hour: '2-digit',
+                                minute: '2-digit',
+                                second: '2-digit',
+                                timeZone: 'UTC',
+                            }).format(new Date(attrs.date));
+                        }
+
+                        if (attrs.struct) {
+                            function countAttachments(struct) {
+                                return struct.reduce((count, part) => {
+                                    if (Array.isArray(part)) {
+                                        return count + countAttachments(part);
+                                    }
+                                    return part.disposition && part.disposition.type.toLowerCase() === 'attachment' ? count + 1 : count;
+                                }, 0);
+                            }
+                            messageData.attachmentCount = countAttachments(attrs.struct);
+                        }
+                    });
+
+                    msg.once('end', function () {
+                        console.log("Final message data before pushing:", messageData);
+                        messages.push(messageData);
+                    });
+                });
+
+                f.once('error', function () {
+                    resolve({ data: [], status: 400 });
+                });
+
+                f.once('end', function () {
+                    imap.end();
+                    resolve({ data: messages.reverse(), status: 200 });
+                });
+            });
+        });
+
+        imap.once('error', function () {
+            resolve({ data: [], status: 401 });
+        });
+
+        imap.once('end', function () {
+            console.log('IMAP connection closed.');
+        });
+
+        imap.connect();
+    });
+};
+

package/server_connect/modules/imapmailheaders.php

@@ -0,0 +1,71 @@
+<?php
+
+namespace modules;
+
+use \lib\core\Module;
+
+class custom extends Module
+
+  <?php
+public function imapMailHeaders($options, $name) {
+    $IMAP_HOST = $options['imap_host'] ?? getenv('IMAP_HOST');
+    $IMAP_PASSWORD = $options['imap_password'] ?? getenv('IMAP_PASSWORD');
+    $IMAP_USER = $options['imap_usesr'] ?? getenv('IMAP_USER');
+    $IMAP_PORT = $options['imap_port'] ?? getenv('IMAP_PORT');
+    $IMAP_TLS = strtolower($options['imap_tls'] ?? getenv('IMAP_TLS')) === 'true';
+
+    $offset = $options['offset'] ?? 0;
+    $payload = $options['payload'] ?? 25;
+    $mailbox = $options['mailbox'] ?? 'INBOX';
+
+    $imap = imap_open("{" . $IMAP_HOST . ":" . $IMAP_PORT . ($IMAP_TLS ? "/ssl" : "") . "}INBOX", $IMAP_USER, $IMAP_PASSWORD);
+    
+    if (!$imap) {
+        return ['data' => [], 'status' => 401];
+    }
+
+    $messages = [];
+    $totalMessages = imap_num_msg($imap);
+
+    if ($totalMessages === 0) {
+        imap_close($imap);
+        return ['data' => [], 'status' => 200];
+    }
+
+    $end = max($totalMessages - ($offset * $payload), 1);
+    $start = max($end - $payload, 1);
+
+    if ($start > $end || $start < 1) {
+        imap_close($imap);
+        return ['data' => [], 'status' => 400];
+    }
+
+    for ($i = $start; $i <= $end; $i++) {
+        $headers = imap_headerinfo($imap, $i);
+        $messageData = [
+            'id' => $i,
+            'uid' => imap_uid($imap, $i),
+            'headers' => [
+                'from' => $headers->fromaddress,
+                'to' => $headers->toaddress ?? '',
+                'cc' => $headers->ccaddress ?? '',
+                'bcc' => $headers->bccaddress ?? '',
+                'subject' => $headers->subject,
+                'message-id' => $headers->message_id ?? '',
+                'messagedate' => date('Y-m-d H:i:s', strtotime($headers->date))
+            ],
+            'flags' => imap_fetch_overview($imap, $i)[0]->flags ?? [],
+            'attachmentCount' => count(imap_mime_header_decode($headers->subject)),
+            'uidvalidity' => imap_uid($imap, $i),
+            'mailbox' => $mailbox
+        ];
+
+        $messages[] = $messageData;
+    }
+
+    imap_close($imap);
+    return ['data' => array_reverse($messages), 'status' => 200];
+}
+?>
+
+

package/server_connect/modules/imapmovefolder.hjson

@@ -0,0 +1,158 @@
+[{
+  type: 'imapmovefolder-imapmovefolder',
+  module : 'imapmovefolder',
+  action : 'imapmovefolder',
+  groupTitle : 'Mailer',
+groupIcon : 'fas fa-envelope comp-general',
+  title : 'IMAP Move Folder',
+  icon : 'fas fa-solid fa-list comp-exec',
+  dataPickObject: true,
+  usedModules : {
+    node: {
+      'imap' : '^8.8.19',
+       'mailparser' : '^3.7.2'
+    }
+      },
+        dataScheme: [
+          { type: "number",name: "uid"},
+          { type: "text",name: "mailbox"},
+          { type: "text",name: "destination"},
+          { type: "number",name: "uidvalidity"},
+          { 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: 'Message UID', 
+          type: 'text', 
+          required: true,
+          defaultValue: "", 
+          serverDataBindings: true,
+           help: 'uid of the message'
+           },
+          { 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: 'dirto', 
+          optionName: 'dirto', 
+          title: 'To Mailbox', 
+          type: 'text', 
+          required: true,
+          defaultValue: "", 
+          serverDataBindings: true,
+           help: 'To box'
+           },
+
+    
+          { name: 'output', 
+          optionName: 'output', 
+          title: 'Output', 
+          type: 'boolean', 
+          defaultValue: false 
+          }
+
+      ]
+    },
+    
+  ]
+}
+]

package/server_connect/modules/imapmovefolder.js

@@ -0,0 +1,86 @@
+const Imap = require('imap');
+
+exports.imapmovefolder = 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_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');
+
+    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 dirto = this.parseRequired(options.dirto, '*', "No destination Mailbox specified");
+
+    return new Promise((resolve) => {
+        const imap = new Imap({
+            user: IMAP_USER,
+            password: IMAP_PASSWORD,
+            host: IMAP_HOST,
+            port: IMAP_PORT,
+            tls: IMAP_TLS
+        });
+
+        imap.once('ready', () => {
+            console.log(`Connected to IMAP. Opening mailbox: ${mailbox}`);
+
+            imap.openBox(mailbox, false, (err, box) => {
+                if (err) {
+                    imap.end();
+                    return resolve({ uid: null, mailbox: mailbox, destination: dirto, uidValidityDest: "", status: 401 });
+                }
+
+                // Validate UIDVALIDITY
+                if (box.uidvalidity !== uidvalidity) {
+                    imap.end();
+                    return resolve({ uid: null, mailbox: mailbox, destination: dirto, uidvalidity: "", status: 401 });
+                }
+
+                console.log(`Mailbox UIDVALIDITY verified (${uidvalidity}). Searching for UID ${uid}...`);
+
+                imap.search([['UID', uid]], (searchErr, results) => {
+                    if (searchErr || results.length === 0) {
+                        imap.end();
+                        return resolve({ uid: null, mailbox: mailbox, destination: dirto, uidvalidity: "", status: 404 });
+                    }
+
+                    console.log(`Found UID ${uid}, moving to ${dirto}...`);
+                    imap.move(uid.toString(), dirto, (moveErr) => {
+                        if (moveErr) {
+                            imap.end();
+                            return resolve({ uid: uid, mailbox: mailbox, destination: dirto, uidvalidity: "", status: 401 });
+                        }
+
+                        // Open the destination mailbox to retrieve the new UID and UIDVALIDITY
+                        imap.openBox(dirto, false, (destErr, destBox) => {
+                            if (destErr) {
+                                imap.end();
+                                return resolve({ uid: null, mailbox: mailbox, destination: dirto, uidvalidity: "", status: 401 });
+                            }
+
+                            const uidValidityDest = destBox.uidvalidity;
+
+                            // Search for the latest message in the destination mailbox
+                            imap.search(['ALL'], (searchDestErr, destResults) => {
+                                imap.end();
+                                if (searchDestErr || destResults.length === 0) {
+                                    return resolve({ uid: null, mailbox: mailbox, destination: dirto, uidvalidity: "", status: 404 });
+                                }
+
+                                const newUid = Math.max(...destResults); // Get the highest UID (latest message)
+                                resolve({ uid: newUid, mailbox: mailbox, destination: dirto, uidvalidity: uidValidityDest, status: 200 });
+                            });
+                        });
+                    });
+                });
+            });
+        });
+
+        imap.once('error', () => resolve({ uid: null, mailbox: mailbox, destination: dirto, uidvalidityDest: "", status: 401 }));
+
+        imap.once('end', () => console.log('IMAP connection closed.'));
+
+        imap.connect();
+    });
+};

package/server_connect/modules/imapmovefolder.php

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

package/server_connect/modules/imapremoveflag.hjson

@@ -0,0 +1,151 @@
+[{
+  type: 'imapremoveflag-imapremoveflag',
+  module : 'imapremoveflag',
+  action : 'imapremoveflag',
+  groupTitle : 'Mailer',
+groupIcon : 'fas fa-envelope comp-general',
+  title : 'IMAP Remove flag by UID',
+  icon : 'fas fa-solid fa-minus comp-exec',
+  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 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: 'flag', 
+          optionName: 'flag', 
+          title: 'Flag to remove', 
+          type: 'text', 
+          required: true,
+          defaultValue: "//Seen", 
+          serverDataBindings: true,
+           help: 'The flag to remove'
+           },
+   
+   
+          { name: 'output', 
+          optionName: 'output', 
+          title: 'Output', 
+          type: 'boolean', 
+          defaultValue: false 
+          }
+
+      ]
+    },
+    
+  ]
+}
+]