3 |
3 |
4 |
5 | # ActiveCampaign Postmark for WordPress
6 |
7 | If you’re still sending email with default SMTP, you’re blind to delivery problems! ActiveCampaign Postmark for WordPress enables sites of any size to deliver and track WordPress notification emails reliably, with minimal setup time and zero maintenance.
8 |
9 | If you don’t already have an ActiveCampaign Postmark account, you can get one in minutes, sign up at https://postmarkapp.com.
10 |
11 | ## Installation
12 |
13 | 1. Upload postmark directory to your /wp-content/plugins directory or install from plugin marketplace
14 | 2. Activate plugin in WordPress admin
15 | 3. In WordPress admin, go to **Settings** then **ActiveCampaign Postmark**. You will then want to insert your ActiveCampaign Postmark details. If you don’t already have an ActiveCampaign Postmark account, get one at https://postmarkapp.com.
16 | 4. Verify sending by entering a recipient email address you have access to and pressing the “Send Test Email” button. Enable logging for troubleshooting and to check the send result.
17 | 5. Once everything is verified as working, check **Send emails using ActiveCampaign Postmark** and Save, to override `wp_mail` to send using the ActiveCampaign Postmark API instead.
18 |
19 | ## FAQ
20 |
21 | ### What is ActiveCampaign Postmark?
22 | ActiveCampaign 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, ActiveCampaign Postmark makes all of these problems vanish in seconds. Without ActiveCampaign Postmark, you may not even know you're having delivery problems. Find out in seconds by installing and configuring this plugin.
23 |
24 | ### Will this plugin work with my WordPress site?
25 |
26 | The ActiveCampaign 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.
27 |
28 | ### TLS Version Requirements/Compatibility
29 |
30 | The ActiveCampaign Postmark API requires TLS v1.1 or v1.2 support. We recommend using TLS v1.2.
31 |
32 | 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.
33 |
34 | TLS 1.2 requires:
35 |
36 | - PHP 5.5.19 or higher
37 | - cURL 7.34.0 or higher
38 | - OpenSSL 1.0.1 or higher
39 |
40 | ### Does this cost me money?
41 |
42 | The ActiveCampaign Postmark service (and this plugin) are free to get started, for up to 100 emails a month. You can sign up at https://postmarkapp.com/. When you need to process more than 100 emails a month, ActiveCampaign Postmark offers monthly plans to fit your needs.
43 |
44 | ### My emails are still not sending, or they are going to spam! HELP!?
45 |
46 | First, enable logging in **Settings** and check your send attempts for any errors returned by the ActiveCampaign Postmark API. These errors can let you know why the send attempts are failing. If you aren't seeing log entries for your send attempts, then the plugin or contact form generating the emails is likely not using `wp_mail` and not compatible with this plugin.
47 |
48 | If you are still unsure how to proceed, just send an email to [support@postmarkapp.com](mailto:support@postmarkapp.com) or tweet [@postmarkapp](https://twitter.com/postmarkapp) for help. Be sure to include as much detail as possible.
49 |
50 | ### Why should I trust you with my email sending?
51 |
52 | 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.
53 |
54 | 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 ActiveCampaign 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.
55 |
56 | ### How do I tag a message?
57 |
58 | There are two ways to tag a message.
59 |
60 | 1. Set an `X-PM-Tag` message header, i.e. `array_push( $headers, 'X-PM-Tag: PostmarkPluginTest' );` where you are calling `wp_mail()`.
61 |
62 | 2. Add a filter for `postmark_tag` that hooks into a function that returns the tag you desire.
63 |
64 | Using the `postmark_tag` filter option will override a tag set via message headers.
65 |
66 | ### Why aren't my HTML emails being sent?
67 |
68 | 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 ActiveCampaign Postmark to be sent out only the plain text version of the email.
69 |
70 | ### Why are password reset links not showing in emails sent with this plugin?
71 |
72 | There are a couple ways to resolve this issue.
73 |
74 | 1. Open the ActiveCampaign 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.
75 |
76 | 2. Access your WordPress site directory and open the `wp-login.php` file.
77 |
78 | Change this line:
79 |
80 | $message .= ‘<‘ . network_site_url(“wp-login.php?action=rp&key=$key&login=” . rawurlencode($user_login), ‘login’) . “>\r\n”;
81 |
82 | Remove the brackets, so it becomes:
83 |
84 | $message .= network_site_url(“wp-login.php?action=rp&key=$key&login=” . rawurlencode($user_login), ‘login’) . “\r\n”;
85 |
86 | And save the changes to the file.
87 |
88 | ### How do I set the from name?
89 |
90 | The plugin supports using the `wp_mail_from_name` filter for manually setting a name in the From header.
91 |
92 | ## Additional Resources
93 |
94 | [ActiveCampaign Postmark for WordPress FAQ](https://postmarkapp.com/support/article/1138-postmark-for-wordpress-faq)
95 |
96 | [Can I use the ActiveCampaign Postmark for WordPress plugin with Gravity Forms?](https://postmarkapp.com/support/article/1129-can-i-use-the-postmark-for-wordpress-plugin-with-gravity-forms)
97 |
98 | [How do I send with Ninja Forms and ActiveCampaign Postmark for WordPress?](https://postmarkapp.com/support/article/1047-how-do-i-send-with-ninja-forms-and-postmark-for-wordpress)
99 |
100 | [How do I send with Contact Form 7 and ActiveCampaign Postmark for WordPress?](https://postmarkapp.com/support/article/1072-how-do-i-send-with-contact-form-7-and-postmark-for-wordpress)
101 |
102 | [Can I use the ActiveCampaign 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)
103 |
104 | ## Changelog
105 | ## [1.19.1]
106 | - Fix warning when logging sends with a null To address
107 |
108 | --------
109 |
110 | [See the previous changelogs here](https://github.com/ActiveCampaign/postmark-wordpress/blob/master/CHANGELOG.md)
111 |
112 | ActiveCampaign, 2022
113 |
--------------------------------------------------------------------------------
/assets/css/admin.css:
--------------------------------------------------------------------------------
1 | .logo-bar {
2 | background-color: #ffde00;
3 | border-radius: 5px;
4 | margin-bottom: 5px;
5 | padding: 10px;
6 | line-height: 1;
7 | }
8 |
9 | .logo-bar a {
10 | display: inline-block;
11 | }
12 |
13 | .footnote {
14 | font-size: 13px;
15 | margin-top: 5px;
16 | }
17 |
18 | .postmark-input {
19 | width: 300px;
20 | }
21 |
22 | .nav-tab {
23 | cursor: pointer;
24 | }
25 |
26 | .tab-content {
27 | display: none;
28 | }
29 |
30 | .tab-content.active {
31 | display: block;
32 | }
33 |
34 | .footnote {
35 | font-size: 13px;
36 | }
37 |
38 | #wpbody-content > div.wrap > div.tab-content.tab-log.active > table.pm-log {
39 | margin-bottom: 0;
40 | margin-top: 3%;
41 | overflow: hidden;
42 | overflow-y: scroll;
43 | display: block;
44 | border-collapse: collapse;
45 | }
46 |
47 | #wpbody-content > div.wrap > div.tab-content.tab-log.active > table.pm-log > tbody > tr:nth-child(odd) {
48 | background-color: white;
49 | }
50 |
51 | #wpbody-content > div.wrap > div.tab-content.tab-log.active > table.pm-log > tbody > tr > td {
52 | border-bottom: 1px solid #ddd;
53 | padding-bottom: 0.5em;
54 | padding-top: 0.5em;
55 | padding-left: 0.5em
56 | }
57 |
58 | #wpbody-content > div.wrap > div.tab-content.tab-log.active > table > thead > tr > th {
59 | font-size: 1.2em;
60 | padding-bottom: 0.7em;
61 | }
62 |
63 | .load-more {
64 | display: flex;
65 | justify-content: center;
66 | }
67 |
--------------------------------------------------------------------------------
/assets/images/logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ActiveCampaign/postmark-wordpress/40ecc957252bf79ce9b73e3a58348ab056c51dec/assets/images/logo.png
--------------------------------------------------------------------------------
/assets/js/admin.js:
--------------------------------------------------------------------------------
1 | (function ($) {
2 | $(function() {
3 | var settings = postmark.settings;
4 | var logs_offset = 10;
5 | $('.pm-enabled').prop('checked', settings.enabled);
6 | $('.pm-api-key').val(settings.api_key);
7 | $('.pm-stream-name').val(settings.stream_name);
8 | $('.pm-sender-address').val(settings.sender_address);
9 | $('.pm-force-from').prop('checked', settings.force_from);
10 | $('.pm-force-html').prop('checked', settings.force_html);
11 | $('.pm-track-opens').prop('checked', settings.track_opens);
12 | $('.pm-track-links').prop('checked', settings.track_links);
13 | $('.pm-enable-logs').prop('checked', settings.enable_logs);
14 |
15 | // save
16 | $(document).on('click', '.save-settings', function() {
17 | var data = {
18 | 'enabled': $('.pm-enabled').is(':checked') ? 1 : 0,
19 | 'api_key': $('.pm-api-key').val(),
20 | 'stream_name': $('.pm-stream-name').val() ? $('.pm-stream-name').val() : 'outbound',
21 | 'sender_address': $('.pm-sender-address').val(),
22 | 'force_from': $('.pm-force-from').is(':checked') ? 1 : 0,
23 | 'force_html': $('.pm-force-html').is(':checked') ? 1 : 0,
24 | 'track_opens': $('.pm-track-opens').is(':checked') ? 1 : 0,
25 | 'track_links': $('.pm-track-links').is(':checked') ? 1 : 0,
26 | 'enable_logs': $('.pm-enable-logs').is(':checked') ? 1 : 0
27 | };
28 |
29 | $.post(ajaxurl, {
30 | '_wpnonce' : $('#_wpnonce').val(),
31 | 'action': 'postmark_save',
32 | 'data': JSON.stringify(data)
33 | }, function(response) {
34 | $('.pm-notice').html('' + response + '
'); 35 | $('.pm-notice').removeClass('hidden'); 36 | 37 | // Immediately hides logs tab if logs were disabled. 38 | if (data.enable_logs == 1) { 39 | $('#pm-log-nav-tab').show(); 40 | } else { 41 | $('#pm-log-nav-tab').hide(); 42 | } 43 | }); 44 | }); 45 | 46 | // send test email 47 | $(document).on('click', '.send-test', function() { 48 | $.post(ajaxurl, { 49 | '_wpnonce' : $('#_wpnonce').val(), 50 | 'action': 'postmark_test', 51 | 'email': $('.pm-test-email').val(), 52 | 'with_tracking_and_html': $('.pm-test-with-opens').is(':checked') ? 1 : 0, 53 | 'override_from_address' : $('.pm-test-email-sender').val() 54 | }, function(response) { 55 | $('.pm-notice').html('' + response + '
'); 56 | $('.pm-notice').removeClass('hidden'); 57 | }); 58 | }); 59 | 60 | // tab handler 61 | $(document).on('click', '.nav-tab', function() { 62 | var which = $(this).attr('rel'); 63 | $('.nav-tab').removeClass('nav-tab-active'); 64 | $('.tab-content').removeClass('active'); 65 | $(this).addClass('nav-tab-active'); 66 | $('.tab-' + which).addClass('active'); 67 | }); 68 | 69 | // Loads more logs when 'Load More' button is clicked. 70 | $(document).on('click', '.load-more', function() { 71 | 72 | var data = { 73 | action: 'postmark_load_more_logs', 74 | offset: logs_offset, 75 | _wpnonce : $('#_wpnonce').val() 76 | }; 77 | 78 | // Prepares for next 'Load More' by increasing the offset amount for next query. 79 | logs_offset += 10; 80 | 81 | $.post( ajaxurl, data, function( response ) { 82 | 83 | // Parses response string into JSON. 84 | response = JSON.parse(response); 85 | 86 | // Adds new logs to logs table. 87 | $('#pm-log-table tr:last').after(response.html); 88 | 89 | // Tracks the number of total logs present in logs table. 90 | var has_more = response.has_more; 91 | 92 | // Hides the 'Load More' button if no additional logs to display. 93 | if (!has_more) { 94 | $('.load-more').hide(); 95 | } 96 | }); 97 | }); 98 | 99 | // force html if track opens is enabled 100 | $(document).on('click', '.pm-track-opens', function() { 101 | if ($(this).is(':checked')) { 102 | $('.pm-force-html').attr('checked', 'checked'); 103 | } 104 | }); 105 | 106 | // uncheck track opens if force html is disabled 107 | $(document).on('click', '.pm-force-html', function() { 108 | if (! $(this).is(':checked')) { 109 | $('.pm-track-opens').removeAttr('checked'); 110 | } 111 | }); 112 | 113 | // trigger active tab 114 | $('.nav-tab:first').click(); 115 | }); 116 | })(jQuery); -------------------------------------------------------------------------------- /includes/class-postmark-debug.php: -------------------------------------------------------------------------------- 1 | __( 'Active Campaign Postmark', 'postmark-wordpress' ), 28 | 'fields' => array( 29 | 'status' => array( 30 | 'label' => __( 'Enabled', 'postmark-wordpress' ), 31 | 'value' => $this->strbool( $settings->enabled ), 32 | 'private' => false, 33 | ), 34 | 'version' => array( 35 | 'label' => __( 'POSTMARK_VERSION', 'postmark-wordpress' ), 36 | 'value' => defined( 'POSTMARK_VERSION' ) ? POSTMARK_VERSION : $postmark::$POSTMARK_VERSION, 37 | 'private' => false, 38 | ), 39 | 'directory' => array( 40 | 'label' => __( 'POSTMARK_DIR', 'postmark-wordpress' ), 41 | 'value' => defined( 'POSTMARK_DIR' ) ? POSTMARK_DIR : $postmark::$POSTMARK_DIR, 42 | 'private' => false, 43 | ), 44 | 'url' => array( 45 | 'label' => __( 'POSTMARK_URL', 'postmark-wordpress' ), 46 | 'value' => defined( 'POSTMARK_URL' ) ? POSTMARK_URL : $postmark::$POSTMARK_URL, 47 | 'private' => false, 48 | ), 49 | 'apikey' => array( 50 | 'label' => __( 'API Key', 'postmark-wordpress' ), 51 | 'value' => $settings->api_key, 52 | 'private' => true, 53 | ), 54 | 'stream' => array( 55 | 'label' => __( 'Stream', 'postmark-wordpress' ), 56 | 'value' => $settings->stream_name, 57 | 'private' => false, 58 | ), 59 | 'sender_address' => array( 60 | 'label' => __( 'Sender Address', 'postmark-wordpress' ), 61 | 'value' => $settings->sender_address, 62 | 'private' => false, 63 | ), 64 | 'force_from' => array( 65 | 'label' => __( 'Force From', 'postmark-wordpress' ), 66 | 'value' => $this->strbool( $settings->force_from ), 67 | 'private' => false, 68 | ), 69 | 'force_html' => array( 70 | 'label' => __( 'Force HTML', 'postmark-wordpress' ), 71 | 'value' => $this->strbool( $settings->force_html ), 72 | 'private' => false, 73 | ), 74 | 'track_opens' => array( 75 | 'label' => __( 'Track Opens', 'postmark-wordpress' ), 76 | 'value' => $this->strbool( $settings->track_opens ), 77 | 'private' => false, 78 | ), 79 | 'track_links' => array( 80 | 'label' => __( 'Track Links', 'postmark-wordpress' ), 81 | 'value' => $this->strbool( $settings->track_links ), 82 | 'private' => false, 83 | ), 84 | 'enable_logs' => array( 85 | 'label' => __( 'Logs Enabled', 'postmark-wordpress' ), 86 | 'value' => $this->strbool( $settings->enable_logs ), 87 | 'private' => false, 88 | ), 89 | ), 90 | ); 91 | 92 | return $debug_info; 93 | } 94 | 95 | /** 96 | * String Boolean. 97 | * 98 | * @param bool $value Value. 99 | * @return string Yes or No based on boolean provided. 100 | */ 101 | private function strbool( $value ) { 102 | return $value ? 'Yes' : 'No'; 103 | } 104 | 105 | } 106 | 107 | new Postmark_Debug(); 108 | 109 | } 110 | -------------------------------------------------------------------------------- /page-settings.php: -------------------------------------------------------------------------------- 1 | 5 | 22 |; ?>){kind=logo}
25 | POSTMARK_API_KEY is defined in your wp-config.php and overrides the API Key set here.POSTMARK_STREAM_NAME is defined in your wp-config.php and overrides the Message Stream set here.POSTMARK_SENDER_ADDRESS is defined in your wp-config.php and overrides the Sender Email set here.POSTMARK_FORCE_FROM is defined in your wp-config.php and overrides the Force From set here.| 66 | | 67 | 68 | Send emails using ActiveCampaign Postmark 69 | | 70 |
|---|---|
| 73 | |
74 |
75 | Your API key is in the API Tokens tab of your Postmark Server.
76 | |
77 |
| 80 | |
81 |
82 | Optional - Default is 'outbound' if blank.
83 | |
84 |
| 87 | |
88 |
89 | This email must be a verified Sender Signature. It will appear as the "from" address on all outbound emails.
90 | |
91 |
| 94 | |
95 |
96 | Force emails to be sent from the Sender Email specified above. Disallows overriding using the $headers array.
97 | |
98 |
| 101 | | 102 | 103 | Force emails to be sent as HTML. 104 | | 105 |
| 108 | |
109 |
110 | Track email opens (Force HTML is required).
111 | |
112 |
| 115 | | 116 | 117 | Track links in emails. 118 | | 119 |
| 122 | | 123 | 124 | Log send attempts for historical/troubleshooting purposes (Recommended). 125 | | 126 |
| 138 | | 139 | |
|---|---|
| 142 | | 143 | |
| 146 | 147 | Send test as HTML, with both Open Tracking and Link Tracking enabled, and a Tag. 148 | | 149 ||
Instead of using Force HTML, we recommend setting wp_mail headers when possible.
161 | $headers = array(); 162 | 163 | // Override the default 'From' address if 'Force Sender Email' is not enabled 164 | $headers['From'] = 'john.smith@example.com'; 165 | 166 | // Send the message as HTML 167 | $headers['Content-Type'] = 'text/html'; 168 | 169 | // Enable open tracking (requires HTML email enabled) 170 | $headers['X-PM-Track-Opens'] = true; 171 | 172 | // Enable or disable link tracking 173 | // Options are None, HtmlAndText, TextOnly, or HtmlOnly 174 | $headers['X-PM-Track-Links'] = 'HtmlAndText'; 175 | 176 | // Send the email 177 | $response = wp_mail( $to, $subject, $message, $headers ); 178 |179 | To learn more about
wp_mail, see the WordPress Codex page.
180 | | 204 | 205 | | 206 | page->state; ?> 207 | | 208 |
|---|---|
| 211 | | 212 | page->updated_at ) ); 214 | $date_format = get_option( 'date_format' ); 215 | $time_format = get_option( 'time_format' ); 216 | echo wp_date( "{$date_format} {$time_format}", $unix_date ); 217 | ?> 218 | | 219 |
| 222 | 223 | |
| Date | 251 |From | 252 |To | 253 |Subject | 254 |Postmark API Response | 255 | '; 256 | 257 | // Builds HTML for each log to show as a row in the logs table. 258 | foreach ( $result as $row ) { 259 | echo '
|---|---|---|---|---|
| ' . date( 'Y-m-d h:i A', strtotime( esc_html( $row->log_entry_date ) ) ) . ' | ' . esc_html( $row->fromaddress ) . ' | ' . esc_html( $row->toaddress ) . ' | ' . esc_html( $row->subject ) . ' | ' . $row->response . ' |
| 281 | | 282 | 283 | | 284 |
|---|---|
| 287 | | 288 | 289 | | 290 |
| 293 | | 294 | 295 | | 296 |
| 299 | | 300 | 301 | | 302 |
' . $dump . ''; 253 | } 254 | 255 | wp_die(); 256 | } 257 | 258 | /** 259 | * Save Settings. 260 | */ 261 | public function save_settings() { 262 | // We check the wp_nonce. 263 | if ( ! isset( $_POST['_wpnonce'] ) || ! wp_verify_nonce( $_POST['_wpnonce'], 'postmark_nonce' ) ) { 264 | wp_die( __( 'We were unable to verify this request, please reload the page and try again.' ) ); 265 | } 266 | 267 | // We check that the current user is allowed to update settings. 268 | if ( ! current_user_can( 'manage_options' ) ) { 269 | wp_die( __( 'We were unable to verify this request, please reload the page and try again.' ) ); 270 | } 271 | 272 | // We check that we have received some data. 273 | if ( ! isset( $_POST['data'] ) ) { 274 | wp_die( __( 'We were unable to verify this request, please reload the page and try again.' ) ); 275 | } 276 | 277 | $data = json_decode( stripslashes( $_POST['data'] ), true ); 278 | 279 | $settings = array(); 280 | 281 | // We check that we were able to decode data. 282 | if ( ! is_array( $data ) ) { 283 | wp_die( __( 'Something went wrong!', 'postmark-wordpress' ) ); 284 | } 285 | 286 | // We validate that 'enabled' is a numeric boolean. 287 | if ( isset( $data['enabled'] ) && 1 === $data['enabled'] ) { 288 | $settings['enabled'] = 1; 289 | } else { 290 | $settings['enabled'] = 0; 291 | } 292 | 293 | // We validate that 'api_key' contains only allowed caracters [letters, numbers, dash]. 294 | if ( isset( $data['api_key'] ) && ( 1 === preg_match( '/^[A-Za-z0-9\-]*$/', $data['api_key'] || 'POSTMARK_API_TEST' === $data['api_key'] ) ) ) { 295 | $settings['api_key'] = $data['api_key']; 296 | } else { 297 | $settings['api_key'] = ''; 298 | } 299 | 300 | // We validate that 'stream_name' contains only allowed caracters [letters, numbers, dash]. 301 | if ( isset( $data['stream_name'] ) && ( 1 === preg_match( '/^[A-Za-z0-9\-]*$/', $data['stream_name'] ) ) ) { 302 | $settings['stream_name'] = $data['stream_name']; 303 | } else { 304 | $settings['stream_name'] = 'outbound'; 305 | } 306 | 307 | // We validate that 'sender_address' is a valid email address. 308 | if ( isset( $data['sender_address'] ) && is_email( $data['sender_address'] ) ) { 309 | $settings['sender_address'] = sanitize_email( $data['sender_address'] ); 310 | } else { 311 | $settings['sender_address'] = ''; 312 | } 313 | 314 | // We validate that 'force_from' is a numeric boolean. 315 | if ( isset( $data['force_from'] ) && 1 === $data['force_from'] ) { 316 | $settings['force_from'] = 1; 317 | } else { 318 | $settings['force_from'] = 0; 319 | } 320 | 321 | // We validate that 'force_html' is a numeric boolean. 322 | if ( isset( $data['force_html'] ) && 1 === $data['force_html'] ) { 323 | $settings['force_html'] = 1; 324 | } else { 325 | $settings['force_html'] = 0; 326 | } 327 | 328 | // We validate that 'track_opens' is a numeric boolean. 329 | if ( isset( $data['track_opens'] ) && 1 === $data['track_opens'] ) { 330 | $settings['track_opens'] = 1; 331 | } else { 332 | $settings['track_opens'] = 0; 333 | } 334 | 335 | // We validate that 'track_links' is a numeric boolean. 336 | if ( isset( $data['track_links'] ) && 1 === $data['track_links'] ) { 337 | $settings['track_links'] = 1; 338 | } else { 339 | $settings['track_links'] = 0; 340 | } 341 | 342 | // Validates that 'enable_logs' is a numeric boolean and creates table for storing logs. 343 | if ( isset( $data['enable_logs'] ) && 1 === $data['enable_logs'] ) { 344 | $settings['enable_logs'] = 1; 345 | // check if logs table exists, if not create it. 346 | pm_log_create_db(); 347 | } 348 | // Removes logs table if setting for logging is disabled. 349 | else { 350 | $settings['enable_logs'] = 0; 351 | postmark_log_remove_table(); 352 | pm_log_cron_deactivate(); 353 | } 354 | 355 | update_option( 'postmark_settings', wp_json_encode( $settings ) ); 356 | 357 | wp_die( 'Settings saved' ); 358 | } 359 | 360 | /** 361 | * Settings HTML. 362 | */ 363 | function settings_html() { 364 | include POSTMARK_DIR . '/page-settings.php'; 365 | } 366 | } 367 | 368 | /** 369 | * Creates a table for storing logs of send attempts. 370 | */ 371 | function pm_log_create_db() { 372 | 373 | global $wpdb; 374 | 375 | $table_name = $wpdb->prefix . 'postmark_log'; 376 | 377 | // Creates a logs table if it doesn't exist already. 378 | if ( $wpdb->get_var( "SHOW TABLES LIKE '$table_name'" ) != $table_name ) { 379 | 380 | $charset_collate = $wpdb->get_charset_collate(); 381 | 382 | $sql = "CREATE TABLE $table_name ( 383 | id INT(9) NOT NULL AUTO_INCREMENT, 384 | log_entry_date datetime DEFAULT '0000-00-00 00:00:00' NOT NULL, 385 | fromaddress text, 386 | toaddress text, 387 | subject text, 388 | response text, 389 | PRIMARY KEY id (id) 390 | ) $charset_collate;"; 391 | 392 | require_once ABSPATH . 'wp-admin/includes/upgrade.php'; 393 | 394 | dbDelta( $sql ); 395 | 396 | // Activates cron job for automatically purging old (7+ days) Postmark logs. 397 | pm_log_cron_activation(); 398 | 399 | } 400 | } 401 | 402 | /** 403 | * Schedules cron job for deleting old Postmark logs. 404 | */ 405 | function pm_log_cron_activation() { 406 | if ( ! wp_next_scheduled( 'pm_log_cron_job' ) ) { 407 | wp_schedule_event( time(), 'daily', 'pm_log_cron_job' ); 408 | } 409 | } 410 | 411 | // Attaches pm_clear_old_logs function to cron job hook. 412 | add_action( 'pm_log_cron_job', 'pm_clear_old_logs' ); 413 | 414 | /** 415 | * Deletes up to 500 Postmark logs at a time that are older than 7 days. 416 | */ 417 | function pm_clear_old_logs() { 418 | 419 | global $wpdb; 420 | 421 | $table_name = $wpdb->prefix . 'postmark_log'; 422 | 423 | // Checks if there are any logs older than seven days to delete. 424 | $rows_to_delete_count = $wpdb->get_var( 425 | $wpdb->prepare( 426 | "SELECT COUNT(*) 427 | FROM $table_name 428 | WHERE BINARY(%s) < BINARY(DATE_SUB(NOW(), INTERVAL %d DAY))", 429 | 'log_entry_date', 430 | 7 431 | ) 432 | ); 433 | 434 | // Deletes logs that are more than 7 days old, limited to 500 log deletions at a time to prevent locking up db. 435 | if ( $rows_to_delete_count > 500 ) { 436 | $rows_to_delete_count = 500; 437 | } 438 | 439 | if ( $rows_to_delete_count > 0 ) { 440 | 441 | $wpdb->query( 442 | $wpdb->prepare( 443 | "DELETE FROM $table_name 444 | WHERE BINARY(%s) < BINARY(DATE_SUB(NOW(), INTERVAL %d DAY)) 445 | LIMIT %d", 446 | 'log_entry_date', 447 | 7, 448 | $rows_to_delete_count 449 | ) 450 | ); 451 | 452 | // Check again for more logs to delete. 453 | pm_clear_old_logs(); 454 | } 455 | } 456 | 457 | /** 458 | * Unschedules Postmark logs cleanup cron job. 459 | */ 460 | function pm_log_cron_deactivate() { 461 | 462 | // Checks when the next cron job was scheduled for. 463 | $timestamp = wp_next_scheduled( 'pm_log_cron_job' ); 464 | 465 | // Unschedules upcoming cron job. 466 | wp_unschedule_event( $timestamp, 'pm_log_cron_job' ); 467 | } 468 | 469 | // Removes cron job for deleting old logs, if plugin is disabled. 470 | register_deactivation_hook( __FILE__, 'pm_log_cron_deactivate' ); 471 | 472 | // Creates logs table on activation, if it doesn't exist. 473 | register_activation_hook( __FILE__, 'pm_log_create_db' ); 474 | 475 | /** 476 | * Drops logs table (called when plugin is uninstalled). 477 | */ 478 | function postmark_log_remove_table() { 479 | global $wpdb; 480 | $table_name = $wpdb->prefix . 'postmark_log'; 481 | $sql = "DROP TABLE IF EXISTS $table_name"; 482 | $wpdb->query( $sql ); 483 | } 484 | 485 | // Removes logs table on uninstall. 486 | register_uninstall_hook( __FILE__, 'postmark_log_remove_table' ); 487 | 488 | if ( ! function_exists( 'wp_mail' ) ) { 489 | $postmark = new Postmark_Mail(); 490 | 491 | if ( is_array( $postmark->settings ) && ( 1 == $postmark->settings['enabled'] ) ) { 492 | include POSTMARK_DIR . '/wp-mail.php'; 493 | } 494 | } 495 | 496 | /** 497 | * Handle upgrades (build the logs db) for upgrades from versions prior to 1.10.1. 498 | * 499 | * @param [type] $upgrader_object Upgrader Object. 500 | * @param [type] $options Options. 501 | */ 502 | function pm_upgrade_completed( $upgrader_object, $options ) { 503 | 504 | $pm_plugin = plugin_basename( __FILE__ ); 505 | 506 | if ( 'update' === $options['action'] && 'plugin' === $options['type'] && isset( $options['plugins'] ) ) { 507 | 508 | foreach ( $options['plugins'] as $plugin ) { 509 | if ( $plugin == $pm_plugin ) { 510 | pm_log_create_db(); 511 | $postmark = new Postmark_Mail(); 512 | if ( isset( $postmark ) ) { 513 | $postmark->load_settings(); 514 | } 515 | } 516 | } 517 | } 518 | } 519 | 520 | add_action( 'upgrader_process_complete', 'pm_upgrade_completed', 10, 2 ); 521 | 522 | require_once 'includes/class-postmark-debug.php'; 523 | -------------------------------------------------------------------------------- /readme.txt: -------------------------------------------------------------------------------- 1 | === ActiveCampaign Postmark for Wordpress === 2 | Contributors: andy7629, alexknowshtml, mgibbs189, jptoto, atheken, prileygraham, dorzki 3 | Tags: postmark, email, smtp, notifications, wp_mail, wildbit 4 | Requires PHP: 7.0 5 | Requires at least: 5.3 6 | Tested up to: 6.7 7 | Stable tag: 1.19.1 8 | 9 | The *officially-supported* ActiveCampaign Postmark plugin for Wordpress. 10 | 11 | == Description == 12 | 13 | If you're still sending email with default SMTP, you're blind to delivery problems! ActiveCampaign Postmark for Wordpress enables sites of any size to deliver and track WordPress notification emails reliably, with minimal setup time and zero maintenance. 14 | 15 | If you don't already have a Postmark account, you can get one in minutes, sign up at https://postmarkapp.com 16 | 17 | Check out our video on how to set up the Postmark for WordPress plugin [here](https://postmarkapp.com/webinars/postmark-wordpress). 18 | 19 | == Installation == 20 | 21 | 1. Upload postmark directory to your /wp-content/plugins directory 22 | 2. Activate plugin in WordPress admin 23 | 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 https://postmarkapp.com 24 | 4. Verify sending by entering a recipient email address you have access to and pressing the "Send Test Email" button. 25 | 5. Once verified, then check "Enable" to override `wp_mail` and send using the Postmark API instead. 26 | 27 | == Frequently Asked Questions == 28 | 29 | = What is Postmark? = 30 | 31 | 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. 32 | 33 | = Will this plugin work with my WordPress site? = 34 | 35 | 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. 36 | 37 | = TLS Version Requirements/Compatibility = 38 | 39 | The Postmark API requires TLS v1.1 or v1.2 support. We recommend using TLS v1.2. 40 | 41 | 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. 42 | 43 | TLS 1.2 requires: 44 | 45 | - PHP 5.5.19 or higher 46 | - cURL 7.34.0 or higher 47 | - OpenSSL 1.0.1 or higher 48 | 49 | = Does this cost me money? = 50 | 51 | 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. 52 | 53 | = My emails are still not sending, or they are going to spam! HELP!? = 54 | 55 | No worries, our expert team can help. Just send an email to [support@postmarkapp.com](mailto:support@postmarkapp.com) or tweet [@postmarkapp](https://twitter.com/postmarkapp) for help. Be sure to include as much detail as possible. 56 | 57 | = Why should I trust you with my email sending? = 58 | 59 | Because we've been in this business for many 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. 60 | 61 | 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 62 | 63 | = How do I tag a message? = 64 | 65 | There are two ways to tag a message. 66 | 67 | 1. Set an X-PM-Tag message header, i.e. array_push( $headers, 'X-PM-Tag: PostmarkPluginTest' ); where you are calling wp_mail(). 68 | 69 | 2. Add a filter for 'postmark_tag' that hooks into a function that returns the tag you desire. 70 | 71 | Using the postmark_tag filter will override a tag set via message headers. 72 | 73 | = How do I add metadata to a message? = 74 | 75 | Add a filter for 'postmark_metadata' that hooks into a function which returns the array of metadata you wish to attach to a message. 76 | 77 | = Why aren't my HTML emails being sent? = 78 | 79 | 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. 80 | 81 | = How do I set environment specific Postmark plugin settings? 82 | 83 | You can optionally set the Postmark API Token, message stream, and default sending address by adding the following to your `wp-config.php` file: 84 | 85 | ``` 86 | define( 'POSTMARK_API_KEY', '