Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Mail transport for Winston
JavaScript
branch: master

readme.md

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 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
  • 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.
  • silent: Boolean flag indicating whether to suppress output.
  • html: Boolean flag indicating whether to send mail body as html attach.

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

License

The MIT License (MIT)

Copyright (c) 2015 Marc Harter

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Something went wrong with that request. Please try again.