ImapClientOptions

Defined in: packages/net-imap/src/imap/imap-client.ts:45

Construction options for ImapClient.

Properties

defaultTimeoutMs?

optional defaultTimeoutMs?: number

Defined in: packages/net-imap/src/imap/imap-client.ts:68

Applied to every command that does not specify its own timeout.

---

maxBufferSize?

optional maxBufferSize?: number

Defined in: packages/net-imap/src/imap/imap-client.ts:51

Ceiling on undecoded received bytes. Defaults to 1 MiB, since IMAP responses such as FETCH envelopes can be substantially larger than a mail command line.

---

maxLineLength?

optional maxLineLength?: number

Defined in: packages/net-imap/src/imap/imap-client.ts:57

Maximum response line length. Defaults to 64 KiB; IMAP sets no line limit, so this is a safety bound rather than a protocol constant.

---

maxPipelineDepth?

optional maxPipelineDepth?: number

Defined in: packages/net-imap/src/imap/imap-client.ts:65

How many outstanding commands an inbound line may be offered to.

Defaults to 8. IMAP servers may complete pipelined commands out of order, so unlike SMTP a strict depth of 1 would mis-attribute responses.