imapkit 4.0.2 → 4.1.0

package/dist/esm/smtp-listener.d.ts

@@ -0,0 +1,13 @@
+import { SMTPServer } from 'smtp-server';
+import type { IMAPServer } from './types.js';
+/**
+ * Starts an SMTP server that appends every received message to the INBOX
+ * of the given ImapKit IMAP server. Any sender, recipient and credentials
+ * are accepted.
+ *
+ * @param {Number} smtpPort - port to listen on for SMTP commands
+ * @param {Object} imapServer - the ImapKit IMAP server
+ * @param {Function} [callback] - function executed when SMTP server is listening
+ * @return {SMTPServer} the SMTP server instance, use `close()` to stop it
+ */
+export declare function startSMTPServer(smtpPort: number, imapServer: IMAPServer, callback?: (() => void) | null): SMTPServer;

package/{lib → dist/esm}/smtp-listener.js

@@ -1,7 +1,4 @@
-'use strict';
-
-const { SMTPServer } = require('smtp-server');
-
+import { SMTPServer } from 'smtp-server';
 /**
  * Starts an SMTP server that appends every received message to the INBOX
  * of the given ImapKit IMAP server. Any sender, recipient and credentials
@@ -12,9 +9,8 @@ const { SMTPServer } = require('smtp-server');
  * @param {Function} [callback] - function executed when SMTP server is listening
  * @return {SMTPServer} the SMTP server instance, use `close()` to stop it
  */
