imapkit 4.3.0 → 5.0.0

package/dist/cjs/control.js

@@ -0,0 +1,637 @@
+"use strict";
+/**
+ * The control API, `server.control`: inspects and changes the server state from a test, without an IMAP session.
+ * Every change reaches the connected sessions as if another session had made it (EXISTS, EXPUNGE or VANISHED,
+ * unsolicited FETCH, BYE, NOTIFY events, CONDSTORE mod-sequences), with no session as its origin. The API is the
+ * operator: ACL does not apply, but every argument is checked. Mailboxes are addressed by their storage name
+ * (modified UTF-7), messages by mailbox and UID. Methods return plain data and throw an ImapKitError with a `code`:
+ * NONEXISTENT, ALREADYEXISTS, INVALID, or a RFC 5530 code of a failed mailbox operation (CANNOT, HASCHILDREN ...)
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ImapKitError = exports.Control = void 0;
+const mailbox_name_js_1 = __importDefault(require("./mailbox-name.js"));
+const store_operations_js_1 = require("./store-operations.js");
+Object.defineProperty(exports, "ImapKitError", { enumerable: true, get: function () { return store_operations_js_1.ImapKitError; } });
+/**
+ * Copies a value of a plugin into the snapshot as JSON data, values that JSON can not hold are left out
+ *
+ * @param {*} value Any value
+ * @return {*} a JSON copy, or undefined
+ */
+function jsonCopy(value) {
+    if (value === undefined || typeof value === 'function') {
+        return undefined;
+    }
+    // strings, numbers and booleans are immutable, the message source does not need a round trip
+    return value === null || typeof value !== 'object' ? value : JSON.parse(JSON.stringify(value));
+}
+/**
+ * Copies the properties of an object as JSON data, except the listed keys and values JSON can not hold
+ *
+ * @param {Object} source Object to copy
+ * @param {Set} skip Keys to leave out
+ * @return {Object} copy
+ */
+function copyProperties(source, skip) {
+    const result = {};
+    Object.keys(source).forEach(key => {
+        const value = skip.has(key) ? undefined : jsonCopy(source[key]);
+        if (value !== undefined) {
+            result[key] = value;
+        }
+    });
+    return result;
+}
+const MESSAGE_SKIP = new Set(['ghost']);
+const NAMESPACE_SKIP = new Set(['folders']);
+// properties the server derives when it loads a mailbox, a snapshot leaves them out
+const DERIVED_MAILBOX_KEYS = new Set(['path', 'namespace', 'messages', 'folders', 'subscribed', 'flags']);
+const DERIVED_FLAGS = new Set(['\\HasChildren', '\\HasNoChildren']);
+class Control {
+    constructor(server) {
+        this.server = server;
+        this.routes = [];
+        this.snapshotHandlers = [];
+        this.mailboxInfoHandlers = [];
+        this.messageInfoHandlers = [];
+    }
+    /**
+     * Adds an operation of a plugin, e.g. `server.control.setAcl()` of ACL, so that a plugin that is not loaded
+     * leaves no trace. The operation runs with no session as its origin, like the built-in ones, and throws
+     * ImapKitErrors (see storeError() in store-operations.ts)
+     *
+     * @param {String} name Method name on server.control
+     * @param {Function} fn Operation
+     * @param {Array} [routes] REST routes of the operation
+     */
+    register(name, fn, routes) {
+        if (name in this) {
+            throw new Error('Control operation ' + name + ' exists already');
+        }
+        this[name] = (...args) => this.run(() => fn(...args));
+        this.routes.push(...(routes || []));
+    }
+    /**
+     * Runs a change with no session as its origin, also when a listener of a command event calls the API
+     *
+     * @param {Function} fn Change
+     * @return {*} the result of fn
+     */
+    run(fn) {
+        return this.server.withOrigin(null, fn);
+    }
+    /**
+     * Finds a mailbox by its storage name
+     *
+     * @param {String} path Storage name, INBOX in any case
+     * @param {Boolean} [selectable] true if the mailbox must hold messages (not \Noselect)
+     * @return {Object} mailbox
+     * @throws {ImapKitError} NONEXISTENT
+     */
+    requireMailbox(path, selectable) {
+        const mailbox = typeof path === 'string' && path ? this.server.getMailbox(path) : undefined;
+        if (!mailbox || (selectable && mailbox.flags.indexOf('\\Noselect') >= 0)) {
+            throw new store_operations_js_1.ImapKitError('Mailbox ' + JSON.stringify(path) + ' does not exist', 'NONEXISTENT');
+        }
+        return mailbox;
+    }
+    /**
+     * Checks a new mailbox name
+     *
+     * @param {String} path Storage name
+     * @throws {ImapKitError} INVALID for a name that is not valid modified UTF-7
+     */
+    checkName(path) {
+        this.checkPath(path);
+        const problem = (0, mailbox_name_js_1.default)(path);
+        if (problem) {
+            throw new store_operations_js_1.ImapKitError(problem, 'INVALID');
+        }
+    }
+    /**
+     * Checks that a mailbox argument is a name, the store operations check the rest
+     *
+     * @param {String} path Storage name
+     * @throws {ImapKitError} INVALID
+     */
+    checkPath(path) {
+        if (typeof path !== 'string' || !path) {
+            throw new store_operations_js_1.ImapKitError('Mailbox name must be a non-empty string', 'INVALID');
+        }
+    }
+    /**
+     * Finds messages by UID
+     *
+     * @param {Object} mailbox Mailbox
+     * @param {Array} uids UIDs of the messages
+     * @return {Array} messages in the order of the UIDs, without duplicates
+     * @throws {ImapKitError} INVALID for a list that is not UIDs, NONEXISTENT for a UID that is not in the mailbox
+     */
+    requireMessages(mailbox, uids) {
+        if (!Array.isArray(uids) || uids.some(uid => !Number.isSafeInteger(uid) || uid < 1)) {
+            throw new store_operations_js_1.ImapKitError('UIDs must be an array of positive integers', 'INVALID');
+        }
+        const byUid = new Map(mailbox.messages.map(message => [message.uid, message]));
+        const missing = uids.filter(uid => !byUid.has(uid));
+        if (missing.length) {
+            throw new store_operations_js_1.ImapKitError('No message with UID ' + missing.join(', ') + ' in ' + mailbox.path, 'NONEXISTENT');
+        }
+        return [...new Set(uids)].map(uid => byUid.get(uid));
+    }
+    /**
+     * Finds the sessions a filter selects
+     *
+     * @param {Number|Object} filter A session number, or `{ session, user }`
+     * @return {Array} connections
+     */
+    findSessions(filter) {
+        const query = typeof filter === 'number' ? { session: filter } : filter || {};
+        if (query.session === undefined && query.user === undefined) {
+            throw new store_operations_js_1.ImapKitError('Select sessions by number or user', 'INVALID');
+        }
+        // a session that is closing already (BYE) is left out
+        return [...this.server.connections].filter(connection => connection.isOpen() &&
+            (query.session === undefined || connection.sessionNumber === query.session) &&
+            (query.user === undefined || connection.username === query.user));
+    }
+    // Inspection
+    /**
+     * Returns the storage as JSON data in the shape of the `storage` option, so that `imapkit({ storage })` with it
+     * starts from the same mailboxes, messages, UIDs, flags and subscriptions. Plugin data on mailboxes and messages
+     * is included as far as it is JSON data. Subscriptions of names that are not mailboxes are not part of it
+     *
+     * @return {Object} storage
+     */
+    snapshot() {
+        const server = this.server;
+        const copyMailbox = (mailbox) => {
+            const result = copyProperties(mailbox, DERIVED_MAILBOX_KEYS);
+            this.snapshotHandlers.forEach(handler => handler(mailbox, result));
+            result.flags = mailbox.flags.filter(flag => !DERIVED_FLAGS.has(flag));
+            result.subscribed = !!mailbox.subscribed;
+            result.messages = mailbox.messages.map(message => copyProperties(message, MESSAGE_SKIP));
+            if (mailbox.folders) {
+                result.folders = copyFolders(mailbox.folders);
+            }
+            return result;
+        };
+        const copyFolders = (folders) => {
+            const result = {};
+            Object.keys(folders).forEach(name => {
+                result[name] = copyMailbox(folders[name]);
+            });
+            return result;
+        };
+        const storage = {};
+        Object.keys(server.storage).forEach(key => {
+            if (key === 'INBOX') {
+                storage.INBOX = copyMailbox(server.storage.INBOX);
+                return;
+            }
+            const namespace = server.storage[key];
+            storage[key] = Object.assign(copyProperties(namespace, NAMESPACE_SKIP), { folders: copyFolders(namespace.folders || {}) });
+        });
+        return storage;
+    }
+    /**
+     * Describes every mailbox, including \Noselect hierarchy levels
+     *
+     * @return {Array} mailboxes ordered by name
+     */
+    listMailboxes() {
+        return Object.keys(this.server.folderCache)
+            .sort()
+            .map(path => this.describeMailbox(this.server.folderCache[path]));
+    }
+    /**
+     * Describes a mailbox
+     *
+     * @param {String} path Storage name
+     * @return {Object} mailbox info
+     */
+    getMailbox(path) {
+        return this.describeMailbox(this.requireMailbox(path));
+    }
+    describeMailbox(mailbox) {
+        const status = this.server.getStatus(mailbox);
+        const info = {
+            path: mailbox.path,
+            delimiter: this.server.getSeparator(mailbox),
+            flags: mailbox.flags.slice(),
+            selectable: mailbox.flags.indexOf('\\Noselect') < 0,
+            subscribed: !!mailbox.subscribed,
+            messages: mailbox.messages.length,
+            unseen: status ? status.unseen : 0,
+            uidnext: mailbox.uidnext,
+            uidvalidity: mailbox.uidvalidity,
+            permanentFlags: status ? status.permanentFlags.slice() : []
+        };
+        if (this.server.condstore && typeof mailbox.HIGHESTMODSEQ === 'number') {
+            info.highestModseq = mailbox.HIGHESTMODSEQ;
+        }
+        this.mailboxInfoHandlers.forEach(handler => handler(mailbox, info));
+        return info;
+    }
+    /**
+     * Describes the messages of a mailbox
+     *
+     * @param {String} path Storage name
+     * @param {Object} [options] `{ uids, raw }`: only these UIDs, include the message source
+     * @return {Array} messages ordered by UID
+     */
+    listMessages(path, options = {}) {
+        const mailbox = this.requireMailbox(path, true);
+        const messages = options.uids ? this.requireMessages(mailbox, options.uids).sort((a, b) => a.uid - b.uid) : mailbox.messages;
+        return messages.map(message => this.describeMessage(message, !!options.raw));
+    }
+    /**
+     * Describes a message
+     *
+     * @param {String} path Storage name
+     * @param {Number} uid UID of the message
+     * @param {Object} [options] `{ raw }`: include the message source, true by default
+     * @return {Object} message info
+     */
+    getMessage(path, uid, options = {}) {
+        const mailbox = this.requireMailbox(path, true);
+        return this.describeMessage(this.requireMessages(mailbox, [uid])[0], options.raw !== false);
+    }
+    describeMessage(message, raw) {
+        const info = {
+            uid: message.uid,
+            flags: message.flags.slice(),
+            internaldate: message.internaldate,
+            size: message.raw.length
+        };
+        if (this.server.condstore && typeof message.MODSEQ === 'number') {
+            info.modseq = message.MODSEQ;
+        }
+        if (raw) {
+            info.raw = Buffer.from(message.raw, 'binary');
+        }
+        this.messageInfoHandlers.forEach(handler => handler(message, info));
+        return info;
+    }
+    /**
+     * Describes the connected sessions
+     *
+     * @return {Array} sessions ordered by number
+     */
+    sessions() {
+        return [...this.server.connections].map(connection => connection.describe()).sort((a, b) => a.session - b.session);
+    }
+    // Messages
+    /**
+     * Adds a message to a mailbox, like a delivery from outside: sessions that have the mailbox selected get EXISTS,
+     * the first read-write one sees it as \Recent
+     *
+     * @param {String} path Storage name
+     * @param {Object} message `{ raw, flags, internaldate }`
+     * @param {Object} [options] `{ checks }`: true runs the checks APPEND runs (QUOTA, APPENDLIMIT ...), a failed
+     *   one throws an ImapKitError with its response code, e.g. OVERQUOTA
+     * @return {Object} `{ uid, uidvalidity }`
+     */
+    addMessage(path, message, options = {}) {
+        const mailbox = this.requireMailbox(path, true);
+        const { raw, flags, internaldate } = message || {};
+        let source;
+        if (typeof raw === 'string') {
+            source = Buffer.from(raw, 'utf-8').toString('binary');
+        }
+        else if (raw instanceof Uint8Array) {
+            source = Buffer.from(raw).toString('binary');
+        }
+        else {
+            throw new store_operations_js_1.ImapKitError('Message source (raw) must be a string or a Buffer', 'INVALID');
+        }
+        if (!source.length) {
+            throw new store_operations_js_1.ImapKitError('Message source (raw) can not be empty', 'INVALID');
+        }
+        const list = (0, store_operations_js_1.checkFlags)(this.server, mailbox, flags || [], true);
+        if (internaldate !== undefined &&
+            !(internaldate instanceof Date && !isNaN(internaldate.getTime())) &&
+            !this.server.validateInternalDate(internaldate)) {
+            throw new store_operations_js_1.ImapKitError('Internal date must be a Date or a date-time string like "17-Jul-1996 02:44:25 -0700"', 'INVALID');
+        }
+        if (options.checks) {
+            const failure = this.server.appendChecks
+                .map(check => check(null, mailbox, [{ raw: source, flags: list, internaldate }], { command: 'APPEND' }))
+                .find(result => result && !result.soft);
+            if (failure) {
+                const code = Array.isArray(failure.code) ? failure.code[0] : failure.code;
+                throw new store_operations_js_1.ImapKitError(failure.text, typeof code === 'string' ? code : 'CANNOT');
+            }
+        }
+        const added = this.run(() => this.server.appendMessage(mailbox, list, internaldate || null, source));
+        return { uid: added.message.uid, uidvalidity: mailbox.uidvalidity };
+    }
+    /**
+     * Changes the flags of messages. Sessions that have the mailbox selected get unsolicited FETCH responses, with
+     * CONDSTORE the messages get new mod-sequences
+     *
+     * @param {String} path Storage name
+     * @param {Array} uids UIDs of the messages
+     * @param {Array} flags Flags
+     * @param {String} [mode] "set" (default), "add" or "remove"
+     * @return {Array} `{ uid, flags }` of every message
+     */
+    setFlags(path, uids, flags, mode = 'set') {
+        const mailbox = this.requireMailbox(path, true);
+        const messages = this.requireMessages(mailbox, uids);
+        this.run(() => (0, store_operations_js_1.changeFlags)(this.server, mailbox, messages, flags, mode));
+        return messages.map(message => ({ uid: message.uid, flags: message.flags.slice() }));
+    }
+    /**
+     * Removes messages. Sessions that have the mailbox selected get EXPUNGE (VANISHED with QRESYNC), following the
+     * RFC 2180 rules a session's EXPUNGE would
+     *
+     * @param {String} path Storage name
+     * @param {Array} uids UIDs of the messages
+     * @return {Array} the removed UIDs
+     */
+    expungeMessages(path, uids) {
+        const mailbox = this.requireMailbox(path, true);
+        const messages = this.requireMessages(mailbox, uids);
+        return this.run(() => (0, store_operations_js_1.expungeMessages)(this.server, mailbox, messages)).map(message => message.uid);
+    }
+    /**
+     * Copies messages to another mailbox, the copies keep flags and internal date and get new UIDs
+     *
+     * @param {String} path Storage name of the source
+     * @param {Array} uids UIDs of the messages
+     * @param {String} target Storage name of the target
+     * @return {Object} `{ uidvalidity, uids }`: UIDVALIDITY of the target, `{ uid, targetUid }` for every message
+     */
+    copyMessages(path, uids, target) {
+        return this.transfer(path, uids, target, false);
+    }
+    /**
+     * Moves messages to another mailbox: copies them and expunges them from the source
+     *
+     * @param {String} path Storage name of the source
+     * @param {Array} uids UIDs of the messages
+     * @param {String} target Storage name of the target
+     * @return {Object} `{ uidvalidity, uids }`: UIDVALIDITY of the target, `{ uid, targetUid }` for every message
+     */
+    moveMessages(path, uids, target) {
+        return this.transfer(path, uids, target, true);
+    }
+    transfer(path, uids, target, move) {
+        const mailbox = this.requireMailbox(path, true);
+        const targetMailbox = this.requireMailbox(target, true);
+        // in UID order, like COPY and MOVE
+        const messages = this.requireMessages(mailbox, uids).sort((a, b) => a.uid - b.uid);
+        return this.run(() => {
+            const result = messages.map(message => ({ uid: message.uid, targetUid: this.server.copyMessage(targetMailbox, message).message.uid }));
+            if (move) {
+                (0, store_operations_js_1.expungeMessages)(this.server, mailbox, messages);
+            }
+            return { uidvalidity: targetMailbox.uidvalidity, uids: result };
+        });
+    }
+    /**
+     * Replaces a message. The content of a UID never changes (RFC 9051 section 2.3.1.1), so this adds the new
+     * message and expunges the old one, the new message gets a new UID. Flags and internal date of the old
+     * message are kept unless given
+     *
+     * @param {String} path Storage name
+     * @param {Number} uid UID of the message to replace
+     * @param {Object} message `{ raw, flags, internaldate }`
+     * @return {Object} `{ uid, uidvalidity }` of the new message
+     */
+    replaceMessage(path, uid, message) {
+        const mailbox = this.requireMailbox(path, true);
+        const old = this.requireMessages(mailbox, [uid])[0];
+        const added = this.addMessage(path, {
+            raw: message && message.raw,
+            flags: message && message.flags ? message.flags : old.flags.slice(),
+            internaldate: message && message.internaldate ? message.internaldate : old.internaldate
+        });
+        this.run(() => (0, store_operations_js_1.expungeMessages)(this.server, mailbox, [old]));
+        return added;
+    }
+    // Mailboxes
+    /**
+     * Creates a mailbox, with any missing superior levels
+     *
+     * @param {String} path Storage name
+     * @param {Object} [options] `{ subscribed }`
+     * @return {Object} mailbox info
+     */
+    createMailbox(path, options = {}) {
+        this.checkName(path);
+        const mailbox = this.run(() => {
+            const created = (0, store_operations_js_1.createMailbox)(this.server, path);
+            if (options.subscribed) {
+                (0, store_operations_js_1.subscribeMailbox)(this.server, created.path);
+            }
+            return created;
+        });
+        return this.describeMailbox(mailbox);
+    }
+    /**
+     * Deletes a mailbox. Sessions that have it selected are disconnected with BYE, like after DELETE in another session
+     *
+     * @param {String} path Storage name
+     */
+    deleteMailbox(path) {
+        this.checkPath(path);
+        this.run(() => (0, store_operations_js_1.deleteMailbox)(this.server, path));
+    }
+    /**
+     * Renames a mailbox, with the RENAME rules (renaming INBOX moves its messages)
+     *
+     * @param {String} path Storage name
+     * @param {String} newPath New storage name
+     * @return {Object} info of the renamed mailbox
+     */
+    renameMailbox(path, newPath) {
+        this.checkPath(path);
+        this.checkName(newPath);
+        const result = this.run(() => (0, store_operations_js_1.renameMailbox)(this.server, path, newPath));
+        return this.getMailbox(result.path);
+    }
+    /**
+     * Gives a mailbox a new UIDVALIDITY, optionally with new UIDs ("keep", "renumber", "shuffle" or "offset"). Sessions
+     * that have the mailbox selected are disconnected with BYE, as a UID must not change during a session
+     *
+     * @param {String} path Storage name
+     * @param {Object} [options] `{ uidvalidity, uids, offset, seed }`
+     * @return {Object} `{ uidvalidity, uidnext, uids }`, `uids` lists `{ uid, newUid }` for every message
+     */
+    resetUidValidity(path, options = {}) {
+        const mailbox = this.requireMailbox(path, true);
+        return this.run(() => (0, store_operations_js_1.resetUidValidity)(this.server, mailbox, options || {}));
+    }
+    /**
+     * Subscribes a mailbox
+     *
+     * @param {String} path Storage name
+     * @return {Boolean} true if the subscription changed
+     */
+    subscribe(path) {
+        this.checkPath(path);
+        return this.run(() => (0, store_operations_js_1.subscribeMailbox)(this.server, path));
+    }
+    /**
+     * Unsubscribes a name, it does not have to be a mailbox
+     *
+     * @param {String} path Storage name
+     * @return {Boolean} true if the subscription changed
+     */
+    unsubscribe(path) {
+        this.checkPath(path);
+        return this.run(() => (0, store_operations_js_1.unsubscribeMailbox)(this.server, path));
+    }
+    // Users
+    /**
+     * Lists the users, without credentials
+     *
+     * @return {Array} `{ name, xoauth2 }`, xoauth2 is true for a user with an access token
+     */
+    listUsers() {
+        return Object.keys(this.server.users)
+            .sort()
+            .map(name => ({ name, xoauth2: !!(this.server.users[name].xoauth2 && this.server.users[name].xoauth2.accessToken) }));
+    }
+    /**
+     * Adds a user
+     *
+     * @param {String} name User name
+     * @param {Object} options `{ password, xoauth2: { accessToken, sessionTimeout } }`
+     */
+    addUser(name, options) {
+        if (typeof name !== 'string' || !name) {
+            throw new store_operations_js_1.ImapKitError('User name must be a non-empty string', 'INVALID');
+        }
+        if (Object.hasOwn(this.server.users, name)) {
+            throw new store_operations_js_1.ImapKitError('User ' + JSON.stringify(name) + ' already exists', 'ALREADYEXISTS');
+        }
+        this.server.users[name] = this.userData({}, options);
+    }
+    /**
+     * Changes the password or the XOAUTH2 token of a user
+     *
+     * @param {String} name User name
+     * @param {Object} options `{ password, xoauth2 }`, null xoauth2 removes the token
+     */
+    updateUser(name, options) {
+        this.server.users[name] = this.userData(this.requireUser(name), options);
+    }
+    /**
+     * Deletes a user, its sessions are disconnected with BYE unless `disconnect` is false
+     *
+     * @param {String} name User name
+     * @param {Object} [options] `{ disconnect }`
+     */
+    deleteUser(name, options = {}) {
+        this.requireUser(name);
+        delete this.server.users[name];
+        if (options.disconnect !== false) {
+            this.findSessions({ user: name }).forEach(connection => connection.bye('User was deleted', 'USER DELETED'));
+        }
+    }
+    requireUser(name) {
+        if (typeof name !== 'string' || !Object.hasOwn(this.server.users, name)) {
+            throw new store_operations_js_1.ImapKitError('User ' + JSON.stringify(name) + ' does not exist', 'NONEXISTENT');
+        }
+        return this.server.users[name];
+    }
+    userData(user, options) {
+        const { password, xoauth2 } = options || {};
+        const result = Object.assign({}, user);
+        if (password !== undefined) {
+            if (typeof password !== 'string') {
+                throw new store_operations_js_1.ImapKitError('Password must be a string', 'INVALID');
+            }
+            result.password = password;
+        }
+        if (xoauth2 === null) {
+            delete result.xoauth2;
+        }
+        else if (xoauth2 !== undefined) {
+            if (typeof xoauth2 !== 'object' || typeof xoauth2.accessToken !== 'string') {
+                throw new store_operations_js_1.ImapKitError('xoauth2 must be { accessToken, sessionTimeout }', 'INVALID');
+            }
+            result.xoauth2 = { accessToken: xoauth2.accessToken, sessionTimeout: Number(xoauth2.sessionTimeout) || store_operations_js_1.DEFAULT_SESSION_TIMEOUT };
+        }
+        return result;
+    }
+    // Server
+    /**
+     * Disconnects sessions
+     *
+     * @param {Number|Object} filter A session number, or `{ session, user }`
+     * @param {Object} [options] `{ text, reset }`: the text of the untagged BYE, or reset the TCP connection without BYE
+     * @return {Number} how many sessions were disconnected
+     */
+    disconnect(filter, options = {}) {
+        const sessions = this.findSessions(filter);
+        sessions.forEach(connection => {
+            if (options.reset) {
+                connection.closeNow('reset');
+            }
+            else {
+                connection.bye(options.text || 'Disconnected by the server', 'DISCONNECT');
+            }
+        });
+        return sessions.length;
+    }
+    /**
+     * Writes bytes to a session as they are, e.g. an untagged response between commands (ALERT, BYE, EXISTS).
+     * Nothing checks that they are valid IMAP
+     *
+     * @param {Number} session Session number
+     * @param {String|Buffer} data Bytes to send, a string is encoded as UTF-8
+     */
+    inject(session, data) {
+        const connection = this.findSessions({ session })[0];
+        if (!connection) {
+            throw new store_operations_js_1.ImapKitError('Session ' + session + ' does not exist', 'NONEXISTENT');
+        }
+        if (typeof data !== 'string' && !(data instanceof Uint8Array)) {
+            throw new store_operations_js_1.ImapKitError('Data must be a string or a Buffer', 'INVALID');
+        }
+        connection.write(Buffer.from(data));
+    }
+    /**
+     * Restores the mailboxes and users of the server options and disconnects every session with BYE, so that a
+     * long running server (the imapkit command) can be reused between tests. Plugins restore their own state on
+     * the `reset` event (QUOTA limits, server annotations). Script rules stay, `server.script.clear()` removes them
+     */
+    reset() {
+        this.server.connections.forEach(connection => {
+            if (connection.isOpen()) {
+                connection.bye('Server reset', 'RESET');
+            }
+        });
+        this.run(() => {
+            this.server.loadUsers();
+            this.server.loadStorage();
+            this.server.emit('reset');
+        });
+    }
+    /**
+     * Stops the server. A graceful shutdown stops accepting connections and waits until the clients disconnect,
+     * otherwise the sessions are closed right away
+     *
+     * @param {Object} [options] `{ graceful }`, true by default
+     * @return {Promise} resolves when the server is closed
+     */
+    shutdown(options = {}) {
+        return new Promise((resolve, reject) => {
+            const done = (err) => (err && err.code !== 'ERR_SERVER_NOT_RUNNING' ? reject(err) : resolve());
+            if (options.graceful === false) {
+                this.server.close(done);
+            }
+            else {
+                this.server.closeListeners(false);
+                this.server.server.close(done);
+            }
+        });
+    }
+}
+exports.Control = Control;

