Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Implements

Index

Type aliases

Static AuthenticationType

Constructors

constructor

  • Parameters

    Returns SMTPTransport

Properties

auth

logger

logger: Logger

mailer

mailer: Mail

name

name: string

options

options: Options

version

version: string

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

  • addListener(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

close

  • close(): void
  • Releases resources

    Returns void

emit

  • emit(event: string | symbol, ...args: any[]): boolean
  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>

getAuth

getMaxListeners

  • getMaxListeners(): number

getSocket

  • getSocket(options: Options, callback: function): void
  • Placeholder function for creating proxy sockets. This method immediatelly returns without a socket

    Parameters

    • options: Options
    • callback: function
        • (err: Error | null, socketOptions: object): void
        • Parameters

          • err: Error | null
          • socketOptions: object

          Returns void

    Returns void

listenerCount

  • listenerCount(type: string | symbol): number

listeners

  • listeners(event: string | symbol): Function[]

off

  • off(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

on

  • on(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

once

  • once(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependListener

  • prependListener(event: string | symbol, listener: function): this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: function): this

rawListeners

  • rawListeners(event: string | symbol): Function[]

removeAllListeners

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

removeListener

  • removeListener(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

send

  • Sends an e-mail using the selected settings

    Parameters

    Returns void

setMaxListeners

  • setMaxListeners(n: number): this

verify

  • verify(callback: function): void
  • verify(): Promise<true>
  • Verifies SMTP configuration

    Parameters

    • callback: function
        • (err: Error | null, success: true): void
        • Parameters

          • err: Error | null
          • success: true

          Returns void

    Returns void

  • Returns Promise<true>

Static listenerCount

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

    since v4.0.0

    Parameters

    Returns number

Generated using TypeDoc