winston-mail-logging v3.0.0

A email transport for winston.

Installation

$ npm install winston
$ npm install winston-mail-logging

Usage

var winston = require('winston');

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

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
• cc: The address(es) you want to send cc. required
• bcc: The address(es) you want to send bcc. 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
• subject Subject for email (default: winston: {{level}} {{msg}})
• ssl: Use SSL (boolean or object { key, ca, cert })
• tls: Boolean (if true, use starttls)
• level: Level of messages that this transport should log.
• unique: Boolean flag indicating whether to log only the declared level and none above.
• silent: Boolean flag indicating whether to suppress output.
• filter: Filter function with signature function({level, message, meta}). If specified, should return true for log messages that need to send.
• html: Boolean flag indicating whether to send mail body as html attach.
• timeout: Maximum number of milliseconds to wait for smtp responses (optional, defaults to emailjs defaults - 5000)
• authentication: Preffered SMTP auth methods (optional, defaults to emailjs defaults - 'PLAIN', 'CRAM-MD5', 'LOGIN', 'XOAUTH2')
• formatter: Custom mail body formatter with signature function({level, message, meta}). If specified, the return value will be used as mail body.

Subject templating

The subject option takes a mustache template string that exposes the following fields:

• {{level}} - Log level
• {{msg}} - First line of the error message