jfhbrook / Node Sendgrid Web
Licence: mit
Send emails with ease using sendgrid.com and node.js!
Stars: ✭ 31
Programming Languages
javascript
184084 projects - #8 most used programming language
I HAVENT TOUCHED THIS IN YEARS
USE THIS INSTEAD
https://github.com/sendgrid/sendgrid-nodejs
sendgrid-web
Send emails with sendgrid and node.js! This sendgrid module (there are others) uses their JSON web API and the request module.
Install:
npm install sendgrid-web
Example:
var Sendgrid = require("sendgrid-web");
var sendgrid = new Sendgrid({
user: "[email protected]",
key: "oh, like you need to know."
});
sendgrid.send({
to: '[email protected]',
from: '[email protected]',
subject: 'Hello world!',
html: '<h1>Hello world!</h1>'
}, function (err) {
if (err) {
console.log(err);
} else {
console.log("Success.");
}
});
Usage:
new Sendgrid(credentials)
This constructor creates a new sendgrid object. The "credentials" object should contain:
-
user
: Your sendgrid username -
key
: Your sendgrid API key/password
sendgrid.send(options, cb)
Sends an email. Options are the same as those of the sendgrid json web api. Common ones include:
- to: The recipient of the email.
- from: The email address to reply back to.
- subject: The subject of the email.
- html: The body of the email, if it's intended to be treated like html.
- text: The body of the email, if it's intended to be treated like plaintext.
Tests:
In order to run the tests, sendgrid needs a user, api key, and email addresses to send to and from. Before running these tests, open ./test/config-template.json
, edit it to contain your credentials and information, and save it as ./test/config.json
.
Then, you may run the tests with nodeunit:
nodeunit test/*.js
Author: Joshua Holbrook
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].