Pop3Client
Defined in: packages/net-pop3/src/pop3/pop3-client.ts:74
POP3 client over any transport.
Handles CRLF framing, single-line and dot-terminated multi-line replies, and dot-unstuffing. Each method maps to one command per RFC 1939.
Replies are strictly ordered, so the default FIFO correlation applies.
The connection is not established here — pass an already-connected stream or transport.
Extends
Section titled “Extends”Session<string,string,Pop3ClientEvents>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Pop3Client(
source,options?):Pop3Client
Defined in: packages/net-pop3/src/pop3/pop3-client.ts:83
Parameters
Section titled “Parameters”source
Section titled “source”Transport
Any Transport. For a Node.js Duplex/net.Socket,
wrap it first: new DuplexTransport(socket) from
@ac-kit/net-transport-node.
options?
Section titled “options?”Buffer, line-length and timeout tuning.
Returns
Section titled “Returns”Pop3Client
Overrides
Section titled “Overrides”Session<string, string, Pop3ClientEvents>.constructor
Accessors
Section titled “Accessors”buffered
Section titled “buffered”Get Signature
Section titled “Get Signature”get buffered():
number
Defined in: packages/net-core/src/session.ts:243
Bytes received but not yet decoded.
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”Session.buffered
pendingExchanges
Section titled “pendingExchanges”Get Signature
Section titled “Get Signature”get pendingExchanges():
number
Defined in: packages/net-core/src/session.ts:248
Number of outstanding exchanges, including abort tombstones.
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”Session.pendingExchanges
Methods
Section titled “Methods”[asyncDispose]()
Section titled “[asyncDispose]()”[asyncDispose]():
Promise<void>
Defined in: packages/net-core/src/session.ts:277
Destroys the session, so it can be used with await using.
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”Session.[asyncDispose]
capa()
Section titled “capa()”capa(
options?):Promise<Pop3MultilineResponse>
Defined in: packages/net-pop3/src/pop3/pop3-client.ts:253
Send CAPA and read the capability list.
Parameters
Section titled “Parameters”options?
Section titled “options?”ExchangeOptions<string>
Abort, timeout and abort-policy overrides.
Returns
Section titled “Returns”Promise<Pop3MultilineResponse>
command()
Section titled “command()”command(
command,options?):Promise<Pop3Response>
Defined in: packages/net-pop3/src/pop3/pop3-client.ts:101
Send a command and read its single-line reply.
Parameters
Section titled “Parameters”command
Section titled “command”string
The command line, without a terminator.
options?
Section titled “options?”ExchangeOptions<string>
Abort, timeout and abort-policy overrides.
Returns
Section titled “Returns”Promise<Pop3Response>
The parsed reply.
commandMultiline()
Section titled “commandMultiline()”commandMultiline(
command,options?):Promise<Pop3MultilineResponse>
Defined in: packages/net-pop3/src/pop3/pop3-client.ts:120
Send a command and read its status line plus dot-terminated body.
Parameters
Section titled “Parameters”command
Section titled “command”string
The command line, without a terminator.
options?
Section titled “options?”ExchangeOptions<string>
Abort, timeout and abort-policy overrides.
Returns
Section titled “Returns”Promise<Pop3MultilineResponse>
The parsed reply with its body lines, dot-unstuffed.
dele()
Section titled “dele()”dele(
msg,options?):Promise<Pop3Response>
Defined in: packages/net-pop3/src/pop3/pop3-client.ts:226
Send DELE msg.
Parameters
Section titled “Parameters”number
The message number.
options?
Section titled “options?”ExchangeOptions<string>
Abort, timeout and abort-policy overrides.
Returns
Section titled “Returns”Promise<Pop3Response>
destroy()
Section titled “destroy()”destroy(
error?):void
Defined in: packages/net-core/src/session.ts:271
Tear the session down, rejecting every outstanding exchange.
Rejection happens here rather than relying on the transport emitting
close, so callers are never left with promises that hang against a
transport that closes silently.
Parameters
Section titled “Parameters”error?
Section titled “error?”unknown
Optional cause reported to outstanding exchanges.
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Session.destroy
end():
Promise<void>
Defined in: packages/net-core/src/session.ts:258
Half-close the outbound direction and flush pending writes.
Prefer this over destroy for protocols with a farewell command, so the peer sees an orderly shutdown.
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”Session.end
isSubscribed()
Section titled “isSubscribed()”isSubscribed<
K>(event,listener):boolean
Defined in: packages/async/src/events/event-dispatcher-map-base.ts:38
Check if a callback is subscribed to a specific event.
Type Parameters
Section titled “Type Parameters”K extends "push" | keyof BaseSessionEvents
Parameters
Section titled “Parameters”K
The event name.
listener
Section titled “listener”Callable<Pop3ClientEvents[K]>
The callback to check.
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”Session.isSubscribed
list()
Section titled “list()”list(
options?):Promise<Pop3MultilineResponse>
Defined in: packages/net-pop3/src/pop3/pop3-client.ts:190
Send LIST and read every scan listing.
Parameters
Section titled “Parameters”options?
Section titled “options?”ExchangeOptions<string>
Abort, timeout and abort-policy overrides.
Returns
Section titled “Returns”Promise<Pop3MultilineResponse>
listOne()
Section titled “listOne()”listOne(
msg,options?):Promise<Pop3Response>
Defined in: packages/net-pop3/src/pop3/pop3-client.ts:200
Send LIST msg for a single message.
Parameters
Section titled “Parameters”number
The message number.
options?
Section titled “options?”ExchangeOptions<string>
Abort, timeout and abort-policy overrides.
Returns
Section titled “Returns”Promise<Pop3Response>
noop()
Section titled “noop()”noop(
options?):Promise<Pop3Response>
Defined in: packages/net-pop3/src/pop3/pop3-client.ts:235
Send NOOP.
Parameters
Section titled “Parameters”options?
Section titled “options?”ExchangeOptions<string>
Abort, timeout and abort-policy overrides.
Returns
Section titled “Returns”Promise<Pop3Response>
pass()
Section titled “pass()”pass(
password,options?):Promise<Pop3Response>
Defined in: packages/net-pop3/src/pop3/pop3-client.ts:168
Send PASS password.
Parameters
Section titled “Parameters”password
Section titled “password”string
The mailbox password.
options?
Section titled “options?”ExchangeOptions<string>
Abort, timeout and abort-policy overrides.
Returns
Section titled “Returns”Promise<Pop3Response>
quit()
Section titled “quit()”quit(
options?):Promise<Pop3Response>
Defined in: packages/net-pop3/src/pop3/pop3-client.ts:244
Send QUIT.
Parameters
Section titled “Parameters”options?
Section titled “options?”ExchangeOptions<string>
Abort, timeout and abort-policy overrides.
Returns
Section titled “Returns”Promise<Pop3Response>
retr()
Section titled “retr()”retr(
msg,options?):Promise<Pop3MultilineResponse>
Defined in: packages/net-pop3/src/pop3/pop3-client.ts:213
Send RETR msg and read the full message.
Parameters
Section titled “Parameters”number
The message number.
options?
Section titled “options?”ExchangeOptions<string>
Abort, timeout and abort-policy overrides.
Returns
Section titled “Returns”Promise<Pop3MultilineResponse>
stat()
Section titled “stat()”stat(
options?):Promise<Pop3Response>
Defined in: packages/net-pop3/src/pop3/pop3-client.ts:181
Send STAT.
Parameters
Section titled “Parameters”options?
Section titled “options?”ExchangeOptions<string>
Abort, timeout and abort-policy overrides.
Returns
Section titled “Returns”Promise<Pop3Response>
The +OK count size reply.
stls()
Section titled “stls()”stls(
options?):Promise<Pop3Response>
Defined in: packages/net-pop3/src/pop3/pop3-client.ts:285
Send STLS. The caller performs the TLS handshake and then calls
upgradeTransport.
Parameters
Section titled “Parameters”options?
Section titled “options?”ExchangeOptions<string>
Abort, timeout and abort-policy overrides.
Returns
Section titled “Returns”Promise<Pop3Response>
subscribe()
Section titled “subscribe()”subscribe<
K>(event,listener,options?):Callable|null
Defined in: packages/async/src/events/event-dispatcher-map-base.ts:23
Type Parameters
Section titled “Type Parameters”K extends "push" | keyof BaseSessionEvents
Parameters
Section titled “Parameters”K
listener
Section titled “listener”Callable<Pop3ClientEvents[K]>
options?
Section titled “options?”EventDispatcherSubscribeOptions
Returns
Section titled “Returns”Callable | null
Inherited from
Section titled “Inherited from”Session.subscribe
uidl()
Section titled “uidl()”uidl(
options?):Promise<Pop3MultilineResponse>
Defined in: packages/net-pop3/src/pop3/pop3-client.ts:262
Send UIDL and read every unique identifier.
Parameters
Section titled “Parameters”options?
Section titled “options?”ExchangeOptions<string>
Abort, timeout and abort-policy overrides.
Returns
Section titled “Returns”Promise<Pop3MultilineResponse>
uidlOne()
Section titled “uidlOne()”uidlOne(
msg,options?):Promise<Pop3Response>
Defined in: packages/net-pop3/src/pop3/pop3-client.ts:272
Send UIDL msg for a single message.
Parameters
Section titled “Parameters”number
The message number.
options?
Section titled “options?”ExchangeOptions<string>
Abort, timeout and abort-policy overrides.
Returns
Section titled “Returns”Promise<Pop3Response>
unsubscribe()
Section titled “unsubscribe()”unsubscribe<
K>(event,listener):void
Defined in: packages/async/src/events/event-dispatcher-map-base.ts:31
Unsubscribe a callback from a specific event.
Type Parameters
Section titled “Type Parameters”K extends "push" | keyof BaseSessionEvents
Parameters
Section titled “Parameters”K
The event name.
listener
Section titled “listener”Callable<Pop3ClientEvents[K]>
The callback to remove.
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Session.unsubscribe
upgradeTransport()
Section titled “upgradeTransport()”upgradeTransport(
transport):void
Defined in: packages/net-pop3/src/pop3/pop3-client.ts:298
Replace the transport after a successful STLS.
Buffered plaintext is discarded rather than carried across, since bytes sent before the handshake must never be read as part of the secured session.
Parameters
Section titled “Parameters”transport
Section titled “transport”Transport
The TLS transport wrapping the same connection.
Returns
Section titled “Returns”void
user()
Section titled “user()”user(
username,options?):Promise<Pop3Response>
Defined in: packages/net-pop3/src/pop3/pop3-client.ts:155
Send USER username.
Parameters
Section titled “Parameters”username
Section titled “username”string
The mailbox name.
options?
Section titled “options?”ExchangeOptions<string>
Abort, timeout and abort-policy overrides.
Returns
Section titled “Returns”Promise<Pop3Response>
wait()
Section titled “wait()”wait<
K>(event,options?):Promise<Pop3ClientEvents[K]>
Defined in: packages/async/src/events/event-dispatcher-map-base.ts:45
Wait for the next occurrence of a specific event, optionally matching a predicate.
This is a convenience method that subscribes to the dispatcher, waits for the next event that matches the predicate (if provided), and then unsubscribes automatically.
Type Parameters
Section titled “Type Parameters”K extends "push" | keyof BaseSessionEvents
Parameters
Section titled “Parameters”K
The event name to wait for.
options?
Section titled “options?”EventDispatcherWaitOptions<Pop3ClientEvents[K]>
Optional settings including predicate and abort signal.
Returns
Section titled “Returns”Promise<Pop3ClientEvents[K]>
A promise that resolves with the event arguments as an array.
Inherited from
Section titled “Inherited from”Session.wait