smtp-channel

  

smtp-channel

Low level SMTP communication layer.

This is an open source npm package from Node.js. The source code is available on GitHub where you can also find our issue tracker.

Install

$ npm install --save smtp-channel

Example

import {SMTPChannel} from 'smtp-channel';

(async function() {
  let handler = console.log;

  let smtp = new SMTPConnector({
    host: 'mx.domain.com',
    port: 25
  });

  await s.connect({handler, timeout: 3000});
  await s.write('EHLO mx.me.com\r\n', {handler});
  await s.write('QUIT\r\n', {handler});

})().catch(console.error);

API

SMTPChannel(options)

A core SMTP class. This class pass options directly to the net.connect or tls.connect methods. Additional available options are listed below.

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).

SMTPChannel.prototype.connect({handler, timeout}):Promise;

Connects to the SMTP server and starts socket I/O activity.

Option	Type	Required	Default	Description
handler	Function	Promise	No	-
timeout	Integer	No	0	A time in milliseconds after the operation automatically rejects (0 disables the timeout).

SMTPChannel.prototype.write(data, {handler, timeout}):Promise;

Sends data on the socket.

Option	Type	Required	Default	Description
data	String	Stream	Buffer	Yes
handler	Function	Promise	No	-
timeout	Integer	No	0	A time in milliseconds after the operation automatically rejects (0 disables the timeout).

SMTPChannel.prototype.close({handler, timeout}):Promise;

Destroys the socket and ensures that no more I/O activity happens on this socket.

Option	Type	Required	Default	Description
handler	Function	Promise	No	-
timeout	Integer	No	0	A time in milliseconds after the operation automatically rejects (0 disables the timeout).

SMTPChannel.prototype.negotiateTLS(options):Promise;

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 method.

SMTPChannel.prototype.isSecure():Boolean;

Returns true if the connection is secured over TLS.

Event: close: () => {}

Emitted once the socket is fully closed.

Event: connect: () => {}

Emitted when a socket connection is successfully established.

Event: data: (data) => {}

Emitted when data is received.

Argument	Type	Description
data	Buffer,String	Received data string.

Event: end: () => {}

Emitted when the other end of the socket sends a FIN packet. This means that the socket is about to close.

Event: error: (error) => {}

Emitted when an error occurs. The 'close' event will be called directly following this event.

Argument	Type	Description
error	Error	Error object.

Event: timeout: () => {}

Emitted if the socket times out from inactivity. The timeout event automatically sends the QUIT SMTP command.

License (MIT)

Copyright (c) 2016 Kristijan Sedlak <[e-mail]>

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.