danielschwartz/winston-mail

Mail transport for Winston

winston-mail

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 emailjs behind the scenes. Options are the following:

• 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 (default: localhost)
• port: SMTP port (default: 587 or 25)
• username User for server auth
• password Password for server auth
• ssl: Use SSL (boolean or object { key, ca, cert })
• tls: Boolean (if true, use starttls)
• level: Level of messages that this transport should log.
• silent: Boolean flag indicating whether to suppress output.