Permalink
Find file
Fetching contributors…
Cannot retrieve contributors at this time
46 lines (33 sloc) 1.22 KB

winston-mail Build Status

A email transport for winston.

Installation

Installing npm (node package manager)

  $ curl http://npmjs.org/install.sh | sh

Installing winston-mail

  $ npm install winston
  $ npm install winston-mail

Usage

  var winston = require('winston');

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

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

The Mail transport uses node-mail behind the scenes. Options are the following, to and host are required:

  • to: The address(es) you want to send to. [required]
  • from: The address you want to send from. (default: winston@[server-host-name])
  • host: SMTP server hostname
  • port: SMTP port (default: 587 or 25)
  • secure: Use secure
  • 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.