-exports.startSMTPServer = function startSMTPServer(smtpPort, imapServer, callback) {
+export function startSMTPServer(smtpPort, imapServer, callback) {
     const credentials = imapServer.getCredentials();
-
     const server = new SMTPServer({
         banner: 'ImapKit',
         key: credentials.key,
@@ -26,7 +22,7 @@ exports.startSMTPServer = function startSMTPServer(smtpPort, imapServer, callbac
         },
         onData(stream, session, done) {
             const chunks = [];
-            stream.on('data', chunk => chunks.push(chunk));
+            stream.on('data', (chunk) => chunks.push(chunk));
             stream.on('error', done);
             stream.on('end', () => {
                 // smtp-server has already removed the dot-stuffing (RFC 5321 section 4.5.2)
@@ -35,17 +31,14 @@ exports.startSMTPServer = function startSMTPServer(smtpPort, imapServer, callbac
             });
         }
     });
-
-    server.on('error', err => {
+    server.on('error', (err) => {
         if (imapServer.options.debug) {
             console.error('SMTP server error: %s', err.message);
         }
     });
-
     server.listen(smtpPort, () => {
         console.log('Incoming SMTP server up and running on port %s', server.server.address().port);
         callback?.();
     });
-
     return server;
-};
+}

package/dist/esm/sorting.d.ts

@@ -0,0 +1,77 @@
+import makeSearch from './commands/handlers/search.js';
+import type { Attribute, IMAPConnection, Message, ParsedCommand } from './types.js';
+/**
+ * Returns the i;unicode-casemap form of a string (RFC 5051 section 2): every character is titlecased
+ * and then decomposed (NFKD). Comparing the UTF-8 octets of the results is the collation that
+ * RFC 5256 section 7 requires for SORT and THREAD (I18NLEVEL=1, RFC 5255 section 4.5)
+ *
+ * @param {String} str Unicode string
+ * @return {Buffer} UTF-8 octets to compare with Buffer.compare
+ */
+declare function collationKey(str: string): Buffer;
+/**
+ * Extracts the base subject (RFC 5256 section 2.1) and tells if the subject marks a reply or a
+ * forward (RFC 5256 section 3, REFERENCES): the extraction removed a subj-refwd, a "(fwd)" trailer
+ * or a subj-fwd-hdr and subj-fwd-trl pair.
+ *
+ * @param {String} subject Subject header value as a binary string
+ * @return {Object} `{ subject, isReply }`, subject is the base subject as a Unicode string
+ */
+declare function baseSubject(subject: string | undefined): {
+    subject: string;
+    isReply: boolean;
+};
+/**
+ * Internal date and time of a message in milliseconds (RFC 5256 ARRIVAL)
+ *
+ * @param {Object} message Message object
+ * @return {Number} timestamp, 0 if the internal date can not be parsed
+ */
+declare function arrivalTime(message: Message): number;
+/**
+ * Sent date of a message in milliseconds (RFC 5256 section 2.2): the Date header normalized to UTC.
+ * An invalid zone is read as UTC and an invalid time as 00:00:00, and if the header is missing or
+ * has no valid date, the internal date is used instead.
+ *
+ * @param {Object} message Message object
+ * @return {Number} timestamp
+ */
+declare function sentTime(message: Message): number;
+/**
+ * addr-mailbox of the first address in a header (RFC 5256 CC, FROM and TO), empty if there is none
+ *
+ * @param {Object} message Message object
+ * @param {String} header "from", "to" or "cc"
+ * @return {String} Unicode string
+ */
+declare function addressMailbox(message: Message, header: string): string;
+/**
+ * DISPLAY sort value of the first address in a header (RFC 5957 sections 3 and 4): the decoded
+ * addr-name, or addr-mailbox@addr-host, or addr-mailbox, or the empty string
+ *
+ * @param {Object} message Message object
+ * @param {String} header "from" or "to"
+ * @return {String} Unicode string
+ */
+declare function displayAddress(message: Message, header: string): string;
+/**
+ * Lists the Message IDs in a header value, normalized so that quoting does not matter (RFC 5256
+ * section 3, REFERENCES): comments and white space are dropped and a quoted id-left is unquoted.
+ * Only ids of the form "<" id-left "@" id-right ">" (RFC 5322 section 3.6.4) are valid.
+ *
+ * @param {String|Array} value Header value
+ * @return {Array} Message IDs
+ */
+declare function parseMessageIds(value: string | string[] | undefined): string[];
+/**
+ * Runs the search part of SORT and THREAD (RFC 5256 section 3): the charset is mandatory and the
+ * criteria follow it, both as in SEARCH. Sends a tagged BAD or NO response if the search fails.
+ *
+ * @param {Object} connection IMAP connection
+ * @param {Object} parsed Parsed command
+ * @param {String} data Raw command
+ * @param {Array} attributes Command arguments starting with the charset
+ * @return {Object|Boolean} `{ list, numbers }` like the SEARCH handler returns, or false after an error
+ */
+declare function searchMessages(connection: IMAPConnection, parsed: ParsedCommand, data: string, attributes: Attribute[]): ReturnType<typeof makeSearch> | false;
+export { collationKey, baseSubject, arrivalTime, sentTime, addressMailbox, displayAddress, parseMessageIds, searchMessages };

package/{lib → dist/esm}/sorting.js

@@ -1,15 +1,11 @@
-'use strict';
-
 // Message values for SORT and THREAD (RFC 5256): string collation, base subject, sent date,
 // addresses and Message IDs, and the search step that both commands start with
-
-const { getMessageData } = require('./mimeparser');
-const { processAddress } = require('./envelope');
-const { parseDateTime, parseHeaderDate, toTimestamp } = require('./dates');
-const makeSearch = require('./commands/handlers/search');
-const { badError, criteriaValues, sendSearchError } = makeSearch;
-const { decodeHeader } = require('./encoded-words');
-
+import { getMessageData } from './mimeparser.js';
+import { processAddress } from './envelope.js';
+import { parseDateTime, parseHeaderDate, toTimestamp } from './dates.js';
+import makeSearch from './commands/handlers/search.js';
+import { badError, criteriaValues, sendSearchError } from './commands/handlers/search.js';
+import { decodeHeader } from './encoded-words.js';
 // UnicodeData.txt titlecase mappings that differ from the single code point uppercase mapping
 // that String#toUpperCase gives: the Latin digraphs and the Greek letters with ypogegrammeni
 const TITLECASE = new Map([
@@ -30,7 +26,6 @@ for (const start of [0x1f80, 0x1f90, 0x1fa0]) {
         TITLECASE.set(start + i, start + i + 8);
     }
 }
-
 /**
  * Returns the i;unicode-casemap form of a string (RFC 5051 section 2): every character is titlecased
  * and then decomposed (NFKD). Comparing the UTF-8 octets of the results is the collation that
@@ -53,12 +48,10 @@ function collationKey(str) {
     }
     return Buffer.from(result.normalize('NFKD'), 'utf-8');
 }
-
 // RFC 5256 section 5: subj-refwd = ("re" / ("fw" ["d"])) *WSP [subj-blob] ":", subj-blob = "[" *BLOBCHAR "]" *WSP
 const SUBJ_BLOB = '\\[[^[\\]]*\\] *';
 const SUBJ_LEADER = new RegExp('^(?:' + SUBJ_BLOB + ')*(?:re|fwd?) *(?:' + SUBJ_BLOB + ')?:', 'i');
 const SUBJ_BLOB_PREFIX = new RegExp('^' + SUBJ_BLOB);
-
 /**
  * Extracts the base subject (RFC 5256 section 2.1) and tells if the subject marks a reply or a
  * forward (RFC 5256 section 3, REFERENCES): the extraction removed a subj-refwd, a "(fwd)" trailer
@@ -69,55 +62,54 @@ const SUBJ_BLOB_PREFIX = new RegExp('^' + SUBJ_BLOB);
  */
 function baseSubject(subject) {
     let isReply = false;
-
     // (1) decode encoded words, tabs and continuations become a space, runs of spaces one space
     let text = decodeHeader(subject)
         .replace(/\r?\n(?=[ \t])/g, '')
         .replace(/[\t\r\n]/g, ' ')
         .replace(/ {2,}/g, ' ');
-
     for (;;) {
         // (2) remove subj-trailer text until there is none
         let end = text.length;
         for (;;) {
             if (text.charAt(end - 1) === ' ') {
                 end--;
-            } else if (end >= 5 && text.substring(end - 5, end).toLowerCase() === '(fwd)') {
+            }
+            else if (end >= 5 && text.substring(end - 5, end).toLowerCase() === '(fwd)') {
                 isReply = true;
                 end -= 5;
-            } else {
+            }
+            else {
                 break;
             }
         }
         text = text.substring(0, end);
-
         // (3) remove subj-leader text, (4) remove a subj-blob prefix if a subj-base remains, (5) repeat
         for (;;) {
             let match;
             if (text.charAt(0) === ' ') {
                 text = text.substr(1);
-            } else if ((match = text.match(SUBJ_LEADER))) {
+            }
+            else if ((match = text.match(SUBJ_LEADER))) {
                 isReply = true;
                 text = text.substr(match[0].length);
-            } else if ((match = text.match(SUBJ_BLOB_PREFIX)) && match[0].length < text.length) {
+            }
+            else if ((match = text.match(SUBJ_BLOB_PREFIX)) && match[0].length < text.length) {
                 text = text.substr(match[0].length);
-            } else {
+            }
+            else {
                 break;
             }
         }
-
         // (6) unwrap "[fwd: ... ]" and start over from step (2)
         if (/^\[fwd:/i.test(text) && /\]$/.test(text)) {
             isReply = true;
             text = text.slice(5, -1);
             continue;
         }
-
         // (7) the remaining text is the base subject
         return { subject: text, isReply };
     }
 }
-
 /**
  * Internal date and time of a message in milliseconds (RFC 5256 ARRIVAL)
  *
@@ -128,7 +120,6 @@ function arrivalTime(message) {
     const date = parseDateTime(message.internaldate);
     return date ? toTimestamp(date) : 0;
 }
-
 /**
  * Sent date of a message in milliseconds (RFC 5256 section 2.2): the Date header normalized to UTC.
  * An invalid zone is read as UTC and an invalid time as 00:00:00, and if the header is missing or
@@ -142,12 +133,12 @@ function sentTime(message) {
     if (!date) {
         return arrivalTime(message);
     }
+    // the parsers set minutes and seconds together with hours
     if (date.hours === undefined || date.hours > 23 || date.minutes > 59 || date.seconds > 60) {
         Object.assign(date, { hours: 0, minutes: 0, seconds: 0 });
     }
     return toTimestamp(date);
 }
-
 /**
  * Returns the first address of an envelope address list, as [name, adl, mailbox, host]
  */
@@ -155,7 +146,6 @@ function firstAddress(message, header) {
     const list = processAddress(getMessageData(message).tree.parsedHeader[header]);
     return (list && list[0]) || null;
 }
-
 /**
  * addr-mailbox of the first address in a header (RFC 5256 CC, FROM and TO), empty if there is none
  *
@@ -167,7 +157,6 @@ function addressMailbox(message, header) {
     const address = firstAddress(message, header);
     return address && address[2] ? decodeHeader(address[2]) : '';
 }
-
 /**
  * DISPLAY sort value of the first address in a header (RFC 5957 sections 3 and 4): the decoded
  * addr-name, or addr-mailbox@addr-host, or addr-mailbox, or the empty string
@@ -184,7 +173,6 @@ function displayAddress(message, header) {
     }
     return decodeHeader(address[3] ? address[2] + '@' + address[3] : address[2]);
 }
-
 /**
  * Lists the Message IDs in a header value, normalized so that quoting does not matter (RFC 5256
  * section 3, REFERENCES): comments and white space are dropped and a quoted id-left is unquoted.
@@ -199,7 +187,6 @@ function parseMessageIds(value) {
     let depth = 0;
     let quoted = false;
     let current = null;
-
     for (let i = 0; i < str.length; i++) {
         const char = str.charAt(i);
         if (quoted) {
@@ -208,26 +195,35 @@ function parseMessageIds(value) {
                     current += str.charAt(i + 1);
                 }
                 i++;
-            } else if (char === '"') {
+            }
+            else if (char === '"') {
                 quoted = false;
-            } else if (current !== null) {
+            }
+            else if (current !== null) {
                 current += char;
             }
-        } else if (depth) {
+        }
+        else if (depth) {
             if (char === '\\') {
                 i++;
-            } else if (char === '(') {
+            }
+            else if (char === '(') {
                 depth++;
-            } else if (char === ')') {
+            }
+            else if (char === ')') {
                 depth--;
             }
-        } else if (char === '"') {
+        }
+        else if (char === '"') {
             quoted = true;
-        } else if (char === '(') {
+        }
+        else if (char === '(') {
             depth++;
-        } else if (char === '<') {
+        }
+        else if (char === '<') {
             current = '';
-        } else if (char === '>') {
+        }
+        else if (char === '>') {
             if (current !== null) {
                 const at = current.lastIndexOf('@');
                 if (at > 0 && at < current.length - 1) {
@@ -235,13 +231,13 @@ function parseMessageIds(value) {
                 }
             }
             current = null;
-        } else if (current !== null && !/\s/.test(char)) {
+        }
+        else if (current !== null && !/\s/.test(char)) {
             current += char;
         }
     }
     return ids;
 }
-
 /**
  * Runs the search part of SORT and THREAD (RFC 5256 section 3): the charset is mandatory and the
  * criteria follow it, both as in SEARCH. Sends a tagged BAD or NO response if the search fails.
@@ -273,19 +269,10 @@ function searchMessages(connection, parsed, data, attributes) {
         }
         const params = ['CHARSET', charset.value].concat(criteria);
         return makeSearch(connection, connection.getSessionMessages(), params);
-    } catch (E) {
+    }
+    catch (E) {
         sendSearchError(connection, parsed, data, E, command + ' FAILED');
         return false;
     }
 }
-
-module.exports = {
-    collationKey,
-    baseSubject,
-    arrivalTime,
-    sentTime,
-    addressMailbox,
-    displayAddress,
-    parseMessageIds,
-    searchMessages
-};
+export { collationKey, baseSubject, arrivalTime, sentTime, addressMailbox, displayAddress, parseMessageIds, searchMessages };

package/dist/esm/threading.d.ts

@@ -0,0 +1,30 @@
+import type { IMAPServer, Message } from './types.js';
+/** A searched message with the values that threading looks at */
+export interface ThreadEntry {
+    message: Message;
+    seq: number;
+    /** sent date, see sentTime() */
+    date: number;
+    /** the base subject as a binary string of its collation key, and if the subject marks a reply or forward */
+    subject: {
+        id: string;
+        isReply: boolean;
+    };
+}
+/** A node of a thread tree, a node without an entry is a dummy */
+export interface ThreadNode {
+    entry: ThreadEntry | null;
+    parent: ThreadNode | null;
+    children: ThreadNode[];
+}
+/** A threading algorithm, returns the top level nodes */
+export type ThreadAlgorithm = (entries: ThreadEntry[]) => ThreadNode[];
+/**
+ * Adds the THREAD and UID THREAD commands, unless another algorithm plugin did already, and the
+ * THREAD=<algorithm> capability
+ *
+ * @param {Object} server IMAP server
+ * @param {String} algorithm "ORDEREDSUBJECT" or "REFERENCES"
+ */
+declare function addThreadAlgorithm(server: IMAPServer, algorithm: string): void;
+export { addThreadAlgorithm };