# optune-mailer

> Opinionated package for simplifying mailing via mailgun.com

Latest version **0.0.5** (published 2017-02-01) · LGPL 3 license · 0 weekly downloads

## Install

```sh
npm install optune-mailer
pnpm add optune-mailer
yarn add optune-mailer
bun add optune-mailer
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.5 |
| Published | 2017-02-01 |
| First published | 2015-07-13 |
| Weekly downloads | 0 |
| License | LGPL 3 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+13 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Simon Schmid |
| Maintainers | schmidsi |
| Keywords | optune, mailgun, mailer |

## Links

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

## Dependencies (3)

- [nodemailer](https://npm.io/package/nodemailer.md) ^1.4.0
- [coffee-script](https://npm.io/package/coffee-script.md) ^1.9.3
- [nodemailer-mailgun-transport](https://npm.io/package/nodemailer-mailgun-transport.md) ^1.2.4

## 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

- 0.0.5 (latest) — 2017-02-01
- 0.0.4 — 2017-02-01
- 0.0.3 — 2015-08-14
- 0.0.2 — 2015-08-14
- 0.0.1 — 2015-07-13

## README

optune-mailer
=============

Opinionated package for simplifying mailing via mailgun.com

[ ![Codeship Status for optune/optune-mailer](https://codeship.com/projects/9483dc80-0ba0-0133-52c5-265ef25499ca/status?branch=master)](https://codeship.com/projects/90874)

## Preconditions
1. CoffeeScript
2. A Mailgun account
3. Mandrill API Key in Env vars 


## Installation

    npm install optune-mailer --save


## Usage
    mailer = require 'optune-mailer'

    mailer.sendText 'Debug <debug@optune.me>', 'Test subject', 'Test body', callback

    # Events:
    mailer.on 'send', (opts) ->
        console.log opts
        # opts:
        #   from: ...
        #   to: ...
        #   subject: ...
        #   text or html: ...


## [Expected ENV Vars](http://12factor.net/config)
(For testing, put a .env file in the root with the following content)

    MAILGUN_APIKEY=YOUR_MAILGUN_API_KEY


## License
LGPL v3

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