Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MailClient

SMTP mail client for Vert.x

A simple asynchronous API for sending mails from Vert.x applications

Hierarchy

  • MailClient

Index

Properties

Methods

Properties

Static Readonly DEFAULT_POOL_NAME

DEFAULT_POOL_NAME: string

The name of the default pool

Methods

close

  • close(): PromiseLike<void>
  • close(closedHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

  • Close the MailClient

    Returns PromiseLike<void>

  • Close the MailClient

    Parameters

    • closedHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

    Returns void

sendMail

  • send a single mail via MailClient

    Parameters

    Returns PromiseLike<MailResult>

  • send a single mail via MailClient

    Parameters

    Returns MailClient

Static create

  • Create a non shared instance of the mail client.

    Parameters

    Returns MailClient

Static createShared

  • Create a Mail client which shares its connection pool with any other Mail clients created with the same pool name

    Parameters

    • vertx: Vertx
    • config: MailConfig
    • poolName: string

    Returns MailClient

  • Like {@link MailClient#createShared} but with the default pool name

    Parameters

    Returns MailClient

Generated using TypeDoc