# trailpack-email

> Add a Trails service to sending emails

Latest version **3.0.1** (published 2018-03-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install trailpack-email
pnpm add trailpack-email
yarn add trailpack-email
bun add trailpack-email
```

## 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 | 3.0.1 |
| Published | 2018-03-22 |
| First published | 2016-01-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 4.0.0 |
| Dependencies | 3 |
| Unpacked size | 8.5 KB |
| Known vulnerabilities | 0 (+14 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Jimmy Aumard |
| Maintainers | jaumard |
| Keywords | trailpack, trails, trailjs, email, smtp, gmail, nodemailer |

## Links

- npm: https://www.npmjs.com/package/trailpack-email
- Repository: https://github.com/jaumard/trailpack-email
- Issues: https://github.com/jaumard/trailpack-email/issues
- npm.io page: https://npm.io/package/trailpack-email

## Dependencies (3)

- [lodash](https://npm.io/package/lodash.md) ^4.17.5
- [trailpack](https://npm.io/package/trailpack.md) ^3.0.0
- [nodemailer](https://npm.io/package/nodemailer.md) ^4.6.3

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

- 3.0.1 (latest) — 2018-03-22
- 3.0.0 — 2018-03-21
- 2.0.1 — 2017-06-24
- 2.0.0 — 2017-01-16
- 1.0.1 — 2016-07-14
- 1.0.0 — 2016-05-12
- 0.0.5 — 2016-01-28
- 0.0.4 — 2016-01-28
- 0.0.3 — 2016-01-25
- 0.0.2 — 2016-01-24
- 0.0.1 — 2016-01-21

## README

# trailpack-email
[![Gitter][gitter-image]][gitter-url]
[![NPM version][npm-image]][npm-url]
[![NPM downloads][npm-download]][npm-url]
[![Build status][ci-image]][ci-url]
[![Dependency Status][daviddm-image]][daviddm-url]
[![Code Climate][codeclimate-image]][codeclimate-url]
[![Beerpay](https://beerpay.io/jaumard/trailpack-email/badge.svg?style=flat)](https://beerpay.io/jaumard/trailpack-email)
[![Beerpay](https://beerpay.io/jaumard/trailpack-email/make-wish.svg?style=flat)](https://beerpay.io/jaumard/trailpack-email)

:package: Add a Trails service to sending emails

## Intallation
With yo : 

```
npm install -g yo generator-trails
yo trails:trailpack trailpack-email
```

With npm (you will have to create config file manually) :
 
`npm install --save trailpack-email`

## Configuration
First you need to add this trailpack to your __main__ configuration : 
```js
// config/main.js

module.exports = {
   ...

   packs: [
      ...
      require('trailpack-email'),
      ...
   ]
   ...
}
```

Then:
```js
// config/email.js
module.exports = {
  //Custom transporter object to send email, by default created from smtp values but can be override here
  customTransporter: null,
  
    /*
     * SMTP Configuration
     * @see {@link http://nodemailer.com/2-0-0-beta/setup-smtp/}
     */
    smtp: {
      host: 'smtp.gmail.com',
      port: 465,
      secure: true, // use SSL
      auth: {
        user: 'user@gmail.com',
        pass: 'pass'
      }
    },
    /*
     * Default data use with EmailService.send
     * from, to, css, bcc, subject, text, html, attachments
     */
    defaultData: {
      from: 'noreply@gmail.com'
    }
}
```

## Usage
Now you can send emails like this : 

```
this.app.services.EmailService.send({
      to: 'user@gmail.com',
      subject: 'Test',
      text: 'test',
      html: '<p>test</p>'
    }, (err, info) => {

    })
//Or with Promise
this.app.services.EmailService.send({
      to: 'user@gmail.com',
      subject: 'Test',
      text: 'test',
      html: '<p>test</p>'
    }).then(info => {

    }).catch(err => this.log.error(err))
    
```

## License
[MIT](https://github.com/jaumard/trailpack-email/blob/master/LICENSE)

[npm-image]: https://img.shields.io/npm/v/trailpack-email.svg?style=flat-square
[npm-url]: https://npmjs.org/package/trailpack-email
[npm-download]: https://img.shields.io/npm/dt/trailpack-email.svg
[ci-image]: https://travis-ci.org/jaumard/trailpack-email.svg?branch=master
[ci-url]: https://travis-ci.org/jaumard/trailpack-email
[daviddm-image]: http://img.shields.io/david/jaumard/trailpack-email.svg?style=flat-square
[daviddm-url]: https://david-dm.org/jaumard/trailpack-email
[codeclimate-image]: https://img.shields.io/codeclimate/github/jaumard/trailpack-email.svg?style=flat-square
[codeclimate-url]: https://codeclimate.com/github/jaumard/trailpack-email
[gitter-image]: http://img.shields.io/badge/+%20GITTER-JOIN%20CHAT%20%E2%86%92-1DCE73.svg?style=flat-square
[gitter-url]: https://gitter.im/trailsjs/trails

## Support on Beerpay
Hey dude! Help me out for a couple of :beers:!

[![Beerpay](https://beerpay.io/jaumard/trailpack-email/badge.svg?style=beer-square)](https://beerpay.io/jaumard/trailpack-email)  [![Beerpay](https://beerpay.io/jaumard/trailpack-email/make-wish.svg?style=flat-square)](https://beerpay.io/jaumard/trailpack-email?focus=wish)

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