sparkpost-mail's Introduction

SparkPost for Meteor

Send emails using SparkPost as the SMTP server

What is SparkPost?

tl;dr - SparkPost is a cloud email delivery service. It's easy to get started with either SMTP or their REST API.

SparkPost is the world’s #1 email delivery and analytics provider. Our customers send over 3 trillion messages a year, 37% of B2C and B2B email.

Get Started with SparkPost

Sign up for a SparkPost account
Add and verify a sending domain
Configure SMTP and save the password

Setup

Install

Add this package using the following command

meteor add agoldman:sparkpost-mail

Example

import { Meteor } from 'meteor/meteor';
import { Sparkpost } from 'meteor/agoldman:sparkpost-mail';

Meteor.startup(() => {
    // configure Sparkpost
    Sparkpost.config('YOUR SMTP PASSWORD');

    // Send an email
    Sparkpost.send({
  	    from: 'postmaster@<YOUR SENDING DOMAIN>.com',
  	    to: '[email protected]',
  	    subject: 'Your Email Subject',
  	    text: 'Message'
    });
});

Documentation

config([options])

password An SparkPost API Key that has SMTP permissions
username Username for SMTP account - defaults to SMTP_Injection
port Port for SMTP - defaults to 587
host Host for SMTP - defaults to smtp.sparkpostmail.com
from Sets default sending email if none is specified in the send function
subject Sets default subject if none is specified in the send function
headers Sets default headers if none are specified in the send function
secure Boolean to set the connection to smtps or smtp. Defaults to false