# @nowak-ds/mailer

> This module can be used to send emails.

Latest version **1.1.4** (published 2021-12-07) · ISC license · 0 weekly downloads

## Install

```sh
npm install @nowak-ds/mailer
pnpm add @nowak-ds/mailer
yarn add @nowak-ds/mailer
bun add @nowak-ds/mailer
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.4 |
| Published | 2021-12-07 |
| First published | 2021-10-25 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 16.1 KB |
| Known vulnerabilities | 0 (+31 in 2 direct dependencies) |
| Install scripts | no |
| Maintainers | nowak-ds |

## Links

- npm: https://www.npmjs.com/package/@nowak-ds/mailer
- Repository: https://github.com/nowak-ds/mailer
- Homepage: https://github.com/nowak-ds/mailer#readme
- Issues: https://github.com/nowak-ds/mailer/issues
- npm.io page: https://npm.io/package/@nowak-ds/mailer

## Dependencies (6)

- [cors](https://npm.io/package/cors.md) ^2.8.5
- [path](https://npm.io/package/path.md) ^0.12.7
- [axios](https://npm.io/package/axios.md) ^0.21.1
- [https](https://npm.io/package/https.md) ^1.0.0
- [express](https://npm.io/package/express.md) ^4.17.1
- [nodemailer](https://npm.io/package/nodemailer.md) ^6.6.5

## Recent versions

- 1.1.4 (latest) — 2021-12-07
- 1.1.3 — 2021-12-07
- 1.1.2 — 2021-12-07
- 1.1.1 — 2021-12-07
- 1.1.0 — 2021-12-07
- 1.0.4 — 2021-10-25
- 1.0.3 — 2021-10-25
- 1.0.1 — 2021-10-25
- 1.0.0 — 2021-10-25

## README

# Mailer

This module can be used to send emails.

## Installation
```sh
npm i @nowak-ds/mailer
```

## Configuration
Add a file to your root folder and name it mailer-config.json.
Add the following content to that file and replace the information with the correct values.

```json
{
    "port": 5010,
    "host": "your-server:4010",
    "smtp": {
        "host": "smtp.mail.com",
        "port": 465,
        "secure": true,
        "auth": {
            "user": "you@mail.com",
            "pass": "savePW123"
        }
    }
}
```
### port
This is the port where the application will be available.

### smtp
The details of the email account that shall be used to send emails.

## Execute
Simply call:
```sh
node node_modules/@nowak-ds/mailer/index.js
```

Or create a new script in your package.json file:
```json
"scripts": {
    "start-mailer": "node node_modules/@nowak-ds/mailer/index.js"
 }
```

---
_Source: https://npm.io/package/@nowak-ds/mailer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._