imapkit 4.0.3 → 4.1.0

package/dist/esm/plugins/index.js

@@ -0,0 +1,113 @@
+// Built-in plugins by name (the file name without extension), see load-plugins.ts
+import aclPlugin from './acl.js';
+import appendlimitPlugin from './appendlimit.js';
+import authPlainPlugin from './auth-plain.js';
+import binaryPlugin from './binary.js';
+import catenatePlugin from './catenate.js';
+import compressPlugin from './compress.js';
+import condstorePlugin from './condstore.js';
+import contextSearchPlugin from './context-search.js';
+import contextSortPlugin from './context-sort.js';
+import createSpecialUsePlugin from './create-special-use.js';
+import enablePlugin from './enable.js';
+import esearchPlugin from './esearch.js';
+import esortPlugin from './esort.js';
+import idPlugin from './id.js';
+import idlePlugin from './idle.js';
+import imap4rev2Plugin from './imap4rev2.js';
+import listExtendedPlugin from './list-extended.js';
+import listStatusPlugin from './list-status.js';
+import literalminusPlugin from './literalminus.js';
+import literalplusPlugin from './literalplus.js';
+import logindisabledPlugin from './logindisabled.js';
+import messagelimitPlugin from './messagelimit.js';
+import metadataPlugin from './metadata.js';
+import metadataServerPlugin from './metadata-server.js';
+import movePlugin from './move.js';
+import multiappendPlugin from './multiappend.js';
+import multisearchPlugin from './multisearch.js';
+import namespacePlugin from './namespace.js';
+import notifyPlugin from './notify.js';
+import oauthbearerPlugin from './oauthbearer.js';
+import objectidPlugin from './objectid.js';
+import partialPlugin from './partial.js';
+import previewPlugin from './preview.js';
+import qresyncPlugin from './qresync.js';
+import quotaPlugin from './quota.js';
+import replacePlugin from './replace.js';
+import saslIrPlugin from './sasl-ir.js';
+import savedatePlugin from './savedate.js';
+import savelimitPlugin from './savelimit.js';
+import searchresPlugin from './searchres.js';
+import sortPlugin from './sort.js';
+import sortDisplayPlugin from './sort-display.js';
+import specialUsePlugin from './special-use.js';
+import starttlsPlugin from './starttls.js';
+import statusSizePlugin from './status-size.js';
+import threadOrderedsubjectPlugin from './thread-orderedsubject.js';
+import threadReferencesPlugin from './thread-references.js';
+import uidonlyPlugin from './uidonly.js';
+import uidplusPlugin from './uidplus.js';
+import unauthenticatePlugin from './unauthenticate.js';
+import unselectPlugin from './unselect.js';
+import utf8AcceptPlugin from './utf8-accept.js';
+import xGmExt1Plugin from './x-gm-ext-1.js';
+import xoauth2Plugin from './xoauth2.js';
+import xtoybirdPlugin from './xtoybird.js';
+export const plugins = {
+    acl: aclPlugin,
+    appendlimit: appendlimitPlugin,
+    'auth-plain': authPlainPlugin,
+    binary: binaryPlugin,
+    catenate: catenatePlugin,
+    compress: compressPlugin,
+    condstore: condstorePlugin,
+    'context-search': contextSearchPlugin,
+    'context-sort': contextSortPlugin,
+    'create-special-use': createSpecialUsePlugin,
+    enable: enablePlugin,
+    esearch: esearchPlugin,
+    esort: esortPlugin,
+    id: idPlugin,
+    idle: idlePlugin,
+    imap4rev2: imap4rev2Plugin,
+    'list-extended': listExtendedPlugin,
+    'list-status': listStatusPlugin,
+    literalminus: literalminusPlugin,
+    literalplus: literalplusPlugin,
+    logindisabled: logindisabledPlugin,
+    messagelimit: messagelimitPlugin,
+    metadata: metadataPlugin,
+    'metadata-server': metadataServerPlugin,
+    move: movePlugin,
+    multiappend: multiappendPlugin,
+    multisearch: multisearchPlugin,
+    namespace: namespacePlugin,
+    notify: notifyPlugin,
+    oauthbearer: oauthbearerPlugin,
+    objectid: objectidPlugin,
+    partial: partialPlugin,
+    preview: previewPlugin,
+    qresync: qresyncPlugin,
+    quota: quotaPlugin,
+    replace: replacePlugin,
+    'sasl-ir': saslIrPlugin,
+    savedate: savedatePlugin,
+    savelimit: savelimitPlugin,
+    searchres: searchresPlugin,
+    sort: sortPlugin,
+    'sort-display': sortDisplayPlugin,
+    'special-use': specialUsePlugin,
+    starttls: starttlsPlugin,
+    'status-size': statusSizePlugin,
+    'thread-orderedsubject': threadOrderedsubjectPlugin,
+    'thread-references': threadReferencesPlugin,
+    uidonly: uidonlyPlugin,
+    uidplus: uidplusPlugin,
+    unauthenticate: unauthenticatePlugin,
+    unselect: unselectPlugin,
+    'utf8-accept': utf8AcceptPlugin,
+    'x-gm-ext-1': xGmExt1Plugin,
+    xoauth2: xoauth2Plugin,
+    xtoybird: xtoybirdPlugin
+};

