imapflow 2.0.7 → 2.0.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (78) hide show
  1. package/CHANGELOG.md +9 -0
  2. package/dist/cjs/commands/append.js +12 -12
  3. package/dist/cjs/commands/authenticate.d.ts +3 -8
  4. package/dist/cjs/commands/close.js +2 -1
  5. package/dist/cjs/commands/copy.js +4 -4
  6. package/dist/cjs/commands/create.js +2 -3
  7. package/dist/cjs/commands/delete.js +4 -4
  8. package/dist/cjs/commands/expunge.js +8 -5
  9. package/dist/cjs/commands/fetch.js +12 -10
  10. package/dist/cjs/commands/idle.js +6 -2
  11. package/dist/cjs/commands/list.js +2 -2
  12. package/dist/cjs/commands/move.js +11 -6
  13. package/dist/cjs/commands/namespace.js +1 -1
  14. package/dist/cjs/commands/quota.js +10 -9
  15. package/dist/cjs/commands/rename.js +4 -4
  16. package/dist/cjs/commands/search.js +7 -8
  17. package/dist/cjs/commands/select.js +5 -6
  18. package/dist/cjs/commands/status.js +11 -11
  19. package/dist/cjs/commands/store.js +5 -5
  20. package/dist/cjs/commands/subscribe.js +2 -17
  21. package/dist/cjs/commands/subscription.d.ts +10 -0
  22. package/dist/cjs/commands/subscription.js +29 -0
  23. package/dist/cjs/commands/unsubscribe.js +2 -17
  24. package/dist/cjs/download.d.ts +22 -0
  25. package/dist/cjs/download.js +588 -0
  26. package/dist/cjs/errors.d.ts +2 -0
  27. package/dist/cjs/handler/imap-compiler.js +1 -1
  28. package/dist/cjs/handler/imap-stream.js +4 -4
  29. package/dist/cjs/handler/parser-instance.js +2 -2
  30. package/dist/cjs/handler/token-parser.js +1 -1
  31. package/dist/cjs/imap-flow.d.ts +16 -7
  32. package/dist/cjs/imap-flow.js +247 -730
  33. package/dist/cjs/jp-decoder.js +1 -1
  34. package/dist/cjs/package-info.d.ts +1 -1
  35. package/dist/cjs/package-info.js +3 -3
  36. package/dist/cjs/search-compiler.js +5 -12
  37. package/dist/cjs/tools.d.ts +51 -10
  38. package/dist/cjs/tools.js +77 -15
  39. package/dist/cjs/types.d.ts +30 -16
  40. package/dist/esm/commands/append.js +13 -13
  41. package/dist/esm/commands/authenticate.d.ts +3 -8
  42. package/dist/esm/commands/close.js +2 -1
  43. package/dist/esm/commands/copy.js +5 -5
  44. package/dist/esm/commands/create.js +3 -4
  45. package/dist/esm/commands/delete.js +5 -5
  46. package/dist/esm/commands/expunge.js +9 -6
  47. package/dist/esm/commands/fetch.js +13 -11
  48. package/dist/esm/commands/idle.js +7 -3
  49. package/dist/esm/commands/list.js +2 -2
  50. package/dist/esm/commands/move.js +12 -7
  51. package/dist/esm/commands/namespace.js +2 -2
  52. package/dist/esm/commands/quota.js +11 -10
  53. package/dist/esm/commands/rename.js +5 -5
  54. package/dist/esm/commands/search.js +8 -9
  55. package/dist/esm/commands/select.js +6 -7
  56. package/dist/esm/commands/status.js +12 -12
  57. package/dist/esm/commands/store.js +6 -6
  58. package/dist/esm/commands/subscribe.js +2 -17
  59. package/dist/esm/commands/subscription.d.ts +10 -0
  60. package/dist/esm/commands/subscription.js +26 -0
  61. package/dist/esm/commands/unsubscribe.js +2 -17
  62. package/dist/esm/download.d.ts +22 -0
  63. package/dist/esm/download.js +581 -0
  64. package/dist/esm/errors.d.ts +2 -0
  65. package/dist/esm/handler/imap-compiler.js +1 -1
  66. package/dist/esm/handler/imap-stream.js +4 -4
  67. package/dist/esm/handler/parser-instance.js +2 -2
  68. package/dist/esm/handler/token-parser.js +1 -1
  69. package/dist/esm/imap-flow.d.ts +16 -7
  70. package/dist/esm/imap-flow.js +248 -731
  71. package/dist/esm/jp-decoder.js +1 -1
  72. package/dist/esm/package-info.d.ts +1 -1
  73. package/dist/esm/package-info.js +3 -3
  74. package/dist/esm/search-compiler.js +5 -12
  75. package/dist/esm/tools.d.ts +51 -10
  76. package/dist/esm/tools.js +72 -15
  77. package/dist/esm/types.d.ts +30 -16
  78. package/package.json +4 -4
@@ -7,21 +7,16 @@ import crypto from 'node:crypto';
7
7
  import zlib from 'node:zlib';
8
8
  import { EventEmitter } from 'node:events';
9
9
  import { PassThrough } from 'node:stream';
10
- import libmime from 'libmime';
11
- import libqp from 'libqp';
12
- import libbase64 from 'libbase64';
13
- import { Headers } from '@zone-eu/mailsplit';
14
- import FlowedDecoder from '@zone-eu/mailsplit/lib/flowed-decoder.js';
15
10
  import logger from './logger.js';
16
11
  import * as packageInfo from './package-info.js';
17
- import { LimitedPassthrough, normalizeByteLimit } from './limited-passthrough.js';
18
12
  import { ImapStream } from './handler/imap-stream.js';
19
13
  import { parser, compiler } from './handler/imap-handler.js';
20
14
  import { proxyConnection, detachEarlyErrorHandler } from './proxy-connection.js';
21
15
  import { ConnectionDeadline } from './connection-deadline.js';
16
+ import { downloadMessage, downloadMessageParts } from './download.js';
22
17
  import { AuthenticationFailure } from './errors.js';
23
18
  import imapCommands from './imap-commands.js';
24
- import { comparePaths, updateCapabilities, getFolderTree, formatMessageResponse, getDecoder, packMessageRange, normalizePath, expandRange, getColorFlags, hasCapability, isRev2Active, logConnectionError, unrefTimer, clearTimer, parseUintValue, isUnsafeKey, getStringList, buildConnectionError, guardedPromise, guardedReject, MAX_UINT32_DIGITS } from './tools.js';
19
+ import { comparePaths, updateCapabilities, getFolderTree, formatMessageResponse, packMessageRange, normalizePath, expandRange, getColorFlags, hasCapability, isRev2Active, logConnectionError, unrefTimer, clearTimer, parseUintValue, getStringList, getTextValues, emitSafe, buildConnectionError, guardedPromise, guardedReject, MAX_UINT32_DIGITS } from './tools.js';
25
20
  export { AuthenticationFailure } from './errors.js';
26
21
  const GREETING_TIMEOUT = 16 * 1000;
27
22
  const UPGRADE_TIMEOUT = 10 * 1000;