package/dist/cjs/index.d.ts

@@ -1,10 +1,17 @@
 import createServer, { TAG_REGEX, IMAPServer, IMAPConnection } from './server.js';
-export { TAG_REGEX, IMAPServer, IMAPConnection };
+import { ImapKitError } from './control.js';
+import { quirks } from './quirks.js';
+import { storageSchema, validateStorage } from './storage-schema.js';
+export { TAG_REGEX, IMAPServer, IMAPConnection, ImapKitError, quirks, storageSchema, validateStorage };
 export type { Attribute, ParsedCommand, IMAPResponse, Notification, Callback, CommandHandler, CommandOptions, Plugin, IMAPError, Message, Mailbox, StorageNamespace, UserData, IMAPServerOptions } from './types.js';
 export type { ScriptRule, ScriptContext, ScriptEvent, ScriptBytes, ScriptHandle } from './script.js';
+export type { Quirk } from './quirks.js';
+export type { Control, MailboxInfo, MessageInfo, SessionInfo, NewMessage, UserOptions, SessionFilter } from './control.js';
 declare const imapkit: typeof createServer & {
     TAG_REGEX: RegExp;
     IMAPServer: typeof IMAPServer;
     IMAPConnection: typeof IMAPConnection;
+    ImapKitError: typeof ImapKitError;
+    quirks: Record<string, import("./quirks.js").Quirk>;
 };
 export default imapkit;

