@hyperbytes/wappler-imap-manager 1.0.0

package/server_connect/modules/imapgetrawheaders.js

@@ -0,0 +1,121 @@
+const Imap = require('imap');
+const { simpleParser } = require('mailparser');
+
+exports.imapgetrawheaders = 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 mailbox = this.parseOptional(options.mailbox, '*', 'INBOX');
+
+    console.log(`Connecting to IMAP server... User: ${IMAP_USER}`);
+
+    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('error', (err) => {
+            console.error(`IMAP Connection Error: ${err.message}`);
+            return reject(`IMAP Error: ${err.message}`);
+        });
+
+        imap.once('ready', () => {
+            console.log('IMAP connection established.');
+
+            imap.openBox(mailbox, false, (err, box) => {
+                if (err) {
+                    console.error(`Error opening mailbox: ${err.message}`);
+                    imap.end();
+                    return reject(`Error opening mailbox: ${err.message}`);
+                }
+
+                console.log(`Mailbox "${mailbox}" opened. Total Messages: ${box.messages.total}`);
+
+                if (box.messages.total === 0) {
+                    imap.end();
+                    console.warn('No messages found.');
+                    return reject('No messages found.');
+                }
+
+                imap.search(['ALL'], (err, results) => {
+                    if (err || results.length === 0) {
+                        console.error('No messages available.');
+                        imap.end();
+                        return reject('No messages available.');
+                    }
+
+                    console.log(`Found ${results.length} messages. Fetching headers and body...`);
+
+                    const fetch = imap.fetch([results[0]], { bodies: '', struct: true });
+
+                    fetch.on('message', (msg, seqno) => {
+                        console.log(`Processing message #${seqno}`);
+                        let headerData = '';
+                        let bodyData = '';
+                        let internalDate = '';
+
+                        msg.on('body', (stream, info) => {
+                            stream.on('data', (chunk) => {
+                                if (info.which === 'HEADER') {
+                                    headerData += chunk.toString();
+                                } else {
+                                    bodyData += chunk.toString();
+                                }
+                            });
+
+                            stream.on('end', async () => {
+                                try {
+                                    const parsed = await simpleParser(headerData + bodyData);
+                                    console.log(`Parsed Message #${seqno}:`, parsed);
+
+                                    resolve({
+                                        id: seqno,
+                                        headers: parsed.headers,
+                                        subject: parsed.subject,
+                                        from: parsed.from?.text,
+                                        to: parsed.to?.text,
+                                        date: parsed.date || internalDate,
+                                        body: parsed.text, // Plain text version of the email
+                                        htmlBody: parsed.html, // HTML version of the email
+                                    });
+                                } catch (error) {
+                                    console.error(`Error parsing message: ${error.message}`);
+                                    reject(`Error parsing message: ${error.message}`);
+                                }
+                            });
+                        });
+
+                        msg.on('attributes', (attrs) => {
+                            internalDate = attrs.date?.toUTCString();
+                            console.log(`Message #${seqno} internal date: ${internalDate}`);
+                        });
+                    });
+
+                    fetch.once('error', (err) => {
+                        console.error(`Fetch error: ${err.message}`);
+                        reject(`Fetch error: ${err.message}`);
+                    });
+
+                    fetch.once('end', () => {
+                        console.log('Fetching process completed. Closing IMAP connection.');
+                        imap.end();
+                    });
+                });
+            });
+        });
+
+        imap.once('end', () => {
+            console.log('IMAP connection closed.');
+        });
+
+        imap.connect();
+    });
+};

package/server_connect/modules/imapgetrawheaders.php

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

package/server_connect/modules/imapmailcontent.hjson

