summaryrefslogtreecommitdiffstats
path: root/lib/helpers/mail/README.md
blob: 48570cdee00e9811a5d39d7121cd10ef01fc401b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
**This helper allows you to quickly and easily build a Mail object for sending email through SendGrid.**

# Quick Start

Run the [example](https://github.com/sendgrid/sendgrid-nodejs/tree/master/examples) (make sure you have set your environment variable to include your SENDGRID_API_KEY).

```bash
node examples/helpers/mail/example.js
```

## Usage

- See the [example](https://github.com/sendgrid/sendgrid-nodejs/tree/master/examples) for a complete working example.
- [Documentation](https://sendgrid.com/docs/API_Reference/Web_API_v3/Mail/overview.html)