imapflow 2.5.9 → 2.7.0

package/dist/esm/types.d.ts

@@ -76,8 +76,13 @@ export interface ImapFlowOptions {
     emitLogs?: boolean | undefined;
     /** If true, then logs out automatically after successful authentication */
     verifyOnly?: boolean | undefined;
-    /** If true and verifyOnly is set, lists mailboxes */
+    /** If true and verifyOnly is set, lists mailboxes. The listing is in `client.mailboxList` once `connect()` resolved */
     includeMailboxes?: boolean | undefined;
+    /**
+     * Data of the application's own to keep with the client, such as the account the connection
+     * belongs to. ImapFlow never reads it, it is the initial value of `client.context`
+     */
+    context?: unknown;
     /**
      * Proxy URL. Supports HTTP CONNECT (http:, https:) and SOCKS (socks:, socks4:, socks4a:,
      * socks5:) proxies. IPv6 proxy endpoints are given in URL form, e.g. `socks5://[2001:db8::1]:1080`.
@@ -789,6 +794,22 @@ export interface ExistsEvent {
     /** Message count before this update */
     prevCount: number;
 }
+/**
+ * Payload of the `highestModseq` event: the HIGHESTMODSEQ of the selected mailbox changed (RFC
+ * 7162), so flags or other message metadata changed on the server. Emitted when a poll on a
+ * server without IDLE (`missingIdleCommand` STATUS or SELECT) or a STATUS or re-SELECT of the
+ * open mailbox reports a new value, which is when the changes themselves are not delivered as
+ * `flags` events. A consumer resynchronizes with `fetch(range, { flags: true }, { changedSince:
+ * prevHighestModseq })`.
+ */
+export interface HighestModseqEvent {
+    /** Mailbox path */
+    path: string;
+    /** The new HIGHESTMODSEQ value */
+    highestModseq: bigint;
+    /** The value before this update, undefined when none was known */
+    prevHighestModseq?: bigint | undefined;
+}
 export interface FlagsEvent {
     /** Mailbox path */
     path: string;
@@ -888,7 +909,10 @@ export interface TlsInfo extends CipherNameAndProtocol {
 export interface ImapFlowEvents {
     /** Connection close event */
     close: [];
-    /** Error event */
+    /**
+     * Error event. Emitted at most once per connection, the connection closes after it. An error
+     * while `connect()` is pending rejects `connect()` instead and is not emitted
+     */
     error: [error: Error];
     /** Message count in currently opened mailbox changed */
     exists: [data: ExistsEvent];
@@ -896,7 +920,13 @@ export interface ImapFlowEvents {
     expunge: [data: ExpungeEvent];
     /** Flags were updated for a message */
     flags: [data: FlagsEvent];
-    /** Mailbox was opened */
+    /** The HIGHESTMODSEQ of the selected mailbox changed without the changes being reported, see {@link HighestModseqEvent} */
+    highestModseq: [data: HighestModseqEvent];
+    /**
+     * Mailbox was opened. Also emitted, after `mailboxClose` for the old mailbox object, when the
+     * open mailbox turned out to have a new UIDVALIDITY (a re-SELECT, or a STATUS poll on a server
+     * without IDLE, which then selects the mailbox again): every cached UID of it is invalid
+     */
     mailboxOpen: [mailbox: MailboxObject];
     /** Mailbox was closed, either explicitly or because the connection went away while a mailbox was still selected */
     mailboxClose: [mailbox: MailboxObject];

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "imapflow",
-    "version": "2.5.9",
+    "version": "2.7.0",
     "description": "IMAP Client for Node",
     "type": "module",
     "main": "./dist/cjs/imap-flow.js",