-
Notifications
You must be signed in to change notification settings - Fork 15
/
readme.txt
179 lines (126 loc) · 7.05 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
=== SparkPost ===
Contributors: sparkpost, rajuru
Tags: sparkpost, smtp, wp_mail, mail, email
Requires at least: 5.5
Tested up to: 6.3
Stable tag: 3.2.8
License: GPLv2 or later
Send all your email from WordPress through SparkPost, the most advanced email delivery service.
== Description ==
The [SparkPost](https://www.sparkpost.com/) email delivery service offers best in class deliverability to ensure your mail hits the inbox, live analytics to review, track and optimize your email activities, as well as highest performance when you need it most: always.
When the SparkPost plugin is enabled, all outgoing email from your WordPress installation is sent through your SparkPost service. From within [the SparkPost UI](https://app.sparkpost.com/) or [SparkPost EU UI](https://app.eu.sparkpost.com/), you can then watch your campaigns unfold live by tracking your engagement metrics, learn what your audience responds to and even integrate more deeply with your app using the SparkPost API.
**Requirements**
- PHP 7.0 or later
- WordPress 5.5 or later
== Installation ==
Option 1: Install using the WordPress Admin Panel:
1. From your WordPress site's Admin Panel go to _Plugins -> Add New_.
1. Enter 'sparkpost' in the _Search Plugins_ text field and hit Enter.
1. Your search results will include a plugin named SparkPost.
1. Click the _Install Now_ button to install the SparkPost plugin.
1. Upon successful installation, the SparkPost plugin will appear in _Plugins -> Installed Plugins_.
1. Finally, click _Activate Plugin_ to activate your new plugin.
Option 2: Install manually:
1. Download the plugin zip file by clicking on the _Download_ button on [this page](https://wordpress.org/plugins/sparkpost).
1. Unzip the plugin zip file into your WordPress plugins directory (usually `wp-content/plugins`)
1. In the WordPress Admin Panel, go to the _Plugins_ page. In the list, you should see your new **SparkPost** plugin.
1. Click **Activate** to activate your new plugin.
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.
== 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* and *Transmission Read/Write* permissions. Creating an account is completely free. Visit [SparkPost](https://app.sparkpost.com/join) to signup (https://app.eu.sparkpost.com/ for EU).
= 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* and *Transmission Read/Write* permissions to be usable by this plugin.
= How do I get further help? =
Visit plugin's [official issue tracker](https://github.com/SparkPost/wordpress-sparkpost/issues) and create new issue, if appropriate.
== Changelog ==
= 3.2.8 =
- Fixed XSS Vulnerability ([169](https://github.com/SparkPost/wordpress-sparkpost/pull/169))
= 3.2.7 =
- Fixed CVE-2017-9841 ([168](https://github.com/SparkPost/wordpress-sparkpost/pull/168))
= 3.2.6 =
- Fixed CVE-2017-9841 ([166](https://github.com/SparkPost/wordpress-sparkpost/pull/166))
= 3.2.5 =
- Fixed fatal error PHPMailer\Exception not found ([163](https://github.com/SparkPost/wordpress-sparkpost/pull/163))
= 3.2.4 =
- Fixed undefined property warning when logging subject ([160](https://github.com/SparkPost/wordpress-sparkpost/pull/160))
= 3.2.3 =
- Fixed broken SparkPost logo on settings page ([157](https://github.com/SparkPost/wordpress-sparkpost/pull/157))
= 3.2.2 =
- Fixed parsing of headers and addressed class-phpmailer.php deprecation notice (for HTTP) ([156](https://github.com/SparkPost/wordpress-sparkpost/pull/156))
= 3.2.1 =
- Fixed invalid data format/type bug ([153](https://github.com/SparkPost/wordpress-sparkpost/pull/153))
- Tested up to Wordpress v5.5.0
= 3.2.0 =
- Add support for EU hostnames ([141](https://github.com/SparkPost/wordpress-sparkpost/pull/141))
= 3.1.1 =
- Avoid db checking if email logging is not enabled
= 3.1.0 =
- Improved UI
- (Optional) Email logging support for better debugging
- Template validation with mailer
- Allow string attachment ([133](https://github.com/SparkPost/wordpress-sparkpost/pull/133))
- Tested up to Wordpress v4.9.4
= 3.0.1 =
- Fix error with older php version ([#113](https://github.com/SparkPost/wordpress-sparkpost/issues/113))
= 3.0.0 =
- Support attachments in template ([#97](https://github.com/SparkPost/wordpress-sparkpost/issues/97)). Add `Templates: Read/Write` permission to API Key for this to work!
- Tested in WordPress v4.7.3
- Fix sending email with sandbox ([#109](https://github.com/SparkPost/wordpress-sparkpost/issues/109))
= 2.6.4 =
- Fix the issue to use template hook when not set in settings ([#95](https://github.com/SparkPost/wordpress-sparkpost/issues/95))
- Clarify attachment can't be sent with template and include workaround example ([#96](https://github.com/SparkPost/wordpress-sparkpost/issues/96))
- Include attachment in test email
= 2.6.3 =
- Add plugin name to XMailer (for SMTP)
- Tested in WordPress v4.7.2
= 2.6.2 =
- Tested in WordPress v4.7.1
= 2.6.0 =
- Handle multiple recipients correctly
- Fix getting started link
- Send assoc array to `wpsp_smtp_msys_api` filter
= 2.5.0 =
- Add support for [Transactional email](https://github.com/SparkPost/wordpress-sparkpost/blob/master/docs/transactional.md)
- Add support for [hooks](https://github.com/SparkPost/wordpress-sparkpost/blob/master/docs/hooks.md)
= 2.4.1 =
- Fix Reply-To header issue with WordPress 4.6
= 2.4.0 =
- Add supports for CC and BCC using HTTP API
= 2.3.0 =
- Fixed issue [#33](https://github.com/SparkPost/wordpress-sparkpost/issues/33) where from email and reply to were being overridden by templates: see [this article](https://support.sparkpost.com/customer/portal/articles/2409547-using-templates-with-the-sparkpost-wordpress-plugin) for detailed information
= 2.2.1 =
- Fix issue for previous version of WordPress
= 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
= 2.1.0 =
- Enable/disable tracking option
- Add support for Reply-To in HTTP Mailer
= 2.0.1 =
- Fix email content type problem
= 2.0.0 =
- Support sending using HTTP API
- UI Tweak
- Hide API Key from UI
- Misc code improvements
= 1.1.5 =
- Support alternate port
- Use filter to set sender info
- Clearer settings panel
= 1.1.4 =
- Update copy
= 1.1.3 =
- 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'
= 1.1.1 =
- Add link to `Settings` in plugins list page
= 1.1.0 =
- Add support for sending test email
- Add support for enable/disable sending via SparkPost
= 1.0.0 =
- Initial version
== Upgrade Notice ==
From WordPress plugins list, click `update now`.