summaryrefslogtreecommitdiffstats
path: root/lib/helpers/mail/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'lib/helpers/mail/README.md')
-rw-r--r--lib/helpers/mail/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/lib/helpers/mail/README.md b/lib/helpers/mail/README.md
new file mode 100644
index 0000000..f0e4746
--- /dev/null
+++ b/lib/helpers/mail/README.md
@@ -0,0 +1,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/tree/master/examples/helpers/mail) (make sure you have set your environment variable to include your SENDGRID_API_KEY).
+
+```bash
+php examples/helpers/mail/example.php
+```
+
+## Usage
+
+- See the [example](https://github.com/sendgrid/sendgrid-php/tree/master/examples) for a complete working example.
+- [Documentation](https://sendgrid.com/docs/API_Reference/Web_API_v3/Mail/overview.html) \ No newline at end of file