-
Notifications
You must be signed in to change notification settings - Fork 24
/
readme.txt
264 lines (175 loc) · 9.88 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
=== WP Better Emails ===
Donate link: https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=7Q49VJQNRCQ8E&lc=FR&item_name=wp-better-emails&item_number=wp%2dbetter%2demails¤cy_code=EUR&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHosted
Tags: email, emails, html emails, templates, notification, wp_mail, wpmu, multisite, html template
Requires at least: 4.8
Tested up to: 5.5.1
Stable tag: 0.4
Adds a customizable good looking HTML template to all WP default text/plain emails and lets you set
a custom sender name and email address.
== Description ==
All emails from Wordpress (lost password, notifications, etc.) are sent by default in text/plain format. WP Better
Emails wraps them with a much better looking customizable **HTML email template** and lets you also set your own **sender name** and **email address**.
* WP Better Emails comes with a default simple and clean template that has been tested on various and popular email clients
like Gmail, Yahoo Mail, Hotmail/Live, AOL, Outlook, Apple Mail and many more. This to ensure your emails will always display
nicely in your recipient mailbox. But you can of course design your own.
* WP Better Emails lets you send sample emails to test and preview your own custom HTML email template.
* Watch your HTML email template during editing with the live preview.
* Fancy HTML editor with CodeMirror syntax highlighting.
* Supports WpMandrill plugin
* All emails sent by this plugin are sent as 'multipart' so that email clients that don't support HTML can read them.
* Include some dynamic tags in your template such as your blog URL, home URL, blog name, blog description, admin email or date and time. They will all be
replaced when sending the email.
* Add your own tags with Wordpress filters (see [FAQ](http://wordpress.org/extend/plugins/wp-better-emails/faq/) for usage).
* The default template is included as an HTML file in the plugin folder, feel free to edit it with your favorite editor.
* Clean uninstall process, doesn't leave some useless data in your database when deleted, you can easily give it a try !
= Example usages : =
* Brand your emails to your website or client website
* Add some ads/sponsored links to every email sent with wordpress
* Include some banners to promote a special event or feature of your website
= Internationalization =
WP Better Emails is currently available in :
* English
* French
* German - [Robert Tremmel](http://roberttremmel.de/ "Robert Tremmel")
* Hebrew - [Avi Ben-Avraham](mailto:[email protected] "Avi Ben-Avraham")
* Turkish - [Ãœnsal Korkmaz](http://www.unsalkorkmaz.com/ "Ãœnsal Korkmaz")
* Italian - [Fabio Lelli](http://www.synaestesia.com/ "Fabio Lelli")
* Arabic - [Yaser Maadan](http://www.englize.com/ "Yaser Maadan")
* Simplified Chinese - [Will Yuan](http://yslove.net/ "Will Yuan")
* Brazilian portuguese - [Johnny Bauer](mailto:[email protected] "Johnny Bauer")
* Russian - Vsevolod Bauer
* Farsi
* Indonesian
* Spanish - [Kaled Kelevra](http://howly-mowly.com/ "Kaled Kelevra")
* Swedish - [Andréas Lundgren](http://adevade.com/ "Andréas Lundgren")
* Dutch - [Paul Romijn](http://www.bluecloudcompany.com/)
* Slovenian - Primož Troha
* Vietnamese - Tim N.
I'm looking for translators to extend to other languages. If you have translated the plugin in your language or want to,
please let me know : wpbetteremails [ at ] helloni.co
= Support =
This plugin is free and developed on my spare time. Please consider reading the [FAQ](https://wordpress.org/plugins/wp-better-emails/faq/) and the [support guide](https://wordpress.org/support/topic/support-guide-read-me-before-posting?replies=1) before posting new topics. Many of them have already been resolved.
= Contributing =
WP Better Emails is also available on [GitHub](https://github.com/nlemoine/WP-Better-Emails).
= Credits =
[CodeMirror](http://codemirror.net/ "CodeMirror") library
== Installation ==
1. Extract and upload the `wp-better-emails` folder to the `/wp-content/plugins/` directory
2. Activate the plugin through the 'Plugins' menu in the WordPress admin panel
3. (Optional) Set a sender email and name, if none, wordpress defaults will be used : '[email protected]' and 'Your Blog Title'
4. (Optional) Edit your own email template. See the screenshot tab to have a look at the default template
5. Every email going out from your Wordpress Blog (notifications, lost password, etc.) looks better now !
== Upgrade Notice ==
If you're using the default template provided with WP Better Emails, you should delete the plugin and reinstall it to make sure you have the lastest template improvements.
If you have customized the HTML template and want to keep it, just update.
= Manual update =
1. Delete the plugin `wp-better-emails` folder under the `/wp-content/plugins/` directory
2. Upload the last version and activate it
= Automatic update =
Just use the Wordpress automatic plugin update system
== Frequently Asked Questions ==
= What if recipient can't read HTML emails ? =
WP Better Emails sends all emails in both formats ('multipart', i.e. HTML and plain text) so that emails can be displayed in every email client.
= Why are the emails still sent in plain text format ? =
Be sure to include the **%content%** tag in your template. WP Better Emails wrap the content with the template, if no tag
is found, sending HTML emails is automatically desactivated.
= How does WP Better Emails interact with others plugins ? =
WP Better Emails wraps every "text/plain" email sent with the Wordpress function `wp_mail()`.
= I totally messed up with the template, how can I get the original one ? =
Just delete and reinstall the plugin from the admin panel.
= I'm using SB Welcome Editor and emails have no template =
WP Better Emails only wraps "text/plain" emails. By default, SB Welcome Editor sends email as HTML, with no style but as "text/html". Be sure to set the SB Welcome Editor format option to "text".
= How can I add my own tags ? =
You can filter the tags array and add your replacements. Let's say you want to randomly display some sponsored links somewhere in your email template:
add_filter('wpbe_tags', 'add_my_tags');
function add_my_tags( $tags ) {
$ads = array('<a href="#">Sponsored link 1</a>', '<a href="#">Sponsored link 2</a>', '<a href="#">Sponsored link 3</a>');
$tags['sponsored_link'] = $ads[array_rand($ads, 1)];
return $tags;
}
The key of the array `sponsored_link` will be a new tag (`%sponsored_link%`) you can include. It will be randomly replaced with one of your sponsored links.
The example above is taking sponsored links as an additinonal content but you can imagine anything like including lastest posts, a quote of the day or whatever.
You can place this function in your functions.php theme file or in a plugin.
= Do you provide hooks to alter some WP Better Emails behaviors? =
* wpbe_html_body (filter) will let you apply your own logic on HTML emails
* wpbe_plaintext_body (filter) will let you apply your own logic on plain text emails
* wpbe_convert_line_breaks (filter) will let remove line breaks conversion
* wpbe_convert_urls (filter) will let you remove links conversion
== Screenshots ==
1. The default template provided with WP Better Emails. Tested on many email clients like Gmail, Yahoo!, Live/Hotmail, etc.
2. WP Better Emails settings screen with the default WP TinyMCE editor.
3. Editor in source mode using CodeMirror syntax highlighting.
4. Live preview your template in a thickbox.
5. Help tab with information about available tags.
== Changelog ==
= 0.4 =
* Fix deprecation notices
* Fix TinyMCE plugins
* Remove live preview
= 0.3 =
* Add proper multisite support: options are saved network wide
* Remove strip_tags from message as it deletes password retrieve link from lost password email (see: https://wordpress.org/support/topic/password-reset-url-in-plain-version-password-reset-emails-not-showing?replies=3)
* Improve from name and email, they are only set when default email is used
* Fix help tab link
* Add new filters to control converting line breaks to `br` tags and URls to links
= 0.2.8 =
* Added translation: Vietnamese
* Fixed bug in plain text email. See: https://wordpress.org/support/topic/content-in-plain-message-empty?replies=4
= 0.2.7 =
* Added translation: Slovenian
* Fixed bug in Dutch translation. See: https://wordpress.org/support/topic/saving-changes-to-the-email-template
* Added support for WpMandrill. See: https://wordpress.org/support/topic/plug-in-does-not-sent-html-mail-only-text
= 0.2.6.6 =
* Added translation: Dutch
= 0.2.6.5 =
* Fixed editor (WordPress 3.9 compatibility issue)
* Added translation: Swedish
= 0.2.6.4 =
* Fixed live preview feature
= 0.2.6.3 =
* Added translation: Spanish
= 0.2.6.2 =
* Added translation: Indonesian
* Fixed translation: Arabic, Farsi
= 0.2.6.1 =
* New translation: Farsi
* New translation: Russian
* Updated transaltion: German
= 0.2.6 =
* Fixed options not recording on activation
= 0.2.5 =
* Added plain text template support
* Fixed phpmailer_init action
* Added Brazilian portuguese translation
= 0.2.4.1 =
* Lower HTML filter priority to make the plugin more compatible with other plugins (Woocommerce, etc.)
* Simplified Chinese, Italian, Arabic translations added
= 0.2.4 =
* Fixed TinyMCE role issue
= 0.2.3 =
* Fixed 3.3 beta compatilibity
* Fixed 3.3 help panel trigger
= 0.2.2 =
* Added 3.3 compatibility
* Added Turkish translation
= 0.2.1 =
* Editor role bug fix
* Template centering fix
= 0.2 =
* WP TinyMCE editor support
* HTML editor with CodeMirror as a TinyMCE plugin
* Live preview (> WP 3.1)
* Include filter to add your own tag replacements
* Help moved to contextual help
* Added translations for german, hebrew
* Improved template email clients support
= 0.1.3 =
* Sender email and name are now optional
* Fixes replacing URLs of plain text content to handle https protocol
= 0.1.2 =
* Added 3.1 compatibility
* Dutch translation
= 0.1.1 =
* Added French translation
= 0.1 =
* WP Better Emails first release