This node module allows you to quickly and more easily generate SendGrid X-SMTPAPI headers.
varsmtpapi=require('smtpapi');varheader=smtpapi.Header();header.addTo('[email protected]');header.setUniqueArgs({cow: 'chicken'});varsmtpapi_header_string=header.jsonString();See this for more information on the available X-SMTPAPI custom handling instructions.
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.
Add the following to your package.json file:
{..."dependencies":{..."smtpapi": "0.0.1" } }Install smtpapi-nodejs and its dependencies:
npm installvarsmtpapi=require('smtpapi');varheader=newsmtpapi.Header();This gives you back the stringified json formatted X-SMTPAPI header. Use this with your smtp client of choice.
varsmtpapi=require('smtpapi');varheader=newsmtpapi.Header();header.jsonString();varheader=newsmtpapi.Header();header.addTo('[email protected]');header.addTo('[email protected]');varheader=newsmtpapi.Header();header.setTos(['[email protected]','[email protected]');varheader=newsmtpapi.Header();header.addSubstitution('keep','secret');// sub ={keep: ['secret']}header.addSubstitution('other',['one','two']);// sub ={keep: ['secret'], other: ['one', 'two']}varheader=newsmtpapi.Header();header.setSubstitution({'-charge-': 'This ship is useless.'});// section ={'-charge-': 'This ship is useless.'}varheader=newsmtpapi.Header();header.addUniqueArg({cow: 'chicken'});// unique_args ={cow: 'chicken'}header.addUniqueArg({cat: 'dog'});// unique_args ={cow: 'chicken', cat: 'dog'}varheader=newsmtpapi.Header();header.setUniqueArgs({cow: 'chicken'});// unique_args ={cow: 'chicken'}header.setUniqueArgs({dad: 'proud'});// unique_args ={dad: 'proud'}varheader=newsmtpapi.Header();header.addCategory('tactics');// category = ['tactics']header.addCategory('advanced');// category = ['tactics', 'advanced']varheader=newsmtpapi.Header();header.setCategories(['snowball-fight','tactics']);// category = ['snowball-fight', 'tactics']varheader=newsmtpapi.Header();header.addSection({'-charge-': 'This ship is useless.'});// section ={'-charge-': 'This ship is useless.'}varheader=newsmtpapi.Header();header.setSections({'-charge-': 'This ship is useless.','-other': 'Another section here'});// section ={'-charge-': 'This ship is useless.', '-other': 'Another section here'}You can add filter settings one at a time.
varheader=newsmtpapi.Header();header.addFilter('footer','enable',1);header.addFilter('footer','text/html','<strong>boo</strong>');You can set a filter using an object literal.
varheader=newsmtpapi.Header();header.setFilters({'footer': {'setting': {'enable': 1,'text/plain': 'You can haz footers!'}}});The following example builds the X-SMTPAPI headers and adds them to nodemailer. Nodemailer then sends the email through SendGrid. You can use this same code in your application or optionally you can use sendgrid-nodejs.
varnodemailer=require('nodemailer');varsmtpapi=require('smtpapi');// Build the smtpapi headervarheader=newsmtpapi.Header();header.addTo('[email protected]');header.setUniqueArgs({cow: 'chicken'});// Add the smtpapi header to the general headersvarheaders={'x-smtpapi': header.jsonString()};// Use nodemailer to send the emailvarsettings={host: "smtp.sendgrid.net",port: parseInt(587,10),requiresAuth: true,auth: {user: "sendgrid_username",pass: "sendgrid_password"}};varsmtpTransport=nodemailer.createTransport("SMTP",settings);varmailOptions={from: "Fred Foo <[email protected]>",to: "[email protected]",subject: "Hello",text: "Hello world",html: "<b>Hello world</b>",headers: headers}smtpTransport.sendMail(mailOptions,function(error,response){smtpTransport.close();if(error){console.log(error);}else{console.log("Message sent: "+response.message);}});- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Added some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request
npm test```