package/dist/esm/plugins/list-extended.d.ts

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

package/{lib → dist/esm}/plugins/list-extended.js

@@ -1,17 +1,12 @@
-'use strict';
-
-const { isDeepStrictEqual } = require('util');
-const { getListExtensions } = require('../list-extensions');
-
+import { isDeepStrictEqual } from 'node:util';
+import { getListExtensions } from '../list-extensions.js';
 /**
  * @help Adds LIST-EXTENDED [RFC5258] capability: selection options
  * @help SUBSCRIBED, REMOTE and RECURSIVEMATCH, return options SUBSCRIBED
  * @help and CHILDREN, multiple mailbox patterns and CHILDINFO.
  * @help \Noselect mailboxes are listed as \NonExistent
  */
-
-const { isAstring } = require('../arguments');
-
+import { isAstring } from '../arguments.js';
 /**
  * Checks if a LIST command uses the extended syntax (RFC 5258 section 1): selection options before
  * the reference, a list of patterns, or more than 2 arguments (return options)
@@ -19,32 +14,27 @@ const { isAstring } = require('../arguments');
  * @param {Array} args Command arguments
  * @return {Boolean} true for an extended LIST command
  */
-const isExtended = args => Array.isArray(args[0]) || Array.isArray(args[1]) || args.length > 2;
-
-module.exports = function (server) {
+const isExtended = (args) => Array.isArray(args[0]) || Array.isArray(args[1]) || args.length > 2;
+export default function listExtendedPlugin(server) {
     const extensions = getListExtensions(server);
     if (extensions.enabled) {
         // already loaded by LIST-STATUS
         return;
     }
     extensions.enabled = true;
-
     server.registerCapability('LIST-EXTENDED');
-
     // RFC 5258 section 3.1. There are no remote mailboxes, so REMOTE changes nothing
     extensions.selectionOptions.SUBSCRIBED = {
         type: 'base',
         returnOption: 'SUBSCRIBED',
         includeNonExistent: true,
-        match: folder => !!folder.subscribed
+        match: (folder) => !!folder.subscribed
     };
     extensions.selectionOptions.REMOTE = { type: 'independent' };
     extensions.selectionOptions.RECURSIVEMATCH = { type: 'modifier' };
-
     // RFC 5258 section 3.2. Children attributes are always returned, so CHILDREN needs no handling
     extensions.returnOptions.SUBSCRIBED = {};
     extensions.returnOptions.CHILDREN = {};
-
     /**
      * Parses selection or return options (RFC 5258 section 6, option-extension = tag [SP option-value])
      *
@@ -62,22 +52,22 @@ module.exports = function (server) {
                 throw new Error('Invalid ' + kind + ' option');
             }
             const name = item.value.toUpperCase();
+            // only return options take a value (parse)
             const option = registry[name];
             if (!option) {
                 // RFC 5258 section 3: "A server MUST respond to options it does not recognize with a BAD response"
                 throw new Error('Unknown ' + kind + ' option ' + name);
             }
-
             let value = true;
             if (option.parse) {
                 if (!Array.isArray(list[i + 1])) {
                     throw new Error(name + ' ' + kind + ' option requires a value');
                 }
                 value = option.parse(list[++i], connection);
-            } else if (Array.isArray(list[i + 1])) {
+            }
+            else if (Array.isArray(list[i + 1])) {
                 throw new Error(name + ' ' + kind + ' option takes no value');
             }
-
             // RFC 5258 section 3: a repeated option counts once, so it can not have different values
             if (options.has(name) && !isDeepStrictEqual(options.get(name), value)) {
                 throw new Error(name + ' ' + kind + ' option is repeated with a different value');
@@ -86,7 +76,6 @@ module.exports = function (server) {
         }
         return options;
     };
-
     /**
      * Parses the arguments of an extended LIST command:
      * list = "LIST" [SP list-select-opts] SP mailbox SP mbox-or-pat [SP list-return-opts]
@@ -99,26 +88,21 @@ module.exports = function (server) {
         let selection = new Map();
         let returns = new Map();
         let pos = 0;
-
         if (Array.isArray(args[0])) {
             selection = parseOptions(args[0], extensions.selectionOptions, 'selection', connection);
             pos++;
         }
-
         const reference = args[pos];
         let patterns = args[pos + 1];
         const rest = args.slice(pos + 2);
-
         if (!isAstring(reference)) {
             throw new Error('LIST expects a reference name');
         }
-
         // patterns = "(" list-mailbox *(SP list-mailbox) ")"
         patterns = Array.isArray(patterns) ? patterns : [patterns];
         if (!patterns.length || !patterns.every(isAstring)) {
             throw new Error('LIST expects a mailbox pattern or a list of patterns');
         }
-
         // list-return-opts = "RETURN" SP "(" [return-option *(SP return-option)] ")"
         if (rest.length) {
             if (rest.length !== 2 || !rest[0] || rest[0].type !== 'ATOM' || rest[0].value.toUpperCase() !== 'RETURN' || !Array.isArray(rest[1])) {
@@ -126,13 +110,11 @@ module.exports = function (server) {
             }
             returns = parseOptions(rest[1], extensions.returnOptions, 'return', connection);
         }
-
         // RFC 5258 section 3.1: RECURSIVEMATCH (any list-select-mod-opt) needs a list-select-base-opt
         const types = [...selection.keys()].map(name => extensions.selectionOptions[name].type);
         if (types.includes('modifier') && !types.includes('base')) {
             throw new Error('RECURSIVEMATCH must be used together with a selection option like SUBSCRIBED');
         }
-
         // a selection option implies its return option, eg. SUBSCRIBED
         selection.forEach((value, name) => {
             const implied = extensions.selectionOptions[name].returnOption;
@@ -140,73 +122,64 @@ module.exports = function (server) {
                 returns.set(implied, true);
             }
         });
-
         return {
             selection,
             reference: reference.value,
             // RFC 5258 section 3: an empty pattern is ignored in an extended LIST command
-            patterns: patterns.map(pattern => pattern.value).filter(pattern => pattern),
+            patterns: patterns.map(pattern => pattern.value).filter((pattern) => pattern),
             returns
         };
     };
-
-    const exists = folder => folder.flags.indexOf('\\Noselect') < 0;
-
+    const exists = (folder) => folder.flags.indexOf('\\Noselect') < 0;
     /**
      * Mailbox attributes for an extended LIST response. \NonExistent replaces \Noselect (RFC 5258
      * section 3, \NonExistent implies \Noselect), children attributes are computed (RFC 5258 section 4),
      * \Subscribed is only listed with the SUBSCRIBED return option (RFC 5258 section 3.2)
      */
-    const getAttributes = (folder, isExisting, hasChildren, returns) =>
-        server
-            .listAttributes(folder, { exists: isExisting, subscribed: returns.has('SUBSCRIBED') && folder.subscribed, hasChildren })
-            .map(flag => ({ type: 'ATOM', value: flag }));
-
+    const getAttributes = (folder, isExisting, hasChildren, returns) => server
+        .listAttributes(folder, { exists: isExisting, subscribed: returns.has('SUBSCRIBED') && folder.subscribed, hasChildren })
+        .map(flag => ({ type: 'ATOM', value: flag }));
     const listHandler = server.getCommandHandler('LIST');
-
     server.setCommandHandler('LIST', (connection, parsed, data, callback) => {
         const args = parsed.attributes || [];
         if (!isExtended(args)) {
             // RFC 3501 LIST
             return listHandler(connection, parsed, data, callback);
         }
-
         let request;
         try {
             request = parseArguments(args, connection);
-        } catch (err) {
+        }
+        catch (err) {
             connection.sendStatus(parsed, data, 'BAD', err.message, false, 'INVALID COMMAND');
             return callback();
         }
-
         const selection = [...request.selection.keys()].map(name => ({ name, ...extensions.selectionOptions[name] }));
         const filters = selection.filter(option => option.match);
         const includeNonExistent = selection.some(option => option.includeNonExistent);
         const recursive = request.selection.has('RECURSIVEMATCH');
         // RFC 5258 section 6: CHILDINFO lists the list-select-base-opt options, always quoted
         const childInfo = selection.filter(option => option.type === 'base').map(option => ({ type: 'STRING', value: option.name }));
-
         // does a mailbox satisfy the selection criteria. Without options that means an existing mailbox
-        const matches = folder => (includeNonExistent || exists(folder)) && filters.every(option => option.match(folder, connection));
-
+        // the match functions also get the subscribed names that are not mailboxes
+        const matches = (folder) => (includeNonExistent || exists(folder)) && filters.every(option => option.match(folder, connection));
         // RFC 5258 section 3.1: SUBSCRIBED lists subscribed names, also the ones that are not mailboxes
         let folders = server.folderCache;
         if (includeNonExistent) {
             folders = Object.assign(Object.create(null), folders, server.getSubscriptionTree());
         }
-
         // RFC 5258 section 3: a mailbox that matches several patterns is listed once
         const candidates = new Set();
-        request.patterns.forEach(pattern => {
-            server.matchFolders(request.reference, pattern, path => connection.exportMailboxName(path), folders).forEach(folder => candidates.add(folder));
+        request.patterns.forEach((pattern) => {
+            server
+                .matchFolders(request.reference, pattern, (path) => connection.exportMailboxName(path), folders)
+                .forEach(folder => candidates.add(folder));
         });
-
         candidates.forEach(folder => {
             const isExisting = exists(folder);
             const isMatch = matches(folder);
             const descendants = server.getDescendants(folder.path, folders);
             const hasChildren = descendants.some(exists);
-
             let hasChildInfo = false;
             if (recursive) {
                 // RFC 5258 section 3.5: a matching mailbox gets CHILDINFO if a descendant matches as well.
@@ -214,14 +187,12 @@ module.exports = function (server) {
                 // listed itself (redundant CHILDINFO SHOULD be suppressed)
                 hasChildInfo = descendants.some(descendant => matches(descendant) && (isMatch || !candidates.has(descendant)));
             }
-
             // RFC 5258 section 3.5: without selection filters a mailbox that does not exist but has
             // existing descendants is listed as "\NonExistent \HasChildren"
             const listed = isMatch || hasChildInfo || (!filters.length && !isExisting && hasChildren);
             if (!listed) {
                 return;
             }
-
             const attributes = [
                 getAttributes(folder, isExisting, hasChildren, request.returns),
                 server.getSeparator(folder),
@@ -231,19 +202,11 @@ module.exports = function (server) {
                 // mbox-list-extended = "(" mbox-list-extended-item *(SP mbox-list-extended-item) ")"
                 attributes.push([{ type: 'STRING', value: 'CHILDINFO' }, childInfo]);
             }
-
-            connection.send(
-                {
-                    tag: '*',
-                    command: 'LIST',
-                    attributes
-                },
-                'LIST ITEM',
-                parsed,
-                data,
-                folder
-            );
-
+            connection.send({
+                tag: '*',
+                command: 'LIST',
+                attributes
+            }, 'LIST ITEM', parsed, data, folder);
             request.returns.forEach((value, name) => {
                 const option = extensions.returnOptions[name];
                 if (option.onItem) {
@@ -251,8 +214,7 @@ module.exports = function (server) {
                 }
             });
         });
-
         connection.sendStatus(parsed, data, 'OK', 'Completed', false, 'LIST');
         return callback();
     });
-};
+}

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

@@ -0,0 +1,6 @@
+import type { IMAPServer } from '../types.js';
+/**
+ * @help Adds LIST-STATUS [RFC5819] capability, the STATUS return option
+ * @help of LIST. Loads LIST-EXTENDED as well
+ */
+export default function listStatusPlugin(server: IMAPServer): void;

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

@@ -1,24 +1,17 @@
-'use strict';
-
-const { getListExtensions } = require('../list-extensions');
-const { parseStatusItems, sendStatus } = require('../commands/handlers/status');
-const listExtended = require('./list-extended');
-
+import { getListExtensions } from '../list-extensions.js';
+import { parseStatusItems, sendStatus } from '../commands/handlers/status.js';
+import listExtended from './list-extended.js';
 /**
  * @help Adds LIST-STATUS [RFC5819] capability, the STATUS return option
  * @help of LIST. Loads LIST-EXTENDED as well
  */
-
-module.exports = function (server) {
+export default function listStatusPlugin(server) {
     // the STATUS return option needs the extended LIST syntax (RFC 5819 section 4)
     listExtended(server);
-
     server.registerCapability('LIST-STATUS');
-
     // status-option = "STATUS" SP "(" status-att *(SP status-att) ")"
     getListExtensions(server).returnOptions.STATUS = {
         parse: (list, connection) => parseStatusItems(server, list, connection),
-
         // RFC 5819 section 2: a STATUS response follows the LIST response of every selectable mailbox
         // that matches the selection criteria. Mailboxes listed only for CHILDINFO or as \NonExistent
         // get none. The selected mailbox is no exception (RFC 9051 section 6.3.11)
@@ -28,4 +21,4 @@ module.exports = function (server) {
             }
         }
     };
-};
+}

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

@@ -0,0 +1,8 @@
+import type { IMAPServer } from '../types.js';
+/**
+ * @help Enables LITERAL- [RFC7888] capability
+ * @help Non-synchronizing literals up to 4096 octets, a larger
+ * @help one is dropped and answered with BAD [TOOBIG]
+ * @help Can not be loaded with LITERAL+
+ */
+export default function literalminusPlugin(server: IMAPServer): void;

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

@@ -1,13 +1,10 @@
-'use strict';
-
 /**
  * @help Enables LITERAL- [RFC7888] capability
  * @help Non-synchronizing literals up to 4096 octets, a larger
  * @help one is dropped and answered with BAD [TOOBIG]
  * @help Can not be loaded with LITERAL+
  */
-
-module.exports = function (server) {
+export default function literalminusPlugin(server) {
     // RFC 7888 section 5: servers MUST NOT advertise both LITERAL+ and LITERAL-
     if (server.capabilities['LITERAL+']) {
         throw new Error('LITERAL- can not be enabled together with LITERAL+');
@@ -17,4 +14,4 @@ module.exports = function (server) {
     server.impliedLiteralMinus = false;
     server.literalPlus = true;
     server.nonSyncLiteralLimit = 4096;
-};
+}

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

@@ -0,0 +1,6 @@
+import type { IMAPServer } from '../types.js';
+/**
+ * @help Enables LITERAL+ [RFC7888] capability
+ * @help Can not be loaded with LITERAL-
+ */
+export default function literalplusPlugin(server: IMAPServer): void;

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

@@ -1,11 +1,8 @@
-'use strict';
-
 /**
  * @help Enables LITERAL+ [RFC7888] capability
  * @help Can not be loaded with LITERAL-
  */
-
-module.exports = function (server) {
+export default function literalplusPlugin(server) {
     // RFC 7888 section 5: servers MUST NOT advertise both LITERAL+ and LITERAL-. IMAP4rev2 adds LITERAL- only
     // when LITERAL+ is not loaded, LITERAL+ replaces it then, as it allows more (RFC 9051 section 4.3)
     if (server.capabilities['LITERAL-'] && !server.impliedLiteralMinus) {
@@ -15,4 +12,4 @@ module.exports = function (server) {
     server.registerCapability('LITERAL+');
     server.literalPlus = true;
     server.nonSyncLiteralLimit = Infinity;
-};
+}

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

@@ -0,0 +1,5 @@
+import type { IMAPServer } from '../types.js';
+/**
+ * @help Disables LOGIN support for unencrypted connections
+ */
+export default function logindisabledPlugin(server: IMAPServer): void;

package/dist/esm/plugins/logindisabled.js

@@ -0,0 +1,39 @@
+/**
+ * @help Disables LOGIN support for unencrypted connections
+ */
+export default function logindisabledPlugin(server) {
+    server.registerCapability('LOGINDISABLED', (connection) => {
+        return !connection.secureConnection && connection.state === 'Not Authenticated';
+    });
+    // Retrieve actual LOGIN handler
+    // Will be run if conditions are met
+    const oldHandler = server.getCommandHandler('LOGIN');
+    // Override LOGIN
+    server.setCommandHandler('LOGIN', (connection, parsed, data, callback) => {
+        // If the connection is unsecure, do not allow LOGIN
+        if (!connection.secureConnection) {
+            connection.send({
+                tag: parsed.tag,
+                command: 'NO',
+                attributes: [
+                    {
+                        type: 'SECTION',
+                        section: [
+                            {
+                                type: 'ATOM',
+                                value: 'PRIVACYREQUIRED'
+                            }
+                        ]
+                    },
+                    {
+                        type: 'TEXT',
+                        value: 'Run STARTTLS first'
+                    }
+                ]
+            }, 'LOGIN FAILED', parsed, data);
+            return callback();
+        }
+        // Reroute command to actual LOGIN handler
+        oldHandler(connection, parsed, data, callback);
+    });
+}

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

@@ -0,0 +1,19 @@
+import type { IMAPServer } from '../types.js';
+/**
+ * Reads the limit from the "messageLimit" server option
+ *
+ * @param {Object} server IMAPServer
+ * @param {String} name Capability name for the error message
+ * @return {Number} limit
+ */
+declare function getLimit(server: IMAPServer, name: string): any;
+/**
+ * Refuses COPY and APPEND of more messages than the limit, shared with the SAVELIMIT plugin. COPY and
+ * MULTIAPPEND APPEND are atomic, so nothing is copied or appended (RFC 9738 section 3.1)
+ *
+ * @param {Object} server IMAPServer
+ * @param {Number} limit Message limit
+ */
+declare function addSaveLimit(server: IMAPServer, limit: number): void;
+export default function messagelimitPlugin(server: IMAPServer): void;
+export { getLimit, addSaveLimit };