Class Pop3Client

A Pop3 Client for a TLS encrypted connection over a WebSocket.

Hierarchy (View Summary)

AbstractTlsConnection
- Pop3Client

Index

Constructors

Properties

socket reader timeout debugEnabled onVerifyTlsConnection lastError

Methods

debug getReader setTimeoutRead getSocket getTlsCertificateChain sendCommand connectTlsClient getLastError login

Constructors

constructor

new Pop3Client(socketProvider: TlsWebSocketProvider): Pop3Client
Parameters
- socketProvider: TlsWebSocketProvider
Returns Pop3Client
Inherited from AbstractTlsConnection.constructor

Properties

`Protected`socket

socket: undefined | TlsWebSocket

`Protected`reader

reader: undefined | SocketReader

`Protected`timeout

timeout: number

debugEnabled

debugEnabled: boolean

set to debug HttpClient with console.log

onVerifyTlsConnection

onVerifyTlsConnection: (socket: TlsWebSocket) => Promise<void>

Hook method for double verify a connection aber the tls connection has been established.

Type Declaration

- (socket: TlsWebSocket): Promise<void>
- Parameters
  - socket: TlsWebSocket
    the new opened tls connection.
  Returns Promise<void>

`Protected`lastError

lastError: Pop3ClientError

Methods

debug

debug(...args: unknown[]): void
Parameters
- ...args: unknown[]
Returns void
Inherited from AbstractTlsConnection.debug

getReader

getReader(): SocketReader
Returns SocketReader
Inherited from AbstractTlsConnection.getReader

setTimeoutRead

setTimeoutRead(timeout: number): void
Sets the read timeout in ms
Parameters
- timeout: number
  timeout in ms
Returns void
Inherited from AbstractTlsConnection.setTimeoutRead

getSocket

getSocket(): TlsWebSocket
Returns TlsWebSocket
Inherited from AbstractTlsConnection.getSocket

getTlsCertificateChain

getTlsCertificateChain(): undefined | string
Returns a PEM string containing of the certificate chain.

Returns undefined | string
PEM string.

Inherited from AbstractTlsConnection.getTlsCertificateChain

sendCommand

sendCommand(command: string): void
Parameters
- command: string
Returns void
Inherited from AbstractTlsConnection.sendCommand

`Protected`connectTlsClient

connectTlsClient(): Promise<void>
Waits for the WASM to be loaded, then starts the connection to the WebSocket after that tries to establish a tls connections.

Returns Promise<void>
a Promise that resolves after the TLS connection is established, and rejects in case of an error

Inherited from AbstractTlsConnection.connectTlsClient

getLastError

getLastError(): Pop3ClientError
Returns the last recorded error type while establishing an POP3Session.

Returns Pop3ClientError

login(username: string, password: string): Promise<Pop3Session>
Establishes a connection to the POP3 Server and tries to login. Creates a Pop3Session if successful.
Parameters
- username: string
- password: string
Returns Promise<Pop3Session>
Pop3Session

Throws
Error if any error occur. Use getLastError to determine the source of the error.