A mail transport for winston with to, cc and bcc fields
npm install winston-mail-logging
A email transport for [winston][0].
`` sh`
$ npm install winston
$ npm install winston-mail-logging
js
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:
)
* __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