This node module allows you to quickly and more easily generate SendGrid X-SMTPAPI headers.
The default branch name for this repository has been changed to
main as of 07/27/2020.
All updates to this module are documented in our CHANGELOG.
Table of Contents
- Node.js version 4, 5, 6, 7, 8, 10, 12, or 14
- The SendGrid service, starting at the free level
Update your environment with your SendGrid credentials. (if you will be sending via nodemailer or other SMTP transport)
echo "export SENDGRID_USERNAME='YOUR_USERNAME'" > sendgrid.envecho "export SENDGRID_PASSWORD='YOUR_PASSWORD'" >> sendgrid.envecho "sendgrid.env" >> .gitignoresource ./sendgrid.env
The following recommended installation requires npm. If you are unfamiliar with npm, see the npm docs. Npm comes installed with Node.js since node version 0.8.x, therefore, you likely already have it.
Install smtpapi-nodejs and its dependencies:
npm install smtpapi
- Please see package.json
var smtpapi = ;var header = ;header;header;console;
How to Contribute
We encourage contribution to our projects, please see our CONTRIBUTING guide for details.
smtpapi-nodejs is maintained and funded by Twilio SendGrid, Inc. The names and logos for smtpapi-nodejs are trademarks of Twilio SendGrid, Inc.
If you need help installing or using the library, please check the Twilio SendGrid Support Help Center.
If you've instead found a bug in the library or would like new features added, go ahead and open issues or pull requests against this repo!