-
Notifications
You must be signed in to change notification settings - Fork 16
/
Copy pathreadme.txt
240 lines (153 loc) · 10.8 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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
=== Postmark for Wordpress ===
Contributors: andy7629, alexknowshtml, mgibbs189, jptoto, atheken, prileygraham
Tags: postmark, email, smtp, notifications, wp_mail, wildbit
Requires at least: 4.0
Tested up to: 5.7
Stable tag: trunk
The *officially-supported* Postmark plugin for Wordpress.
== Description ==
If you're still sending email with default SMTP, you're blind to delivery problems! Postmark for Wordpress enables sites of any size to deliver and track WordPress notification emails reliably, with minimal setup time and zero maintenance.
If you don't already have a Postmark account, you can get one in minutes, sign up at https://postmarkapp.com
Check out our video on how to set up the Postmark for WordPress plugin [here](https://postmarkapp.com/webinars/postmark-wordpress).
== Installation ==
1. Upload postmark directory to your /wp-content/plugins directory
2. Activate plugin in WordPress admin
3. In WordPress admin, go to Settings then Postmark. You will then want to insert your Postmark details. If you don't already have a Postmark account, get one at http://postmarkapp.com
4. Verify sending by entering a recipient email address you have access to and pressing the "Send Test Email" button.
5. Once verified, then check "Enable" to override `wp_mail` and send using the Postmark API instead.
== Frequently Asked Questions ==
= What is Postmark? =
Postmark is a hosted service that expertly handles all delivery of transactional webapp and web site email. This includes welcome emails, password resets, comment notifications, and more. If you've ever installed WordPress and had issues with PHP's `mail()` function not working right, or your WordPress install sends comment notifications or password resets to spam, Postmark makes all of these problems vanish in seconds. Without Postmark, you may not even know you're having delivery problems. Find out in seconds by installing and configuring this plugin.
= Will this plugin work with my WordPress site? =
The Postmark for WordPress plugin overrides any usage of the `wp_mail()` function. Because of this, if any 3rd party code or plugins send mail directly using the PHP mail function, or any other method, we cannot override it. Please contact the makers of any offending plugins and let them know that they should use `wp_mail()` instead of unsupported mailing functions.
= TLS Version Requirements/Compatibility =
The Postmark API requires TLS v1.1 or v1.2 support. We recommend using TLS v1.2.
You can check your TLS v1.2 compatibility using [this plugin](https://wordpress.org/plugins/tls-1-2-compatibility-test/). After installing the plugin, change the dropdown for 'Select API Endpoint' to _How's My SSL?_ and run the test. If compatibility with TLS v1.2 is not detected, contact your server host or make the necessary upgrades to support TLS v1.1 or v1.2.
TLS 1.2 requires:
- PHP 5.5.19 or higher
- cURL 7.34.0 or higher
- OpenSSL 1.0.1 or higher
= Does this cost me money? =
The Postmark service (and this plugin) are free to get started. You can sign up at https://postmarkapp.com/. When you need to process more email, Postmark offers monthly plans to fit your needs.
= My emails are still not sending, or they are going to spam! HELP!? =
No worries, our expert team can help. Just send an email to [[email protected]](mailto:[email protected]) or tweet [@postmarkapp](https://twitter.com/postmarkapp) for help. Be sure to include as much detail as possible.
= Why should I trust you with my email sending? =
Because we've been in this business for many years. We’ve been running an email marketing service, Newsberry, for five years. Through trial and error we already know what it takes to manage a large volume of email. We handle things like whitelisting, ISP throttling, reverse DNS, feedback loops, content scanning, and delivery monitoring to ensure your emails get to the inbox.
Most importantly, a great product requires great support and even better education. Our team is spread out across six time zones to offer fast support on everything from using Postmark to best practices on content and user engagement. A solid infrastructure only goes so far, that’s why improving our customer’s sending practices helps achieve incredible results
= Why aren't my HTML emails being sent? =
This plugin detects HTML by checking the headers sent by other WordPress plugins. If a "text/html" content type isn't set then this plugin won't send the HTML to Postmark to be sent out only the plain text version of the email.
= Why are password reset links not showing in emails sent with this plugin? =
There are a couple ways to resolve this issue.
1. Open the Postmark plugin settings and uncheck Force HTML and click Save Changes. If the default WordPress password reset email is sent in Plain Text format, the link will render as expected.
2. Access your WordPress site directory and open the `wp-login.php` file.
Change this line:
`$message .= ‘<‘ . network_site_url(“wp-login.php?action=rp&key=$key&login=” . rawurlencode($user_login), ‘login’) . “>\r\n”;`
Remove the brackets, so it becomes:
`$message .= network_site_url(“wp-login.php?action=rp&key=$key&login=” . rawurlencode($user_login), ‘login’) . “\r\n”;`
And save the changes to the file.
= How do I set the from name? =
The plugin supports using the `wp_mail_from_name` filter for manually setting a name in the From header.
== Additional Resources ==
[Postmark for WordPress FAQ](https://postmarkapp.com/support/article/1138-postmark-for-wordpress-faq)
[Can I use the Postmark for WordPress plugin with Gravity Forms?](https://postmarkapp.com/support/article/1129-can-i-use-the-postmark-for-wordpress-plugin-with-gravity-forms)
[How do I send with Ninja Forms and Postmark for WordPress?](https://postmarkapp.com/support/article/1047-how-do-i-send-with-ninja-forms-and-postmark-for-wordpress)
[How do I send with Contact Form 7 and Postmark for WordPress?](https://postmarkapp.com/support/article/1072-how-do-i-send-with-contact-form-7-and-postmark-for-wordpress)
[Can I use the Postmark for WordPress plugin with Divi contact forms?](https://postmarkapp.com/support/article/1128-can-i-use-the-postmark-for-wordpress-plugin-with-divi-contact-forms)
== Screenshots ==
1. Postmark WP Plugin Settings screen.
== Changelog ==
= v.1.14.0 =
* Support using wp_mail_from hook to set From address. Overriding From address via header still has priority.
= v1.13.4 =
* Handle special characters in site titles for test emails.
= v1.13.3 =
* Additional bugfix for using wp_mail_from_name filter.
= v1.13.2 =
* Fixes error when upgrading by ensuring $postmark is set before trying to load settings.
= v1.13.1 =
* Fixes error from using incorrect filter name and mailparse_rfc822_parse_addresses function.
= v1.13.0 =
* Adds support for using the wp_mail_from_name filter to specify a from_name when sending.
= v1.12.5 =
* Fixes 'POSTMARK_DIR is undefined' warning when upgrading other plugins via the CLI.
= v1.12.4 =
* Fixes potential collation mismatch errors from date comparisons during old sending logs deletion.
= v1.12.3 =
* Uses count() for check of logs query result count.
= v1.12.2 =
* Corrects SQL for deletion of log entries older than 7 days.
= v1.12.1 =
* Checks if stream_name is set in settings before determining which stream to use.
= v1.12 =
* Adds support for message streams.
= v1.11.6 =
* Updates server API token location hint in plugin settings.
= v1.11.5 =
* Allows using POSTMARK_API_TEST in the plugin settings for generating test send requests that aren't actually delivered.
= v1.11.4 =
* Fixes handling of situation where call to Postmark API results in WP_Error instead of array for response, such as during incidents of the API being offline and not returning a response.
= v1.11.3 =
* Fixes log page display of From/To addresses including the From/To names. Only email addresses will now appear in logs page, to avoid confusion, while also preserving the sanitation of email addresses before inserting into db.
= v1.11.2 =
* Fixes no index error with track links check in wp_mail.
= v1.11.1 =
* Fixes call of non-global load_settings function during upgrade.
= v1.11.0 =
* Adds link tracking support.
* Fixes send test with HTML/open tracking option not being honored in sent test email.
= v1.10.6 =
* Fixes undefined index error.
* Adds Upgrade Notice
= v1.10.5 =
* Corrects logs deletion cron job unscheduling issue.
= v1.10.4 =
* Removes index on logs table.
= v1.10.3 =
* Corrects version mismatch in constructor.
= v1.10.1 =
* Adds a new logging feature that can be enabled to store logs for send attempts. Logs include Date, From address, To address, Subject, and Postmark API response. Logs are displayed in a Logs tab in the plugin setting once enabled.
* Switch loading of JS/CSS to use enqueue()
= v1.9.6 =
* Resolves issue when saving settings in UI.
* Falls attachment Content-Type back to 'application/octet-stream' when other methods fail.
= v1.9.5 =
* Update javascript to fix settings update issue.
= v1.9.4 =
* Added `postmark_error` and `postmark_response` actions to the plugin, to intercept API results after calling wp_mail. You can register callbacks for these using `add_action` (more info here: https://developer.wordpress.org/reference/functions/add_action/)
= v1.9.3 =
* Interface cleanup
* Minor code restructuring
= v1.9.2 =
* Make the errors available in the PHP variable `Postmark_Mail::$LAST_ERROR` if `wp_mail()` returns false, examine this variable to find out what happened.
* When doing a test send, if an error occurs, it will be printed in the settings page header.
= v1.9.1 =
* Fix case where 'From' header is specified as a literal string, instead of in an associative array.
= v1.9 =
* Allow the 'From' header to override the default sender.
* Don't send TextBody when the user has specified the 'Content-Type' header of 'text/html'
* Allow individual messages to opt-in to Track-Opens by including a header of 'X-PM-Track-Opens' and a value of `true`
= v1.8 =
* Modernization of codebase.
= v1.7 =
* Support headers for cc, bcc, and reply-to
= v1.6 =
* Added open tracking support.
= v1.5 =
* Fix issue with new WordPress HTTP API Integration.
= v1.4 =
* New option to force emails to be sent as HTML. Previously just detected Content-Type.
* Now uses the WordPress HTTP API.
= v1.3 =
* Resolved error with handing arrays of recipients
= v1.2 =
* Arrays of recipients are now properly handled
* HTML emails and Text Emails are now handled by checking the headers of the emails sent, and sends via Postmark appropriately.
* Optional "Powered by Postmark" footer of sent emails. "Postmark solves your WordPress email problems. Send transactional email confidently using http://postmarkapp.com"
* Add license to README and PHP file
= v1.0.0 =
* First Public release.
== Upgrade Notice ==
= 1.11 =
Adds link tracking support.
= 1.10 =
Adds new feature for enabling logging of send attempts, including the response from the Postmark API.