**THIS PACKAGE HAS MOVED** **Please see the latest official package [here](https://www.npmjs.com/package/@sendgrid/mail), thank you!** [![BuildStatus](https://travis-ci.org/sendgrid/sendgrid-nodejs.svg?branch=master)](https://travis-ci.org/sendgrid/sendgrid-nodejs) [![npm version](https://badge.fury.io/js/sendgrid.svg)](https://badge.fury.io/js/sendgrid) [![Email Notifications Badge](https://dx.sendgrid.com/badge/nodejs)](https://dx.sendgrid.com/newsletter/nodejs) **NEW:** Subscribe to email [notifications](https://dx.sendgrid.com/newsletter/nodejs) for releases and breaking changes. **This library allows you to quickly and easily use the SendGrid Web API v3 via Node.js.** 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). 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. Please browse the rest of this README for further detail. We appreciate your continued support, thank you! # Table of Contents * [Installation](#installation) * [Quick Start](#quick_start) * [Usage](#usage) * [Use Cases](#use_cases) * [Announcements](#announcements) * [Roadmap](#roadmap) * [How to Contribute](#contribute) * [Troubleshooting](#troubleshooting) * [About](#about) # Installation ## Prerequisites - Node.js version 4, 6 or 7 - The SendGrid service, starting at the [free level](https://sendgrid.com/free?source=sendgrid-nodejs) ## Setup Environment Variables 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 echo "sendgrid.env" >> .gitignore source ./sendgrid.env ``` ## Install Package The following recommended installation requires [npm](https://npmjs.org/). If you are unfamiliar with npm, see the [npm docs](https://npmjs.org/doc/). Npm comes installed with Node.js since node version 0.8.x therefore you likely already have it. ```bash npm install --save sendgrid ``` ## Dependencies - [Nodejs-HTTP-Client](https://github.com/sendgrid/nodejs-http-client) # Quick Start ## 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; var fromEmail = new helper.Email('test@example.com'); var toEmail = new helper.Email('test@example.com'); var subject = 'Sending with SendGrid is Fun'; var content = new helper.Content('text/plain', 'and easy to do anywhere, even with Node.js'); var mail = new helper.Mail(fromEmail, subject, toEmail, content); var sg = require('sendgrid')(process.env.SENDGRID_API_KEY); var request = sg.emptyRequest({ method: 'POST', path: '/v3/mail/send', body: mail.toJSON() }); sg.API(request, function (error, response) { if (error) { console.log('Error response received'); } console.log(response.statusCode); console.log(response.body); console.log(response.headers); }); ``` 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')(process.env.SENDGRID_API_KEY); var request = sg.emptyRequest({ method: 'POST', path: '/v3/mail/send', body: { personalizations: [ { to: [ { email: 'test@example.com' } ], subject: 'Sending with SendGrid is Fun' } ], from: { email: 'test@example.com' }, content: [ { type: 'text/plain', value: 'and easy to do anywhere, even with Node.js' } ] } }); // With promise sg.API(request) .then(function (response) { console.log(response.statusCode); console.log(response.body); console.log(response.headers); }) .catch(function (error) { // error is an instance of SendGridError // The full response is attached to error.response console.log(error.response.statusCode); }); // With callback sg.API(request, function (error, response) { if (error) { console.log('Error response received'); } console.log(response.statusCode); console.log(response.body); console.log(response.headers); }); ``` ## General v3 Web API Usage ```javascript var sg = require('sendgrid')(process.env.SENDGRID_API_KEY); // GET Collection var request = sg.emptyRequest({ method: 'GET', path: '/v3/api_keys' }); // With promise sg.API(request) .then(function (response) { console.log(response.statusCode); console.log(response.body); console.log(response.headers); }) .catch(function (error) { // error is an instance of SendGridError // The full response is attached to error.response console.log(error.response.statusCode); }); // With callback sg.API(request, function (error, response) { if (error) { console.log('Error response received'); } console.log(response.statusCode); console.log(response.body); console.log(response.headers); }); ``` # Usage - [SendGrid Docs](https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html) - [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) # Use Cases [Examples of common API use cases](https://github.com/sendgrid/sendgrid-nodejs/blob/master/USE_CASES.md), such as how to send an email with a transactional template. # Announcements Please see our announcement regarding [breaking changes](https://github.com/sendgrid/sendgrid-nodejs/issues/290). Your support is appreciated! All updates to this library are documented in our [CHANGELOG](https://github.com/sendgrid/sendgrid-nodejs/blob/master/CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-nodejs/releases). You may also subscribe to email [release notifications](https://dx.sendgrid.com/newsletter/nodejs) for releases and breaking changes. # Roadmap 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 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) * [Improvements to the Codebase](https://github.com/sendgrid/sendgrid-nodejs/tree/master/CONTRIBUTING.md#improvements_to_the_codebase) # Troubleshooting Please see our [troubleshooting guide](https://github.com/sendgrid/sendgrid-nodejs/blob/master/TROUBLESHOOTING.md) for common library issues. # About sendgrid-nodejs is guided and supported by the SendGrid [Developer Experience Team](mailto:dx@sendgrid.com). sendgrid-nodejs is maintained and funded by SendGrid, Inc. The names and logos for sendgrid-nodejs are trademarks of SendGrid, Inc. ![SendGrid Logo](https://uiux.s3.amazonaws.com/2016-logos/email-logo%402x.png)

Package	Téléchargements	Stars	Taille	Issues	Publication	Licence

sendgrid	46,246	3,038	-	82	il y a 8 ans	MIT