@livy/mail-handler

This Livy handler dispenses log records via email using Nodemailer.

Synchronous logger support: no

Runtime: Node.js

Basic Example

const { MailHandler } = require('@livy/mail-handler')

const handler = new MailHandler({
  subject: 'Hello world!',
  to: '[email protected]',
  from: '[email protected]'
})

Installation

Install it via npm:

npm install @livy/mail-handler

Options

An object of options must be passed to the handler constructor as the first argument.

The following options are available:

from (required)

Type: string

Description: The sender of the emails to send.

subject (required)

Type: string

Description: The subject of the emails to send. All properties of the corresponding log record are available as %tokens%, for example %channel% will be replaced with the record's channel.

to (required)

Type: string | string[]

Description: One or more receivers of the emails

bubble

Type: boolean

Default: true

Description: Controls whether records handled by this handler should bubble up to other handlers.

See also: Bubbling

level

Type: LogLevel

Default: 'warning'

Description: Controls which log records should be handled based on their log level.

htmlFormatter

Type: FormatterInterface

Default: new HtmlPrettyFormatter()

Description: The formatter for the HTML part of mails.

plainTextFormatter

Type: FormatterInterface

Default: new LineFormatter()

Description: The formatter for the plain text part of mails.

template

Type: object

Default: { html: '%logs%', text: '%logs%' }

Description: A template for either HTML or plain text emails or both. The %logs% token will be replaced with the formatted log record(s).

transport

Type: object

Default: { sendmail: true }

Description: Nodemailer transport options (e.g. for using SMTP). Available options can be looked up in the Nodemailer docs.

Public API

bubble

Controls whether records handled by this handler should bubble up to other handlers. Initially set through the bubble option.

See also: Bubbling

defaultHtmlFormatter (read-only)

The default formatter used for emails' HTML parts.

defaultPlainTextFormatter (read-only)

The default formatter used for emails' plain text parts.

level

The minimum log level of a log record to be considered by this handler. Initially set through the level option.

htmlFormatter

The formatter used for the HTML part of mails. Initially set through the htmlFormatter option.

plainTextFormatter

The formatter used for the plain text part of mails. Initially set through the plainTextFormatter option.

processors

This handler supports processors by implementing the ProcessableHandlerInterface.

reset()

This handler implements the ResettableInterface. Resetting it resets all attached processors.

You usually don't want to call this method manually on an individual handler. Consider calling it on the logger instead.