Options
All
  • Public
  • Public/Protected
  • All
Menu

Creates an object for exposing the Mail API

Hierarchy

Index

Type aliases

Static Headers

Headers: object | Array<object>

Static ListHeader

ListHeader: string | object

Static PluginFunction

PluginFunction: function

Type declaration

    • Parameters

      • mail: MailMessage
      • callback: function
          • (err?: Error | null): void
          • Parameters

            • Optional err: Error | null

            Returns void

      Returns void

Static TextEncoding

TextEncoding: "quoted-printable" | "base64"

Constructors

constructor

Properties

MailMessage

MailMessage: MailMessage

Usage: typeof transporter.MailMessage

dkim

dkim: DKIM

logger

logger: Logger

meta

meta: Map<string, any>

options

options: Options

transporter

transporter: Transport

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

  • addListener(event: "error", listener: function): this
  • addListener(event: "idle", listener: function): this
  • addListener(event: "token", listener: function): this
  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "idle"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "token"
    • listener: function
        • Parameters

          Returns void

    Returns this

close

  • close(): void
  • Closes all connections in the pool. If there is a message being sent, the connection is closed later

    Returns void

emit

  • emit(event: "error", error: Error): boolean
  • emit(event: "idle"): boolean
  • emit(event: "token", token: Token): boolean
  • Parameters

    • event: "error"
    • error: Error

    Returns boolean

  • Parameters

    • event: "idle"

    Returns boolean

  • Parameters

    • event: "token"
    • token: Token

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>

get

  • get(key: "oauth2_provision_cb"): function
  • get(key: "proxy_handler_http" | "proxy_handler_https" | "proxy_handler_socks" | "proxy_handler_socks5" | "proxy_handler_socks4" | "proxy_handler_socks4a"): function
  • get(key: string): any
  • Parameters

    • key: "oauth2_provision_cb"

    Returns function

      • (user: string, renew: boolean, callback: function): void
      • Parameters

        • user: string
        • renew: boolean
        • callback: function
            • (err: Error | null, accessToken: string, expires: number): void
            • Parameters

              • err: Error | null
              • accessToken: string
              • expires: number

              Returns void

        Returns void

  • Parameters

    • key: "proxy_handler_http" | "proxy_handler_https" | "proxy_handler_socks" | "proxy_handler_socks5" | "proxy_handler_socks4" | "proxy_handler_socks4a"

    Returns function

      • Parameters

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

              • err: Error | null
              • socketOptions: object

              Returns void

        Returns void

  • Parameters

    • key: string

    Returns any

getMaxListeners

  • getMaxListeners(): number

getVersionString

  • getVersionString(): string
  • Returns string

isIdle

  • isIdle(): boolean
  • Returns true if there are free slots in the queue

    Returns boolean

listenerCount

  • listenerCount(type: string | symbol): number

listeners

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

    • event: "error"

    Returns Array<function>

  • Parameters

    • event: "idle"

    Returns Array<function>

  • Parameters

    • event: "end"

    Returns Array<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: "error", listener: function): this
  • on(event: "idle", listener: function): this
  • on(event: "token", listener: function): this
  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "idle"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "token"
    • listener: function
        • Parameters

          Returns void

    Returns this

once

  • once(event: "error", listener: function): this
  • once(event: "idle", listener: function): this
  • once(event: "token", listener: function): this
  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "idle"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "token"
    • listener: function
        • Parameters

          Returns void

    Returns this

prependListener

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

    • event: "error"
    • listener: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "idle"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "end"
    • listener: function
        • Parameters

          Returns void

    Returns this

prependOnceListener

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

    • event: "error"
    • listener: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "idle"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "end"
    • listener: function
        • Parameters

          Returns void

    Returns 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

sendMail

  • Sends an email using the preselected transport object

    Parameters

    Returns void

  • Parameters

    Returns Promise<SentMessageInfo>

set

  • set(key: "oauth2_provision_cb", value: function): Map<string, any>
  • set(key: "proxy_handler_http" | "proxy_handler_https" | "proxy_handler_socks" | "proxy_handler_socks5" | "proxy_handler_socks4" | "proxy_handler_socks4a", value: function): Map<string, any>
  • set(key: string, value: any): Map<string, any>
  • Parameters

    • key: "oauth2_provision_cb"
    • value: function
        • (user: string, renew: boolean, callback: function): void
        • Parameters

          • user: string
          • renew: boolean
          • callback: function
              • (err: Error | null, accessToken?: undefined | string, expires?: undefined | number): void
              • Parameters

                • err: Error | null
                • Optional accessToken: undefined | string
                • Optional expires: undefined | number

                Returns void

          Returns void

    Returns Map<string, any>

  • Parameters

    • key: "proxy_handler_http" | "proxy_handler_https" | "proxy_handler_socks" | "proxy_handler_socks5" | "proxy_handler_socks4" | "proxy_handler_socks4a"
    • value: function
        • Parameters

          • proxy: Url
          • options: TransportOptions
          • callback: function
              • (err: Error | null, socketOptions?: undefined | object): void
              • Parameters

                • err: Error | null
                • Optional socketOptions: undefined | object

                Returns void

          Returns void

    Returns Map<string, any>

  • Parameters

    • key: string
    • value: any

    Returns Map<string, any>

setMaxListeners

  • setMaxListeners(n: number): this

setupProxy

  • setupProxy(proxyUrl: string): void
  • Sets up proxy handler for a Nodemailer object

    Parameters

    • proxyUrl: string

    Returns void

use

  • Parameters

    Returns 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