sanchothefat/sparkpost-wp-mail

wp_mail() drop-in for SparkPost

dev-master 2016-06-02 01:13 UTC

Requires

• composer/installers: ~1.0

GPL-2.0+

• Robert O'Rourke

• wordpress

README

Dropin wp_mail() replacement for WordPress that uses the SparkPost.com API.

Heavily based on prior art by @danielbachhuber for Mandrill

How to Use

To implement this drop-in, add it to your mu-plugins directory. In order for it to work, you must define your Mandrill API key. The easiest way to do this is to add it to your wp-config.php file like so:

define( 'SPARKPOST_API_KEY', 'your-api-key' );

If you've cloned this repo into your mu-plugins directory as the full folder (e.g. wp-content/mu-plugins/mandrill-wp-mail, you'll need to make sure you load the plugin files:

<?php

require_once dirname( __FILE__ ) . '/sparkpost-wp-mail/sparkpost-wp-mail.php';

A Note About SparkPost

Sparkpost require sending domain verification via TXT records in your DNS or receiving an email at your domain.

For local development you can use their sandbox which allows up to 50 emails.

<?php

add_filter( 'wp_mail_from', function() {
    return '[e-mail]';
} );

A Note About Composer

This plugin can be installed and managed using Composer; however, because of the way Composer and mu-plugins work, you'll need a bit of a workaround to make sure the plugin is loaded. For more information about how to use this drop-in with Composer, read this blog post by Richard Tape.