smtp-channel - npm Package Compare versions

Comparing version 0.1.1 to 0.1.2

package.json

 {
   "name": "smtp-channel",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Low level SMTP communication layer.",
@@ -5,0 +5,0 @@ "main": "./src/index.js",

README.md

@@ -39,3 +39,3 @@ ![Build Status](https://travis-ci.org/xpepermint/smtp-channel.svg?branch=master) [![NPM Version](https://badge.fury.io/js/smtp-channel.svg)](https://badge.fury.io/js/smtp-channel) [![Dependency Status](https://gemnasium.com/xpepermint/smtp-channel.svg)](https://gemnasium.com/xpepermint/smtp-channel)
 
-> A core SMTP class. This class pass options directly to the [net.connect](https://nodejs.org/api/net.html#net_net_connect_options_connectlistener) or  [tls.connect](https://nodejs.org/api/tls.html#tls_tls_connect_options_callback) methods. Additional available options are listed below.
+> The core SMTP class. This class passes options directly to the [net.connect](https://nodejs.org/api/net.html#net_net_connect_options_connectlistener) or  [tls.connect](https://nodejs.org/api/tls.html#tls_tls_connect_options_callback) methods. Other available options are listed below.
 
@@ -45,3 +45,3 @@ | Option | Type | Required | Default | Description
 | secure | Boolean | No | false | When `true` the channel will connect to the SMTP server using TLS.
-| timeout | Integer | No | 0 | A time in milliseconds after the the socket connection is automatically closed (`0` disables the timeout).
+| timeout | Integer | No | 0 | A time in milliseconds after the socket is automatically closed (`0` disables the timeout).
 
@@ -63,3 +63,3 @@ **SMTPChannel.prototype.connect({handler, timeout})**:Promise;
 |--------|------|----------|---------|------------
-| data | String|Stream|Buffer | Yes | - | Data to be sent to the SMTP server. Make sure that you apply to the SMTP rules and end complete lines with `\r\n`.
+| data | String,Stream,Buffer | Yes | - | Data to be sent to the SMTP server. Make sure that you apply to the SMTP rules and complete lines with `\r\n`. When sending email data stream, make sure you include the `.` as the last line.
 | handler | Function|Promise | No | - | A method for handling SMTP server replies.
@@ -74,3 +74,3 @@ | timeout | Integer | No | 0 | A time in milliseconds after the operation automatically rejects (`0` disables the timeout).
 |--------|------|----------|---------|------------
-| handler | Function|Promise | No | - | A method for handling SMTP server replies.
+| handler | Function,Promise | No | - | A method for handling SMTP server replies.
 | timeout | Integer | No | 0 | A time in milliseconds after the operation automatically rejects (`0` disables the timeout).
@@ -80,3 +80,3 @@
 
-> Upgrades the existing socket connection to TLS. This method should be used after sending the `STARTTLS` command. The method accepts `options` which are sent directly to the [tls.connect](https://nodejs.org/api/tls.html#tls_tls_connect_options_callback) method.
+> Upgrades the existing socket connection to TLS. This method should be used after sending the `STARTTLS` command. The method accepts `options` which are sent directly to the [tls.connect](https://nodejs.org/api/tls.html#tls_tls_connect_options_callback) method (existing class options are overriden).
 
@@ -83,0 +83,0 @@ **SMTPChannel.prototype.isSecure()**:Boolean;

No alert changes

Improved metrics

Total package byte prevSize

18635

increased by0.53%

No dependency changes