imapkit 4.0.2 → 4.1.0

package/{lib → dist/esm}/plugins/move.js

@@ -1,8 +1,5 @@
-'use strict';
-
-const { copyToMailbox } = require('../commands/copy');
-const { states } = require('../command-states');
-
+import { copyToMailbox } from '../commands/copy.js';
+import { states } from '../command-states.js';
 /**
  * @help Adds MOVE [RFC6851] capability
  *
@@ -12,9 +9,8 @@ const { states } = require('../command-states');
  * - MOVE
  * - UID MOVE
  */
-module.exports = function (server) {
+export default function movePlugin(server) {
     server.registerCapability('MOVE');
-
     const moveHandler = function (uidMode, connection, parsed, data, callback) {
         function uidify(str) {
             if (uidMode) {
@@ -22,89 +18,64 @@ module.exports = function (server) {
             }
             return str;
         }
-
-        if (
-            !parsed.attributes ||
+        if (!parsed.attributes ||
             parsed.attributes.length !== 2 ||
             !parsed.attributes[0] ||
             ['ATOM', 'SEQUENCE'].indexOf(parsed.attributes[0].type) < 0 ||
             !parsed.attributes[1] ||
-            ['ATOM', 'STRING', 'LITERAL'].indexOf(parsed.attributes[1].type) < 0
-        ) {
-            connection.send(
-                {
-                    tag: parsed.tag,
-                    command: 'BAD',
-                    attributes: [
-                        {
-                            type: 'TEXT',
-                            value: uidify('MOVE expects sequence set and a mailbox name')
-                        }
-                    ]
-                },
-                'INVALID COMMAND',
-                parsed,
-                data
-            );
+            ['ATOM', 'STRING', 'LITERAL'].indexOf(parsed.attributes[1].type) < 0) {
+            connection.send({
+                tag: parsed.tag,
+                command: 'BAD',
+                attributes: [
+                    {
+                        type: 'TEXT',
+                        value: uidify('MOVE expects sequence set and a mailbox name')
+                    }
+                ]
+            }, 'INVALID COMMAND', parsed, data);
             return callback();
         }
-
         // MOVE expunges messages from the source mailbox, which is not allowed after EXAMINE
         if (connection.refuseReadOnly(parsed, data, uidify('MOVE FAIL'))) {
             return callback();
         }
-
         const result = copyToMailbox(connection, parsed, data, uidMode, uidify('MOVE FAIL'), true);
         if (!result) {
             return callback();
         }
-
         // Hook for UIDPLUS to generate the untagged COPYUID response (that wants
         // to happen prior to the EXPUNGEs).  If the UIDPLUS extension is not
         // active, this will not happen.
-        connection.send(
-            {
-                tag: '*',
-                command: 'OK',
-                attributes: [
-                    {
-                        type: 'TEXT',
-                        value: 'Copied'
-                    }
-                ],
-                skipResponse: true
-            },
-            uidify('MOVE COPYUID'),
-            parsed,
-            data,
-            result
-        );
-
+        connection.send({
+            tag: '*',
+            command: 'OK',
+            attributes: [
+                {
+                    type: 'TEXT',
+                    value: 'Copied'
+                }
+            ],
+            skipResponse: true
+        }, uidify('MOVE COPYUID'), parsed, data, result);
         // Expunge the messages from the source folder. When moving into the selected mailbox,
         // the copies were already announced with EXISTS responses
         connection.expungeSpecificMessages(connection.selectedMailbox, result.messages, false, true, !!parsed.highestFirst);
-
-        connection.send(
-            {
-                tag: parsed.tag,
-                command: 'OK',
-                attributes: [
-                    {
-                        type: 'TEXT',
-                        value: 'Done'
-                    }
-                ]
-            },
-            uidify('MOVE OK'),
-            parsed,
-            data
-        );
+        connection.send({
+            tag: parsed.tag,
+            command: 'OK',
+            attributes: [
+                {
+                    type: 'TEXT',
+                    value: 'Done'
+                }
+            ]
+        }, uidify('MOVE OK'), parsed, data);
         callback();
     };
-
     // RFC 6851 section 3.1: valid only in the selected state, the second argument is the target mailbox
     // MOVE takes a sequence set of message numbers, UID MOVE of UIDs
     const options = { states: states.SELECTED, mailboxArguments: [1] };
     server.setCommandHandler('MOVE', moveHandler.bind(null, false), Object.assign({ sequenceSet: 0 }, options));
     server.setCommandHandler('UID MOVE', moveHandler.bind(null, true), options);
-};
+}

package/dist/esm/plugins/multiappend.d.ts

@@ -0,0 +1,12 @@
+import type { IMAPServer } from '../types.js';
+/**
+ * @help Adds MULTIAPPEND [RFC3502] capability
+ * @help With UIDPLUS, APPENDUID lists the UIDs of all messages
+ *
+ * MULTIAPPEND: https://www.rfc-editor.org/rfc/rfc3502
+ *
+ * APPEND takes several messages, which are appended all or nothing. A zero-length
+ * message literal cancels the whole APPEND with NO. With UIDPLUS, APPENDUID lists the
+ * UIDs of all appended messages as a UID set.
+ */
+export default function multiappendPlugin(server: IMAPServer): void;

package/{lib → dist/esm}/plugins/multiappend.js

@@ -1,5 +1,3 @@
-'use strict';
-
 /**
  * @help Adds MULTIAPPEND [RFC3502] capability
  * @help With UIDPLUS, APPENDUID lists the UIDs of all messages
@@ -10,10 +8,9 @@
  * message literal cancels the whole APPEND with NO. With UIDPLUS, APPENDUID lists the
  * UIDs of all appended messages as a UID set.
  */
-module.exports = function (server) {
+export default function multiappendPlugin(server) {
     server.registerCapability('MULTIAPPEND');
     server.multiAppend = true;
-
     // RFC 3502 section 6.3.11: "A zero-length message literal argument is an error, and MUST return a NO.
     // This can be used to cancel the append." Nothing is stored when any message fails
     server.appendChecks.push((connection, mailbox, messages, options) => {
@@ -23,4 +20,4 @@ module.exports = function (server) {
         }
         return false;
     });
-};
+}

package/dist/esm/plugins/multisearch.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @help Adds MULTISEARCH [RFC7377] capability, loads ESEARCH as well
+ * @help ESEARCH IN (mailboxes "a" subtree "b" personal ...) RETURN (...) searches several mailboxes, also in the authenticated state
+ */
+import type { IMAPServer } from '../types.js';
+export default function multisearchPlugin(server: IMAPServer): void;

package/{lib → dist/esm}/plugins/multisearch.js

@@ -1,17 +1,13 @@
-'use strict';
-
 /**
  * @help Adds MULTISEARCH [RFC7377] capability, loads ESEARCH as well
  * @help ESEARCH IN (mailboxes "a" subtree "b" personal ...) RETURN (...) searches several mailboxes, also in the authenticated state
  */
-
-const esearch = require('./esearch');
-const { buildEsearchResponse, selectReturned } = require('../esearch');
-const makeSearch = require('../commands/handlers/search');
-const { badError, criteriaValues, sendSearchError } = makeSearch;
-const { states } = require('../command-states');
-const { isAtom, isAstring } = require('../arguments');
-
+import esearch from './esearch.js';
+import { buildEsearchResponse, selectReturned } from '../esearch.js';
+import makeSearch from '../commands/handlers/search.js';
+import { badError, criteriaValues, sendSearchError } from '../commands/handlers/search.js';
+import { states } from '../command-states.js';
+import { isAtom, isAstring } from '../arguments.js';
 // RFC 5465 section 6 filter-mailboxes, as changed by RFC 7377 section 2.2. The value tells if a mailbox name
 // or a list of names follows (one-or-more-mailbox)
 const FILTERS = {
@@ -23,7 +19,6 @@ const FILTERS = {
     'SUBTREE-ONE': true,
     MAILBOXES: true
 };
-
 /**
  * Parses the source options (RFC 7377 section 4): esearch-source-opts = "IN" SP "(" source-mbox [SP "(" scope-options ")"] ")",
  * source-mbox = filter-mailboxes *(SP filter-mailboxes)
@@ -62,43 +57,37 @@ function parseSources(connection, list) {
     }
     return sources;
 }
-
 /**
  * Parses the arguments of ESEARCH (RFC 7377 section 4): esearch = "ESEARCH" [SP esearch-source-opts] [SP search-return-opts] SP search-program
  *
  * @return {Object} `{ sources, attributes }`, sources is null when IN was not used, attributes hold the result options and the search program
  */
 function splitArguments(connection, attributes) {
-    attributes = attributes || [];
-    if (isAtom(attributes[0], 'IN')) {
-        return { sources: parseSources(connection, attributes[1]), attributes: attributes.slice(2) };
+    const args = attributes || [];
+    if (isAtom(args[0], 'IN')) {
+        return { sources: parseSources(connection, args[1]), attributes: args.slice(2) };
     }
-    return { sources: null, attributes };
+    return { sources: null, attributes: args };
 }
-
-module.exports = function (server) {
+export default function multisearchPlugin(server) {
     // RFC 7377 section 2.1: the ESEARCH command answers with ESEARCH responses (RFC 4731)
     esearch(server);
-
     server.registerCapability('MULTISEARCH');
-
-    const isSelectable = mailbox => !!mailbox && mailbox.flags.indexOf('\\Noselect') < 0;
-
+    const isSelectable = (mailbox) => !!mailbox && mailbox.flags.indexOf('\\Noselect') < 0;
     // every mailbox, INBOX first
     const allMailboxes = () => {
         const list = Object.keys(server.folderCache).map(path => server.folderCache[path]);
         return list.sort((a, b) => (a.path === 'INBOX' ? -1 : b.path === 'INBOX' ? 1 : 0));
     };
-
     // a mailbox and the mailboxes below it, `depth` levels down (RFC 7377 section 2.2). Visited
     // mailboxes are not walked again, which also defends against loops in the hierarchy
     const walkSubtree = (mailbox, depth, visit) => {
         if (!visit(mailbox) || !depth || !mailbox.folders) {
             return;
         }
-        Object.keys(mailbox.folders).forEach(name => walkSubtree(mailbox.folders[name], depth - 1, visit));
+        const folders = mailbox.folders;
+        Object.keys(folders).forEach(name => walkSubtree(folders[name], depth - 1, visit));
     };
-
     /**
      * Resolves the source options to the mailboxes to search, in the order they were given. Mailboxes
      * that do not exist, are not selectable or that the user may not search (server.searchAccessChecks, ACL)
@@ -139,12 +128,12 @@ module.exports = function (server) {
                         .forEach(mailbox => add(mailbox, false));
                     break;
                 case 'MAILBOXES':
-                    source.names.forEach(name => add(server.getMailbox(name), true));
+                    source.names.forEach((name) => add(server.getMailbox(name), true));
                     break;
                 default: {
                     const depth = source.filter === 'SUBTREE' ? Infinity : 1;
                     const visited = new Set();
-                    source.names.forEach(name => {
+                    source.names.forEach((name) => {
                         const mailbox = server.getMailbox(name);
                         if (mailbox) {
                             walkSubtree(mailbox, depth, child => {
@@ -163,13 +152,11 @@ module.exports = function (server) {
         });
         return result;
     };
-
     const handler = (connection, parsed, data, callback) => {
         const fail = (status, text) => {
             connection.sendStatus(parsed, data, status, text, false, 'ESEARCH FAILED');
             return callback();
         };
-
         let sources;
         let options = new Map();
         let params;
@@ -185,10 +172,10 @@ module.exports = function (server) {
                 throw badError('ESEARCH expects search criteria');
             }
             params = criteriaValues(attributes);
-        } catch (E) {
+        }
+        catch (E) {
             return fail('BAD', E.message);
         }
-
         const onlySelected = sources.every(source => source.filter === 'SELECTED');
         // RFC 7377 section 2.2: "selected" needs the selected state
         if (sources.some(source => source.filter === 'SELECTED') && !connection.selectedMailbox) {
@@ -202,12 +189,11 @@ module.exports = function (server) {
         if (options.has('UPDATE') && !connection.selectedMailbox) {
             return fail('BAD', 'UPDATE needs a selected mailbox');
         }
-
         const mailboxes = resolveMailboxes(connection, sources);
         const results = [];
         try {
             // the criteria are checked even when no mailbox is searched
-            const searchMailbox = mailbox => {
+            const searchMailbox = (mailbox) => {
                 if (mailbox && mailbox === connection.selectedMailbox) {
                     return makeSearch(connection, connection.getSessionMessages(), params);
                 }
@@ -218,11 +204,11 @@ module.exports = function (server) {
                 searchMailbox(connection.selectedMailbox || null);
             }
             mailboxes.forEach(mailbox => results.push({ mailbox, result: searchMailbox(mailbox) }));
-        } catch (E) {
+        }
+        catch (E) {
             sendSearchError(connection, parsed, data, E, 'ESEARCH FAILED');
             return callback();
         }
-
         const silent = server.isSilentReturn(options);
         results.forEach(({ mailbox, result }) => {
             // RFC 7377 section 2.1: one ESEARCH response per mailbox with matches, always with UIDs and the
@@ -230,15 +216,8 @@ module.exports = function (server) {
             if (!result.list.length || silent) {
                 return;
             }
-            connection.send(
-                buildEsearchResponse(parsed.tag, true, result, options, mailbox),
-                'ESEARCH',
-                parsed,
-                data,
-                Object.assign({}, result, { list: selectReturned(result.list, options) })
-            );
+            connection.send(buildEsearchResponse(parsed.tag, true, result, options, mailbox), 'ESEARCH', parsed, data, Object.assign({}, result, { list: selectReturned(result.list, options) }));
         });
-
         const selected = results.find(entry => entry.mailbox === connection.selectedMailbox);
         if (options.has('SAVE')) {
             // SEARCHRES stores it once the tagged response tells if the command succeeded
@@ -247,16 +226,13 @@ module.exports = function (server) {
         if (options.has('UPDATE') && selected) {
             server.addSearchContext(connection, parsed, data, selected.result, true, selected.mailbox);
         }
-
         connection.sendStatus(parsed, data, 'OK', 'ESEARCH completed', false, 'ESEARCH');
         return callback();
     };
-
     // RFC 7377 section 4: command-auth =/ esearch, command-select =/ esearch
     server.setCommandHandler('ESEARCH', handler, { states: states.AUTHENTICATED, searchCriteria: 0 });
-
     // RFC 3501 section 5.5: sequence numbers can only be in the search program
-    server.connectionHandlers.push(connection => {
+    server.connectionHandlers.push((connection) => {
         // the source options are taken off here, the ESEARCH plugin takes off the result options
         const usesSequenceNumbers = connection.usesSequenceNumbers;
         connection.usesSequenceNumbers = function (parsed) {
@@ -266,4 +242,4 @@ module.exports = function (server) {
             return usesSequenceNumbers.call(this, parsed);
         };
     });
-};
+}

package/dist/esm/plugins/namespace.d.ts

@@ -0,0 +1,5 @@
+import type { IMAPServer } from '../types.js';
+/**
+ * @help Adds NAMESPACE [RFC2342] capability
+ */
+export default function namespacePlugin(server: IMAPServer): void;

package/dist/esm/plugins/namespace.js

@@ -0,0 +1,42 @@
+import { states } from '../command-states.js';
+/**
+ * @help Adds NAMESPACE [RFC2342] capability
+ */
+export default function namespacePlugin(server) {
+    // Register capability, always usable
+    server.registerCapability('NAMESPACE');
+    // Add NAMESPACE command
+    server.setCommandHandler('NAMESPACE', (connection, parsed, data, callback) => {
+        const list = {
+            personal: [],
+            user: [],
+            shared: []
+        };
+        Object.keys(server.storage).forEach(key => {
+            const ns = server.storage[key];
+            // INBOX is a mailbox, not a namespace
+            if (key === 'INBOX' || !ns) {
+                return;
+            }
+            if (Object.hasOwn(list, ns.type)) {
+                list[ns.type].push([connection.exportMailboxName(key), ns.separator]);
+            }
+        });
+        connection.send({
+            tag: '*',
+            command: 'NAMESPACE',
+            attributes: [list.personal.length ? list.personal : null, list.user.length ? list.user : null, list.shared.length ? list.shared : null]
+        }, 'NAMESPACE', parsed, data, list);
+        connection.send({
+            tag: parsed.tag,
+            command: 'OK',
+            attributes: [
+                {
+                    type: 'TEXT',
+                    value: 'Completed'
+                }
+            ]
+        }, 'NAMESPACE', parsed, data, list);
+        return callback();
+    }, { states: states.AUTHENTICATED, noArguments: true });
+}

package/dist/esm/plugins/notify.d.ts

@@ -0,0 +1,2 @@
+import type { IMAPServer } from '../types.js';
+export default function notifyPlugin(server: IMAPServer): void;