Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Type aliases

Static AuthenticationType

Static DSNOption

DSNOption: "NEVER" | "SUCCESS" | "FAILURE" | "DELAY"

Static OAuth2

OAuth2: Options

Constructors

constructor

  • Parameters

    Returns SMTPConnection

Properties

_socket

_socket: Socket

The socket connecting to the server

alreadySecured

alreadySecured: boolean

authenticated

authenticated: boolean

If true, then the user is authenticated

destroyed

destroyed: boolean

If set to true, this instance is no longer active

host

host: string

id

id: string

lastServerResponse

lastServerResponse: string | false

logger

logger: Logger

name

name: string

options

options: Options

port

port: number

secure

secure: boolean

Defines if the current connection is secure or not. If not, STARTTLS can be used if available

secureConnection

secureConnection: boolean

stage

stage: "init" | "connected"

version

version: string

Expose version nr, just for the reference

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

  • addListener(event: "connect" | "end", listener: function): this
  • addListener(event: "error", listener: function): this
  • Parameters

    • event: "connect" | "end"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function

    Returns this

close

  • close(): void
  • Closes the connection to the server

    Returns void

connect

  • connect(callback: function): void
  • Creates a connection to a SMTP server and sets up connection listener

    Parameters

    • callback: function

    Returns void

emit

  • emit(event: "connect" | "end"): boolean
  • emit(event: "error", error: Error): boolean
  • Parameters

    • event: "connect" | "end"

    Returns boolean

  • Parameters

    • event: "error"
    • error: Error

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(event: "connect" | "end" | "error"): number
  • Parameters

    • event: "connect" | "end" | "error"

    Returns number

listeners

  • listeners(event: "connect" | "end"): Array<function>
  • listeners(event: "error"): Array<function>
  • Parameters

    • event: "connect" | "end"

    Returns Array<function>

  • Parameters

    • event: "error"

    Returns Array<function>

login

off

  • off(event: "connect" | "end", listener: function): this
  • off(event: "error", listener: function): this
  • Parameters

    • event: "connect" | "end"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function

    Returns this

on

  • on(event: "connect" | "end", listener: function): this
  • on(event: "error", listener: function): this
  • Parameters

    • event: "connect" | "end"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function

    Returns this

once

  • once(event: "connect" | "end", listener: function): this
  • once(event: "error", listener: function): this
  • Parameters

    • event: "connect" | "end"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function

    Returns this

prependListener

  • prependListener(event: "connect" | "end", listener: function): this
  • prependListener(event: "error", listener: function): this
  • Parameters

    • event: "connect" | "end"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function

    Returns this

prependOnceListener

  • prependOnceListener(event: "connect" | "end", listener: function): this
  • prependOnceListener(event: "error", listener: function): this
  • Parameters

    • event: "connect" | "end"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function

    Returns this

quit

  • quit(): void
  • Sends QUIT

    Returns void

rawListeners

  • rawListeners(event: "connect" | "end"): Array<function>
  • rawListeners(event: "error"): Array<function>
  • Parameters

    • event: "connect" | "end"

    Returns Array<function>

  • Parameters

    • event: "error"

    Returns Array<function>

removeAllListener

  • removeAllListener(event: "connect" | "end" | "error"): this
  • Parameters

    • event: "connect" | "end" | "error"

    Returns this

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

removeListener

  • removeListener(event: "connect" | "end", listener: function): this
  • removeListener(event: "error", listener: function): this
  • Parameters

    • event: "connect" | "end"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function

    Returns this

reset

  • reset(callback: function): void
  • Resets connection state

    Parameters

    • callback: function

    Returns void

send

setMaxListeners

  • setMaxListeners(n: number): this

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    Returns number

Generated using TypeDoc