smtp-connection-as-promised
This module provides promisified version of smtp-connection
from
nodemailer
module. The API is the
same as for smtp-connection
, except that all methods return
Promise
objects.
Requirements
This module requires Node >= 6.
Installation
npm install smtp-connection-as-promised
Additionally for Typescript:
npm install @types/node @types/nodemailer
Usage
const SMTPConnectionAsPromised =
Typescript:
// or
constructor
const connection = options
Create new SMTPConnection instance. Options are the same as for original
smtp-connection
constructor.
Example:
const connection = opportunisticTLS: true host: "smtp.example.com" port: 25
ended
const isEnded = connectionended
It is true
if connection is already ended.
secure
const isSecure = connectionsecure
It is true
if connection uses TLS.
connect
await connectionconsole
Establish the connection and set the secure
property.
login
await connection
Login to the server if requires authentication.
auth
is the authentication object with user
, pass
and xoauth2
properties.
Example:
await connection
send
const info = await connection
Send a message with an envelope. The info
object is returned in a Promise.
Example:
const envelope = from: "from@example.com" to: "to@example.net" // prettier-ignoreconst message = '' + 'From: from@example.com\n' + 'To: to@example.net\n' + 'Subject: test\n' + '\n' + 'Test\n' const info = await connectionconsole
quit
await connection
Graceful SMTP session ending. The QUIT
command is sent.
close
await connection
Disconnecting of SMTP session.
reset
await connection
Reseting the SMTP session. The RSET
command is set.
destroy
await connection
Manually free resources taken by connection.
License
Copyright (c) 2016-2019 Piotr Roszatycki piotr.roszatycki@gmail.com