Merge pull request #22 from SparkPost/ISSUE-10

Add template support

Author: richleland

trunk/admin.widget.class.php

@@ -131,6 +131,7 @@ public function admin_page_init()
         add_settings_field('sending_method', 'Method*', array($this, 'render_sending_method_field'), 'sp-options', 'general');
         add_settings_field('password', 'API Key*', array($this, 'render_password_field'), 'sp-options', 'general');
         add_settings_field('enable_tracking', 'Enable tracking*', array($this, 'render_enable_tracking_field'), 'sp-options', 'general');
+        add_settings_field('template', 'Template', array($this, 'render_template_field'), 'sp-options', 'general');
 
         add_settings_section('overrides', 'Overrides', null, 'sp-overrides');
         add_settings_field('from_name', 'From name', array($this, 'render_from_name_field'), 'sp-overrides', 'overrides');
@@ -147,11 +148,15 @@ public function sanitize($input)
         $new_input = array();
 
         if (!empty($input['from_email'])) {
-            $new_input['from_email'] = trim($input['from_email']);
+            $new_input['from_email'] = sanitize_text_field($input['from_email']);
         }
 
         if (!empty($input['from_name'])) {
-            $new_input['from_name'] = trim($input['from_name']);
+            $new_input['from_name'] = sanitize_text_field($input['from_name']);
+        }
+
+        if (!empty($input['template'])) {
+            $new_input['template'] = sanitize_text_field($input['template']);
         }
 
         if (empty($input['password'])) {
@@ -160,7 +165,7 @@ public function sanitize($input)
             if(SparkPost::is_key_obfuscated(esc_attr($input['password']))) { //do not change password
                 $new_input['password'] = $this->options['password'];
             } else {
-                $new_input['password'] = trim(esc_attr($input['password']));
+                $new_input['password'] = sanitize_text_field($input['password']);
             }
         }
 
@@ -217,11 +222,28 @@ public function render_password_field()
 
         printf(
             '<input type="text" id="password" name="sp_settings[password]" class="regular-text" value="%s" /><br/>
-            <small><ul><li>For SMTP, use a SparkPost API key with <strong>Send via SMTP</strong> permission</li> <li>For HTTP API, use API Key with <strong>Transmissions: Read/Write</strong> permission</li><a href="https://support.sparkpost.com/customer/portal/articles/1933377-create-api-keys" target="_blank">Need help creating a SparkPost API key?</a></small>',
+            <small><ul><li>For SMTP, set up an API key with the <strong>Send via SMTP</strong> permission</li> <li>For HTTP API, set up an API Key with the <strong>Transmissions: Read/Write</strong> permission</li><a href="https://support.sparkpost.com/customer/portal/articles/1933377-create-api-keys" target="_blank">Need help creating a SparkPost API key?</a></small>',
             isset($api_key) ? $api_key : ''
         );
     }
 
+    public function render_template_field()
+    {
+        ?>
+        <input type="text" id="template" name="sp_settings[template]" class="regular-text"
+               value="<?php echo $this->options['template']; ?>"/><br/>
+        <small>
+            <ul>
+                <li>- Templates can only be used with the HTTP API.</li>
+                <li>- Leave this field blank to disable use of a template.</li>
+                <li>- The template must have a variable in it named <code>{{{content}}}</code>. Note the triple curly braces, which are required to include non-escaped HTML.</li>
+                <li>- Use <code>{{subject}}</code> and <code>{{from_name}}</code> in your template to allow substitution of Subject and From Name respectively.</li>
+                <li>- From email override has no effect when using a template.</li>
+            </ul>
+        </small>
+    <?php
+    }
+
     public function render_from_email_field()
     {
         $hint = 'Important: Domain must match with one of your verified sending domains.';

trunk/mailer.http.class.php

@@ -48,11 +48,11 @@ function sparkpostSend()
     protected function get_request_body()
     {
         $tracking_enabled = !!$this->options['enable_tracking'];
-
+        $sender = $this->get_sender();
         $body = array(
             'recipients' => $this->get_recipients(),
             'content' => array(
-                'from' => $this->get_sender(),
+                'from' => $sender,
                 'subject' => $this->Subject,
                 'headers' => $this->get_headers()
             ),
@@ -62,17 +62,24 @@ protected function get_request_body()
             )
         );
 
-        switch ($this->ContentType) {
-            case 'multipart/alternative':
-                $body['content']['html'] = $this->Body;
-                $body['content']['text'] = $this->AltBody;
-                break;
-            case 'text/plain':
-                $body['content']['text'] = $this->Body;
-                break;
-            default:
-                $body['content']['html'] = $this->Body;
-                break;
+        if (!empty($this->options['template'])) {
+          $body['content']['template_id'] = $this->options['template'];
+          $body['substitution_data']['content'] = $this->Body;
+          $body['substitution_data']['subject'] = $this->Subject;
+          $body['substitution_data']['from_name'] = $sender['name'];
+        } else {
+          switch($this->ContentType) {
+              case 'multipart/alternative':
+                  $body['content']['html'] = $this->Body;
+                  $body['content']['text'] = $this->AltBody;
+                  break;
+              case 'text/plain':
+                  $body['content']['text'] = $this->Body;
+                  break;
+              default:
+                  $body['content']['html'] = $this->Body;
+                  break;
+          }
         }
 
         $replyTo = $this->get_reply_to();
@@ -242,4 +249,4 @@ protected function get_headers()
 
         return $formatted_headers;
     }
-}
+}

trunk/sparkpost.class.php

@@ -16,7 +16,8 @@ class SparkPost
         'from_name' => '',
         'from_email' => '',
         'enable_sparkpost' => false,
-        'enable_tracking' => true
+        'enable_tracking' => true,
+        'template' => ''
     );
 
     var $options;
@@ -97,4 +98,13 @@ static function is_key_obfuscated($api_key)
     {
         return strpos($api_key, '*') !== false;
     }
+
+    public function init_sp_http_mailer($args)
+    {
+        global $phpmailer;
+        if (!$phpmailer instanceof SparkPostHTTPMailer) {
+            $phpmailer = new SparkPostHTTPMailer();
+        }
+        return $args;
+    }
 }

trunk/wordpress-sparkpost.php

@@ -35,13 +35,7 @@
         new SparkPostSMTPMailer();
     } else {
         require_once(WPSP_PLUGIN_DIR . 'mailer.http.class.php');
-        add_filter('wp_mail', function ($args) {
-            global $phpmailer;
-            if (!$phpmailer instanceof SparkPostHTTPMailer) {
-                $phpmailer = new SparkPostHTTPMailer();
-            }
-            return $args;
-        });
+        add_filter('wp_mail', array($sp, 'init_sp_http_mailer'));
     }
 }