Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

x-winston-mailer

machadogj3BSD0.0.1

Winston transport based on mailer. It buffers errors, and packs them in one email if necessary.

winston, email, mail, mailer

readme

An email transport based on mailer for winston.

Installation

  $ npm install winston
  $ npm install winston-mailer

Usage

  var winston = require('winston');

  //
  // Requiring `winston-mailer` will expose 
  // `winston.transports.Mail`
  //
  require('winston-mailer').Mail;

  winston.add(winston.transports.Mail, options);

The Mail transport uses mailer behind the scenes. Options are the following:

  • to: The address(es) you want to send to. [required]
  • from: The 'from' address (default: winston@[server-host-name].com)
  • host: SMTP server hostname (default: localhost)
  • port: SMTP port (default: 587 or 25)
  • username User for server auth
  • password Password for server auth
  • level: Level of messages that this transport should log.
  • silent: Boolean flag indicating whether to suppress output.
  • prefix: String for using in as prefix in the subject.
  • maxBufferItems Max errors that will be buffered (default 100)
  • maxBufferTimeSpan Max miliseconds errors will be buffered (default 60000)