From 34fcfcfa05eb77999bbd6cd4b5aefd0208d90c4c Mon Sep 17 00:00:00 2001 From: Rich Leland Date: Thu, 24 Mar 2016 11:20:46 -0400 Subject: [PATCH 1/4] Fix local dev instructions --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b8141c14..c2f8b709 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,6 @@ From Test Email section, try sending a test email to yourself to make sure the c For example, if you've cloned this repository to `~/src/wordpress-sparkpost` and your WordPress is installed in `~/src/wordpress`, you should create a symlink like following ``` -ln -s ~/src/wordpress-sparkpost/trunk ~/src/wordpress/wp-content/plugins/wordpress-sparkpost +ln -s ~/src/wordpress-sparkpost ~/src/wordpress/wp-content/plugins/wordpress-sparkpost ``` * Activate the plugin from admin panel From a2c821c5dd1f285a79b3dc1e69871c1b24855ef4 Mon Sep 17 00:00:00 2001 From: Rich Leland Date: Thu, 24 Mar 2016 11:38:24 -0400 Subject: [PATCH 2/4] Version bump in prep for release --- readme.txt | 38 +++++++++++++++++++++++++++----------- wordpress-sparkpost.php | 2 +- 2 files changed, 28 insertions(+), 12 deletions(-) diff --git a/readme.txt b/readme.txt index dc290863..5c7dc3f7 100644 --- a/readme.txt +++ b/readme.txt @@ -3,7 +3,7 @@ Contributors: sparkpost, rajuru Tags: sparkpost, smtp, wp_mail, mail, email Requires at least: 4.0 Tested up to: 4.4.2 -Stable tag: 2.1.0 +Stable tag: 2.1.1 License: GPLv2 or later Send all your email from Wordpress through SparkPost, the most advanced email delivery service. @@ -35,32 +35,47 @@ Upon successful activation, **SparkPost** will appear on the _Settings_ menu in Fill in each plugin configuration field: -* **enable?**: Check this box to enable your plugin :) -* **from name**: a human-friendly name to show in 'From' headers - * e.g. your name or your site's name +* Check the "Send email using SparkPost" box to enable the plugin -* **from email**: your 'From' email address - * e.g. yourname@yourdomain.com +* **Method**: select whether to send using the HTTP API or SMTP -* **SMTP password**: A SparkPost API key with *Send via SMTP* permission +* **API Key**: a SparkPost API key with *Send via SMTP* and *Transmission Read/Write* permissions * Hint: they look like this: 39fb780c182927cde6baddab00f67676feed1beef17 +* **Enable tracking**: select whether to enable open and click tracking + +* **Template**: SparkPost template to use when sending email + * Note: a template can only be used if the HTTP API method is selected + +* **From name**: a human-friendly name to show in 'From' headers + * e.g. your name or your site's name + +* **From email**: your 'From' email address + * e.g. yourname@yourdomain.com + For information on how to create an API key, follow the [official documentation](https://support.sparkpost.com/customer/portal/articles/1933377-create-api-keys). -Ensure your [sending domain](https://app.sparkpost.com/#/configuration/sending-domains) is properly configured within SparkPost. +Ensure your [sending domain](https://app.sparkpost.com/configuration/sending-domains) is properly configured within SparkPost. == Frequently Asked Questions == + = What do I need to start using this plugin? = -You'll need to create an account on SparkPost.com and then generate an API Key with *Send via SMTP* permission. Creating an account is completely free. Visit [SparkPost](https://app.sparkpost.com/sign-up) to signup. +You'll need to create an account on SparkPost.com and then generate an API Key with *Send via SMTP* and *Transmission Read/Write* permissions. Creating an account is completely free. Visit [SparkPost](https://app.sparkpost.com/sign-up) to signup. = How do I create an API key? = -Follow [this tutorial](https://support.sparkpost.com/customer/portal/articles/1933377) for creating an API key. **Remember:** your API key must have 'Send via SMTP' permission to be usable by this plugin. +Follow [this tutorial](https://support.sparkpost.com/customer/portal/articles/1933377) for creating an API key. **Remember:** your API key must have *Send via SMTP* and *Transmission Read/Write* permissions to be usable by this plugin. = How do I get further help? = -Visit our [support portal](https://support.sparkpost.com/) for help. +Visit our [support site](https://support.sparkpost.com/) for help. == Changelog == + += 2.1.1 = +- Add template field for selecting a SparkPost template when using HTTP API +- Allow substituion of Subject, From name in HTTP API +- Replaced anonymous function for compatibility with older versions of PHP + = 2.1.0 = - Enable/disable tracking option - Add support for Reply-To in HTTP Mailer @@ -99,4 +114,5 @@ Richer plugin settings error messages and help text, TLS now permanently enabled - Initial version == Upgrade Notice == + This is initial version. diff --git a/wordpress-sparkpost.php b/wordpress-sparkpost.php index e2593e1a..c1aa0b3d 100644 --- a/wordpress-sparkpost.php +++ b/wordpress-sparkpost.php @@ -6,7 +6,7 @@ Plugin Name: SparkPost Plugin URI: http://sparkpost.com/ Description: Send all your email from Wordpress through SparkPost, the world's most advanced email delivery service. -Version: 2.1.0 +Version: 2.1.1 Author: SparkPost Author URI: http://sparkpost.com License: GPLv2 or later From 2c1883a7c75ce6e5bd9a6aa4d0d679c1b5978e5c Mon Sep 17 00:00:00 2001 From: Rich Leland Date: Thu, 24 Mar 2016 11:50:20 -0400 Subject: [PATCH 3/4] Address review feedback --- README.md | 8 +++----- readme.txt | 26 +------------------------- 2 files changed, 4 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index c2f8b709..a688e2d7 100644 --- a/README.md +++ b/README.md @@ -29,12 +29,10 @@ From Test Email section, try sending a test email to yourself to make sure the c ## Development * Install WordPress -* Clone this repository -* Create a symlink to the repository's `trunk` directory in WordPress plugins directory. - -For example, if you've cloned this repository to `~/src/wordpress-sparkpost` and your WordPress is installed in `~/src/wordpress`, you should create a symlink like following +* Clone this repository to the WordPress plugins directory: ``` -ln -s ~/src/wordpress-sparkpost ~/src/wordpress/wp-content/plugins/wordpress-sparkpost +git clone git@github.com:SparkPost/wordpress-sparkpost.git ~/src/wordpress/wp-content/plugins/wordpress-sparkpost ``` + * Activate the plugin from admin panel diff --git a/readme.txt b/readme.txt index 5c7dc3f7..9717e6a5 100644 --- a/readme.txt +++ b/readme.txt @@ -33,30 +33,6 @@ Option 2: Install manually: Upon successful activation, **SparkPost** will appear on the _Settings_ menu in the Wordpress Admin Panel. Click on _Settings -> SparkPost_ to open the SparkPost plugin configuration page and complete setup. -Fill in each plugin configuration field: - -* Check the "Send email using SparkPost" box to enable the plugin - -* **Method**: select whether to send using the HTTP API or SMTP - -* **API Key**: a SparkPost API key with *Send via SMTP* and *Transmission Read/Write* permissions - * Hint: they look like this: 39fb780c182927cde6baddab00f67676feed1beef17 - -* **Enable tracking**: select whether to enable open and click tracking - -* **Template**: SparkPost template to use when sending email - * Note: a template can only be used if the HTTP API method is selected - -* **From name**: a human-friendly name to show in 'From' headers - * e.g. your name or your site's name - -* **From email**: your 'From' email address - * e.g. yourname@yourdomain.com - -For information on how to create an API key, follow the [official documentation](https://support.sparkpost.com/customer/portal/articles/1933377-create-api-keys). - -Ensure your [sending domain](https://app.sparkpost.com/configuration/sending-domains) is properly configured within SparkPost. - == Frequently Asked Questions == = What do I need to start using this plugin? = @@ -98,7 +74,7 @@ Visit our [support site](https://support.sparkpost.com/) for help. - Update copy = 1.1.3 = -Richer plugin settings error messages and help text, TLS now permanently enabled +- Richer plugin settings error messages and help text, TLS now permanently enabled = 1.1.2 = - Shortened the plugin name to just SparkPost, added more readme copy, renamed 'SMTP password' setting to 'API key' From 14d656123404e176d29d78f9ec9f81c4b3458ce1 Mon Sep 17 00:00:00 2001 From: Rich Leland Date: Thu, 24 Mar 2016 11:52:34 -0400 Subject: [PATCH 4/4] Use minor version instead of patch --- readme.txt | 4 ++-- wordpress-sparkpost.php | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/readme.txt b/readme.txt index 9717e6a5..713501c4 100644 --- a/readme.txt +++ b/readme.txt @@ -3,7 +3,7 @@ Contributors: sparkpost, rajuru Tags: sparkpost, smtp, wp_mail, mail, email Requires at least: 4.0 Tested up to: 4.4.2 -Stable tag: 2.1.1 +Stable tag: 2.2.0 License: GPLv2 or later Send all your email from Wordpress through SparkPost, the most advanced email delivery service. @@ -47,7 +47,7 @@ Visit our [support site](https://support.sparkpost.com/) for help. == Changelog == -= 2.1.1 = += 2.2.0 = - Add template field for selecting a SparkPost template when using HTTP API - Allow substituion of Subject, From name in HTTP API - Replaced anonymous function for compatibility with older versions of PHP diff --git a/wordpress-sparkpost.php b/wordpress-sparkpost.php index c1aa0b3d..dc700352 100644 --- a/wordpress-sparkpost.php +++ b/wordpress-sparkpost.php @@ -6,7 +6,7 @@ Plugin Name: SparkPost Plugin URI: http://sparkpost.com/ Description: Send all your email from Wordpress through SparkPost, the world's most advanced email delivery service. -Version: 2.1.1 +Version: 2.2.0 Author: SparkPost Author URI: http://sparkpost.com License: GPLv2 or later