ajgagnon / WP_Mail

WP_Mail - Send Templated emails with WordPress

A simple class for sending templated emails using WordPress

Introduction: Medium Post

$email = (new WP_Mail)
    ->to('[e-mail]')
    ->subject('test')
    ->template(get_template_directory() .'/email.html', [
        'name' => 'Anthony Budd',
        'job'  => 'Developer',
    ])
    ->send();

email.html

<h1>Hello {{name}},</h1>
<p>You work as a {{job}}.</p>

---

Installation

Require WP_Mail with composer

$ composer require anthonybudd/WP_Mail

Or

Download the WP_Mail class and require it at the top of your functions.php file.

    require 'src/WP_Mail.php';

---

Methods

to(), cc(), bcc()

All of these functions allow you to set an array or string of recipient(s) for your email as shown in the example below.

    $email = (new WP_Mail)
        ->to([
            '[e-mail]'
            '[e-mail]'
        ])
        ->cc('[e-mail]')

subject()

To set the subject field use the subject function. The first argument will be the emails subject.

    $email = (new WP_Mail)
        ->subject('This this the subject')

from()

To set the from header there is a useful helper function.

    $email = (new WP_Mail)
        ->from('John Doe <[e-mail]>')

attach()

Similar to the to, cc and bcc, methods the attach method can accept a string or array of stings. This strings must be absolute file paths, this method will throw if the file does not exist.

    $email = (new WP_Mail)
        ->attach(ABSPATH .'wp-content/uploads/2017/06/file.pdf')

template($templatePath, $variables = [])

The templet method is for setting the path to the html email template. The second argument is for an asoc array where the keys will correspond to your HTML email’s variables. Variables are optional and are not required for templates that do not have any variables.

    $email = (new WP_Mail)
        ->template(get_template_directory() .'/email.html', [
           'name' => 'Anthony Budd',
           'job'  => 'Developer',
        ])

headers()

This method allows you to set additional headers for your email. This can be an array of headers or a single string header.

    $email = (new WP_Mail)
        ->headers("From: John Doe <[e-mail]>")

    $email = (new WP_Mail)
        ->headers([
            "From: John Doe <[e-mail]>",
            "X-Mailer: PHP/". phpversion(),
            "Reply-To: [e-mail]",
            "Content-type: text/html; charset=iso-8859-1",
        ])

send()

The render() method is called when you send an email will use a simple bit of regex to find and replace variables using a mustache-esque syntax. Finally the method sends the email using WordPresses built in wp_mail() function.

    $email = (new WP_Mail)
        ->send()