package/dist/cjs/index.js

@@ -33,14 +33,21 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IMAPConnection = exports.IMAPServer = exports.TAG_REGEX = void 0;
+exports.validateStorage = exports.storageSchema = exports.quirks = exports.ImapKitError = exports.IMAPConnection = exports.IMAPServer = exports.TAG_REGEX = void 0;
 const server_js_1 = __importStar(require("./server.js"));
 Object.defineProperty(exports, "TAG_REGEX", { enumerable: true, get: function () { return server_js_1.TAG_REGEX; } });
 Object.defineProperty(exports, "IMAPServer", { enumerable: true, get: function () { return server_js_1.IMAPServer; } });
 Object.defineProperty(exports, "IMAPConnection", { enumerable: true, get: function () { return server_js_1.IMAPConnection; } });
+const control_js_1 = require("./control.js");
+Object.defineProperty(exports, "ImapKitError", { enumerable: true, get: function () { return control_js_1.ImapKitError; } });
+const quirks_js_1 = require("./quirks.js");
+Object.defineProperty(exports, "quirks", { enumerable: true, get: function () { return quirks_js_1.quirks; } });
+const storage_schema_js_1 = require("./storage-schema.js");
+Object.defineProperty(exports, "storageSchema", { enumerable: true, get: function () { return storage_schema_js_1.storageSchema; } });
+Object.defineProperty(exports, "validateStorage", { enumerable: true, get: function () { return storage_schema_js_1.validateStorage; } });
 // `imapkit(options)` creates a server. TAG_REGEX was a property of the CommonJS export, it and the
 // classes are properties of the factory with both module formats
-const imapkit = Object.assign(server_js_1.default, { TAG_REGEX: server_js_1.TAG_REGEX, IMAPServer: server_js_1.IMAPServer, IMAPConnection: server_js_1.IMAPConnection });
+const imapkit = Object.assign(server_js_1.default, { TAG_REGEX: server_js_1.TAG_REGEX, IMAPServer: server_js_1.IMAPServer, IMAPConnection: server_js_1.IMAPConnection, ImapKitError: control_js_1.ImapKitError, quirks: quirks_js_1.quirks });
 exports.default = imapkit;
 {
     const defaultExport = exports.default;