From 7453e137e87955dab791cff465a0d389592af8f0 Mon Sep 17 00:00:00 2001
From: mhossain <mohammad.hossain@sparkpost.com>
Date: Thu, 16 Feb 2017 12:30:40 -0500
Subject: [PATCH] add templates/attachment related comments/docs

---
 admin.widget.class.php        |  5 +++--
 docs/templates-attachments.md | 27 +++++++++++++++++++++++++++
 2 files changed, 30 insertions(+), 2 deletions(-)
 create mode 100644 docs/templates-attachments.md

diff --git a/admin.widget.class.php b/admin.widget.class.php
index ce4db444..22ddf16b 100644
--- a/admin.widget.class.php
+++ b/admin.widget.class.php
@@ -245,9 +245,10 @@ public function render_template_field()
                value="<?php echo $this->settings['template']; ?>"/><br/>
         <small>
             <ul>
-                <li>- Please see <a href="https://support.sparkpost.com/customer/portal/articles/2409547-using-templates-with-the-sparkpost-wordpress-plugin">this article</a> for detailed information about using templates with this plugin.</li>
+                <li>- Please see <a href="https://support.sparkpost.com/customer/portal/articles/2409547-using-templates-with-the-sparkpost-wordpress-plugin" target="_blank">this article</a> for detailed information about using templates with this plugin.</li>
                 <li>- Templates can only be used with the HTTP API.</li>
-                <li>- Leave this field blank to disable use of a template.</li>
+                <li>- <a href="https://github.com/SparkPost/wordpress-sparkpost/blob/master/docs/templates-attachments.md" target="_blank">Does not work with attachment</a>.
+                <li>- Leave this field blank to disable use of a template or use it dynamically (i.e. <a href="https://github.com/SparkPost/wordpress-sparkpost/blob/master/docs/hooks.md" target="_blank">using hooks</a>).</li>
             </ul>
         </small>
     <?php
diff --git a/docs/templates-attachments.md b/docs/templates-attachments.md
new file mode 100644
index 00000000..869e1b25
--- /dev/null
+++ b/docs/templates-attachments.md
@@ -0,0 +1,27 @@
+# Sending Attachments with Template
+
+Currently, you [can't send attachments](https://support.sparkpost.com/customer/portal/articles/2458261-can-attachments-be-sent-when-using-templates-) if you are you using a template. There are [technical work arounds](https://www.sparkpost.com/blog/advanced-email-templates/) but this is not still supported by SparkPost plugin yet.
+
+## Interim solution
+If all of your emails has attachments, easiest solution is not to use any template at all (i.e. Keep `Template` field empty).
+
+However, if some of your emails use template (and they do not have attachments), you can specify a template ID in settings and then use the hook to remove the template just before creating that email that has attachment(s).
+
+Here is an example:
+
+```
+function remove_template() {
+  return false;
+}
+
+//register the filter
+add_filter('wpsp_template_id', remove_template);
+
+// call wp_mail with attachments
+remove_filter('wpsp_template_id', remove_template); //so other emails use template as usual.
+```
+
+## Change in future
+In future SparkPost may support sending attachments with Templates. Also, we can consider the implementing the alternative that is mentioned above directly inside this plugin.
+
+Track [this issue](https://github.com/SparkPost/wordpress-sparkpost/issues/97) to know the latest regarding this.