Merge pull request #718 from log4js-node/deprecate-smtp

Deprecate SMTP appender

docs/appenders.md

@@ -33,7 +33,6 @@ The following appenders are included with log4js. Some require extra dependencie
 * [recording](recording.md)
 * [redis](redis.md)
 * [slack](slack.md)
-* [smtp](smtp.md)
 * [stderr](stderr.md)
 * [stdout](stdout.md)
 * [rabbitmq](rabbitmq.md)
@@ -47,6 +46,7 @@ The following appenders are supported by log4js, but will issue deprecation warn
 * [loggly](https://github.com/log4js-node/loggly)
 * [logstashUDP](https://github.com/log4js-node/logstashUDP)
 * [mailgun](https://github.com/log4js-node/mailgun)
+* [smtp](https://github.com/log4js-node/smtp)
 
 For example, if you were previously using the gelf appender (`type: 'gelf'`) then you should add `@log4js-node/gelf` to your dependencies and change the type to `type: '@log4js-node/gelf'`.
 

docs/index.md

@@ -11,7 +11,7 @@ There have been a few changes between log4js 1.x and 2.x (and 0.x too). You shou
 
 * coloured console logging to [stdout](stdout.md) or [stderr](stderr.md)
 * [file appender](file.md), with configurable log rolling based on file size or [date](dateFile.md)
-* [SMTP appender](smtp.md)
+* [SMTP appender](https://github.com/log4js-node/smtp)
 * [GELF appender](https://github.com/log4js-node/gelf)
 * [Loggly appender](https://github.com/log4js-node/loggly)
 * [Logstash UDP appender](logstashUDP.md)

docs/smtp.md

@@ -1,96 +0,0 @@
-# SMTP Appender
-
-Sends log events as emails. To use this appender you will need to include the [nodemailer](https://www.npmjs.com/package/nodemailer) package in your dependencies. If you use this appender, you should also call `log4js.shutdown` when your application closes so that any remaining emails can be sent. Many of the configuration options below are passed through to nodemailer, so you should read their docs to get the most out of this appender.
-
-## Configuration
-
-* `type` - `smtp`
-* `SMTP` - `object` (optional, if not present will use `transport` field)
-  * `host` - `string` (optional, defaults to `localhost`)
-  * `port` - `integer` (optional, defaults to `25`)
-  * `auth` - `object` (optional) - authentication details
-    * `user` - `string`
-    * `pass` - `string`
-* `transport` - `object` (optional, if not present will use `SMTP`) - see nodemailer docs for transport options
-  * `plugin` - `string` (optional, defaults to `smtp`) - the nodemailer transport plugin to use
-  * `options` - `object` - configuration for the transport plugin
-* `attachment` - `object` (optional) - send logs as email attachment
-  * `enable` - `boolean` (optional, defaults to `false`)
-  * `message` - `string` (optional, defaults to `See logs as attachment`) - message to put in body of email
-  * `filename` - `string` (optional, defaults to `default.log`) - attachment filename
-* `sendInterval` - `integer` (optional, defaults to `0`) - batch emails and send in one email every `sendInterval` seconds, if `0` then every log message will send an email.
-* `shutdownTimeout` - `integer` (optional, defaults to `5`) - time in seconds to wait for emails to be sent during shutdown
-* `recipients` - `string` - email addresses to send the logs to
-* `subject` - `string` (optional, defaults to message from first log event in batch) - subject for email
-* `sender` - `string` (optional) - who the logs should be sent as
-* `html` - `boolean` (optional, defaults to `false`) - send the email as HTML instead of plain text
-* `layout` - `object` (optional, defaults to basicLayout) - see [layouts](layouts.md)
-
-## Example (default config)
-```javascript
-log4js.configure({
-  appenders: {
-    'email': {
-      type: 'smtp', recipients: 'dev.team@company.name'
-    }
-  },
-  categories: { default: { appenders: [ 'email' ], level: 'error' } }
-});
-```
-This configuration will send an email using the smtp server running on `localhost:25`, for every log event of level `ERROR` and above. The email will be sent to `dev.team@company.name`, the subject will be the message part of the log event, the body of the email will be log event formatted by the basic layout function.
-
-## Example (logs as attachments, batched)
-```javascript
-log4js.configure({
-  appenders: {
-    'email': {
-      type: 'smtp',
-      recipients: 'dev.team@company.name',
-      subject: 'Latest logs',
-      sender: 'my.application@company.name',
-      attachment: {
-        enable: true,
-        filename: 'latest.log',
-        message: 'See the attachment for the latest logs'
-      },
-      sendInterval: 3600
-    }
-  },
-  categories: { default: { appenders: ['email'], level: 'ERROR' } }
-});
-```
-This configuration will send an email once every hour, with all the log events of level 'ERROR' and above as an attached file.
-
-## Example (custom SMTP host)
-```javascript
-log4js.configure({
-  appenders: {
-    email: {
-      type: 'smtp', smtp: { host: 'smtp.company.name', port: 8025 }, recipients: 'dev.team@company.name'
-    }
-  },
-  categories: { default: { appenders: ['email'], level: 'info' } }
-});
-```
-This configuration can also be written as:
-```javascript
-log4js.configure({
-  appenders: {
-    email: {
-      type: 'smtp',
-      transport: {
-        plugin: 'smtp',
-        options: {
-          host: 'smtp.company.name',
-          port: 8025
-        }
-      },
-      recipients: 'dev.team@company.name'
-    }
-  },
-  categories: {
-    default: { appenders: ['email'], level: 'info' }
-  }
-});
-```
-A similar config can be used to specify a different transport plugin than `smtp`. See the nodemailer docs for more details.

lib/appenders/smtp.js

@@ -1,5 +1,10 @@
 'use strict';
 
+/**
+ * This appender has been deprecated.
+ * Updates and bug fixes should be made against https://github.com/log4js-node/smtp
+ */
+
 const mailer = require('nodemailer');
 const os = require('os');
 
@@ -124,6 +129,9 @@ function smtpAppender(config, layout, subjectLayout) {
 
   appender.shutdown = shutdown;
 
+  // trigger a deprecation warning.
+  appender.deprecated = '@logj4s-node/smtp';
+
   return appender;
 }
 

test/tap/smtpAppender-test.js

@@ -196,9 +196,10 @@ test('log4js smtpAppender', (batch) => {
     setup.logger.info('This will break');
 
     t.test('should be logged to console', (assert) => {
-      assert.equal(setup.console.errors.length, 1);
-      assert.equal(setup.console.errors[0].msg, 'log4js.smtpAppender - Error happened');
-      assert.equal(setup.console.errors[0].value.message, 'oh noes');
+      assert.equal(setup.console.errors.length, 2);
+      // first error will be deprecation warning, ignore it
+      assert.equal(setup.console.errors[1].msg, 'log4js.smtpAppender - Error happened');
+      assert.equal(setup.console.errors[1].value.message, 'oh noes');
       assert.end();
     });
     t.end();