Open main menu

Extension:SparkPost

MediaWiki extensions manual
OOjs UI icon advanced.svg
SparkPost
Release status: stable
Implementation Notify
Description Enables MediaWiki to use the SparkPost API for email distribution.
Author(s)
Latest version 1.1
Compatibility policy master
MediaWiki 1.31+
PHP 5.6+
Database changes No
Composer sparkpost/sparkpost
License GNU General Public License 2.0 or later
Download
README
Translate the SparkPost extension if it is available at translatewiki.net
Check usage and version matrix.
Issues Open tasks · Report a bug

The SparkPost extension enables MediaWiki to send emails through SparkPost's API service.

Contents

InstallationEdit

  • Download and place the file(s) in a directory called SparkPost in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'SparkPost' );
    
  •   Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

To users running MediaWiki 1.24 or earlier:

The instructions above describe the new way of installing this extension using wfLoadExtension(). If you need to install this extension on these earlier versions (MediaWiki 1.24 and earlier), instead of wfLoadExtension( 'SparkPost' );, you need to use:

require_once "$IP/extensions/SparkPost/SparkPost.php";
You will have to run composer update in extensions/SparkPost/ folder so that composer can pick up and install the required SparkPost dependencies for the extension to run smoothly.

ConfigurationEdit

You need to have an account on https://www.sparkpost.com and a valid API key in order to successfully send emails via SparkPost using this extension. Getting an API key is really easy, just create an account and follow the steps, the last step will give away the API key plus, don't forget to verify your email (account after creation). See here for more information.

Security Warning: Do not paste your SparkPost keys directly in your SparkPost/extension.json as this will be a vulnerability making someone else to be able to use your account to send emails or perform other bad stuff.

With a valid API Key, configure your API key in LocalSettings.php , plus this also requires that you've properly configured a sending domain using your SparkPost account (this is SparkPost specific):

$wgSparkPostAPIKey = "YOUR_API_KEY_HERE";

In addition to the API key config variable, this extension provides 3 more config variables used in setting various options when using the Spark Post API to distribute emails such as: $wgSparkPostClickTracking, $wgSparkPostOpenTracking and $wgSparkPostTransactional. These variables are set to "true" for default behavior with spark post.

Test your settingsEdit

Go to Special:EmailUser and send an email to your own address to verify that the extension is working. You'll receive an email from the address you inputed and check to see if it's sent via the SparkPost API.

Used by Production WikisEdit

This extension is already used by some production wiki instances, see below;