Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dex4er/js-smtp-connection-as-promised
Promisify smtp-connection
https://github.com/dex4er/js-smtp-connection-as-promised
Last synced: about 2 months ago
JSON representation
Promisify smtp-connection
- Host: GitHub
- URL: https://github.com/dex4er/js-smtp-connection-as-promised
- Owner: dex4er
- License: mit
- Created: 2016-08-28T10:14:25.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-05-14T08:42:29.000Z (8 months ago)
- Last Synced: 2024-05-14T09:50:00.772Z (8 months ago)
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/smtp-connection-as-promised
- Size: 126 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# smtp-connection-as-promised
[](http://travis-ci.org/dex4er/js-smtp-connection-as-promised) [](https://coveralls.io/github/dex4er/js-smtp-connection-as-promised) [](https://www.npmjs.com/package/smtp-connection-as-promised)
This module provides promisified version of `smtp-connection` from
[`nodemailer`](https://www.npmjs.com/package/nodemailer) module. The API is the
same as for `smtp-connection`, except that all methods return
[`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)
objects.
## Requirements
This module requires Node >= 6.
## Installation
```shell
npm install smtp-connection-as-promised
```
_Additionally for Typescript:_
```shell
npm install @types/node @types/nodemailer
```
## Usage
```js
const {SMTPConnectionAsPromised} = require("smtp-connection-as-promised")
```
_Typescript:_
```ts
import SMTPConnectionAsPromised from "smtp-connection-as-promised"
// or
import {SMTPConnectionAsPromised} from "smtp-connection-as-promised"
```
### constructor
```js
const connection = new SMTPConnectionAsPromised(options)
```
Create new SMTPConnection instance. Options are the same as for original
`smtp-connection` constructor.
_Example:_
```js
const connection = new SMTPConnectionAsPromised({
opportunisticTLS: true,
host: "smtp.example.com",
port: 25,
})
```
### ended
```js
const isEnded = connection.ended
```
It is `true` if connection is already ended.
### secure
```js
const isSecure = connection.secure
```
It is `true` if connection uses TLS.
### connect
```js
await connection.connect()
console.log(connection.secure)
```
Establish the connection and set the `secure` property.
### login
```js
await connection.login(auth)
```
Login to the server if requires authentication.
`auth` is the authentication object with `user`, `pass` and `xoauth2`
properties.
_Example:_
```js
await connection.login({
user: "[email protected]",
pass: "secret",
})
```
### send
```js
const info = await connection.send(envelope, message)
```
Send a message with an envelope. The `info` object is returned in a Promise.
_Example:_
```js
const envelope = {
from: "[email protected]",
to: "[email protected]",
}
// prettier-ignore
const message =
'' +
'From: [email protected]\n' +
'To: [email protected]\n' +
'Subject: test\n' +
'\n' +
'Test\n'
const info = await connection.send(envelope, message)
console.log(info.response)
```
### quit
```js
await connection.quit()
```
Graceful SMTP session ending. The `QUIT` command is sent.
### close
```js
await connection.close()
```
Disconnecting of SMTP session.
### reset
```js
await connection.reset()
```
Reseting the SMTP session. The `RSET` command is set.
### destroy
```js
await connection.destroy()
```
Manually free resources taken by connection.
## License
Copyright (c) 2016-2019 Piotr Roszatycki
[MIT](https://opensource.org/licenses/MIT)