Sign up for a SparkPost account and visit our Developer Hub for even more content.
The official Node.js binding for your favorite SparkPost APIs!
Before using this library, you must have:
npm install sparkpost
Note: Node.js versions 0.10 and 0.12 are no longer supported. For versions < 4, please continue using sparkpost v1.3.8
new SparkPost(apiKey[, options]) - Initialization
apiKey
SPARKPOST_API_KEY environment variable)Stringoptions.origin or options.endpoint
Stringhttps://api.sparkpost.com:443options.apiVersion
Stringv1options.stackIdentity
Stringproduct/1.0.0options.headers
Objectoptions.debug
Booleanfalsedebug when true for debugging purposesNote: All methods return promises and accept an optional last argument callback. Read about how we handle callbacks and promises.
options - see request modules optionsoptions.uri - can either be a full url or a path that is appended to options.origin used at initialization (url.resolve)options.debug - setting to true includes full response from request client for debugging purposesoptions - see request optionsPassing in an API key
var SparkPost = require('sparkpost');
var client = new SparkPost('YOUR_API_KEY');
Using an API key stored in an environment variable
//Create an env var as SPARKPOST_API_KEY
var SparkPost = require('sparkpost');
var client = new SparkPost();
Specifying non-default options
var SparkPost = require('sparkpost');
var options = {
endpoint: 'https://dev.sparkpost.com:443'
};
var client = new SparkPost('YOUR_API_KEY', options);
We may not wrap every resource available in the SparkPost Client Library, for example the Node Client Library does not wrap the Metrics resource, but you can use the Node Client Library Base Object to form requests to these unwrapped resources. Here is an example request using the base object to make requests to the Metrics resource. Here is an example request using the base object to make requests to the Metrics resource.
// Get a list of domains that the Metrics API contains data on.
var options = {
uri: 'metrics/domains'
};
client.get(options)
.then(data => {
console.log(data);
})
.catch(err => {
console.log(err);
});
Below is an example of how to send a simple email. Sending an email is known as a transmission. By using the send method on the transmissions service that's available from the SparkPost object you instantiate, you can pass in an object with all the transmission attributes relevant to the email being sent. The send method will return a promise that will let you know if the email was sent successful and if not information about the error that occurred. If a callback is passed, it will be executed.
var SparkPost = require('sparkpost');
var client = new SparkPost('<YOUR API KEY>');
client.transmissions.send({
content: {
from: 'testing@sparkpostbox.com',
subject: 'Hello, World!',
html:'<html><body><p>Testing SparkPost - the world\'s most awesomest email service!</p></body></html>'
},
recipients: [
{address: '<YOUR EMAIL ADDRESS>'}
]
})
.then(data => {
console.log('Woohoo! You just sent your first mailing!');
console.log(data);
})
.catch(err => {
console.log('Whoops! Something went wrong');
console.log(err);
});
Click on the desired API to see usage and more information
client.inboundDomains (examples)client.messageEvents (examples)client.recipientLists (examples)client.relayWebhooks (examples)client.sendingDomains (examples)client.subaccounts (examples)client.suppressionList (examples)client.templates (examples)client.transmissions (examples)client.webhooks (examples)Run npm install inside the repository to install all the dev dependencies.
Once all the dependencies are installed, you can execute the unit tests using npm test
[2.1.1] - 2017-01-11
FAQs
A Node.js wrapper for interfacing with your favorite SparkPost APIs
We found that sparkpost demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.