imapkit 4.3.1 → 5.0.0

package/dist/cjs/load-plugins.d.ts

@@ -16,6 +16,6 @@ declare function listPlugins(): string[];
  * @param {Object} server IMAPServer instance
  * @param {Array|String|Function} plugins List of plugins to load
  */
-declare function loadPlugins(server: IMAPServer, plugins: (string | Plugin)[] | string | Plugin | null | undefined): void;
+declare function loadPlugins(server: IMAPServer, plugins: (string | Plugin)[] | string | Plugin | null | undefined, exclude?: string[]): void;
 export default loadPlugins;
 export { listPlugins };

package/dist/cjs/load-plugins.js

@@ -50,12 +50,17 @@ function resolvePlugin(name) {
  * @param {Object} server IMAPServer instance
  * @param {Array|String|Function} plugins List of plugins to load
  */
-function loadPlugins(server, plugins) {
+function loadPlugins(server, plugins, exclude) {
     const loaded = new Set();
+    // plugins a quirk preset leaves out (no-move), they are not loaded even when listed
+    const excluded = new Set((exclude || []).map(name => resolvePlugin(name)).flatMap(name => (name ? [index_js_1.plugins[name]] : [])));
     const load = (entry) => {
         let plugin = entry;
         if (typeof plugin === 'string') {
             const name = resolvePlugin(plugin);
+            if (!name && plugin.toUpperCase() === 'XTOYBIRD') {
+                throw new Error('XTOYBIRD was removed in 5.0.0, use the control API (server.control.snapshot(), server.control.addUser() ...) instead, see the README');
+            }
             if (!name) {
                 throw new Error('Unknown plugin "' + plugin + '". Available plugins: ' + listPlugins().join(', '));
             }
@@ -64,7 +69,7 @@ function loadPlugins(server, plugins) {
         if (typeof plugin !== 'function') {
             throw new TypeError('Invalid plugin, expecting a plugin name or a function');
         }
-        if (loaded.has(plugin)) {
+        if (loaded.has(plugin) || excluded.has(plugin)) {
             return;
         }
         loaded.add(plugin);

package/dist/cjs/plugins/acl.js

@@ -11,6 +11,7 @@ const list_extensions_js_1 = require("../list-extensions.js");
 const select_js_1 = require("../commands/select.js");
 const append_js_1 = require("../commands/append.js");
 const arguments_js_1 = require("../arguments.js");
+const store_operations_js_1 = require("../store-operations.js");
 /**
  * @help Adds ACL [RFC4314] capability with RIGHTS=texk
  * @help The owner (server option "aclOwner", default "testuser")
@@ -205,6 +206,33 @@ function aclPlugin(server) {
         change(acl);
         server.emit('acl', mailbox, previous);
     };
+    /**
+     * Changes the rights of an identifier like SETACL (RFC 4314 section 3.1): "+" adds, "-" removes, no mode
+     * replaces. An identifier without rights is removed from the ACL
+     *
+     * @param {Object} mailbox Mailbox
+     * @param {String} identifier Identifier
+     * @param {String} mode "+", "-" or ""
+     * @param {Set} rights Parsed rights
+     */
+    const applyRights = (mailbox, identifier, mode, rights) => {
+        changeAcl(mailbox, acl => {
+            const current = new Set(acl.get(identifier) || []);
+            if (mode === '+') {
+                rights.forEach(right => current.add(right));
+            }
+            else if (mode === '-') {
+                rights.forEach(right => current.delete(right));
+            }
+            const updated = mode ? current : rights;
+            if (updated.size) {
+                acl.set(identifier, updated);
+            }
+            else {
+                acl.delete(identifier);
+            }
+        });
+    };
     // CATENATE (RFC 4469 section 5): reading a message through an IMAP URL needs the "r" right, a
     // mailbox without "l" is reported like one that does not exist (RFC 4314 section 6)
     server.urlAccessChecks.push((connection, mailbox) => {
@@ -360,22 +388,7 @@ function aclPlugin(server) {
         if (!checkAclCommand(connection, parsed, data, mailbox, hasAdmin) || refuseOwnerIdentifier(connection, parsed, data)) {
             return;
         }
-        changeAcl(mailbox, acl => {
-            const current = new Set(acl.get(identifier) || []);
-            if (mode === '+') {
-                rights.forEach(right => current.add(right));
-            }
-            else if (mode === '-') {
-                rights.forEach(right => current.delete(right));
-            }
-            const updated = mode ? current : rights;
-            if (updated.size) {
-                acl.set(identifier, updated);
-            }
-            else {
-                acl.delete(identifier);
-            }
-        });
+        applyRights(mailbox, identifier, mode, rights);
         connection.sendStatus(parsed, data, 'OK', 'Setacl complete');
     }), Object.assign({ astringArguments: [1, 2] }, aclOptions));
     // RFC 4314 section 3.2
@@ -473,7 +486,7 @@ function aclPlugin(server) {
                 }
                 flags = [].concat(flags);
                 // invalid flags are still refused with BAD, even if the user could not set them anyway
-                flags.forEach((flag) => (0, flags_js_1.checkSystemFlags)(connection, (0, flags_js_1.normalizeSystemFlag)(flagValue(flag))));
+                flags.forEach((flag) => (0, flags_js_1.checkSystemFlags)(connection.server, (0, flags_js_1.normalizeSystemFlag)(flagValue(flag))));
                 let allowed = flags.filter((flag) => canSetFlag(rights, flag));
                 if (item.charAt(0) !== '+' && item.charAt(0) !== '-') {
                     // replacing the flags keeps the ones the user can not change
@@ -568,7 +581,7 @@ function aclPlugin(server) {
         const flags = parsed.attributes[1];
         if (Array.isArray(flags) && flags.every((flag) => flag && flag.type === 'ATOM')) {
             try {
-                flags.forEach((flag) => (0, flags_js_1.checkSystemFlags)(connection, (0, flags_js_1.normalizeSystemFlag)(flag.value)));
+                flags.forEach((flag) => (0, flags_js_1.checkSystemFlags)(connection.server, (0, flags_js_1.normalizeSystemFlag)(flag.value)));
                 // the server MUST NOT fail APPEND for flags the user can not set
                 parsed.attributes[1] = flags.filter((flag) => canSetFlag(rights, flag));
             }
@@ -740,7 +753,7 @@ function aclPlugin(server) {
         }
         const flags = [].concat(args[args.length - 1] || []);
         try {
-            flags.forEach(flag => (0, flags_js_1.checkSystemFlags)(connection, (0, flags_js_1.normalizeSystemFlag)(flagValue(flag))));
+            flags.forEach(flag => (0, flags_js_1.checkSystemFlags)(connection.server, (0, flags_js_1.normalizeSystemFlag)(flagValue(flag))));
         }
         catch {
             // invalid flags are refused with BAD by the STORE handler
@@ -839,40 +852,94 @@ function aclPlugin(server) {
             });
         }
     });
-    // The DELETE command MUST delete the ACL of the mailbox (RFC 4314 section 4), this matters when a
-    // \Noselect placeholder stays for the children of the mailbox
-    // DELETE and CREATE are core commands, so the handlers exist
-    const prevDelete = server.getCommandHandler('DELETE');
-    server.setCommandHandler('DELETE', (connection, parsed, data, callback) => {
-        const mailbox = argumentMailbox(parsed, 0);
-        prevDelete(connection, parsed, data, () => {
-            const placeholder = argumentMailbox(parsed, 0);
-            if (placeholder && placeholder !== mailbox) {
+    server.on('mailbox', (event) => {
+        if (event.type === 'delete') {
+            // DELETE MUST delete the ACL of the mailbox (RFC 4314 section 4), this matters when a \Noselect
+            // placeholder stays for the children of the mailbox
+            const placeholder = server.getMailbox(event.path);
+            if (placeholder && placeholder !== event.mailbox) {
                 delete placeholder.acl;
             }
-            callback();
-        });
-    });
-    // A new mailbox inherits the ACL of its parent (RFC 4314 section 4, CREATE SHOULD)
-    const prevCreate = server.getCommandHandler('CREATE');
-    server.setCommandHandler('CREATE', (connection, parsed, data, callback) => {
-        const existing = new Set(Object.keys(server.folderCache));
-        prevCreate(connection, parsed, data, () => {
-            Object.keys(server.folderCache)
-                .filter(path => !existing.has(path))
-                .sort((a, b) => a.length - b.length)
-                .forEach(path => {
+        }
+        else if (event.type === 'create') {
+            // A new mailbox inherits the ACL of its parent (RFC 4314 section 4, CREATE SHOULD)
+            (event.created || []).forEach((path) => {
                 const parent = getParent(path);
                 const mailbox = server.folderCache[path];
-                if (parent && parent !== mailbox) {
+                if (parent && mailbox && parent !== mailbox) {
                     const acl = new Map();
                     getAcl(parent).forEach((rights, identifier) => acl.set(identifier, new Set(rights)));
                     mailbox.acl = acl;
                 }
             });
-            callback();
+        }
+    });
+    // Control API (README "Control API"): ACLs as objects of identifier to rights, like the storage option
+    const aclObject = (mailbox) => {
+        const result = {};
+        getAcl(mailbox).forEach((rights, identifier) => {
+            result[identifier] = formatRights(rights);
         });
+        return result;
+    };
+    const controlMailbox = (path) => server.control.requireMailbox(path);
+    // the snapshot keeps ACLs in the form of the storage option, the parsed ACL is a Map
+    server.control.snapshotHandlers.push((mailbox, copy) => {
+        if (mailbox.acl instanceof Map) {
+            copy.acl = aclObject(mailbox);
+        }
     });
+    const getAclOperation = (path) => aclObject(controlMailbox(path));
+    // rights replace the rights of the identifier, "+rights" adds and "-rights" removes like SETACL (RFC 4314
+    // section 3.1), empty rights remove the identifier
+    const setAclOperation = (path, identifier, rights) => {
+        const mailbox = controlMailbox(path);
+        if (typeof identifier !== 'string' || !identifier || typeof rights !== 'string') {
+            throw (0, store_operations_js_1.storeError)('setAcl expects an identifier and a rights string', 'INVALID');
+        }
+        const mode = /^[+-]/.test(rights) ? rights.charAt(0) : '';
+        let parsed;
+        try {
+            parsed = parseRights(rights.substr(mode.length));
+        }
+        catch (err) {
+            throw (0, store_operations_js_1.storeError)(err.message, 'INVALID');
+        }
+        applyRights(mailbox, identifier, mode, parsed);
+        return aclObject(mailbox);
+    };
+    const deleteAclOperation = (path, identifier) => {
+        const mailbox = controlMailbox(path);
+        if (typeof identifier !== 'string' || !getAcl(mailbox).has(identifier)) {
+            throw (0, store_operations_js_1.storeError)('No ACL entry for ' + JSON.stringify(identifier), 'NONEXISTENT');
+        }
+        changeAcl(mailbox, acl => acl.delete(identifier));
+        return aclObject(mailbox);
+    };
+    server.control.register('getAcl', getAclOperation, [
+        {
+            method: 'GET',
+            path: '/v1/mailboxes/{path}/acl',
+            summary: 'The ACL of a mailbox (ACL plugin)',
+            handler: ({ params }) => server.control.getAcl(params.path)
+        }
+    ]);
+    server.control.register('setAcl', setAclOperation, [
+        {
+            method: 'PUT',
+            path: '/v1/mailboxes/{path}/acl/{identifier}',
+            summary: 'Sets the rights of an identifier ({ rights }, "+" or "-" in front adds or removes, ACL plugin)',
+            handler: ({ params, body }) => server.control.setAcl(params.path, params.identifier, body.rights)
+        }
+    ]);
+    server.control.register('deleteAcl', deleteAclOperation, [
+        {
+            method: 'DELETE',
+            path: '/v1/mailboxes/{path}/acl/{identifier}',
+            summary: 'Removes an identifier from the ACL (ACL plugin)',
+            handler: ({ params }) => server.control.deleteAcl(params.path, params.identifier)
+        }
+    ]);
 }
 {
     const defaultExport = exports.default;

package/dist/cjs/plugins/condstore.js

@@ -78,6 +78,13 @@ function condstorePlugin(server) {
     server.on('expunge', mailbox => {
         bumpModseq(mailbox);
     });
+    // Flags changed outside of STORE (the control API, see changeFlags() in store-operations.ts): every changed
+    // message gets a new mod-sequence (RFC 7162 section 3.1.1), before the sessions are told
+    server.on('flags', (mailbox, messages) => {
+        messages.forEach(message => {
+            message.MODSEQ = bumpModseq(mailbox);
+        });
+    });
     // RFC 7162 section 3.2.11: SELECT or EXAMINE closes the selected mailbox, a CONDSTORE server marks
     // where the responses for the new mailbox start
     server.closedChecks.push(() => true);

package/dist/cjs/plugins/index.js

@@ -59,7 +59,6 @@ const unselect_js_1 = __importDefault(require("./unselect.js"));
 const utf8_accept_js_1 = __importDefault(require("./utf8-accept.js"));
 const x_gm_ext_1_js_1 = __importDefault(require("./x-gm-ext-1.js"));
 const xoauth2_js_1 = __importDefault(require("./xoauth2.js"));
-const xtoybird_js_1 = __importDefault(require("./xtoybird.js"));
 exports.plugins = {
     acl: acl_js_1.default,
     appendlimit: appendlimit_js_1.default,
@@ -114,6 +113,5 @@ exports.plugins = {
     unselect: unselect_js_1.default,
     'utf8-accept': utf8_accept_js_1.default,
     'x-gm-ext-1': x_gm_ext_1_js_1.default,
-    xoauth2: xoauth2_js_1.default,
-    xtoybird: xtoybird_js_1.default
+    xoauth2: xoauth2_js_1.default
 };

package/dist/cjs/plugins/metadata.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = metadataPlugin;
 exports.setup = setup;
+const store_operations_js_1 = require("../store-operations.js");
 const command_states_js_1 = require("../command-states.js");
 const numbers_js_1 = require("../numbers.js");
 const arguments_js_1 = require("../arguments.js");
@@ -312,6 +313,60 @@ function setup(server, mailboxes) {
         return callback();
     }, { states: command_states_js_1.states.AUTHENTICATED });
     // RFC 5464 section 4.3: setmetadata = "SETMETADATA" SP mailbox SP entry-values
+    /**
+     * Stores the changes of SETMETADATA (or of the control API) when all of them pass the checks, and tells the
+     * sessions that used ENABLE METADATA about the changed entries. The session that made the change
+     * (`server.activeConnection`) is not told, and without one (the control API) the read-only server entries can
+     * be set too
+     *
+     * @param {Object} holder Mailbox object or state.server
+     * @param {Map} changes Lower case entry name to the new value, null removes the entry
+     * @return {Object|null} `{ text, code }` when a change fails, nothing is changed then
+     */
+    const storeChanges = (holder, changes) => {
+        const origin = server.activeConnection;
+        const entries = getEntries(holder);
+        const computed = getComputedEntries(holder);
+        // changes go to a copy that replaces the entries once every check passed
+        const next = Object.assign(Object.create(null), entries);
+        const changed = [];
+        for (const [name, value] of changes) {
+            if ((!holder.path && origin && READ_ONLY_SERVER_ENTRIES.has(name)) || name in computed) {
+                return { text: 'The ' + name + ' entry is read-only', code: 'CANNOT' };
+            }
+            if (!state.allowPrivate && name.startsWith('/private/')) {
+                return { text: 'Private annotations are not supported', code: ['METADATA', 'NOPRIVATE'] };
+            }
+            if (value !== null && value.length > state.maxSize) {
+                return { text: 'Value of ' + name + ' is too large', code: ['METADATA', 'MAXSIZE', state.maxSize] };
+            }
+            if ((entries[name] ?? null) !== value) {
+                changed.push(name);
+            }
+            if (value === null) {
+                delete next[name];
+            }
+            else {
+                next[name] = value;
+            }
+        }
+        // only adding entries can fail, even when the storage already holds more than the limit
+        const count = Object.keys(next).length;
+        if (count > state.maxEntries && count > Object.keys(entries).length) {
+            return { text: 'Too many annotations', code: ['METADATA', 'TOOMANY'] };
+        }
+        setEntries(holder, next);
+        if (changed.length) {
+            // RFC 5464 section 4.4.2: unsolicited responses only list the entry names. Section 4.1:
+            // only sessions that used ENABLE METADATA (or METADATA-SERVER) get them
+            server.notify({
+                tag: '*',
+                command: 'METADATA',
+                attributes: [mailboxAttribute(holder.path)].concat(changed.map(name => ({ type: 'ATOM', value: name })))
+            }, false, origin, isMetadataEnabled);
+        }
+        return null;
+    };
     server.setCommandHandler('SETMETADATA', (connection, parsed, data, callback) => {
         const attrs = parsed.attributes || [];
         if (attrs.length !== 2 || !(0, arguments_js_1.isAstring)(attrs[0]) || !Array.isArray(attrs[1])) {
@@ -347,77 +402,105 @@ function setup(server, mailboxes) {
         if (!holder) {
             return callback();
         }
-        const entries = getEntries(holder);
-        const computed = getComputedEntries(holder);
-        const fail = (text, code) => {
+        const failure = storeChanges(holder, changes);
+        if (failure) {
             // RFC 5464 section 4.3: when one entry fails, no entry is changed
-            connection.sendStatus(parsed, data, 'NO', text, code);
+            connection.sendStatus(parsed, data, 'NO', failure.text, failure.code);
             return callback();
-        };
-        // changes go to a copy that replaces the entries once every check passed
-        const next = Object.assign(Object.create(null), entries);
-        const changed = [];
-        for (const [name, value] of changes) {
-            if ((!holder.path && READ_ONLY_SERVER_ENTRIES.has(name)) || name in computed) {
-                return fail('The ' + name + ' entry is read-only', 'CANNOT');
-            }
-            if (!state.allowPrivate && name.startsWith('/private/')) {
-                return fail('Private annotations are not supported', ['METADATA', 'NOPRIVATE']);
-            }
-            if (value !== null && value.length > state.maxSize) {
-                return fail('Value of ' + name + ' is too large', ['METADATA', 'MAXSIZE', state.maxSize]);
-            }
-            if ((entries[name] ?? null) !== value) {
-                changed.push(name);
-            }
-            if (value === null) {
-                delete next[name];
-            }
-            else {
-                next[name] = value;
-            }
-        }
-        // only adding entries can fail, even when the storage already holds more than the limit
-        const count = Object.keys(next).length;
-        if (count > state.maxEntries && count > Object.keys(entries).length) {
-            return fail('Too many annotations', ['METADATA', 'TOOMANY']);
-        }
-        setEntries(holder, next);
-        if (changed.length) {
-            // RFC 5464 section 4.4.2: unsolicited responses only list the entry names. Section 4.1:
-            // only sessions that used ENABLE METADATA (or METADATA-SERVER) get them
-            server.notify({
-                tag: '*',
-                command: 'METADATA',
-                attributes: [mailboxAttribute(holder.path)].concat(changed.map(name => ({ type: 'ATOM', value: name })))
-            }, false, connection, isMetadataEnabled);
         }
         connection.sendStatus(parsed, data, 'OK', 'SETMETADATA completed');
         return callback();
     }, 
     // RFC 5464 section 5: values can be literal8, with or without BINARY
     { states: command_states_js_1.states.AUTHENTICATED, mailboxArguments: [0], literal8: true });
-    server.outputHandlers.push((connection, response, description, parsed, data, extra) => {
-        if (response.command !== 'OK' || !parsed || !parsed.attributes) {
-            return;
-        }
-        if (description === 'RENAME' && extra && extra.path === 'INBOX') {
-            // RFC 5464 section 4.1: renaming INBOX copies its annotations, INBOX keeps them. Other
-            // mailboxes are moved as objects, so their annotations follow without any help
-            const target = connection.server.getMailbox(parsed.attributes[1].value);
-            if (target && target !== extra && extra.metadata) {
-                setEntries(target, Object.assign(Object.create(null), getEntries(extra)));
+    server.on('mailbox', (event) => {
+        if (event.type === 'rename' && event.oldPath === 'INBOX') {
+            // RFC 5464 section 4.1: renaming INBOX copies its annotations, INBOX keeps them. Other mailboxes are
+            // moved as objects, so their annotations follow without any help
+            const inbox = server.getMailbox('INBOX');
+            const target = server.getMailbox(event.path);
+            if (inbox && target && target !== inbox && inbox.metadata) {
+                setEntries(target, Object.assign(Object.create(null), getEntries(inbox)));
             }
         }
-        else if (description === 'DELETE') {
-            // RFC 5464 section 4.1: a mailbox created later with the same name must not inherit the
-            // annotations. A mailbox with children stays as a \Noselect placeholder
-            const placeholder = connection.server.getMailbox(parsed.attributes[0].value);
-            if (placeholder) {
+        else if (event.type === 'delete') {
+            // RFC 5464 section 4.1: a mailbox created later with the same name must not inherit the annotations.
+            // A mailbox with children stays as a \Noselect placeholder
+            const placeholder = server.getMailbox(event.path);
+            if (placeholder && placeholder !== event.mailbox) {
                 delete placeholder.metadata;
             }
         }
     });
+    // Control API (README "Control API"): the stored annotations of a mailbox, or of the server for "". Values are
+    // UTF-8 text, the protocol keeps them as octets
+    // control.reset() restores the server annotations of the options, the mailboxes come with their storage
+    server.on('reset', () => {
+        state.server = { path: '', metadata: options.metadata };
+    });
+    const controlHolder = (path) => {
+        if (path === '') {
+            return state.server;
+        }
+        if (!state.mailboxes) {
+            throw (0, store_operations_js_1.storeError)('Mailbox annotations need the METADATA plugin, METADATA-SERVER has server annotations only', 'INVALID');
+        }
+        return server.control.requireMailbox(path);
+    };
+    const getMetadataOperation = (path) => {
+        const entries = getEntries(controlHolder(path));
+        const result = {};
+        Object.keys(entries).forEach(name => {
+            result[name] = Buffer.from(entries[name], 'binary').toString('utf-8');
+        });
+        return result;
+    };
+    const setMetadataOperation = (path, values) => {
+        const holder = controlHolder(path);
+        if (!values || typeof values !== 'object' || Array.isArray(values)) {
+            throw (0, store_operations_js_1.storeError)('setMetadata expects an object of entry names and values (null removes an entry)', 'INVALID');
+        }
+        const changes = new Map();
+        Object.keys(values).forEach(name => {
+            const value = values[name];
+            const error = checkEntryName(name, true);
+            if (error) {
+                throw (0, store_operations_js_1.storeError)(error, 'INVALID');
+            }
+            if (value !== null && typeof value !== 'string') {
+                throw (0, store_operations_js_1.storeError)('Value of ' + name + ' must be a string or null', 'INVALID');
+            }
+            changes.set(name.toLowerCase(), value === null ? null : Buffer.from(value, 'utf-8').toString('binary'));
+        });
+        const failure = storeChanges(holder, changes);
+        if (failure) {
+            throw (0, store_operations_js_1.storeError)(failure.text, typeof failure.code === 'string' ? failure.code : 'INVALID');
+        }
+        return getMetadataOperation(path);
+    };
+    server.control.register('getMetadata', getMetadataOperation, [
+        { method: 'GET', path: '/v1/metadata', summary: 'Server annotations (METADATA plugins)', handler: () => server.control.getMetadata('') },
+        {
+            method: 'GET',
+            path: '/v1/mailboxes/{path}/metadata',
+            summary: 'Mailbox annotations (METADATA plugin)',
+            handler: ({ params }) => server.control.getMetadata(params.path)
+        }
+    ]);
+    server.control.register('setMetadata', setMetadataOperation, [
+        {
+            method: 'PUT',
+            path: '/v1/metadata',
+            summary: 'Sets server annotations ({ "/shared/comment": "text" }, null removes one, METADATA plugins)',
+            handler: ({ body }) => server.control.setMetadata('', body)
+        },
+        {
+            method: 'PUT',
+            path: '/v1/mailboxes/{path}/metadata',
+            summary: 'Sets mailbox annotations (METADATA plugin)',
+            handler: ({ params, body }) => server.control.setMetadata(params.path, body)
+        }
+    ]);
 }
 function metadataPlugin(server) {
     setup(server, true);

package/dist/cjs/plugins/objectid.js

@@ -98,6 +98,16 @@ function objectidPlugin(server) {
         }
         getMailboxId(mailbox);
     });
+    // Control API (README "Control API"): the object ids in getMailbox() and getMessage()
+    server.control.mailboxInfoHandlers.push((mailbox, info) => {
+        if (mailbox.flags.indexOf('\\Noselect') < 0) {
+            info.mailboxId = getMailboxId(mailbox);
+        }
+    });
+    server.control.messageInfoHandlers.push((message, info) => {
+        info.emailId = message.EMAILID;
+        info.threadId = message.THREADID;
+    });
     server.messageHandlers.push((server, message, mailbox) => {
         const owner = 'a message of mailbox ' + mailbox.path;
         if (message.EMAILID) {

package/dist/cjs/plugins/quota.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = quotaPlugin;
+const store_operations_js_1 = require("../store-operations.js");
 const command_states_js_1 = require("../command-states.js");
 const mimeparser_js_1 = require("../mimeparser.js");
 const numbers_js_1 = require("../numbers.js");
@@ -32,6 +33,8 @@ function quotaPlugin(server) {
         soft: !!config.soft,
         limits: {}
     };
+    // the limits of the quota option, control.reset() restores them
+    const initialLimits = {};
     RESOURCES.forEach(resource => {
         if (config[resource] === undefined || config[resource] === null) {
             return;
@@ -40,8 +43,13 @@ function quotaPlugin(server) {
         if (!Number.isSafeInteger(limit) || limit < 0) {
             throw new Error('Invalid quota limit for ' + resource + ': ' + JSON.stringify(config[resource]));
         }
-        root.limits[resource] = limit;
+        initialLimits[resource] = limit;
     });
+    const restoreLimits = () => {
+        root.limits = Object.assign({}, initialLimits);
+    };
+    restoreLimits();
+    server.on('reset', restoreLimits);
     // RFC 9208 sections 3.1.1 and 5: every supported resource is advertised, SETQUOTA needs QUOTASET
     server.registerCapability('QUOTA');
     RESOURCES.forEach(resource => server.registerCapability('QUOTA=RES-' + resource));
@@ -114,7 +122,7 @@ function quotaPlugin(server) {
         }
         const added = { MESSAGE: messages.length, bytes: totalSize(messages) };
         // RFC 8508 section 3.4: REPLACE counts only the net usage, the replaced message is removed
-        if (options.replaced && connection.selectedMailbox && inRoot(connection.selectedMailbox)) {
+        if (options.replaced && connection && connection.selectedMailbox && inRoot(connection.selectedMailbox)) {
             added.MESSAGE--;
             added.bytes -= totalSize([options.replaced]);
         }
@@ -239,6 +247,46 @@ function quotaPlugin(server) {
         }
     });
     server.statusHandlers['DELETED-STORAGE'] = (connection, mailbox) => totalSize(mailbox.messages.filter(message => message.flags.indexOf('\\Deleted') >= 0));
+    // Control API (README "Control API"): the quota root with its limits and usage, STORAGE in units of 1024 octets
+    const getQuotaOperation = () => {
+        const usage = getUsage();
+        return {
+            root: root.name,
+            limits: Object.assign({}, root.limits),
+            usage: { STORAGE: Math.ceil(usage.bytes / 1024), MESSAGE: usage.MESSAGE, MAILBOX: usage.MAILBOX }
+        };
+    };
+    // the new limits replace all earlier ones, like SETQUOTA (RFC 9208 section 4.1.3)
+    const setQuotaOperation = (limits) => {
+        if (!limits || typeof limits !== 'object' || Array.isArray(limits)) {
+            throw (0, store_operations_js_1.storeError)('setQuota expects an object of resource limits, e.g. { STORAGE: 1024 }', 'INVALID');
+        }
+        const next = {};
+        Object.keys(limits).forEach(name => {
+            const resource = name.toUpperCase();
+            const value = limits[name];
+            if (RESOURCES.indexOf(resource) < 0) {
+                throw (0, store_operations_js_1.storeError)('Unknown quota resource ' + name + ', expected ' + RESOURCES.join(', '), 'INVALID');
+            }
+            if (typeof value !== 'number' || !Number.isSafeInteger(value) || value < 0) {
+                throw (0, store_operations_js_1.storeError)('Limit of ' + resource + ' must be a non-negative integer', 'INVALID');
+            }
+            next[resource] = value;
+        });
+        root.limits = next;
+        return getQuotaOperation();
+    };
+    server.control.register('getQuota', getQuotaOperation, [
+        { method: 'GET', path: '/v1/quota', summary: 'Quota root, limits and usage (QUOTA plugin)', handler: () => server.control.getQuota() }
+    ]);
+    server.control.register('setQuota', setQuotaOperation, [
+        {
+            method: 'PUT',
+            path: '/v1/quota',
+            summary: 'Replaces the quota limits ({ STORAGE, MESSAGE, MAILBOX }, QUOTA plugin)',
+            handler: ({ body }) => server.control.setQuota(body)
+        }
+    ]);
 }
 {
     const defaultExport = exports.default;

package/dist/cjs/plugins/savedate.js

@@ -28,7 +28,7 @@ function savedatePlugin(server) {
             delete message.SAVEDATE;
             return;
         }
-        const savedate = server.normalizeDateTime(message.SAVEDATE || new Date());
+        const savedate = server.normalizeDateTime(message.SAVEDATE || server.now());
         if (!server.validateInternalDate(savedate)) {
             throw new Error('Invalid SAVEDATE value ' + JSON.stringify(savedate) + ' in mailbox ' + mailbox.path);
         }

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

@@ -1,10 +1,2 @@
 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;