diff options
| -rw-r--r-- | README.md | 85 |
1 files changed, 61 insertions, 24 deletions
@@ -1,25 +1,14 @@ [](https://travis-ci.org/sendgrid/sendgrid-nodejs) -[](http://badge.fury.io/js/sendgrid) -**This library allows you to quickly and easily use the SendGrid Web API via Node.js.** +**This library allows you to quickly and easily use the SendGrid Web API v3 via Node.js.** -# Announcements - -**BREAKING CHANGE as of 2016.06.14** - -Version 3.X.X brings you full support for all Web API v3 endpoints. We -have the following resources to get you started quickly: +Version 3.X.X of this library provides full support for all SendGrid [Web API v3](https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html) endpoints, including the new [v3 /mail/send](https://sendgrid.com/blog/introducing-v3mailsend-sendgrids-new-mail-endpoint). -- [SendGrid - Documentation](https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html) -- [Usage Docs](https://github.com/sendgrid/sendgrid-nodejs/blob/master/USAGE.md) -- [Example - Code](https://github.com/sendgrid/sendgrid-nodejs/tree/master/examples) -- [Migration from v2 to v3](https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/how_to_migrate_from_v2_to_v3_mail_send.html) +This library represents the beginning of a new path for SendGrid. We want this library to be community driven and SendGrid led. We need your help to realize this goal. To help make sure we are building the right things in the right order, we ask that you create [issues](https://github.com/sendgrid/sendgrid-nodejs/issues) and [pull requests](https://github.com/sendgrid/sendgrid-nodejs/blob/master/CONTRIBUTING.md) or simply upvote or comment on existing issues or pull requests. -Thank you for your continued support! +Please browse the rest of this README for further detail. -All updates to this library is documented in our [CHANGELOG](https://github.com/sendgrid/sendgrid-nodejs/blob/master/CHANGELOG.md). +We appreciate your continued support, thank you! # Installation @@ -30,7 +19,7 @@ All updates to this library is documented in our [CHANGELOG](https://github.com/ ## Setup Environment Variables -Update your environment with your [SENDGRID_API_KEY](https://app.sendgrid.com/settings/api_keys). +Update the development environment with your [SENDGRID_API_KEY](https://app.sendgrid.com/settings/api_keys), for example: ```bash echo "export SENDGRID_API_KEY='YOUR_API_KEY'" > sendgrid.env @@ -76,12 +65,16 @@ npm install sendgrid ## Hello Email +The following is the minimum needed code to send an email with the [/mail/send Helper](https://github.com/sendgrid/sendgrid-nodejs/tree/master/lib/helpers/mail) ([here](https://github.com/sendgrid/sendgrid-nodejs/blob/master/examples/helpers/mail/example.js#L15) is a full example): + +### With Mail Helper Class + ```javascript var helper = require('sendgrid').mail from_email = new helper.Email("test@example.com") to_email = new helper.Email("test@example.com") - subject = "Hello World from the SendGrid Node.js Library" - content = new helper.Content("text/plain", "some text here") + subject = "Hello World from the SendGrid Node.js Library!" + content = new helper.Content("text/plain", "Hello, Email!") mail = new helper.Mail(from_email, subject, to_email, content) var sg = require('sendgrid').SendGrid(process.env.SENDGRID_API_KEY) @@ -97,6 +90,45 @@ npm install sendgrid }) ``` +The `Mail` constructor creates a [personalization object](https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/personalizations.html) for you. [Here](https://github.com/sendgrid/sendgrid-nodejs/blob/master/examples/helpers/mail/example.js#L10) is an example of how to add to it. + +### Without Mail Helper Class + +The following is the minimum needed code to send an email without the /mail/send Helper ([here](https://github.com/sendgrid/sendgrid-nodejs/blob/master/examples/mail/mail.js#L31) is a full example): + +```javascript +var sg = require('sendgrid').SendGrid(process.env.SENDGRID_API_KEY) +var request = sg.emptyRequest() +request.body = { + "personalizations": [ + { + "to": [ + { + "email": "test@example.com" + } + ], + "subject": "Hello World from the SendGrid Node.js Library!" + } + ], + "from": { + "email": "test@example.com" + }, + "content": [ + { + "type": "text/plain", + "value": "Hello, Email!" + } + ] +}; +request.method = 'POST' +request.path = '/v3/mail/send' +sg.API(request, function (response) { + console.log(response.statusCode) + console.log(response.body) + console.log(response.headers) +}) +``` + ## General v3 Web API Usage ```javascript @@ -116,17 +148,22 @@ sg.API(request, function (response) { # Usage - [SendGrid Docs](https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html) -- [Usage Docs](https://github.com/sendgrid/sendgrid-nodejs/blob/master/USAGE.md) +- [Library Usage Docs](https://github.com/sendgrid/sendgrid-nodejs/blob/master/USAGE.md) - [Example Code](https://github.com/sendgrid/sendgrid-nodejs/tree/master/examples) +- [How-to: Migration from v2 to v3](https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/how_to_migrate_from_v2_to_v3_mail_send.html) - [v3 Web API Mail Send Helper](https://github.com/sendgrid/sendgrid-nodejs/tree/master/lib/helpers/mail/README.md) -## Roadmap +# Announcements + +All updates to this library is documented in our [CHANGELOG](https://github.com/sendgrid/sendgrid-nodejs/blob/master/CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-nodejs/releases). + +# Roadmap -If you are intersted in the future direction of this project, please take a look at our [milestones](https://github.com/sendgrid/sendgrid-nodejs/milestones). We would love to hear your feedback. +If you are interested in the future direction of this project, please take a look at our open [issues](https://github.com/sendgrid/sendgrid-nodejs/issues) and [pull requests](https://github.com/sendgrid/sendgrid-nodejs/pulls). We would love to hear your feedback. -## How to Contribute +# How to Contribute -We encourage contribution to our libraries, please see our [CONTRIBUTING](https://github.com/sendgrid/sendgrid-nodejs/tree/master/CONTRIBUTING.md) guide for details. +We encourage contribution to our libraries (you might even score some nifty swag), please see our [CONTRIBUTING](https://github.com/sendgrid/sendgrid-nodejs/blob/master/CONTRIBUTING.md) guide for details. * [Feature Request](https://github.com/sendgrid/sendgrid-nodejs/tree/master/CONTRIBUTING.md#feature_request) * [Bug Reports](https://github.com/sendgrid/sendgrid-nodejs/tree/master/CONTRIBUTING.md#submit_a_bug_report) |