-
Notifications
You must be signed in to change notification settings - Fork 8
/
readme.txt
339 lines (185 loc) · 10.6 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
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
=== Quick Mail ===
Contributors: brainiac
Tags: mail, email, comments, wp-cli, mailgun, sparkpost, attachment, sendgrid, accessibility, idn, multisite
Donate link: https://mitchelldmiller.com/donate
Requires at least: 4.6
Tested up to: 6.6
Requires PHP: 5.3
Stable tag: 4.1.9
License: MIT
License URI: https://github.com/mitchelldmiller/quick-mail-wp-plugin/blob/master/LICENSE
Quick Mail makes it easy to send email with attachments and shortcodes from your WP dashboard or command line. Reply privately to comments. Choose recipients from users or commenters. Multisite compatible. Includes powerful WP-CLI command.
== Description ==
>Quick Mail is the easiest way to send emails with attachments to WordPress users on your site, or to send private replies to comments.
== Features ==
* Send email with attachments and shortcodes from the WordPress dashboard or command line.
* Send private replies to comments.
* Select recipients from users or commenters.
* Compatible with multisite.
* Adds Quick Mail to the Tools menu and comment replies.
* Send a web page, file, or message from the command line with the quick-mail command for [WP-CLI](https://wp-cli.org/).
* Does not require the Gutenberg editor or REST API.
* Edit messages with [TinyMCE](https://codex.wordpress.org/TinyMCE) to add images, rich text, and shortcodes.
* Uses the sender's name and sets the reply-to address to the sender's address.
* Recognizes settings from [Mailgun](https://wordpress.org/plugins/mailgun/), [SparkPost](https://wordpress.org/plugins/sparkpost/) and [Sendgrid](https://github.com/frc/sendgrid-email-delivery-simplified/releases/latest) plugins.
* Attach multiple files from up to six directories (folders) to a message.
* Includes privacy options to help comply with [General Data Protection Regulation](https://en.wikipedia.org/wiki/General_Data_Protection_Regulation).
* [Banned domains](https://wheredidmybraingo.com/quick-mail-4-0-5-blocks-domains/): administrators can prevent users from sending mail to arbitrary domains.
= Learn More =
* [Follow development on Github](https://github.com/mitchelldmiller/quick-mail-wp-plugin/).
== Installation ==
= Automated =
* Install [Git Updater](https://github.com/afragen/git-updater) plugin to update Quick Mail from Github.
= Manual =
1. Download the plugin and unpack in your `/wp-content/plugins` directory.
2. Activate the plugin through the WordPress _Plugins_ menu.
= WP-CLI
* How to install and activate the latest version of Quick Mail with [WP-CLI](https://wp-cli.org/) :
`wp plugin install https://github.com/mitchelldmiller/quick-mail-wp-plugin/archive/master.zip --activate`
== Configuration ==
1. Visit the settings page at `Settings -> Quick Mail` to configure the plugin for your site.
2. Optional: Install [WP-CLI](https://wp-cli.org/#installing) to send mail from the command line.
3. Optional: Install [Mailgun](https://wordpress.org/plugins/mailgun/), [SparkPost](https://wordpress.org/plugins/sparkpost/) or [Sendgrid](https://github.com/frc/sendgrid-email-delivery-simplified/releases/latest) plugin to send reliable email.
4. Optional: Install experimental [Replace Quick Mail Sender](https://github.com/mitchelldmiller/replace-quick-mail-sender/releases/latest) plugin, to change administrator's credentials.
== Translators / Translations ==
* Quick Mail is not distributed with translations.
* A .pot file is included for new translators.
== Frequently Asked Questions ==
= Who can send mail? =
* Users must be able to [publish a post](https://codex.wordpress.org/Roles_and_Capabilities#publish_posts) to send an email. Minimum permission can be changed with a filter.
* WP-CLI: Only administrators can send mail with the `quick-mail` WP-CLI command.
= Who can send rich text messages? =
* User must have [Visual Editor enabled](https://codex.wordpress.org/Function_Reference/user_can_richedit) on their profile, to compose messages with the Visual Editor.
* Anyone can send HTML by pasting it into a message.
= Where Do I Find Sent Emails? =
* You should be able to find sent emails in your email account's Sent Mail folder.
* Delivery services like [Mailgun](https://www.mailgun.com/), [SparkPost](https://wordpress.org/plugins/sparkpost/) and [Sendgrid](https://sendgrid.com/) also provide this information.
= Selecting Recipients =
* Options to send mail to any user, or limit to users with first and last names on their profile.
* Users need permission to [list users](https://codex.wordpress.org/Roles_and_Capabilities#list_users), to view user list or change options. Minimum permission can be changed with an option or filter.
= Mail Delivery Services =
* Uses [Mailgun plugin](https://wordpress.org/plugins/mailgun/) settings for Administrators, if the plugin is activated, using `Override "From" Details` and [Mailgun API](https://documentation.mailgun.com/en/latest/api_reference.html).
* Uses [SparkPost plugin](https://wordpress.org/plugins/sparkpost/) settings for Administrator name and email address, if plugin is activated and `Overrides` for name and email are set.
* Option for administrators to use [Sendgrid API](https://sendgrid.com/solutions/sendgrid-api/).
= Sending Mail from Other Addresses =
* Install the [Replace Quick Mail Sender](https://github.com/mitchelldmiller/replace-quick-mail-sender/releases/latest) plugin, to change the Quick Mail sender's name and email address.
* NOTE: Other email plugins can change these settings.
= Privacy =
* Requires permission to use your email address.
* Requires permission to save email addresses. Saved addresses are cleared if permission option is changed.
= Limitations =
* Up to 12 manually entered recipients are saved in HTML Storage.
* Additional recipients can be either `CC` or `BCC` but not both.
* Up to 99 recipients for [Gmail](https://support.google.com/a/answer/166852), others.
* Multiple files can be uploaded from up to 6 folders (directories).
* "Uploads are disabled" on some mobile devices.
Some devices cannot upload files. According to [Modernizr](https://modernizr.com/download#fileinput-inputtypes-setclasses) :
> iOS < 6 and some Android version don't support uploads.
File uploads are disabled for ancient IOS 5 devices. Please [add a support message](https://wordpress.org/support/plugin/quick-mail) if uploads are disabled on your phone or tablet, so I can remove the upload button if your device is detected.
= Address Validation =
* Check recipient domain on manually entered addresses.
* International (non-ASCII) domains must be converted to [Punycode](https://tools.ietf.org/html/rfc3492) with [idn_to_ascii](http://php.net/manual/en/function.idn-to-ascii.php).
Unfortunately, `idn_to_ascii` is not available on all systems.
* "Cannot verify international domains because idn_to_ascii function not found"
This is displayed when Quick Mail cannot verify domains containing non-ASCII characters.
* [checkdnsrr](http://php.net/manual/en/function.checkdnsrr.php) is used to check a domain for an [MX record](https://en.wikipedia.org/wiki/MX_record).
An MX record tells senders how to send mail to the domain.
*This is not always accurate. Turn verification off if Quick Mail rejects a valid address.*
= Mail Errors =
* Quick Mail sends email with [wp_mail](https://developer.wordpress.org/reference/functions/wp_mail/).
`wp_mail` error messages are displayed, if there is a problem.
* You must provide at least one recipient email address.
`wp_mail` rejected an address. Seen when Quick Mail verification is off.
* "Invalid or blocked mail address."
You tried sending mail to a Banned Domain.
* Error: Invalid Role (WP-CLI error)
You tried sending mail to an unknown WordPress role. Use `wp list roles` to get role names.
= Incompatible Plugins =
* [Stop Emails](https://wordpress.org/plugins/stop-emails/)
Stop Emails displays:
> _To send emails, disable the plugin._
If you are using an email delivery service, you can ignore this message.
= Customizing Quick Mail =
* Add a filter to modify Quick Mail.
* Programmers can replace their credentials by adding a filter to `replace_quick_mail_sender`.
- What filters are available to modify Quick Mail?
`quick_mail_cli_attachment_message`
Replace default CLI attachment message.
`quick_mail_cli_attachment_subject`
Replace default CLI attachment subject.
`quick_mail_comment_style`
Replace quick mail comment style.
`quick_mail_reply_title`
Replace title for private comment reply on comments list.
`quick_mail_user_capability`
Replace minimum user capability.
`replace_quick_mail_sender`
Replace sender credentials. Expects associative array with values for `name` and `email`. See [Replace Quick Mail Sender](https://github.com/mitchelldmiller/replace-quick-mail-sender) plugin for examples.
== Screenshots ==
1. Selecting users on Quick Mail data entry form.
2. Multiple attachments from different folders (directories).
3. Selecting saved recipients.
4. Quick Mail options.
5. Full screen view.
6. Reply to comment.
7. User list with roles.
== Changelog ==
= 4.1.9 =
* Updated versions, readme.
* Tested with WordPress 6.2
= 4.1.6 =
* Fixed "empty needle" after banned addresses are cleared.
* Tested with WordPress 5.8.3.
= 4.1.5 =
* Replace commas with spaces on banned domains.
* Tested with WordPress 5.8.2.
= 4.1.4 =
* Added Update URI header for WordPress 5.8.
* Tested with WordPress 5.8.1.
= 4.1.3 =
* Fixed "empty needle" after new installation.
= 4.1.1 =
* Restored directory value for helper plugins.
* Tested with WordPress 5.7.
= 4.1.0 =
* Replaced file_get_contents, file_put_contents in WP-CLI command.
= 4.0.6 =
* Use cURL to check for a banned domain.
* Fixed bug converting international domain name to Punycode.
* Updated design to improve testing.
= 4.0.5 =
* Added option to reject arbitrary domains.
* New error message: Invalid or blocked mail address.
* Deprecated: Replacing QuickMail::$directory with constant QuickMail::DIRECTORY.
= 4.0.4 =
* Fixed jQuery TypeError on cc address validation.
* Updated readmes, license.
= 4.0.2 =
* Fixed jQuery Migrate 3.0 warnings.
= Earlier versions =
Please refer to changelog.txt for changes of previous versions.
== Upgrade Notice ==
= 4.1.9 =
* Upgrade optional.
= 4.1.6 =
* Upgrade recommended.
= 4.1.5 =
* Upgrade recommended.
= 4.1.4 =
* Upgrade recommended.
= 4.1.3 =
* Upgrade recommended.
= 4.1.1 =
* Upgrade recommended.
= 4.1.0 =
* Upgrade recommended.
= 4.0.6 =
* Upgrade recommended.
= 4.0.5 =
* Upgrade recommended.
= 4.0.4 =
* Upgrade recommended.
== License ==
Quick Mail is free for personal or commercial use. Please support future development with a [donation](https://mitchelldmiller.com/donate).
== Credits ==
Banner image by [Tumisu](https://pixabay.com/en/users/Tumisu-148124/).