This library allows you to quickly and easily use the SendGrid Web API v3 via Node.js.
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 and pull requests or simply upvote or comment on existing issues or pull requests.
For updates to this library, see our CHANGELOG and releases.
Subscribe to email release notifications to receive emails about releases and breaking changes.
We appreciate your continued support, thank you!
- Introduction - Please Read First
- Announcements
- Roadmap
- How to Contribute
- Troubleshooting
- About
- License
This library is broken up into several packages as a monorepo so that you only need to install the packages necessary for your use case. This README contains information pertaining to all packages. For examples on how to get started quickly, head over to the READMEs of each individual package (linked and described below), which includes detailed examples.
You will find a file in the root of the project called .env_sample. You can run cp .env_sample .env or manually rename the file to .env; be sure to add your API key.
- @sendgrid/mail - if you just want to send email
- @sendgrid/client - to use all other SendGrid v3 Web API endpoints
- @sendgrid/inbound-mail-parser - help with parsing the SendGrid Inbound Parse API
- @sendgrid/contact-importer - help with importing contacts into the ContactDB
- @sendgrid/helpers - a collection of classes and helpers used internally by the above packages
All updates to this library are documented in our CHANGELOG and releases. You may also subscribe to email release notifications for releases and breaking changes.
If you are interested in the future direction of this project, please take a look at our open issues and pull requests. We would love to hear your feedback.
We encourage contribution to our libraries (you might even score some nifty swag), please see our CONTRIBUTING guide for details.
Please see our troubleshooting guide for common library issues.
sendgrid-nodejs is guided and supported by the SendGrid Developer Experience Team.
sendgrid-nodejs is maintained and funded by SendGrid, Inc. The names and logos for sendgrid-nodejs are trademarks of SendGrid, Inc.