@@ -160,6 +155,9 @@ export class ImapFlow extends EventEmitter {
160
155
  * Current module version as a static class property
161
156
  */
162
157
  static { this.version = packageInfo.version; }
158
+ /**
159
+ * Creates a client for one IMAP connection. Nothing is sent before `connect()` is called
160
+ */
163
161
  constructor(options) {
164
162
  super({ captureRejections: true });
165
163
  this.options = options || {};
@@ -310,7 +308,7 @@ export class ImapFlow extends EventEmitter {
310
308
  rid = '0'.repeat(20 - rid.length) + rid;
311
309
  }
312
310
  if (rid.length > 20) {
313
- rid = rid.substr(0, 20);
311
+ rid = rid.substring(0, 20);
314
312
  }
315
313
  return rid;
316
314
  }
@@ -898,11 +896,9 @@ export class ImapFlow extends EventEmitter {
898
896
  break;
899
897
  case 'NO':
900
898
  case 'BAD': {
901
- let txt = parsed.attributes &&
902
- parsed.attributes
903
- .filter(val => val.type === 'TEXT')
904
- .map(val => val.value.trim())
905
- .join(' ');
899
+ let txt = getTextValues(parsed.attributes)
900
+ .map(val => val.trim())
901
+ .join(' ');
906
902
  let err = new Error('Command failed');
907
903
  err.response = parsed;
908
904
  err.responseStatus = parsed.command.toUpperCase();
@@ -933,7 +929,7 @@ export class ImapFlow extends EventEmitter {
933
929
  // Example: "tag BAD Request is throttled. Suggested Backoff Time: 92415 milliseconds"
934
930
  if (/Request is throttled/i.test(txt) && /Backoff Time/i.test(txt)) {
935
931
  let throttlingMatch = txt.match(/Backoff Time[:=\s]+(\d+)/i);
936
- if (throttlingMatch && throttlingMatch[1] && !isNaN(throttlingMatch[1])) {
932
+ if (throttlingMatch) {
937
933
  throttleDelay = Number(throttlingMatch[1]);
938
934
  }
939
935
  }
@@ -941,8 +937,14 @@ export class ImapFlow extends EventEmitter {
941
937
  if (throttleDelay) {
942
938
  err.code = 'ETHROTTLE';
943
939
  err.throttleReset = throttleDelay;
944
- // The server-suggested delay can be very large, so throttleWait() caps it
945
- let delayResponse = Math.min(throttleDelay, MAX_THROTTLE_DELAY);
940
+ // The server-suggested delay can be very large, so throttleWait() caps it.
941
+ // The reader loop is parked for the whole wait, so it also stays well
942
+ // inside the socket inactivity timeout: a wait that outlasted it would
943
+ // fire the timeout handler, and the keepalive NOOP it sends can not be
944
+ // read while the loop is parked, so the connection would be torn down.
945
+ // A caller that retries (fetch) waits out the rest of the hint itself.
946
+ let delayResponse = Math.min(throttleDelay, MAX_THROTTLE_DELAY, Math.floor(this.socketTimeout / 2));
947
+ err.throttleWaited = delayResponse;
946
948
  this.log.warn({ msg: 'Throttling detected', cid: this.id, throttleDelay, delayResponse, err });
947
949
  let aborted = await this.throttleWait(delayResponse);
948
950
  if (aborted) {
@@ -1241,7 +1243,9 @@ export class ImapFlow extends EventEmitter {
1241
1243
  let chunk;
1242
1244
  while (this.writeSocket && (chunk = this.writeSocket.read()) !== null) {
1243
1245
  if (this._deflate && this._deflate.write(chunk) === false) {
1244
- this._deflate.once('drain', readNext);
1246
+ this._deflate.once('drain', () => {
1247
+ void readNext();
1248
+ });
1245
1249
  return;
1246
1250
  }
1247
1251
  // Yield to event loop every 100 chunks to prevent CPU blocking
@@ -1267,7 +1271,8 @@ export class ImapFlow extends EventEmitter {
1267
1271
  };
1268
1272
  writeSocket.on('readable', () => {
1269
1273
  if (!reading && this.writeSocket) {
1270
- readNext();
1274
+ // readNext() reports its own failures, the returned promise never rejects
1275
+ void readNext();
1271
1276
  }
1272
1277
  });
1273
1278
  writeSocket.on('error', err => {
@@ -1585,9 +1590,7 @@ export class ImapFlow extends EventEmitter {
1585
1590
  }
1586
1591
  /** @internal */
1587
1592
  async initialOK(message) {
1588
- this.greeting = (message.attributes || [])
1589
- .filter(entry => entry.type === 'TEXT')
1590
- .map(entry => entry.value)
1593
+ this.greeting = getTextValues(message.attributes)
1591
1594
  .filter(entry => entry)
1592
1595
  .join('');
1593
1596
  // ALWAYS emit the error so users can handle it
@@ -1611,10 +1614,8 @@ export class ImapFlow extends EventEmitter {
1611
1614
  async serverBye(parsed) {
1612
1615
  // Extract BYE reason from response for better error messages
1613
1616
  let reason = parsed &&
1614
- parsed.attributes &&
1615
- parsed.attributes
1616
- .filter(val => val.type === 'TEXT')
1617
- .map(val => val.value.trim())
1617
+ getTextValues(parsed.attributes)
1618
+ .map(val => val.trim())
1618
1619
  .join(' ');
1619
1620
  this.byeReason = reason || 'Server closed connection';
1620
1621
  this.untaggedHandlers.BYE = null;
@@ -1801,7 +1802,7 @@ export class ImapFlow extends EventEmitter {
1801
1802
  // Replace "*" with the actual message count. Some servers reject bare "*"
1802
1803
  // in certain commands, and this also forces a sequence query (not UID).
1803
1804
  if (value === '*') {
1804
- if (!this.mailbox.exists) {
1805
+ if (!this.mailbox || !this.mailbox.exists) {
1805
1806
  return false;
1806
1807
  }
1807
1808
  value = this.mailbox.exists.toString();
@@ -2069,50 +2070,14 @@ export class ImapFlow extends EventEmitter {
2069
2070
  */
2070
2071
  close() {
2071
2072
  try {
2072
- // clear pending timers
2073
- clearTimer(this.idleStartTimer);
2074
- clearTimer(this.upgradeTimeout);
2075
- clearTimer(this.connectTimeout);
2076
- clearTimer(this.greetingTimeout);
2077
- // Abort every in-flight throttle back-off so each waiter unblocks and its request is
2078
- // settled promptly rather than after the full delay.
2079
- for (let entry of this._throttleWaits) {
2080
- clearTimer(entry.timer);
2081
- entry.resolve(true);
2082
- }
2083
- this._throttleWaits.clear();
2073
+ this.closeTimers();
2084
2074
  this.usable = false;
2085
2075
  // close() takes over ownership of the idling state: dropping the session token means a
2086
2076
  // poll or IDLE that unwinds after this point sees that it no longer owns the flag and
2087
2077
  // leaves it alone (see claimIdling() in commands/idle.ts).
2088
2078
  this._idleSession = null;
2089
2079
  this.idling = false;
2090
- // An in-flight STARTTLS upgrade has to be settled through its own single settlement
2091
- // path, otherwise the upgrade promise (and the session it belongs to) stays pending
2092
- // for the lifetime of the process.
2093
- if (typeof this._upgradeReject === 'function') {
2094
- let reject = this._upgradeReject;
2095
- this._upgradeReject = null;
2096
- reject(this.createNoConnectionError(false, { rejectedFrom: 'upgrade' }));
2097
- }
2098
- if (typeof this.initialReject === 'function' && !this.options.verifyOnly) {
2099
- clearTimer(this.greetingTimeout);
2100
- let reject = this.initialReject;
2101
- this.initialResolve = false;
2102
- this.initialReject = false;
2103
- let err = new Error('Unexpected close');
2104
- /* c8 ignore next */ // closing a pending connect over an already-secure socket (the TLS branch) is not separately exercised
2105
- err.code = `ClosedAfterConnect${this.secureConnection ? 'TLS' : 'Text'}`;
2106
- // Surface the server's BYE reason (e.g. "Too many connections") when the
2107
- // connection was closed by an untagged BYE, so the caller sees why.
2108
- if (this.byeReason) {
2109
- err.reason = this.byeReason;
2110
- }
2111
- // Synchronous rejection is safe: connectPromise was built by guardedPromise(),
2112
- // so the rejection is already observed. close() is synchronous, so all cleanup
2113
- // completes before any microtask rejection handler runs.
2114
- reject(err);
2115
- }
2080
+ this.closeConnectSteps();
2116
2081
  if (typeof this.preCheck === 'function') {
2117
2082
  // Runs while the connection is being torn down, so the rejection this sees is
2118
2083
  // almost always the NoConnection close() is about to raise itself.
@@ -2139,99 +2104,9 @@ export class ImapFlow extends EventEmitter {
2139
2104
  }
2140
2105
  this.preCheck = false;
2141
2106
  }
2142
- // Collect all pending requests to reject
2143
- let pendingRequests = [];
2144
- // reject command that is currently processed
2145
- if (this.currentRequest && this.requestTagMap.has(this.currentRequest.tag)) {
2146
- let tag = this.currentRequest.tag;
2147
- let request = this.requestTagMap.get(tag);
2148
- if (request) {
2149
- this.requestTagMap.delete(tag);
2150
- pendingRequests.push(request);
2151
- }
2152
- this.currentRequest = false;
2153
- }
2154
- // reject all other pending commands
2155
- while (this.requestQueue.length) {
2156
- let req = this.requestQueue.shift();
2157
- if (req && this.requestTagMap.has(req.tag)) {
2158
- let request = this.requestTagMap.get(req.tag);
2159
- if (request) {
2160
- this.requestTagMap.delete(req.tag);
2161
- pendingRequests.push(request);
2162
- }
2163
- }
2164
- }
2165
- // Reject pending requests and locks synchronously. Every promise rejected here was
2166
- // built by guardedPromise(), so its rejection is already observed and cannot trigger
2167
- // unhandledRejection. close() is synchronous, so all remaining cleanup runs before
2168
- // any microtask rejection handler fires.
2169
- //
2170
- // The error travels on, though, through await chains and .then() links that
2171
- // guardedPromise() knows nothing about. Read a crash stack ending here as "this is
2172
- // the value that escaped", never as "this is the promise that escaped".
2173
- let byeReason = this.byeReason;
2174
- for (let request of pendingRequests) {
2175
- request.reject(this.createNoConnectionError(byeReason, { rejectedFrom: 'pendingRequest', command: request.command }));
2176
- }
2177
- // Clear current lock - holder will see errors when they try operations.
2178
- // Also clear the held-lock diagnostic timer so it doesn't fire post-close.
2179
- if (this.currentLock && this.currentLock.heldWarnTimer) {
2180
- clearTimer(this.currentLock.heldWarnTimer);
2181
- this.currentLock.heldWarnTimer = null;
2182
- }
2183
- this.currentLock = false;
2184
- if (this.locks && this.locks.length) {
2185
- let pendingLocks = this.locks.splice(0); // Take all locks and clear the array
2186
- for (let lock of pendingLocks) {
2187
- if (lock.acquireTimer) {
2188
- clearTimer(lock.acquireTimer);
2189
- lock.acquireTimer = null;
2190
- }
2191
- if (typeof lock.reject === 'function') {
2192
- lock.reject(this.createNoConnectionError(byeReason, { rejectedFrom: 'mailboxLock', path: lock.path }));
2193
- }
2194
- }
2195
- }
2196
- // cleanup compression streams if they exist
2197
- if (this._inflate) {
2198
- try {
2199
- this._inflate.unpipe();
2200
- this._inflate.destroy();
2201
- this._inflate = null;
2202
- }
2203
- catch (err) {
2204
- this.log.error({ err, msg: 'Failed to destroy inflate stream', cid: this.id });
2205
- }
2206
- }
2207
- if (this._deflate) {
2208
- try {
2209
- this._deflate.unpipe();
2210
- this._deflate.destroy();
2211
- this._deflate = null;
2212
- }
2213
- catch (err) {
2214
- this.log.error({ err, msg: 'Failed to destroy deflate stream', cid: this.id });
2215
- }
2216
- }
2217
- // cleanup streamer
2218
- if (this.streamer) {
2219
- try {
2220
- // remove our listeners explicitly by reference
2221
- if (this.socketReadable) {
2222
- this.streamer.removeListener('readable', this.socketReadable);
2223
- }
2224
- if (this._streamerErrorHandler) {
2225
- this.streamer.removeListener('error', this._streamerErrorHandler);
2226
- }
2227
- if (!this.streamer.destroyed) {
2228
- this.streamer.destroy();
2229
- }
2230
- }
2231
- catch (err) {
2232
- this.log.error({ err, msg: 'Failed to cleanup streamer', cid: this.id });
2233
- }
2234
- }
2107
+ this.closeRequests();
2108
+ this.closeLocks();
2109
+ this.closeStreams();
2235
2110
  // clear socket handlers
2236
2111
  this.clearSocketHandlers();
2237
2112
  // clear cached data
@@ -2244,39 +2119,7 @@ export class ImapFlow extends EventEmitter {
2244
2119
  // Set before teardown so a socket event that re-enters close() during destruction
2245
2120
  // cannot run this block a second time.
2246
2121
  this.isClosed = true;
2247
- // Socket teardown, in one documented order. Each stream owns and reports its own
2248
- // lifecycle, so each is destroyed exactly once:
2249
- // 1. the compression PassThrough (writeSocket), if compression replaced it
2250
- // 2. the raw socket, which is also writeSocket when compression is not active
2251
- // The compression streams themselves were destroyed above.
2252
- if (this.writeSocket && this.writeSocket !== this.socket && !this.writeSocket.destroyed) {
2253
- try {
2254
- this.writeSocket.destroy();
2255
- }
2256
- catch (err) {
2257
- this.log.error({ err, cid: this.id });
2258
- }
2259
- }
2260
- if (this.socket && !this.socket.destroyed) {
2261
- try {
2262
- this.socket.destroy();
2263
- }
2264
- catch (err) {
2265
- this.log.error({ err, cid: this.id });
2266
- }
2267
- }
2268
- // Null out all socket and handler references so the GC can collect
2269
- // them even if the ImapFlow instance itself is still referenced.
2270
- this.socket = null;
2271
- this.writeSocket = null;
2272
- this._inflate = null;
2273
- this._deflate = null;
2274
- this._streamerErrorHandler = null;
2275
- this._connectErrorHandler = null;
2276
- this._socketError = null;
2277
- this._socketClose = null;
2278
- this._socketEnd = null;
2279
- this._socketTimeout = null;
2122
+ this.closeSockets();
2280
2123
  this.log.debug({
2281
2124
  msg: 'Connection closed',
2282
2125
  cid: this.id,
@@ -2286,7 +2129,7 @@ export class ImapFlow extends EventEmitter {
2286
2129
  // whether the session ended with a clean logout or a lost transport. Emitted before
2287
2130
  // 'close' and only from the first close(), so no consumer sees it twice.
2288
2131
  if (closedMailbox) {
2289
- this.emit('mailboxClose', closedMailbox);
2132
+ emitSafe(this, 'mailboxClose', closedMailbox);
2290
2133
  }
2291
2134
  this.emit('close');
2292
2135
  }
@@ -2295,6 +2138,212 @@ export class ImapFlow extends EventEmitter {
2295
2138
  this.log.error({ err: ex, cid: this.id });
2296
2139
  }
2297
2140
  }
2141
+ /**
2142
+ * Part of close(): clears the pending timers and aborts every throttle back-off.
2143
+ *
2144
+ * @internal
2145
+ */
2146
+ closeTimers() {
2147
+ // clear pending timers
2148
+ clearTimer(this.idleStartTimer);
2149
+ clearTimer(this.upgradeTimeout);
2150
+ clearTimer(this.connectTimeout);
2151
+ clearTimer(this.greetingTimeout);
2152
+ // Abort every in-flight throttle back-off so each waiter unblocks and its request is
2153
+ // settled promptly rather than after the full delay.
2154
+ for (let entry of this._throttleWaits) {
2155
+ clearTimer(entry.timer);
2156
+ entry.resolve(true);
2157
+ }
2158
+ this._throttleWaits.clear();
2159
+ }
2160
+ /**
2161
+ * Part of close(): settles an in-flight STARTTLS upgrade and a pending connect().
2162
+ *
2163
+ * @internal
2164
+ */
2165
+ closeConnectSteps() {
2166
+ // An in-flight STARTTLS upgrade has to be settled through its own single settlement
2167
+ // path, otherwise the upgrade promise (and the session it belongs to) stays pending
2168
+ // for the lifetime of the process.
2169
+ if (typeof this._upgradeReject === 'function') {
2170
+ let reject = this._upgradeReject;
2171
+ this._upgradeReject = null;
2172
+ reject(this.createNoConnectionError(false, { rejectedFrom: 'upgrade' }));
2173
+ }
2174
+ if (typeof this.initialReject === 'function' && !this.options.verifyOnly) {
2175
+ clearTimer(this.greetingTimeout);
2176
+ let reject = this.initialReject;
2177
+ this.initialResolve = false;
2178
+ this.initialReject = false;
2179
+ let err = new Error('Unexpected close');
2180
+ /* c8 ignore next */ // closing a pending connect over an already-secure socket (the TLS branch) is not separately exercised
2181
+ err.code = `ClosedAfterConnect${this.secureConnection ? 'TLS' : 'Text'}`;
2182
+ // Surface the server's BYE reason (e.g. "Too many connections") when the
2183
+ // connection was closed by an untagged BYE, so the caller sees why.
2184
+ if (this.byeReason) {
2185
+ err.reason = this.byeReason;
2186
+ }
2187
+ // Synchronous rejection is safe: connectPromise was built by guardedPromise(),
2188
+ // so the rejection is already observed. close() is synchronous, so all cleanup
2189
+ // completes before any microtask rejection handler runs.
2190
+ reject(err);
2191
+ }
2192
+ }
2193
+ /**
2194
+ * Part of close(): rejects the command in flight and every queued command.
2195
+ *
2196
+ * @internal
2197
+ */
2198
+ closeRequests() {
2199
+ // Collect all pending requests to reject
2200
+ let pendingRequests = [];
2201
+ // reject command that is currently processed
2202
+ if (this.currentRequest && this.requestTagMap.has(this.currentRequest.tag)) {
2203
+ let tag = this.currentRequest.tag;
2204
+ let request = this.requestTagMap.get(tag);
2205
+ if (request) {
2206
+ this.requestTagMap.delete(tag);
2207
+ pendingRequests.push(request);
2208
+ }
2209
+ this.currentRequest = false;
2210
+ }
2211
+ // reject all other pending commands
2212
+ while (this.requestQueue.length) {
2213
+ let req = this.requestQueue.shift();
2214
+ if (req && this.requestTagMap.has(req.tag)) {
2215
+ let request = this.requestTagMap.get(req.tag);
2216
+ if (request) {
2217
+ this.requestTagMap.delete(req.tag);
2218
+ pendingRequests.push(request);
2219
+ }
2220
+ }
2221
+ }
2222
+ // Reject pending requests and locks synchronously. Every promise rejected here was
2223
+ // built by guardedPromise(), so its rejection is already observed and cannot trigger
2224
+ // unhandledRejection. close() is synchronous, so all remaining cleanup runs before
2225
+ // any microtask rejection handler fires.
2226
+ //
2227
+ // The error travels on, though, through await chains and .then() links that
2228
+ // guardedPromise() knows nothing about. Read a crash stack ending here as "this is
2229
+ // the value that escaped", never as "this is the promise that escaped".
2230
+ for (let request of pendingRequests) {
2231
+ request.reject(this.createNoConnectionError(this.byeReason, { rejectedFrom: 'pendingRequest', command: request.command }));
2232
+ }
2233
+ }
2234
+ /**
2235
+ * Part of close(): drops the held lock and rejects every pending lock request.
2236
+ *
2237
+ * @internal
2238
+ */
2239
+ closeLocks() {
2240
+ // Clear current lock - holder will see errors when they try operations.
2241
+ // Also clear the held-lock diagnostic timer so it doesn't fire post-close.
2242
+ if (this.currentLock && this.currentLock.heldWarnTimer) {
2243
+ clearTimer(this.currentLock.heldWarnTimer);
2244
+ this.currentLock.heldWarnTimer = null;
2245
+ }
2246
+ this.currentLock = false;
2247
+ if (this.locks && this.locks.length) {
2248
+ let pendingLocks = this.locks.splice(0); // Take all locks and clear the array
2249
+ for (let lock of pendingLocks) {
2250
+ if (lock.acquireTimer) {
2251
+ clearTimer(lock.acquireTimer);
2252
+ lock.acquireTimer = null;
2253
+ }
2254
+ if (typeof lock.reject === 'function') {
2255
+ lock.reject(this.createNoConnectionError(this.byeReason, { rejectedFrom: 'mailboxLock', path: lock.path }));
2256
+ }
2257
+ }
2258
+ }
2259
+ }
2260
+ /**
2261
+ * Part of close(): destroys the compression streams and the response streamer.
2262
+ *
2263
+ * @internal
2264
+ */
2265
+ closeStreams() {
2266
+ // cleanup compression streams if they exist
2267
+ if (this._inflate) {
2268
+ try {
2269
+ this._inflate.unpipe();
2270
+ this._inflate.destroy();
2271
+ this._inflate = null;
2272
+ }
2273
+ catch (err) {
2274
+ this.log.error({ err, msg: 'Failed to destroy inflate stream', cid: this.id });
2275
+ }
2276
+ }
2277
+ if (this._deflate) {
2278
+ try {
2279
+ this._deflate.unpipe();
2280
+ this._deflate.destroy();
2281
+ this._deflate = null;
2282
+ }
2283
+ catch (err) {
2284
+ this.log.error({ err, msg: 'Failed to destroy deflate stream', cid: this.id });
2285
+ }
2286
+ }
2287
+ // cleanup streamer
2288
+ if (this.streamer) {
2289
+ try {
2290
+ // remove our listeners explicitly by reference
2291
+ if (this.socketReadable) {
2292
+ this.streamer.removeListener('readable', this.socketReadable);
2293
+ }
2294
+ if (this._streamerErrorHandler) {
2295
+ this.streamer.removeListener('error', this._streamerErrorHandler);
2296
+ }
2297
+ if (!this.streamer.destroyed) {
2298
+ this.streamer.destroy();
2299
+ }
2300
+ }
2301
+ catch (err) {
2302
+ this.log.error({ err, msg: 'Failed to cleanup streamer', cid: this.id });
2303
+ }
2304
+ }
2305
+ }
2306
+ /**
2307
+ * Part of close(): destroys the sockets once and drops every socket and handler reference.
2308
+ *
2309
+ * @internal
2310
+ */
2311
+ closeSockets() {
2312
+ // Socket teardown, in one documented order. Each stream owns and reports its own
2313
+ // lifecycle, so each is destroyed exactly once:
2314
+ // 1. the compression PassThrough (writeSocket), if compression replaced it
2315
+ // 2. the raw socket, which is also writeSocket when compression is not active
2316
+ // The compression streams themselves were destroyed in closeStreams().
2317
+ if (this.writeSocket && this.writeSocket !== this.socket && !this.writeSocket.destroyed) {
2318
+ try {
2319
+ this.writeSocket.destroy();
2320
+ }
2321
+ catch (err) {
2322
+ this.log.error({ err, cid: this.id });
2323
+ }
2324
+ }
2325
+ if (this.socket && !this.socket.destroyed) {
2326
+ try {
2327
+ this.socket.destroy();
2328
+ }
2329
+ catch (err) {
2330
+ this.log.error({ err, cid: this.id });
2331
+ }
2332
+ }
2333
+ // Null out all socket and handler references so the GC can collect
2334
+ // them even if the ImapFlow instance itself is still referenced.
2335
+ this.socket = null;
2336
+ this.writeSocket = null;
2337
+ // closeStreams() leaves these set when destroying them failed
2338
+ this._inflate = null;
2339
+ this._deflate = null;
2340
+ this._streamerErrorHandler = null;
2341
+ this._connectErrorHandler = null;
2342
+ this._socketError = null;
2343
+ this._socketClose = null;
2344
+ this._socketEnd = null;
2345
+ this._socketTimeout = null;
2346
+ }
2298
2347
  /**
2299
2348
  * Returns current quota
2300
2349
  *
@@ -2452,7 +2501,7 @@ export class ImapFlow extends EventEmitter {
2452
2501
  *
2453
2502
  * @param path mailbox path to check for (unicode string). If value is an array then it is joined using current delimiter symbols. Namespace prefix is added automatically if required.
2454
2503
  * @param query defines requested status items
2455
- * @returns status of the indicated mailbox
2504
+ * @returns status of the indicated mailbox, or `false` if the server rejected the request
2456
2505
  *
2457
2506
  * @example
2458
2507
  * let status = await client.status('INBOX', {unseen: true});
@@ -2467,7 +2516,7 @@ export class ImapFlow extends EventEmitter {
2467
2516
  * otherwise IDLE is started by default on connection inactivity. NB! If `idle()` is called manually then it does not
2468
2517
  * return until IDLE is finished which means you would have to call some other command out of scope.
2469
2518
  *
2470
- * @returns Did the operation succeed or not
2519
+ * @returns `false` if IDLE failed, `undefined` otherwise
2471
2520
  *
2472
2521
  * @example
2473
2522
  * let mailbox = await client.mailboxOpen('INBOX');
@@ -2906,433 +2955,13 @@ export class ImapFlow extends EventEmitter {
2906
2955
  * @example
2907
2956
  * let mailbox = await client.mailboxOpen('INBOX');
2908
2957
  * // download body part nr '1.2' from latest message
2909
- * let {meta, content} = await client.download('*', '1.2');
2910
- * content.pipe(fs.createWriteStream(meta.filename));
2958
+ * let download = await client.download('*', '1.2');
2959
+ * if (download.content) {
2960
+ * download.content.pipe(fs.createWriteStream(download.meta.filename));
2961
+ * }
2911
2962
  */
2912
2963
  async download(range, part, options) {
2913
- if (!this.mailbox) {
2914
- // no mailbox selected, nothing to do
2915
- return {};
2916
- }
2917
- let downloadOptions = Object.assign({
2918
- chunkSize: 64 * 1024,
2919
- maxBytes: Infinity
2920
- }, options || {});
2921
- let hasMore = true;
2922
- let processed = 0;
2923
- let chunkSize = Number(downloadOptions.chunkSize) || 64 * 1024;
2924
- // Normalized once here so every bounded stage of the pipeline below agrees on the budget
2925
- let maxBytes = normalizeByteLimit(downloadOptions.maxBytes);
2926
- let uid = false;
2927
- if (part === '1') {
2928
- // Special handling for part "1": in single-node emails (no childNodes),
2929
- // the body is accessed via "TEXT" rather than "1", and headers via
2930
- // "HEADER" instead of "1.MIME". Check bodyStructure to detect this.
2931
- let response = await this.fetchOne(range, { uid: true, bodyStructure: true }, downloadOptions);
2932
- if (!response) {
2933
- return { response: false, chunk: false };
2934
- }
2935
- if (!uid && response.uid) {
2936
- uid = response.uid;
2937
- // force UID from now on even if first range was a sequence number
2938
- range = uid;
2939
- downloadOptions.uid = true;
2940
- }
2941
- if (!response.bodyStructure.childNodes) {
2942
- // single text message
2943
- part = 'TEXT';
2944
- }
2945
- }
2946
- let getNextPart = async (query) => {
2947
- query = query || {};
2948
- let mimeKey;
2949
- if (!part) {
2950
- query.source = {
2951
- start: processed,
2952
- maxLength: chunkSize
2953
- };
2954
- }
2955
- else {
2956
- part = part.toString().toLowerCase().trim();
2957
- if (!query.bodyParts) {
2958
- query.bodyParts = [];
2959
- }
2960
- if (query.size) {
2961
- if (/^[\d.]+$/.test(part)) {
2962
- // fetch meta as well
2963
- mimeKey = part + '.mime';
2964
- query.bodyParts.push(mimeKey);
2965
- }
2966
- else if (part === 'text') {
2967
- mimeKey = 'header';
2968
- query.bodyParts.push(mimeKey);
2969
- }
2970
- }
2971
- query.bodyParts.push({
2972
- key: part,
2973
- start: processed,
2974
- maxLength: chunkSize
2975
- });
2976
- }
2977
- let response = await this.fetchOne(range, query, downloadOptions);
2978
- if (!response) {
2979
- return { response: false, chunk: false };
2980
- }
2981
- if (!uid && response.uid) {
2982
- uid = response.uid;
2983
- // force UID from now on even if first range was a sequence number
2984
- range = uid;
2985
- downloadOptions.uid = true;
2986
- }
2987
- let chunk = !part ? response.source : response.bodyParts && response.bodyParts.get(part);
2988
- if (!chunk) {
2989
- return {};
2990
- }
2991
- processed += chunk.length;
2992
- // A compliant server returns at most `chunkSize` bytes for a partial
2993
- // request. Some servers (Tencent Exmail among them) ignore the partial
2994
- // spec and answer every request with the complete part. That chunk is
2995
- // then larger than requested, so treating it as "full, keep going"
2996
- // would advance the offset past the end forever and never see a short
2997
- // chunk. An oversized answer already contains the whole part - stop.
2998
- hasMore = chunk.length === chunkSize;
2999
- if (chunk.length > chunkSize) {
3000
- this.log.warn({
3001
- msg: 'Server returned more than the requested window, treating the part as complete',
3002
- chunkSize,
3003
- received: chunk.length,
3004
- processed,
3005
- cid: this.id
3006
- });
3007
- }
3008
- let result = { chunk };
3009
- if (query.size) {
3010
- result.response = response;
3011
- }
3012
- if (query.bodyParts) {
3013
- if (mimeKey === 'header') {
3014
- result.mime = response.headers;
3015
- }
3016
- else {
3017
- result.mime = response.bodyParts && mimeKey ? response.bodyParts.get(mimeKey) : undefined;
3018
- }
3019
- }
3020
- return result;
3021
- };
3022
- let { response, chunk, mime } = await getNextPart({
3023
- size: true,
3024
- uid: true
3025
- });
3026
- if (!response || !chunk) {
3027
- // ???
3028
- return {};
3029
- }
3030
- let meta = {
3031
- expectedSize: response.size
3032
- };
3033
- if (!part) {
3034
- meta.contentType = 'message/rfc822';
3035
- }
3036
- else if (mime) {
3037
- let headers = new Headers(mime);
3038
- let contentType = libmime.parseHeaderValue(headers.getFirst('Content-Type'));
3039
- let transferEncoding = libmime.parseHeaderValue(headers.getFirst('Content-Transfer-Encoding'));
3040
- let disposition = libmime.parseHeaderValue(headers.getFirst('Content-Disposition'));
3041
- if (contentType.value.toLowerCase().trim()) {
3042
- meta.contentType = contentType.value.toLowerCase().trim();
3043
- }
3044
- if (contentType.params.charset) {
3045
- meta.charset = contentType.params.charset.toLowerCase().trim();
3046
- }
3047
- if (transferEncoding.value) {
3048
- meta.encoding = transferEncoding.value
3049
- .replace(/\(.*\)/g, '')
3050
- .toLowerCase()
3051
- .trim();
3052
- }
3053
- if (disposition.value) {
3054
- /* c8 ignore next */ // a parsed disposition value is never all-whitespace, so the `false` fallback is unreachable
3055
- meta.disposition = disposition.value.toLowerCase().trim() || false;
3056
- try {
3057
- meta.disposition = libmime.decodeWords(meta.disposition);
3058
- }
3059
- catch {
3060
- // failed to parse disposition, keep as is (most probably an unknown charset is used)
3061
- }
3062
- }
3063
- if (contentType.params.format && contentType.params.format.toLowerCase().trim() === 'flowed') {
3064
- meta.flowed = true;
3065
- if (contentType.params.delsp && contentType.params.delsp.toLowerCase().trim() === 'yes') {
3066
- meta.delSp = true;
3067
- }
3068
- }
3069
- let filename = disposition.params.filename || contentType.params.name || false;
3070
- if (filename) {
3071
- try {
3072
- filename = libmime.decodeWords(filename);
3073
- }
3074
- catch {
3075
- // failed to parse filename, keep as is (most probably an unknown charset is used)
3076
- }
3077
- meta.filename = filename;
3078
- }
3079
- }
3080
- let stream;
3081
- let output;
3082
- let fetchAborted = false;
3083
- // Build a decoder pipeline that progressively transforms the raw FETCH data:
3084
- // 1. Transfer-encoding decoder (base64 or quoted-printable -> binary)
3085
- // 2. Format decoder (format=flowed -> plain text, if applicable)
3086
- // 3. Charset decoder (non-UTF-8 -> UTF-8, for text parts only)
3087
- // 4. Byte limiter (enforces maxBytes cap)
3088
- // `stream` is the head of the pipeline (where raw chunks are written),
3089
- // `output` is the tail (what the caller reads from).
3090
- // Parts that arrived via FETCH BINARY (response.binaryParts) are already
3091
- // decoded by the server - decoding again would corrupt the data, so stage 1
3092
- // is skipped for them.
3093
- let clientEncoding = response.binaryParts && part && response.binaryParts.has(part) ? false : meta.encoding;
3094
- switch (clientEncoding) {
3095
- case 'base64':
3096
- output = stream = new libbase64.Decoder();
3097
- break;
3098
- case 'quoted-printable':
3099
- output = stream = new libqp.Decoder();
3100
- break;
3101
- default:
3102
- output = stream = new PassThrough();
3103
- }
3104
- // Every byte-bounded stage of the pipeline. The fetch loop below stops as soon as any of
3105
- // them has taken all it will accept. The limiter at the tail is not enough on its own: a
3106
- // transform in the middle that buffers its whole input before emitting anything (the
3107
- // format=flowed decoder, the Japanese charset decoder) leaves the tail limiter reporting
3108
- // `limited === false` however much the server sends, so a download with a small maxBytes
3109
- // would still pull the entire part off the wire.
3110
- let limiters = [];
3111
- let isLimited = () => limiters.some(entry => entry.limited);
3112
- // Appending a stage means forwarding the current tail's errors to it before piping, so a
3113
- // failure anywhere reaches the stream the caller is reading
3114
- let pipeStage = (stage) => {
3115
- output.on('error', err => {
3116
- stage.emit('error', err);
3117
- });
3118
- output = output.pipe(stage);
3119
- return stage;
3120
- };
3121
- let isTextNode = ['text/html', 'text/plain', 'text/x-amp-html'].includes(meta.contentType) || (part === '1' && !meta.contentType);
3122
- if ((!meta.disposition || meta.disposition === 'inline') && isTextNode) {
3123
- // RFC 3676 format=flowed text: unwrap soft line breaks
3124
- if (meta.flowed) {
3125
- // FlowedDecoder buffers its whole input before emitting, and being third party it
3126
- // carries no bound of its own, so bound what it can ever be handed. Unwrapping only
3127
- // removes bytes, so capping its input at maxBytes cannot push the delivered output
3128
- // above the cap either.
3129
- limiters.push(pipeStage(new LimitedPassthrough({ maxBytes })));
3130
- pipeStage(new FlowedDecoder(meta.delSp ? { delSp: true } : {}));
3131
- }
3132
- // Convert non-UTF-8 charsets to UTF-8 via a streaming decoder.
3133
- // ASCII and UTF-8 need no conversion. Unknown charsets are left as-is.
3134
- if (meta.charset && !['ascii', 'usascii', 'utf8'].includes(meta.charset.toLowerCase().replace(/[^a-z0-9]+/g, ''))) {
3135
- try {
3136
- let decoder = getDecoder(meta.charset, maxBytes);
3137
- // Safety listener attached first so the decoder always has at least
3138
- // one 'error' listener. Prevents Node.js from throwing
3139
- // ERR_UNHANDLED_ERROR if a later pipe setup step throws and leaves
3140
- // the source-forwarding closure attached without a downstream
3141
- // listener wired up. Any real listener the caller attaches still
3142
- // fires in addition to this one.
3143
- decoder.on('error', err => {
3144
- this.log.warn({ err, charset: meta.charset, cid: this.id });
3145
- });
3146
- // The Japanese decoder buffers its whole input as well, and reports the same
3147
- // `limited` flag the limiters do so the fetch loop can stop once it is full.
3148
- // A streaming decoder has no such flag, which reads as false and is correct.
3149
- limiters.push(pipeStage(decoder));
3150
- // force to utf-8 for output
3151
- meta.charset = 'utf-8';
3152
- }
3153
- catch {
3154
- // do not decode charset
3155
- }
3156
- }
3157
- }
3158
- let limiter = pipeStage(new LimitedPassthrough({ maxBytes }));
3159
- limiters.push(limiter);
3160
- // Cleanup function
3161
- const cleanup = () => {
3162
- fetchAborted = true;
3163
- if (stream && !stream.destroyed) {
3164
- stream.destroy();
3165
- }
3166
- };
3167
- // Listen for stream destruction
3168
- output.once('error', cleanup);
3169
- output.once('close', cleanup);
3170
- let writeChunk = (chunk) => {
3171
- if (isLimited() || fetchAborted || stream.destroyed) {
3172
- return true;
3173
- }
3174
- return stream.write(chunk);
3175
- };
3176
- // Ceiling on how many bytes one download may pull off the wire, as the backstop for the
3177
- // partial-ignoring servers above: a part whose size happens to equal chunkSize exactly
3178
- // comes back looking like a full window every time, so no test over chunk lengths can end
3179
- // that loop. RFC822.SIZE bounds any part of the message; doubled for servers that count
3180
- // line endings differently than they deliver, plus one window so a download sitting right
3181
- // at the bound still gets its terminating chunk. Infinity when the server reported no
3182
- // size, which leaves the loop bounded by maxBytes alone.
3183
- let maxTotalBytes = normalizeByteLimit(meta.expectedSize ? meta.expectedSize * 2 + chunkSize : 0);
3184
- // Fetch remaining chunks in a loop, writing each to the decoder stream.
3185
- // Stops when the server returns a short chunk (< chunkSize), answers with more than the
3186
- // requested window, the byte limiter is satisfied, or the consumer destroys the output
3187
- // stream. Throws when the ceiling above is crossed.
3188
- let fetchAllParts = async () => {
3189
- while (hasMore && !isLimited() && !fetchAborted) {
3190
- if (processed >= maxTotalBytes) {
3191
- // Loud on purpose. Everything written downstream by this point holds
3192
- // duplicated content, and a quiet stop is indistinguishable from a clean EOF,
3193
- // so the consumer would store a corrupt body believing it intact.
3194
- let err = new Error('Download exceeded the expected message size');
3195
- err.code = 'DownloadOverflow';
3196
- err.maxSize = maxTotalBytes;
3197
- err.cid = this.id;
3198
- throw err;
3199
- }
3200
- let { chunk } = await getNextPart();
3201
- if (!chunk || fetchAborted) {
3202
- break;
3203
- }
3204
- // Handle backpressure
3205
- if (writeChunk(chunk) === false) {
3206
- // Wait for drain event before continuing
3207
- try {
3208
- await new Promise((resolve, reject) => {
3209
- // finish() is the listener itself, as settle() is for the TLS upgrade:
3210
- // 'drain' and 'close' emit no arguments, 'error' emits the error, and
3211
- // removal needs no separate handler references. It removes only the
3212
- // three listeners this wait installed - removeAllListeners('error')
3213
- // also took off the forwarder pipeStage() attached to the head stream
3214
- // when the pipeline was built, and the head must keep that forwarder
3215
- // for the life of the download or a chunk failure has nowhere to go.
3216
- const finish = (err) => {
3217
- for (let event of ['drain', 'error', 'close']) {
3218
- stream.removeListener(event, finish);
3219
- }
3220
- /* c8 ignore next 2 */ // stream error during a backpressure drain wait is timing-dependent
3221
- if (err) {
3222
- reject(err);
3223
- }
3224
- else {
3225
- resolve();
3226
- }
3227
- };
3228
- stream.once('drain', finish);
3229
- stream.once('error', finish);
3230
- stream.once('close', finish);
3231
- });
3232
- /* c8 ignore start */ // re-throw path only triggers on a stream error mid-drain, which is timing-dependent
3233
- }
3234
- catch (err) {
3235
- // Re-throw only if not aborted
3236
- if (!fetchAborted) {
3237
- throw err;
3238
- }
3239
- }
3240
- /* c8 ignore stop */
3241
- // Check if we should abort after waiting
3242
- if (fetchAborted) {
3243
- break;
3244
- }
3245
- }
3246
- }
3247
- };
3248
- // A download is a sequence of chunk FETCHes with a backpressure wait in between. Those
3249
- // gaps look exactly like an inactive connection, so without this auto-IDLE would start
3250
- // between chunks and the next chunk would have to break it again - two extra round
3251
- // trips per chunk, for as long as the consumer is slow. Counted before control returns
3252
- // to the event loop: the head chunk's own FETCH already armed the auto-IDLE timer, and
3253
- // with a very short autoIdleDelay that timer could otherwise fire before the deferred
3254
- // chunk loop below has marked the download open.
3255
- this._openDownloads++;
3256
- let downloadDone = false;
3257
- let finishDownload = () => {
3258
- if (!downloadDone) {
3259
- downloadDone = true;
3260
- this._openDownloads--;
3261
- this.autoidle();
3262
- }
3263
- };
3264
- // Kick off the download pipeline asynchronously. The first chunk was
3265
- // already fetched above (to get metadata); write it to the decoder
3266
- // stream and then fetch remaining chunks via fetchAllParts().
3267
- // setImmediate ensures the caller gets the {meta, content} return
3268
- // value before streaming begins.
3269
- let runFetchAllParts = () => {
3270
- fetchAllParts()
3271
- .catch(err => {
3272
- if (!fetchAborted && stream && !stream.destroyed) {
3273
- stream.emit('error', err);
3274
- /* c8 ignore start */ // the else logs when a fetch error arrives after the stream was already torn down (timing-dependent)
3275
- }
3276
- else {
3277
- // Log when error cannot be emitted to stream
3278
- this.log.warn({
3279
- msg: 'Download error after stream closed',
3280
- err,
3281
- fetchAborted,
3282
- streamDestroyed: stream?.destroyed,
3283
- cid: this.id
3284
- });
3285
- }
3286
- /* c8 ignore stop */
3287
- })
3288
- .finally(() => {
3289
- finishDownload();
3290
- if (!fetchAborted && stream && !stream.destroyed) {
3291
- stream.end();
3292
- }
3293
- })
3294
- // Terminal guard: nothing consumes this chain, so a throw from either handler
3295
- // above rejects a promise nobody holds and takes the process down on
3296
- // unhandledRejection. Reaching it always means an invariant broke - the head
3297
- // stream kept pipeStage()'s error forwarder for the life of the download, so
3298
- // emit('error') above has somewhere to go - which is why it logs at error even
3299
- // for a routine-looking connection code.
3300
- .catch(err => this.log.error({ msg: 'Failed to fail the download stream', err, cid: this.id }));
3301
- };
3302
- setImmediate(() => {
3303
- let writeResult;
3304
- try {
3305
- writeResult = writeChunk(chunk);
3306
- }
3307
- catch (err) {
3308
- stream.emit('error', err);
3309
- finishDownload();
3310
- /* c8 ignore next 3 */ // emitting the error above triggers cleanup (fetchAborted=true), so this end() guard is already false here
3311
- if (!fetchAborted && stream && !stream.destroyed) {
3312
- stream.end();
3313
- }
3314
- return;
3315
- }
3316
- /* c8 ignore next 9 */ // `stream` is piped to the limiter before this runs, so the head write drains synchronously and always returns true (verified for chunkSize up to 8MB); the drain-wait branch is unreachable
3317
- if (!writeResult) {
3318
- // Initial chunk filled the buffer, wait for drain
3319
- stream.once('drain', () => {
3320
- if (!fetchAborted) {
3321
- runFetchAllParts();
3322
- }
3323
- else {
3324
- finishDownload();
3325
- }
3326
- });
3327
- }
3328
- else {
3329
- runFetchAllParts();
3330
- }
3331
- });
3332
- return {
3333
- meta,
3334
- content: output
3335
- };
2964
+ return await downloadMessage(this, range, part, options);
3336
2965
  }
3337
2966
  /**
3338
2967
  * Fetch multiple attachments as Buffer values
@@ -3350,119 +2979,7 @@ export class ImapFlow extends EventEmitter {
3350
2979
  * process.stdout.write(response[3].content)
3351
2980
  */
3352
2981
  async downloadMany(range, parts, options) {
3353
- if (!this.mailbox) {
3354
- // no mailbox selected, nothing to do
3355
- return {};
3356
- }
3357
- let downloadOptions = Object.assign({
3358
- chunkSize: 64 * 1024,
3359
- maxBytes: Infinity
3360
- }, options || {});
3361
- let query = { bodyParts: [] };
3362
- for (let part of parts) {
3363
- query.bodyParts.push(part + '.mime');
3364
- query.bodyParts.push(part);
3365
- }
3366
- let response = await this.fetchOne(range, query, downloadOptions);
3367
- if (!response || !response.bodyParts) {
3368
- return { response: false };
3369
- }
3370
- let data = {};
3371
- for (let [part, content] of response.bodyParts) {
3372
- let keyParts = part.split('.mime');
3373
- // The server chooses the BODY[...] keys it answers with: never let one be a
3374
- // prototype-chain name, or the assignments below write onto Object.prototype
3375
- // (process-wide pollution) instead of the result object.
3376
- if (isUnsafeKey(keyParts[0])) {
3377
- continue;
3378
- }
3379
- if (keyParts.length === 1) {
3380
- // content
3381
- let key = keyParts[0];
3382
- if (!data[key]) {
3383
- data[key] = { content };
3384
- }
3385
- else {
3386
- data[key].content = content;
3387
- }
3388
- }
3389
- else if (keyParts.length === 2) {
3390
- // header
3391
- let key = keyParts[0];
3392
- if (!data[key]) {
3393
- data[key] = {};
3394
- }
3395
- let entry = data[key];
3396
- if (!entry.meta) {
3397
- entry.meta = {};
3398
- }
3399
- let meta = entry.meta;
3400
- let headers = new Headers(content);
3401
- let contentType = libmime.parseHeaderValue(headers.getFirst('Content-Type'));
3402
- let transferEncoding = libmime.parseHeaderValue(headers.getFirst('Content-Transfer-Encoding'));
3403
- let disposition = libmime.parseHeaderValue(headers.getFirst('Content-Disposition'));
3404
- if (contentType.value.toLowerCase().trim()) {
3405
- meta.contentType = contentType.value.toLowerCase().trim();
3406
- }
3407
- if (contentType.params.charset) {
3408
- meta.charset = contentType.params.charset.toLowerCase().trim();
3409
- }
3410
- if (transferEncoding.value) {
3411
- meta.encoding = transferEncoding.value
3412
- .replace(/\(.*\)/g, '')
3413
- .toLowerCase()
3414
- .trim();
3415
- }
3416
- if (disposition.value) {
3417
- /* c8 ignore next */ // a parsed disposition value is never all-whitespace, so the `false` fallback is unreachable
3418
- meta.disposition = disposition.value.toLowerCase().trim() || false;
3419
- try {
3420
- meta.disposition = libmime.decodeWords(meta.disposition);
3421
- }
3422
- catch {
3423
- // failed to parse disposition, keep as is (most probably an unknown charset is used)
3424
- }
3425
- }
3426
- if (contentType.params.format && contentType.params.format.toLowerCase().trim() === 'flowed') {
3427
- meta.flowed = true;
3428
- if (contentType.params.delsp && contentType.params.delsp.toLowerCase().trim() === 'yes') {
3429
- meta.delSp = true;
3430
- }
3431
- }
3432
- let filename = disposition.params.filename || contentType.params.name || false;
3433
- if (filename) {
3434
- try {
3435
- filename = libmime.decodeWords(filename);
3436
- }
3437
- catch {
3438
- // failed to parse filename, keep as is (most probably an unknown charset is used)
3439
- }
3440
- meta.filename = filename;
3441
- }
3442
- }
3443
- }
3444
- for (let part of Object.keys(data)) {
3445
- let entry = data[part];
3446
- // `meta` is only built from the companion BODY[<part>.MIME] item. A server may
3447
- // legally answer with fewer items than were requested, and one part arriving
3448
- // without its MIME headers must not cost the caller the whole download.
3449
- let meta = entry.meta || {};
3450
- entry.meta = meta;
3451
- // parts that arrived via FETCH BINARY (response.binaryParts) are already
3452
- // decoded by the server - decoding again would corrupt the data
3453
- let clientEncoding = response.binaryParts && response.binaryParts.has(part) ? false : meta.encoding;
3454
- switch (clientEncoding) {
3455
- case 'base64':
3456
- entry.content = entry.content ? libbase64.decode(entry.content.toString()) : null;
3457
- break;
3458
- case 'quoted-printable':
3459
- entry.content = entry.content ? libqp.decode(entry.content.toString()) : null;
3460
- break;
3461
- default:
3462
- // keep as is, already a buffer
3463
- }
3464
- }
3465
- return data;
2982
+ return await downloadMessageParts(this, range, parts, options);
3466
2983
  }
3467
2984
  /** @internal */
3468
2985
  async run(command, ...args) {