imapkit 4.0.3 → 4.1.0

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

@@ -1,9 +1,6 @@
-'use strict';
-
-const { toVanished } = require('../vanished');
-const { isAtom } = require('../arguments');
-const { registerEnable, isEnabled } = require('./enable');
-
+import { toVanished } from '../vanished.js';
+import { isAtom } from '../arguments.js';
+import { registerEnable, isEnabled } from './enable.js';
 /**
  * @help Adds UIDONLY [RFC9586] capability, loads ENABLE as well
  * @help After ENABLE UIDONLY: FETCH, STORE, SEARCH, COPY, MOVE, SORT, THREAD, REPLACE and
@@ -13,17 +10,12 @@ const { registerEnable, isEnabled } = require('./enable');
  *
  * UIDONLY: https://www.rfc-editor.org/rfc/rfc9586
  */
-
-module.exports = function (server) {
+export default function uidonlyPlugin(server) {
     server.registerCapability('UIDONLY');
-
     registerEnable(server, 'UIDONLY');
-
     // UNAUTHENTICATE clears the ENABLEd extensions (RFC 8437 section 4.1)
-    const isUidonly = connection => isEnabled(connection, 'UIDONLY');
-
-    const refuse = text => ({ command: 'BAD', code: 'UIDREQUIRED', text });
-
+    const isUidonly = (connection) => isEnabled(connection, 'UIDONLY');
+    const refuse = (text) => ({ command: 'BAD', code: 'UIDREQUIRED', text });
     // RFC 9586 section 3: once UIDONLY is enabled, message numbers in any argument MUST be answered with a
     // tagged BAD that has the UIDREQUIRED response code
     const getRefusal = (connection, parsed) => {
@@ -31,45 +23,37 @@ module.exports = function (server) {
         const options = server.getCommandOptions(command);
         // the ESEARCH command of MULTISEARCH always returns UIDs (RFC 7377 section 2), like a UID command
         const isUid = /^UID /.test(command) || command === 'ESEARCH';
-
         // sections 3.2 and 3.8: FETCH, STORE, SEARCH, COPY, MOVE, SORT and THREAD are prohibited, also REPLACE
         // (RFC 8508), its message argument is a sequence number. These have the sequenceSet or searchCriteria
         // command option
         if (!isUid && (options.sequenceSet !== false || options.searchCriteria !== false)) {
             return refuse(command + ' is not allowed once UIDONLY is enabled, use UID ' + command);
         }
-
         // section 3.5: the <sequence set> search key is prohibited, also in UID SORT and UID THREAD
         if (isUid && options.searchCriteria !== false && connection.usesSequenceNumbers(parsed)) {
             return refuse('Message numbers are not allowed in the search criteria once UIDONLY is enabled, use UID <sequence set>');
         }
-
         // section 3.7: the fourth QRESYNC parameter (message sequence match data) MUST NOT be used
-        if ((command === 'SELECT' || command === 'EXAMINE') && Array.isArray(parsed.attributes && parsed.attributes[1])) {
+        if ((command === 'SELECT' || command === 'EXAMINE') && parsed.attributes && Array.isArray(parsed.attributes[1])) {
             const params = parsed.attributes[1];
-            const position = params.findIndex(param => isAtom(param, 'QRESYNC'));
+            const position = params.findIndex((param) => isAtom(param, 'QRESYNC'));
             const value = position >= 0 && params[position + 1];
             if (Array.isArray(value) && value.slice(2).some(Array.isArray)) {
                 return refuse('QRESYNC message sequence match data is not allowed once UIDONLY is enabled');
             }
         }
-
         return false;
     };
-
     server.commandChecks.push((connection, parsed) => isUidonly(connection) && getRefusal(connection, parsed));
-
     // a prohibited command is refused before its literal is sent, before other checks that would answer NO
     server.literalFilters.unshift((connection, command) => isUidonly(connection) && getRefusal(connection, { command }));
-
-    server.connectionHandlers.push(connection => {
+    server.connectionHandlers.push((connection) => {
         // RFC 3501 section 5.5 is about commands with message numbers, these are all refused with
         // BAD [UIDREQUIRED] once UIDONLY is enabled, as if they had waited
         const isAmbiguous = connection.isAmbiguous;
         connection.isAmbiguous = function (parsed) {
             return !isUidonly(this) && isAmbiguous.call(this, parsed);
         };
-
         // RFC 9586 sections 3.4 and 3.6: expunges are announced with VANISHED instead of EXPUNGE, EXISTS and
         // RECENT stay as they are
         const prepareNotifications = connection.prepareNotifications;
@@ -78,24 +62,20 @@ module.exports = function (server) {
             return isUidonly(this) ? toVanished(queue) : queue;
         };
     });
-
     // RFC 9586 section 3: the server MUST NOT return message sequence numbers in any response
     const outputHandler = (connection, response, description, parsed, data, extra) => {
         if (!response || response.tag !== '*' || !Array.isArray(response.attributes) || !isUidonly(connection)) {
             return;
         }
         const attributes = response.attributes;
-
         // the UNSEEN response code of SELECT and EXAMINE is a message number (RFC 3501 section 7.1)
         if (response.command === 'OK' && attributes[0] && attributes[0].type === 'SECTION' && isAtom(attributes[0].section[0], 'UNSEEN')) {
             response.skipResponse = true;
             return;
         }
-
         if (!isAtom(attributes[1], 'FETCH') || !Array.isArray(attributes[2])) {
             return;
         }
-
         // section 3.3: uidfetch-resp = uniqueid SP "UIDFETCH" SP msg-att
         // FETCH responses pass their message as `extra`, notifications like the MessageNew FETCH of NOTIFY carry it
         const list = attributes[2];
@@ -107,7 +87,6 @@ module.exports = function (server) {
             response.skipResponse = true;
             return;
         }
-
         // the UID data item is only included if the client asked for it, like in the examples of section 3.3
         if (parsed && !('uidonlyKeepUid' in parsed)) {
             parsed.uidonlyKeepUid = requestsUid(parsed);
@@ -118,12 +97,10 @@ module.exports = function (server) {
         }
         response.attributes = [uid, { type: 'ATOM', value: 'UIDFETCH' }, items];
     };
-
     // registered once every plugin is loaded, so that the other output handlers see the FETCH responses they
     // know before these are turned into UIDFETCH responses
     server.once('pluginsLoaded', () => server.outputHandlers.push(outputHandler));
-};
-
+}
 // Checks if a UID FETCH command lists the UID data item
 function requestsUid(parsed) {
     if (String(parsed.command || '').toUpperCase() !== 'UID FETCH' || !parsed.attributes) {
@@ -131,5 +108,4 @@ function requestsUid(parsed) {
     }
     return [].concat(parsed.attributes[1] || []).some(item => isAtom(item, 'UID'));
 }
-
-module.exports.requires = ['ENABLE'];
+uidonlyPlugin.requires = ['ENABLE'];

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

@@ -0,0 +1,15 @@
+import type { IMAPServer } from '../types.js';
+/**
+ * @help Adds UIDPLUS [RFC4315] capability
+ *
+ * UIDPLUS: http://tools.ietf.org/html/rfc4315
+ *
+ * Additional commands:
+ * - UID EXPUNGE
+ *
+ * Additional response codes:
+ * - APPENDUID (with a UID set for MULTIAPPEND, and in an untagged OK for REPLACE)
+ * - COPYUID
+ * - Not implemented: UIDNOTSTICKY
+ */
+export default function uidplusPlugin(server: IMAPServer): void;

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

@@ -1,7 +1,4 @@
-'use strict';
-
-const { toSequenceSet } = require('../esearch');
-
+import { toSequenceSet } from '../esearch.js';
 /**
  * @help Adds UIDPLUS [RFC4315] capability
  *
@@ -15,63 +12,47 @@ const { toSequenceSet } = require('../esearch');
  * - COPYUID
  * - Not implemented: UIDNOTSTICKY
  */
-module.exports = function (server) {
+export default function uidplusPlugin(server) {
     server.registerCapability('UIDPLUS');
-
     server.setCommandHandler('UID EXPUNGE', (connection, parsed, data, callback) => {
         if (!parsed.attributes || parsed.attributes.length !== 1 || !parsed.attributes[0] || ['ATOM', 'SEQUENCE'].indexOf(parsed.attributes[0].type) < 0) {
-            connection.send(
-                {
-                    tag: parsed.tag,
-                    command: 'BAD',
-                    attributes: [
-                        {
-                            type: 'TEXT',
-                            value: 'UID EXPUNGE expects uid sequence set'
-                        }
-                    ]
-                },
-                'INVALID COMMAND',
-                parsed,
-                data
-            );
+            connection.send({
+                tag: parsed.tag,
+                command: 'BAD',
+                attributes: [
+                    {
+                        type: 'TEXT',
+                        value: 'UID EXPUNGE expects uid sequence set'
+                    }
+                ]
+            }, 'INVALID COMMAND', parsed, data);
             return callback();
         }
-
         if (connection.refuseReadOnly(parsed, data, 'UID EXPUNGE FAILED')) {
             return callback();
         }
-
         const sequence = parsed.attributes[0].value;
         const range = connection.limitRange(parsed, connection.getMessageRange(sequence, true));
         // Only messages with the \Deleted flag are removed (RFC 4315 section 2.1)
-        const rangeMessages = range.map(x => x[1]).filter(message => message.flags.indexOf('\\Deleted') >= 0);
-
+        const rangeMessages = range.map(x => x[1]).filter((message) => message.flags.indexOf('\\Deleted') >= 0);
         connection.expungeSpecificMessages(connection.selectedMailbox, rangeMessages, false, true, !!parsed.highestFirst);
-
-        connection.send(
-            {
-                tag: parsed.tag,
-                command: 'OK',
-                attributes: [
-                    {
-                        type: 'TEXT',
-                        value: 'UID EXPUNGE completed'
-                    }
-                ]
-            },
-            'UID EXPUNGE',
-            parsed,
-            data
-        );
+        connection.send({
+            tag: parsed.tag,
+            command: 'OK',
+            attributes: [
+                {
+                    type: 'TEXT',
+                    value: 'UID EXPUNGE completed'
+                }
+            ]
+        }, 'UID EXPUNGE', parsed, data);
         callback();
     });
-
     server.outputHandlers.push((connection, response, description, parsed, data, extra) => {
         if (description === 'APPEND' || description === 'REPLACE APPENDUID') {
             // OK [APPENDUID <target-mailbox-uidvalidity> <uid>] APPEND Completed. With MULTIAPPEND the
             // second value is a UID set, but never for a single message (RFC 4315 section 3)
-            const uids = extra.messages.map(message => message.uid);
+            const uids = extra.messages.map((message) => message.uid);
             response.attributes = [
                 {
                     type: 'SECTION',
@@ -89,7 +70,6 @@ module.exports = function (server) {
             response.skipResponse = false;
             return;
         }
-
         if (description === 'COPY' || description === 'UID COPY' || description === 'MOVE COPYUID' || description === 'UID MOVE COPYUID') {
             // Nothing was copied, an empty COPYUID would break the response grammar
             if (!extra || !extra.sourceUids || !extra.sourceUids.length) {
@@ -121,4 +101,4 @@ module.exports = function (server) {
             return;
         }
     });
-};
+}

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

@@ -0,0 +1,7 @@
+import type { IMAPServer } from '../types.js';
+/**
+ * @help Adds UNAUTHENTICATE [RFC8437] capability
+ * @help Returns to the Not Authenticated state, everything
+ * @help but TLS is reset (selected mailbox, ENABLE, COMPRESS)
+ */
+export default function unauthenticatePlugin(server: IMAPServer): void;

package/dist/esm/plugins/unauthenticate.js

@@ -0,0 +1,17 @@
+import { states } from '../command-states.js';
+/**
+ * @help Adds UNAUTHENTICATE [RFC8437] capability
+ * @help Returns to the Not Authenticated state, everything
+ * @help but TLS is reset (selected mailbox, ENABLE, COMPRESS)
+ */
+export default function unauthenticatePlugin(server) {
+    server.registerCapability('UNAUTHENTICATE');
+    server.setCommandHandler('UNAUTHENTICATE', (connection, parsed, data, callback) => {
+        // RFC 8437 section 3: a NO response is not permitted, the reset can not fail here
+        connection.sendStatus(parsed, data, 'OK', 'Completed, now in not authenticated state');
+        // RFC 8437 sections 3 and 4.1: the mailbox is closed without EXPUNGE responses, ENABLEd
+        // extensions and CONDSTORE are turned off, and compression ends after the CRLF of the OK
+        connection.resetSession();
+        return callback();
+    }, { states: states.AUTHENTICATED, noArguments: true });
+}

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

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

package/dist/esm/plugins/unselect.js

@@ -0,0 +1,21 @@
+import { states } from '../command-states.js';
+/**
+ * @help Adds UNSELECT [RFC3691] capability
+ */
+export default function unselectPlugin(server) {
+    server.registerCapability('UNSELECT');
+    server.setCommandHandler('UNSELECT', (connection, parsed, data, callback) => {
+        connection.send({
+            tag: parsed.tag,
+            command: 'OK',
+            attributes: [
+                {
+                    type: 'TEXT',
+                    value: 'Mailbox closed'
+                }
+            ]
+        }, 'CLOSE', parsed, data);
+        connection.closeMailbox();
+        return callback();
+    }, { states: states.SELECTED, noArguments: true });
+}

package/dist/esm/plugins/utf8-accept.d.ts

@@ -0,0 +1,6 @@
+import type { IMAPServer } from '../types.js';
+declare function utf8AcceptPlugin(server: IMAPServer): void;
+declare namespace utf8AcceptPlugin {
+    var requires: string[];
+}
+export default utf8AcceptPlugin;

package/{lib → dist/esm}/plugins/utf8-accept.js

@@ -1,14 +1,10 @@
-'use strict';
-
-const { updateSession } = require('../utf8-session');
-const { registerEnable } = require('./enable');
-
+import { updateSession } from '../utf8-session.js';
+import { registerEnable } from './enable.js';
 /**
  * @help Adds UTF8=ACCEPT [RFC9755] capability, loads ENABLE as well
  * @help After ENABLE UTF8=ACCEPT mailbox names are UTF-8 instead of
  * @help modified UTF-7 and strings are sent quoted as UTF-8
  */
-
 /**
  * Checks if the header of a message holds 8-bit octets
  *
@@ -19,21 +15,17 @@ function has8bitHeader(raw) {
     const match = raw.match(/\r?\n\r?\n/);
     return /[\x80-\xff]/.test(match ? raw.substr(0, match.index) : raw);
 }
-
-module.exports = function (server) {
+export default function utf8AcceptPlugin(server) {
     // RFC 9755 section 3: the client turns UTF-8 support on with ENABLE
     server.registerCapability('UTF8=ACCEPT');
-
     registerEnable(server, 'UTF8=ACCEPT');
-
     // RFC 9755 section 3: a server that supports UTF8=ACCEPT accepts UTF-8 in quoted strings. Before
     // ENABLE, mailbox names must still be modified UTF-7 and SEARCH needs CHARSET UTF-8 for 8-bit strings.
-    // See lib/utf8-session.js, the session state is shared with IMAP4rev2
+    // See src/utf8-session.ts, the session state is shared with IMAP4rev2
     server.utf8Accept = true;
     server.connectionHandlers.push(updateSession);
     // RFC 8437 section 3: UNAUTHENTICATE resets the ENABLEd extensions
     server.resetHandlers.push(updateSession);
-
     server.outputHandlers.push((connection, response, description, parsed, data, extra) => {
         if (description === 'ENABLED' && Array.isArray(extra) && extra.indexOf('UTF8=ACCEPT') >= 0) {
             // strings that are valid UTF-8 are sent quoted, mailbox names are UTF-8 in both directions
@@ -41,7 +33,6 @@ module.exports = function (server) {
             updateSession(connection);
         }
     });
-
     // RFC 9755 section 4: without ENABLE UTF8=ACCEPT, APPEND MUST be refused with NO
     // if the message header has 8-bit characters
     const appendHandler = server.getCommandHandler('APPEND');
@@ -49,20 +40,18 @@ module.exports = function (server) {
         const args = parsed.attributes || [];
         const raw = args[args.length - 1];
         if (
-            // UTF-8 is on after ENABLE UTF8=ACCEPT, or IMAP4rev2, which permits 8-bit characters in the message
-            // (RFC 9051 section 6.3.12) and which RFC 9755 does not extend
-            !connection.utf8Enabled &&
+        // UTF-8 is on after ENABLE UTF8=ACCEPT, or IMAP4rev2, which permits 8-bit characters in the message
+        // (RFC 9051 section 6.3.12) and which RFC 9755 does not extend
+        !connection.utf8Enabled &&
             args.length >= 2 &&
             raw &&
             ['LITERAL', 'LITERAL8'].indexOf(raw.type) >= 0 &&
-            has8bitHeader(raw.value || '')
-        ) {
+            has8bitHeader(raw.value || '')) {
             connection.sendStatus(parsed, data, 'NO', 'Message header has 8-bit characters, ENABLE UTF8=ACCEPT first (RFC 9755 section 4)');
             return callback();
         }
         return appendHandler(connection, parsed, data, callback);
     });
-};
-
+}
 // ENABLE UTF8=ACCEPT is the only way to use this extension
-module.exports.requires = ['ENABLE'];
+utf8AcceptPlugin.requires = ['ENABLE'];

package/dist/esm/plugins/x-gm-ext-1.d.ts

@@ -0,0 +1,26 @@
+import type { IMAPServer } from '../types.js';
+/**
+ * @help Adds Gmail specific X-GM-EXT-1 capability
+ * @help (https://developers.google.com/workspace/gmail/imap/imap-extensions)
+ * @help   X-GM-MSGID and X-GM-THRID: FETCH and SEARCH. X-GM-THRID is the
+ * @help       X-GM-MSGID of the message unless storage sets an X-GM-THRID
+ * @help       value, so every message is its own thread unless the
+ * @help       fixture groups messages. With OBJECTID, the messages of a
+ * @help       THREADID share the X-GM-THRID of its first message
+ * @help   X-GM-LABELS: FETCH, STORE (+/-, .SILENT) and SEARCH. System
+ * @help       labels are atoms that start with "\" (\Inbox for INBOX, the
+ * @help       special-use attribute for special-use mailboxes), other labels
+ * @help       are mailbox names, sent like mailbox names (modified UTF-7, or
+ * @help       UTF-8 after ENABLE UTF8=ACCEPT, quoted when not atoms). Labels
+ * @help       have no side effects: the message is not copied to or removed
+ * @help       from other mailboxes. In SEARCH a label that starts with "\"
+ * @help       is a system label
+ * @help   X-GM-RAW: a subset of the Gmail search syntax. Words and "quoted
+ * @help       phrases" (TEXT), -term, OR, (groups), {any of}, from: to: cc:
+ * @help       bcc: subject: label: in: (inbox sent drafts trash spam
+ * @help       anywhere, or a label) is: (read unread starred important)
+ * @help       larger: smaller: (k and m suffixes) after: before:
+ * @help       (YYYY/MM/DD) and rfc822msgid:. Other Gmail operators are
+ * @help       answered with NO
+ */
+export default function xGmExt1Plugin(server: IMAPServer): void;