summaryrefslogtreecommitdiffstats
path: root/lib/helpers/mail/README.md
blob: fec01c65daf63f5d31e1c11712f4acbd5874913f (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-php/blob/master/examples/helpers/mail/example.php) (make sure you have set your environment variable to include your SENDGRID_API_KEY).

```bash
php examples/helpers/mail/example.php
```

## Usage

- See this complete working [example](https://github.com/sendgrid/sendgrid-php/blob/master/examples/helpers/mail/example.php).
- [Documentation](https://sendgrid.com/docs/API_Reference/Web_API_v3/Mail/overview.html)