imapkit 4.0.2 → 4.1.0

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

@@ -1,30 +1,22 @@
-'use strict';
-
 /**
  * @help Adds SEARCHRES [RFC5182] capability, loads ESEARCH as well
  * @help SEARCH RETURN (SAVE) stores the result, "$" refers to it in place of a sequence set
  */
-
-const esearch = require('./esearch');
-const { selectReturned } = require('../esearch');
-
+import esearch from './esearch.js';
+import { selectReturned } from '../esearch.js';
 // Commands after which the search result variable is empty (RFC 5182 section 2.1). After CLOSE and
 // UNSELECT no mailbox is selected, so "$" can not be used until the next SELECT or EXAMINE anyway
 const RESET_COMMANDS = new Set(['SELECT', 'EXAMINE', 'CLOSE', 'UNSELECT']);
-
 // SAVE also applies to commands based on SEARCH, like SORT (RFC 5182 section 1) with ESORT
 // and to the ESEARCH command of MULTISEARCH, which leaves the messages to save in `parsed.searchresFound`
-const isSearch = command => ['SEARCH', 'UID SEARCH', 'SORT', 'UID SORT', 'ESEARCH'].includes(command);
-
-module.exports = function (server) {
+const isSearch = (command) => ['SEARCH', 'UID SEARCH', 'SORT', 'UID SORT', 'ESEARCH'].includes(command);
+export default function searchresPlugin(server) {
     // a SEARCHRES server MUST also implement ESEARCH (RFC 5182 section 2.1)
     esearch(server);
-
     server.registerCapability('SEARCHRES');
     // SAVE adds no data to the ESEARCH response
     server.searchReturnOptions.set('SAVE', { data: false });
-
-    server.connectionHandlers.push(connection => {
+    server.connectionHandlers.push((connection) => {
         // RFC 5182 section 3: sequence-set =/ seq-last-command, seq-last-command = "$". Dovecot only accepts
         // "$" as the whole sequence set, not combined with numbers like "1,$", and neither does ImapKit
         const getMessageRange = connection.getMessageRange;
@@ -45,38 +37,37 @@ module.exports = function (server) {
             return result;
         };
     });
-
     // RFC 8437 section 4.1: after UNAUTHENTICATE "$" represents the empty set
-    server.resetHandlers.push(connection => {
+    server.resetHandlers.push((connection) => {
         connection.searchResult = null;
     });
-
     server.outputHandlers.push((connection, response, description, parsed, data, extra) => {
         if (!parsed || !response || (response.tag !== parsed.tag && response.command !== 'SEARCH' && response.command !== 'SORT')) {
             return;
         }
         const command = (parsed.command || '').toUpperCase();
         const save = isSearch(command) && parsed.searchReturn && parsed.searchReturn.has('SAVE');
-
         // the result of SEARCH, with MIN and/or MAX only these messages are saved (RFC 5182 section 2.4).
         // It is stored once the tagged response tells if the command succeeded
-        if (save && response.tag === '*' && ['SEARCH', 'SORT'].includes(response.command) && description === command && extra && Array.isArray(extra.list)) {
+        if (save &&
+            response.tag === '*' &&
+            (response.command === 'SEARCH' || response.command === 'SORT') &&
+            description === command &&
+            extra &&
+            Array.isArray(extra.list)) {
             parsed.searchresFound = selectReturned(extra.sorted || extra.list, parsed.searchReturn);
             return;
         }
-
         if (response.tag !== parsed.tag) {
             return;
         }
-
         if (RESET_COMMANDS.has(command)) {
             connection.searchResult = null;
             return;
         }
-
         // RFC 5182 section 2.1: an OK sets the variable, a NO empties it and a BAD leaves it as it was
         if (save && response.command !== 'BAD') {
             connection.searchResult = new Set(response.command === 'OK' ? parsed.searchresFound : []);
         }
     });
-};
+}

package/dist/esm/plugins/sort-display.d.ts

@@ -0,0 +1,11 @@
+import type { IMAPServer } from '../types.js';
+/**
+ * @help Adds SORT=DISPLAY [RFC5957] capability, also loads SORT
+ *
+ * SORT=DISPLAY: https://tools.ietf.org/html/rfc5957
+ *
+ * Additional sort keys for SORT and UID SORT:
+ * - DISPLAYFROM
+ * - DISPLAYTO
+ */
+export default function sortDisplayPlugin(server: IMAPServer): void;

package/{lib → dist/esm}/plugins/sort-display.js

@@ -1,8 +1,5 @@
-'use strict';
-
-const { collationKey, displayAddress } = require('../sorting');
-const sort = require('./sort');
-
+import { collationKey, displayAddress } from '../sorting.js';
+import sort from './sort.js';
 /**
  * @help Adds SORT=DISPLAY [RFC5957] capability, also loads SORT
  *
@@ -12,12 +9,11 @@ const sort = require('./sort');
  * - DISPLAYFROM
  * - DISPLAYTO
  */
-module.exports = function (server) {
+export default function sortDisplayPlugin(server) {
     // RFC 5957 section 1: SORT=DISPLAY means the full SORT extension plus both sort keys
     sort(server);
     server.registerCapability('SORT=DISPLAY');
-
     // RFC 5957 section 4: the DISPLAY sort value of the first address of env-from and env-to
-    server.sortKeys.DISPLAYFROM = message => collationKey(displayAddress(message, 'from'));
-    server.sortKeys.DISPLAYTO = message => collationKey(displayAddress(message, 'to'));
-};
+    server.sortKeys.DISPLAYFROM = (message) => collationKey(displayAddress(message, 'from'));
+    server.sortKeys.DISPLAYTO = (message) => collationKey(displayAddress(message, 'to'));
+}

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

@@ -0,0 +1,11 @@
+import type { IMAPServer } from '../types.js';
+/**
+ * @help Adds SORT [RFC5256] capability
+ *
+ * SORT: https://tools.ietf.org/html/rfc5256
+ *
+ * Additional commands:
+ * - SORT
+ * - UID SORT
+ */
+export default function sortPlugin(server: IMAPServer): void;

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

@@ -1,9 +1,6 @@
-'use strict';
-
-const { states } = require('../command-states');
-const { getMessageData } = require('../mimeparser');
-const { collationKey, baseSubject, arrivalTime, sentTime, addressMailbox, searchMessages } = require('../sorting');
-
+import { states } from '../command-states.js';
+import { getMessageData } from '../mimeparser.js';
+import { collationKey, baseSubject, arrivalTime, sentTime, addressMailbox, searchMessages } from '../sorting.js';
 /**
  * @help Adds SORT [RFC5256] capability
  *
@@ -13,28 +10,24 @@ const { collationKey, baseSubject, arrivalTime, sentTime, addressMailbox, search
  * - SORT
  * - UID SORT
  */
-module.exports = function (server) {
+export default function sortPlugin(server) {
     if (server.sortKeys) {
         // already loaded, e.g. by the SORT=DISPLAY plugin
         return;
     }
-
     server.registerCapability('SORT');
-
     // RFC 5256 section 3: sort keys and the value of a message for each. A value is a number or the
     // collation key of a string, see sorting.collationKey. SORT=DISPLAY adds its keys here
     server.sortKeys = {
-        ARRIVAL: message => arrivalTime(message),
-        CC: message => collationKey(addressMailbox(message, 'cc')),
-        DATE: message => sentTime(message),
-        FROM: message => collationKey(addressMailbox(message, 'from')),
-        SIZE: message => getMessageData(message).raw.length,
-        SUBJECT: message => collationKey(baseSubject(getMessageData(message).tree.parsedHeader.subject).subject),
-        TO: message => collationKey(addressMailbox(message, 'to'))
+        ARRIVAL: (message) => arrivalTime(message),
+        CC: (message) => collationKey(addressMailbox(message, 'cc')),
+        DATE: (message) => sentTime(message),
+        FROM: (message) => collationKey(addressMailbox(message, 'from')),
+        SIZE: (message) => getMessageData(message).raw.length,
+        SUBJECT: (message) => collationKey(baseSubject(getMessageData(message).tree.parsedHeader.subject).subject),
+        TO: (message) => collationKey(addressMailbox(message, 'to'))
     };
-
     const compareValues = (a, b) => (Buffer.isBuffer(a) ? Buffer.compare(a, b) : a - b);
-
     /**
      * Returns a comparator of messages for parsed sort criteria: ascending order, REVERSE turns one
      * criterion around, and mailbox order (the sequence number) breaks ties (RFC 5256 section 3).
@@ -43,14 +36,11 @@ module.exports = function (server) {
      * @param {Array} criteria List of `{ key, reverse }`
      * @return {Function} comparator for two messages of the same mailbox
      */
-    server.sortComparator = criteria => {
+    server.sortComparator = (criteria) => {
         const cache = new WeakMap();
-        const getValues = message => {
+        const getValues = (message) => {
             if (!cache.has(message)) {
-                cache.set(
-                    message,
-                    criteria.map(criterion => server.sortKeys[criterion.key](message))
-                );
+                cache.set(message, criteria.map((criterion) => server.sortKeys[criterion.key](message)));
             }
             return cache.get(message);
         };
@@ -67,16 +57,13 @@ module.exports = function (server) {
             return a.uid - b.uid;
         };
     };
-
     const sortHandler = (isUid, connection, parsed, data, callback) => {
         const command = isUid ? 'UID SORT' : 'SORT';
         const attributes = parsed.attributes || [];
-
-        const fail = text => {
+        const fail = (text) => {
             connection.sendStatus(parsed, data, 'BAD', text, false, command + ' FAILED');
             return callback();
         };
-
         // RFC 5256 section 5: sort-criteria = "(" sort-criterion *(SP sort-criterion) ")",
         // sort-criterion = ["REVERSE" SP] sort-key
         if (!Array.isArray(attributes[0]) || !attributes[0].length) {
@@ -99,34 +86,25 @@ module.exports = function (server) {
         if (reverse) {
             return fail('REVERSE must be followed by a sort key');
         }
-
         const result = searchMessages(connection, parsed, data, attributes.slice(1));
         if (!result) {
             return callback();
         }
-
         const compare = server.sortComparator(criteria);
         const sorted = result.list.slice().sort(compare);
-
-        connection.send(
-            {
-                tag: '*',
-                command: 'SORT',
-                attributes: sorted.map(message => (isUid ? message.uid : result.numbers[message.uid]))
-            },
-            command,
-            parsed,
-            data,
-            // the search result, for CONDSTORE to append the highest mod-sequence (RFC 7162 section 3.1.9), with the
-            // sorted messages and the comparator for ESORT and CONTEXT=SORT
-            Object.assign(result, { sorted, compare })
-        );
+        connection.send({
+            tag: '*',
+            command: 'SORT',
+            attributes: sorted.map(message => (isUid ? message.uid : result.numbers[message.uid]))
+        }, command, parsed, data, 
+        // the search result, for CONDSTORE to append the highest mod-sequence (RFC 7162 section 3.1.9), with the
+        // sorted messages and the comparator for ESORT and CONTEXT=SORT
+        Object.assign(result, { sorted, compare }));
         connection.sendStatus(parsed, data, 'OK', command + ' completed', false, command);
         return callback();
     };
-
     // RFC 5256 section 3: EXPUNGE responses are not permitted while responding to SORT, but are during UID SORT.
     // The search criteria start after the sort criteria and the charset
     server.setCommandHandler('SORT', sortHandler.bind(null, false), { states: states.SELECTED, searchCriteria: 2, noExpunge: true });
     server.setCommandHandler('UID SORT', sortHandler.bind(null, true), { states: states.SELECTED, searchCriteria: 2 });
-};
+}

package/dist/esm/plugins/special-use.d.ts

@@ -0,0 +1,10 @@
+import type { IMAPServer } from '../types.js';
+/**
+ * @help Enables SPECIAL-USE [RFC6154] capability
+ * @help Mailboxes need to have a "special-use"
+ * @help property (String or Array) that will be used
+ * @help as extra flag for LIST and LSUB responses.
+ * @help With LIST-EXTENDED the SPECIAL-USE selection and
+ * @help return options work with the other LIST options
+ */
+export default function specialUsePlugin(server: IMAPServer): void;

package/{lib → dist/esm}/plugins/special-use.js

@@ -1,7 +1,4 @@
-'use strict';
-
-const { getListExtensions } = require('../list-extensions');
-
+import { getListExtensions } from '../list-extensions.js';
 /**
  * @help Enables SPECIAL-USE [RFC6154] capability
  * @help Mailboxes need to have a "special-use"
@@ -10,32 +7,26 @@ const { getListExtensions } = require('../list-extensions');
  * @help With LIST-EXTENDED the SPECIAL-USE selection and
  * @help return options work with the other LIST options
  */
-
-module.exports = function (server) {
+export default function specialUsePlugin(server) {
     // Register capability
     server.registerCapability('SPECIAL-USE');
-
-    const getSpecialUse = folder => [].concat((folder && folder['special-use']) || []);
-
+    const getSpecialUse = (folder) => [].concat((folder && folder['special-use']) || []);
     // RFC 6154 section 2: with LIST-EXTENDED, SPECIAL-USE is a list-select-independent-opt that
     // implies the SPECIAL-USE return option. The LIST-EXTENDED plugin may be loaded before or after this one
     const listExtensions = getListExtensions(server);
     listExtensions.selectionOptions['SPECIAL-USE'] = {
         type: 'independent',
         returnOption: 'SPECIAL-USE',
-        match: folder => folder.flags.indexOf('\\Noselect') < 0 && getSpecialUse(folder).length > 0
+        match: (folder) => folder.flags.indexOf('\\Noselect') < 0 && getSpecialUse(folder).length > 0
     };
     // special-use attributes are always included, so the return option needs no extra handling
     listExtensions.returnOptions['SPECIAL-USE'] = {};
-
     const listHandler = server.getCommandHandler('LIST');
-
     server.setCommandHandler('LIST', (connection, parsed, data, callback) => {
         if (listExtensions.enabled) {
             // LIST-EXTENDED handles the options
             return listHandler(connection, parsed, data, callback);
         }
-
         // without LIST-EXTENDED only the SPECIAL-USE options are understood
         let i;
         if (parsed.attributes && Array.isArray(parsed.attributes[0])) {
@@ -50,30 +41,24 @@ module.exports = function (server) {
                 parsed.attributes.splice(0, 1);
             }
         }
-
-        if (
-            parsed.attributes &&
+        if (parsed.attributes &&
             parsed.attributes[2] &&
             parsed.attributes[2].type === 'ATOM' &&
             parsed.attributes[2].value.toUpperCase() === 'RETURN' &&
-            Array.isArray(parsed.attributes[3])
-        ) {
+            Array.isArray(parsed.attributes[3])) {
             for (i = parsed.attributes[3].length - 1; i >= 0; i--) {
                 if (parsed.attributes[3][i] && parsed.attributes[3][i].type === 'ATOM' && parsed.attributes[3][i].value.toUpperCase() === 'SPECIAL-USE') {
                     // special-use attributes are always included, so the return option needs no extra handling
                     parsed.attributes[3].splice(i, 1);
                 }
             }
-
             // Remove RETURN (List) if no members were left
             if (!parsed.attributes[3].length) {
                 parsed.attributes.splice(2, 2);
             }
         }
-
         listHandler(connection, parsed, data, callback);
     });
-
     server.outputHandlers.push((connection, response, description, parsed, data, folder) => {
         const specialUseList = getSpecialUse(folder).map(specialUse => {
             return {
@@ -81,15 +66,15 @@ module.exports = function (server) {
                 value: specialUse
             };
         });
-
         if ((description === 'LIST ITEM' || description === 'LSUB ITEM') && folder && response.attributes && Array.isArray(response.attributes[0])) {
             if (specialUseList.length) {
                 // special-use attributes are added to the other mailbox attributes, also with RETURN (SPECIAL-USE)
                 response.attributes[0] = response.attributes[0].concat(specialUseList);
-            } else if (parsed.listSpecialUseOnly) {
+            }
+            else if (parsed.listSpecialUseOnly) {
                 // Do not show this response
                 response.skipResponse = true;
             }
         }
     });
-};
+}

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

@@ -0,0 +1,5 @@
+import type { IMAPServer } from '../types.js';
+/**
+ * @help Adds STARTTLS command
+ */
+export default function starttlsPlugin(server: IMAPServer): void;

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

@@ -1,57 +1,40 @@
-'use strict';
-
 /**
  * @help Adds STARTTLS command
  */
-
-module.exports = function (server) {
+export default function starttlsPlugin(server) {
     // Register capability, usable with unsecure connection
-    server.registerCapability('STARTTLS', connection => {
+    server.registerCapability('STARTTLS', (connection) => {
         return !connection.secureConnection;
     });
-
     // Add STARTTLS command
     server.setCommandHandler('STARTTLS', (connection, parsed, data, callback) => {
         // only works in insecure setting
         if (connection.secureConnection) {
             return sendError('Connection is already secured', connection, parsed, data, callback);
         }
-
-        connection.send(
-            {
-                tag: parsed.tag,
-                command: 'OK',
-                attributes: [
-                    {
-                        type: 'TEXT',
-                        value: 'Server ready to start TLS negotiation'
-                    }
-                ]
-            },
-            'STARTTLS INIT',
-            parsed,
-            data
-        );
-
-        connection.upgradeConnection(callback);
-    });
-};
-
-function sendError(message, connection, parsed, data, callback) {
-    connection.send(
-        {
+        connection.send({
             tag: parsed.tag,
-            command: 'BAD',
+            command: 'OK',
             attributes: [
                 {
                     type: 'TEXT',
-                    value: message
+                    value: 'Server ready to start TLS negotiation'
                 }
             ]
-        },
-        'INVALID COMMAND',
-        parsed,
-        data
-    );
+        }, 'STARTTLS INIT', parsed, data);
+        connection.upgradeConnection(callback);
+    });
+}
+function sendError(message, connection, parsed, data, callback) {
+    connection.send({
+        tag: parsed.tag,
+        command: 'BAD',
+        attributes: [
+            {
+                type: 'TEXT',
+                value: message
+            }
+        ]
+    }, 'INVALID COMMAND', parsed, data);
     return callback();
 }

package/dist/esm/plugins/status-size.d.ts

@@ -0,0 +1,7 @@
+import type { IMAPServer } from '../types.js';
+/**
+ * @help Adds STATUS=SIZE [RFC8438] capability. The SIZE status item
+ * @help is the sum of the RFC822.SIZE values of the messages, it can
+ * @help also be used with LIST-STATUS
+ */
+export default function statusSizePlugin(server: IMAPServer): void;

package/{lib → dist/esm}/plugins/status-size.js

@@ -1,19 +1,12 @@
-'use strict';
-
-const fetchHandlers = require('../commands/handlers/fetch');
-
+import fetchHandlers from '../commands/handlers/fetch.js';
 /**
  * @help Adds STATUS=SIZE [RFC8438] capability. The SIZE status item
  * @help is the sum of the RFC822.SIZE values of the messages, it can
  * @help also be used with LIST-STATUS
  */
-
-module.exports = function (server) {
+export default function statusSizePlugin(server) {
     server.registerCapability('STATUS=SIZE');
-
     server.allowedStatus.push('SIZE');
-
     // RFC 8438 section 3: at least the sum of the RFC822.SIZE values of all messages in the mailbox
-    server.statusHandlers.SIZE = (connection, mailbox) =>
-        mailbox.messages.reduce((size, message) => size + fetchHandlers['RFC822.SIZE'](connection, message), 0);
-};
+    server.statusHandlers.SIZE = (connection, mailbox) => mailbox.messages.reduce((size, message) => size + fetchHandlers['RFC822.SIZE'](connection, message), 0);
+}

package/dist/esm/plugins/thread-orderedsubject.d.ts

@@ -0,0 +1,11 @@
+import type { IMAPServer } from '../types.js';
+/**
+ * @help Adds THREAD=ORDEREDSUBJECT [RFC5256] capability
+ *
+ * THREAD: https://tools.ietf.org/html/rfc5256
+ *
+ * Additional commands:
+ * - THREAD ORDEREDSUBJECT
+ * - UID THREAD ORDEREDSUBJECT
+ */
+export default function threadOrderedsubjectPlugin(server: IMAPServer): void;

package/{lib → dist/esm}/plugins/thread-orderedsubject.js

@@ -1,7 +1,4 @@
-'use strict';
-
-const { addThreadAlgorithm } = require('../threading');
-
+import { addThreadAlgorithm } from '../threading.js';
 /**
  * @help Adds THREAD=ORDEREDSUBJECT [RFC5256] capability
  *
@@ -11,6 +8,6 @@ const { addThreadAlgorithm } = require('../threading');
  * - THREAD ORDEREDSUBJECT
  * - UID THREAD ORDEREDSUBJECT
  */
-module.exports = function (server) {
+export default function threadOrderedsubjectPlugin(server) {
     addThreadAlgorithm(server, 'ORDEREDSUBJECT');
-};
+}

package/dist/esm/plugins/thread-references.d.ts

@@ -0,0 +1,11 @@
+import type { IMAPServer } from '../types.js';
+/**
+ * @help Adds THREAD=REFERENCES [RFC5256] capability
+ *
+ * THREAD: https://tools.ietf.org/html/rfc5256
+ *
+ * Additional commands:
+ * - THREAD REFERENCES
+ * - UID THREAD REFERENCES
+ */
+export default function threadReferencesPlugin(server: IMAPServer): void;

package/{lib → dist/esm}/plugins/thread-references.js

@@ -1,7 +1,4 @@
-'use strict';
-
-const { addThreadAlgorithm } = require('../threading');
-
+import { addThreadAlgorithm } from '../threading.js';
 /**
  * @help Adds THREAD=REFERENCES [RFC5256] capability
  *
@@ -11,6 +8,6 @@ const { addThreadAlgorithm } = require('../threading');
  * - THREAD REFERENCES
  * - UID THREAD REFERENCES
  */
-module.exports = function (server) {
+export default function threadReferencesPlugin(server) {
     addThreadAlgorithm(server, 'REFERENCES');
-};
+}

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

@@ -0,0 +1,15 @@
+import type { IMAPServer } from '../types.js';
+/**
+ * @help Adds UIDONLY [RFC9586] capability, loads ENABLE as well
+ * @help After ENABLE UIDONLY: FETCH, STORE, SEARCH, COPY, MOVE, SORT, THREAD, REPLACE and
+ * @help message numbers in UID SEARCH (SORT, THREAD) criteria are refused with BAD [UIDREQUIRED],
+ * @help UIDFETCH responses replace FETCH responses and VANISHED replaces EXPUNGE.
+ * @help Load UIDPLUS for COPYUID and UID EXPUNGE
+ *
+ * UIDONLY: https://www.rfc-editor.org/rfc/rfc9586
+ */
+declare function uidonlyPlugin(server: IMAPServer): void;
+declare namespace uidonlyPlugin {
+    var requires: string[];
+}
+export default uidonlyPlugin;