# @muryllo/mailer

> This is a simple and pragmatic library for sending emails on systems built on Node.js using JavaScript or Typescript.

Latest version **2.3.0** (published 2022-09-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install @muryllo/mailer
pnpm add @muryllo/mailer
yarn add @muryllo/mailer
bun add @muryllo/mailer
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.3.0 |
| Published | 2022-09-03 |
| First published | 2021-07-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 49.3 KB |
| Known vulnerabilities | 0 (+24 in 2 direct dependencies) |
| Install scripts | no |
| Author | Muryllo Pimenta de Oliveira |
| Maintainers | muryllo.pimenta |
| Keywords | email, smtp, transactional, api |

## Links

- npm: https://www.npmjs.com/package/@muryllo/mailer
- npm.io page: https://npm.io/package/@muryllo/mailer

## Dependencies (2)

- [mjml](https://npm.io/package/mjml.md) ^4.13.0
- [axios](https://npm.io/package/axios.md) ^0.21.1

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 2.3.0 (latest) — 2022-09-03
- 2.2.4 — 2022-09-03
- 2.2.3 — 2022-09-02
- 2.2.2 — 2022-09-02
- 2.1.1 — 2022-09-02
- 2.0.1 — 2022-08-31
- 2.0.0 — 2022-08-31
- 1.0.1 — 2021-11-10
- 0.0.1 — 2021-07-30

## README

<h1 align="center">@muryllo/mailer</h1>
<p align="center">This is a simple and pragmatic library for sending emails on systems built on Node.js using JavaScript or Typescript.</p>

<p align="center">
  <img src="https://badgen.net/badge/license/MIT/green"/>
  <img src="https://badgen.net/badge/service/SMTP2GO/blue?icon=label">
  <img src="https://badgen.net/badge/author/Muryllo/yellow?icon=label"/>
</p>

You will only need an api key provided by SMTP2GO to use the library.

## Instalation

Run the following command in your project:

```
# if you are using npm
npm i @muryllo/mailer
```

```
# if you are using yarn
yarn add @muryllo/mailer
```

Use this code snippet to send your emails, change it as you like and see fit.

```typescript
const mail: Mailer = Mailer.create()
  .key('<your-api-key>')
  .subject('Teste de Email!')
  .from('Teste', 'test@muryllo.com.br')
  .to('Muryllo Pimenta', 'muryllo.pimenta@upe.br')
  .htmlBody('<h1>Welcome dear ${{ username }}</h1>')
  .set('username', 'Muryllo');

const result: MailerResponse = await mail.send();

console.log(result.success());
```

## Metadata

Muryllo Pimenta de Oliveira – muryllo.pimenta@upe.br

Released under the MIT license. See ``LICENSE`` for more information.

## Contributing

1. Fork it (<https://github.com/MurylloEx/Mailer/fork>)
2. Create your feature branch (`git checkout -b feature/fooBar`)
3. Commit your changes (`git commit -am 'Add some fooBar'`)
4. Push to the branch (`git push origin feature/fooBar`)
5. Create a new Pull Request

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