@@ -0,0 +1,192 @@
+[{
+  type: 'imapmailcontent-imapmailcontent',
+  module : 'imapmailcontent',
+  action : 'imapmailcontent',
+  groupTitle : 'Mailer',
+groupIcon : 'fas fa-envelope comp-general',
+  title : 'IMAP Get Email Content',
+  icon : 'fas fa-solid fa-envelope-open comp-exec',
+  dataPickObject: true,
+  usedModules : {
+    node: {
+      'imap' : '^8.8.19',
+      'mailparser' : '^3.7.2'
+    }
+      },
+      dataScheme:[
+                {type: "number",name: "uid"},
+                 {type: "object",name: "headers", sub:[
+                       {type: "object",name: "from", sub: [  
+                          {type: "array",name: "value", sub: [ 
+                                {type: "number",name: "address"},
+                                {type: "number",name: "name"} 
+                          ]}
+                       ]},
+
+                       {type: "object",name: "to", sub: [  
+                          {type: "array",name: "value", sub: [ 
+                                {type: "number",name: "address"},
+                                {type: "number",name: "name"} 
+                          ]}
+                       ]},
+
+                        {type: "object",name: "cc", sub: [  
+                          {type: "array",name: "value", sub: [ 
+                                {type: "number",name: "address"},
+                                {type: "number",name: "name"} 
+                          ]}
+                       ]},
+               
+                       {type: "object",name: "bcc", sub: [  
+                          {type: "array",name: "value", sub: [ 
+                                {type: "number",name: "address"},
+                                {type: "number",name: "name"} 
+                          ]}
+                       ]},
+                       {type: "text",name: "subject"},
+                       {type: "text",name: "date"},
+                       {type: "text",name: "message-id"},
+ 
+                 ]
+                 },
+                {type: "text",name: "body"},
+                {type: "array",name: "attachments" sub: [
+                {type: "text",name: "filename"},
+                {type: "text",name: "contentType"},
+                {type: "text",name: "size"},
+                {type: "text",name: "data"}
+                ]
+                },
+                {type: "text",name: "uidvalidity"},
+                {type: "text",name: "mailbox"},
+                {type: "text",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/imapmailcontent.js

@@ -0,0 +1,113 @@
+const Imap = require('imap');
+const { simpleParser } = require('mailparser');
+
+exports.imapmailcontent = async function (options, name) {
+    return new Promise((resolve, reject) => {
+        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 uid = this.parseRequired(options.uid, '*', "No message UID specified");
+        const mailbox = this.parseOptional(options.mailbox, '*', 'INBOX'); // Capture mailbox from options
+        const uidvalidity = this.parseRequired(options.uidvalidity, '*', "No message UIDValidity specified");
+
+        const imapConfig = {
+            user: IMAP_USER,
+            password: IMAP_PASSWORD,
+            host: IMAP_HOST,
+            port: IMAP_PORT,
+            tls: true
+        };
+
+        const imap = new Imap(imapConfig);
+
+        imap.once('ready', () => {
+            imap.openBox(mailbox, false, (err, box) => {
+                if (err) {
+                    imap.end();
+                    return resolve({
+                        uid: null,
+                        headers: {},
+                        body: '',
+                        attachments: [],
+                        uidvalidity: null,
+                        mailbox: null,
+                        uidKey: null,
+                        status: 401
+                    });
+                }
+
+                const fetch = imap.fetch(uid, { bodies: "", struct: true });
+
+                fetch.on('message', (msg) => {
+                    let buffer = '';
+                    let headers = {};
+                    let messageUID = null; // Capture UID separately
+                    let uidvalidity = box.uidvalidity; // Capture UIDVALIDITY
+
+                    msg.on('body', (stream) => {
+                        stream.on('data', (chunk) => buffer += chunk.toString('utf8'));
+                        stream.on('end', async () => {
+                            try {
+                                const parsed = await simpleParser(buffer);
+
+                                headers = {
+                                    from: parsed.headers.get('from'),
+                                    to: parsed.headers.get('to'),
+                                    cc: parsed.headers.get('cc') || '', // Added CC field
+                                    bcc: parsed.headers.get('bcc') || '', // Added BCC field
+                                    subject: parsed.headers.get('subject'),
+                                    date: parsed.headers.get('date'),
+                                    'message-id': parsed.headers.get('message-id')
+                                };
+
+                                resolve({
+                                    uid: messageUID,
+                                    headers: headers,
+                                    body: parsed.html || parsed.text,
+                                    attachments: parsed.attachments.map(att => ({
+                                        filename: att.filename,
+                                        contentType: att.contentType,
+                                        size: att.size,
+                                        data: att.content.toString('base64')
+                                    })),
+                                    uidvalidity: uidvalidity,
+                                    mailbox: mailbox,
+                                    uidKey: `${uidvalidity}:${messageUID}`,
+                                    status: 200
+                                });
+                            } catch (parseError) {
+                                reject(parseError);
+                            }
+                        });
+                    });
+
+                    msg.once('attributes', (attrs) => {
+                        messageUID = attrs.uid;
+                    });
+                });
+
+                fetch.once('end', () => {
+                    imap.end();
+                });
+            });
+        });
+
+        imap.once('error', () => {
+            resolve({
+                uid: null,
+                headers: {},
+                body: '',
+                attachments: [],
+                uidvalidity: null,
+                mailbox: null,
+                uidKey: null,
+                status: 401
+            });
+        });
+
+        imap.connect();
+    });
+};
+

package/server_connect/modules/imapmailcontent.php

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

package/server_connect/modules/imapmailheaders.hjson

@@ -0,0 +1,174 @@
+[{
+  type: 'imapmailheaders-imapmailheaders',
+  module : 'imapmailheaders',
+  action : 'imapmailheaders',
+  groupTitle : 'Mailer',
+groupIcon : 'fas fa-envelope comp-general',
+  title : 'IMAP Get Headers',
+  icon : 'fas fa-solid fa-list comp-exec',
+  dataPickObject: true,
+  usedModules : {
+    node: {
+      'imap' : '^8.8.19',
+       'mailparser' : '^3.7.2'
+    }
+      },
+  dataScheme:  [
+[{ name: 'data',  type: 'text', sub:[ 
+  { name: 'id',  type: 'number' }
+  { name: 'uid',  type: 'number' }
+  {
+    name: 'headers', type: 'object',  sub: [  
+              { name: 'from', type: 'array' , sub: [
+                  { name: 'address', type: 'text' }]
+              },
+
+              { name: 'to', type: 'array' , sub: [
+                  { name: 'address', type: 'text' }]
+              }, 
+
+              { name: 'cc', type: 'array' , sub: [
+                  { name: 'address', type: 'text' }]
+              },
+              { name: 'bcc', type: 'array' , sub: [
+                  { name: 'address', type: 'text' }]
+              },
+      { name: 'message-id',  type: 'number' } # Array of message-id strings
+      { name: 'messagedate', type: 'text' }  # Date/time string
+    ]
+  }
+  { name: 'flags',type: 'array' sub:[
+    { name: 'flag', type: 'text' }
+    ]
+  }
+
+  { name: 'attachmentCount', type: 'number' }
+  { name: 'uidvalidity',     type: 'number' }
+  { name: 'mailbox',         type: 'text' }
+  { name: 'status',          type: 'number' }
+]},
+ { name: 'status',          type: 'number' }
+]],
+  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 to use to collect emails'
+           },
+         { name: 'offset', 
+          optionName: 'offset', 
+          title: 'offset', 
+          type: 'text', 
+          required: true,
+          defaultValue: "0", 
+          serverDataBindings: true,
+           help: 'The offset within the emails'
+           },
+           { name: 'payload', 
+          optionName: 'payload', 
+          title: 'payload', 
+          type: 'text', 
+          required: true,
+          defaultValue: "25", 
+          serverDataBindings: true,
+           help: 'The number of emails to retrieve'
+           },
+
+    
+          { name: 'output', 
+          optionName: 'output', 
+          title: 'Output', 
+          type: 'boolean', 
+          defaultValue: false 
+          }
+
+      ]
+    },
+  ]}]