-
Notifications
You must be signed in to change notification settings - Fork 4
/
readme.txt
195 lines (134 loc) · 6.17 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
=== Stop Emails ===
Contributors: salcode
Tags: email, development
Requires at least: 3.6
Tested up to: 5.7
Stable tag: 1.2.1
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Stop all outgoing emails sent from WordPress.
== Description ==
Stops outgoing emails sent from WordPress. This plugin stops
outgoing emails generated by WordPress core, plugins, and themes.
Emails sent using the `wp_mail()` function, will not be sent.
In the case where an author does not use the recommended `wp_mail()`
function and instead sends the email using another mechanism, an email will
still be sent.
This plugin allows you to suspend sending emails when doing development work.
Any calls to `wp_mail()` will fail silently. WordPress
will operate as if the email were sent successfully
but no email will actually be sent.
On the admin menu page Settings > Stop Emails, there is the option
to log all emails to the PHP error log. By default this logging is
disabled.
NOTE: If using the PHP `mail()` function directly, this
plugin will NOT stop the emails.
Built by [Sal Ferrarello](http://salferrarello.com/) / [@salcode](http://twitter.com/salcode)
== Installation ==
1. Install plugin from WordPress plugin repository http://wordpress.org/plugins/
2. Activate Stop Emails through the 'Plugins' menu in WordPress.
= Manual Installation =
1. Upload the entire `stop-emails` directory to the `/wp-content/plugins/` directory.
2. Activate Stop Emails through the 'Plugins' menu in WordPress.
= mu-plugin Installation =
1. If the directory `wp-content/mu-plugins/` does not exist, create it.
2. Upload the single file `stop-emails.php` to the `wp-content/mu-plugins/` directory
== Frequently Asked Questions ==
= Where do the emails go? =
The emails are lost forever.
= Why are some of my emails still being sent? =
Most likely, this is due to a plugin you have running.
There are two different things the plugin could be
doing to cause emails to still be sent.
1. The plugin is overriding our overriding of the sending mechanism.
2. The plugin is calling the PHP function `mail()` directly.
Unfortunately in either of these cases, this plugin will not be able to stop
the email.
= Known Incompatible Plugins? =
A list of Known Incompatible Plugins is available at [https://github.com/salcode/stop-emails/wiki/Known-Incompatible-Plugins](https://github.com/salcode/stop-emails/wiki/Known-Incompatible-Plugins).
= I want to log the emails that are stopped =
You can enable logging of stopped emails on the
admin menu page Settings > Stop Emails.
Emails will be logged to your PHP error log.
= Why would I want install in the mu-plugins directory? =
Activating a plugin normally requires logging into the site.
Installing the file in the mu-plugins directory allows you to
activate the plugin without logging in. This can be
helpful when setting up an existing site locally.
= Where can I report a bug? =
Please report bugs at https://github.com/salcode/stop-emails/issues
== Screenshots ==
1. When the plugin is running, there will be a warning on the backend of the website.
1. Lies! The email wasn't really sent, we're running Stop Emails
== Changelog ==
= 1.2.1 =
* Conditionally modify how our fake PHPMailer extends the real PHPMailer class based on changes in PHPMailer introduced in WordPress core 5.5. This eliminates the message "PHP Deprecated: class-phpmailer.php is deprecated since version 5.5.0!" in the error logs.
= 1.2.0 =
* Add filter to force BuddyPress to use wp_mail() rather than its own BP_PHPMailer class
= 1.1.0 =
* Add Italian translation (it_IT), thanks to Andrea Gherardi https://twitter.com/ilghera_TP
= 1.0.1 =
* No changes to code functionality
* "Tested Up To:" version bump to 4.2
* Update to readme.txt to more clearly communicate plugin functionality
* Version bump to 1.0.1
= 0.8.0 =
* Overhaul of plugin includes: fixing issue with plugin not stopping emails, moving to a class structure, changing email stopping
behavior to use the same technique as WordPress core tests, improved inline documentation,
addtion of phpunit tests. Introduces a breaking change with https://github.com/salcode/stop-emails-logger
= 0.7.1 =
* Added check for supporting files before loading them. Since the primary functionality
is in stop-emails.php, adding this check allows stop-emails.php to be used in the
mu-plugins/ directory (previously, it would throw warnings)
= 0.7.0 =
* Added filter fe_stop_emails_log to allow other logging of blocked emails
= 0.6.2 =
* "Tested Up To:" version bump to 4.0
* Add plugin icons
= 0.6.1 =
* "Tested Up To:" version bump to 3.9
* Add Settings link to plugin page
= 0.6.0 =
* Add admin settings page with option to enable logging of stopped emails to
PHP error log
= 0.5.0 =
* Correct breaking change
= 0.4.0 =
* Add Spanish translation (es_ES), thanks to Andrew Kurtis from webhostinghub.com
= 0.3.0 =
* Added support for localization
= 0.2.0 =
* Added filter `fe_stop_emails_log_email` for $log_email value, which allows a programmer to add code to
log the blocked emails in the php_error.log
* Renamed functions and classes to follow WordPress standards
= 0.1.0 =
* First release
== Upgrade Notice ==
= 1.2.0 =
* Add filter to stop BuddyPress emails, previously not all were stopped
= 1.1.0 =
Add Italian translation
= 1.0.1 =
No code changes. Documentation update, "Tested To" update, and version bump to 1.0 based on future release plans.
= 0.8.0 =
Important - fixes issues with plugin not Stopping Emails.
= 0.7.0 =
Minor update that adds support for extended logging. See [Stop Emails Logger](https://github.com/salcode/stop-emails-logger).
= 0.6.2 =
Minor update. "Tested to" version bump to 4.0 and added plugin icons
= 0.6.1 =
Minor update. "Tested to" version bump to 3.9 and settings link added to plugins page
= 0.6.0 =
Add admin Settings > Stop Emails page with option to log stopped emails in PHP error log.
= 0.5.0 =
Important - fixes breaking change in 0.4.0
= 0.4.0 =
Add Spanish translation (es_ES)
= 0.3.0 =
No significant change in functionality.
Added support for localization but no additional languages added.
= 0.2.0 =
No significant change in functionality.
Primary motivation for update was to change "Tested Up To:" value to 3.8
= 0.1.0 =
First Release