-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme.txt
482 lines (376 loc) · 22.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
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
=== BuddyPress Group Email Subscription ===
Contributors: dwenaus, boonebgorges, r-a-y
Description: Allow users to receive email notifications of group activity. Weekly or daily digests are available.
Tags: buddypress, bp, activities, activity, groups, group, emails, email, notifications, notification, subscribe, subscription, digest, summary
Requires at least: 3.2
Requires PHP: 5.3
Tested up to: 5.8
Stable tag: 4.0.1
== Description ==
This powerful plugin allows users to receive email notifications of group activity. Weekly or daily digests are available. Each user can choose how they want to subscribe to their groups.
Please note that this plugin requires BuddyPress, as well as the BuddyPress Groups and Activity components.
EMAIL SUBSCRIPTION LEVELS
There are 5 levels of email subscription options:
1. No Email - Read this group on the web
2. Weekly Summary Email - A summary of new topics each week
3. Daily Digest Email - All the day's activity bundled into a single email
4. New Topics Email - Send new topics as they arrive (but don't send replies)
5. All Email - Send all group activity as it arrives
DEFAULT SUBSCRIPTION STATUS
Group admins can choose one of the 5 subscription levels as a default that gets applied when new members join.
DIGEST AND SUMMARY EMAILS
The daily digest email is sent every morning and contains all the emails from all the groups a user is subscribed to. The digest begins with a helpful topic summary. The weekly summary email contains the topic titles from the past week by default. Summary and digest timing can be configured in the back end. (The admin can view a sample of the digests and summaries in the queue by going adding this to your url: mydomain.com/sum=1. This won't send emails just show what will be sent)
HTML EMAILS
The digest and summary emails are sent out in multipart HTML and plain text email format. This makes the digest much more readable with better links. The email is multipart so users who need only plain text will get plain text.
EMAILS FOR TOPICS I'VE STARTED OR COMMENTED ON (only available with BuddyPress legacy discussion forums)
Users receive email notifications when someone replies to a topic they create or comment on (similar to Facebook). This happens whether they are subscribed or not. Users can control this behaviour in their notifications page.
TOPIC FOLLOW AND MUTE (only available with BuddyPress legacy discussion forums)
Users who are not fully subscribed to a group (ie. maybe they are on digest) can choose to get immediate email updates for specific topic threads. Any subsequent replies to that thread will be emailed to them. In an opposite way, users who are fully subscribed to a group but want to stop getting emails from a specific (perhaps annoying) thread can choose to mute that topic. bbPress plugin users can utilize the "Subscribe" / "Notify me of follow-up replies via email" option.
ADMIN NOTIFICATION
Group admins can send out an email to all group members from the group's admin section. This feature is helpful to quickly communicate to the whole group, but it should be used with caution.
GROUP ADMINS CAN SET SUBSCRIPTION LEVEL
Group admins can set the subscription level for existing users on the group's "Admin > Manage Members" page - either one by one or all at once.
SPAM PROTECTION
To protect against spam, you can set a minimum number of days users need to be registered before their group activity will be emailed to other users. This feature is off by default, but can be enabled in the admin.
TRANSLATORS
- Brazilian Portuguese - www.about.me/dennisaltermann (or www.congregacao.net)
- Catalan - Sara Arjona Téllez
- Danish - Morten Nalholm
- Dutch - Anja werkgroepen.net/wordpress, Tim de Hoog
- Farsi - Vahid Masoomi http://www.AzUni.ir
- French - http://www.claudegagne-photo.com, Sylvain Ghysens
- German - Peter Peterson, Thorsten Wollenhöfer, Jörg Lohrer
- Hebrew - Iggy Pritzker
- Italian - Stefano Russo
- Japanese - http://buddypress.org/community/members/chestnut_jp/
- Lithuanian - Vincent G http://www.Host1Free.com
- Russian - http://www.viaestvita.net/groups/
- Spanish - Williams Castillo, Gregor Gimmy
- Swedish - Thomas Schneider, Joakim Hising
NOTE TO PLUGIN AUTHORS
If your plugin posts updates to the standard BuddyPress activity stream, then group members who are subscribed via 3. Daily Digest and 5. All Email will get your updates automatically. However people subscribed as 2. Weekly Summary and 4. New Topic will not. If you feel some of your plugin's updates are very important and want to make sure all subscribed members receive them, you can filter 'ass_this_activity_is_important' and return TRUE when $type matches your activity. See the ass_this_activity_is_important() function in bp-activity-subscription-functions.phpfor more info.
PLUGIN SUPPORTERS:
Major supporters: shambhalanetwork.org & commons.gc.cuny.edu
Other supporters: bluedotproductions.com
PLUGIN DEVELOPMENT
For bug reports or to add patches or translation files, please visit the [GES Github page](https://github.com/boonebgorges/buddypress-group-email-subscription/). Contributions are definitely welcome!
== Installation ==
1. Install plugin
2. Go to the front end and set your email options for each of your groups
3. On the group admin settings, set the default subscription status of existing groups
4. For groups with existing members, go to the bottom of the manage members tab to set all members to the default subscription
5. If emails are not being sent ensure that the activity component is turned on
== Screenshots ==
1. Email Options on settings page
2. Email Options on other group pages
3. Email Options in Group Directory
4. Sample Email (HTML emails in future versions)
5. Follow and mute links in group forum (only available with BuddyPress legacy discussion forums)
6. Send Email Notice to entire group (admin only)
7. Admin Settings
== Changelog ==
= 4.0.1 =
* Improved cleanup when a WP user is deleted.
* Avoid duplicate notifications when a bbPress topic or reply is reapproved by the admin.
* Timezone improvements.
* Improved compatibility with jQuery 3.x.
* Fix bug that could cause certain translatable strings not to be loaded in time.
* Improvements to avoid timeouts and other issues during async send batches.
* Improved formatting for digest content.
= 4.0.0 =
* Overhaul markup for subscription settings panel, for better responsiveness and accessibility.
* Fix bug that could cause incorrect information to be pulled for bp-groupblog activity items.
* Fix bug that can cause empty upload directories to be created in some cases.
* Allow BP email_type to be filtered.
* Introduce `bpges_force_immediate_admin_notice()`, allowing plugins to force admin-sent emails to go out to all members regardles of their subscription setting.
* Fix bug that caused duplicate notices in the case of updated group details.
* Improved handling of local times when building digest.
* Ensure that all non-public links in digest emails are wrapped in a login URL.
* Add ability to modify content-cleanup routine on a per-activity basis.
* Remove duplicate content filtering when sending admin notice.
* Improved compatibility with latest versions of BuddyPress.
* Add filter for just-in-time filtering of digest items on a per-user basis.
* Remove legacy bp-forums function checks.
* Improve CSS selectors in group settings radio buttons.
* Some hardening against potential CSRF attacks.
* Improved stylability for View links in digests.
= 3.9.4 =
* Fix bug that could trigger fatal errors in some upgrade situations.
= 3.9.3 =
* Improvements to the way that the 3.9 update admin notice is shown on Multisite.
* Improvements to user domain caching.
* Improved data cleanup when a user leaves a group or when user account is deleted.
* Improved behavior of email queue so that {ges.subject} tokens work properly in async send batches.
* Ensure that bp-groupblog emails can be sent with HTML content.
* Updated nl_NL translation.
= 3.9.2 =
* Improvements to CLI 3.9 migration tools.
* Improvements to the way that 3.9 migration admin notices are displayed
* Avoid fatal errors during activation when required BP components are not activated
= 3.9.1 =
* Improvements to 3.9 migration routine.
* Updated nl_NL translation.
= 3.9.0 =
* Move to a new system for storing subscription and digest data, for improved performance and scalability
* Improve the ?sum=1 debugging tool, with support for `user_ids` and `user_count` URL paramaters.
* Add the ability to log debugging information about outgoing messages, using the `BPGES_DEBUG` constant. See https://github.com/boonebgorges/buddypress-group-email-subscription/wiki/How-to-troubleshoot-missing-emails
* Require a form submission when clicking on the Unsubscribe link in email footers.
* Move to the wordpress.org translation infrastructure.
* Improve compatibility with new versions of PHP.
* Improve admin-facing notices when minimum requirements (BP components, PHP version) are not met.
* Localization improvements.
* Accessibility improvements for user settings interface.
* Fix bug that could prevent hidden activity items from being fetched when generating digest text.
= 3.8.2 =
* Improve logic in activation routine, to avoid fatal errors in cases where load order is non-standard.
= 3.8.0 =
* Drop support for PHP 5.2, and improve support for PHP 7.2.
* Allow group admin sections to be customized via theme templates.
* Add attachment links when generated by GD bbPress Attachments.
* Improved digest queue cleanup, so that items are only removed from the queue when they're actually added to a digest.
* Improved unsubscription on group leave/remove for better functionality with third-party automated group membership tools.
* Fix bug that caused users to be subscribed to groups when being banned.
* Improved filters for controlling digest vs immediate notifications on a per-user basis.
* Ensure that users set up to receive bbPress self-notifications receive notifications that match their digest preferences.
* Improved filters for login redirect URL.
* Improved filters for group subscriptions.
* Improvements to 'ass_digest_format_item_group' filter.
= 3.7.2 =
* Fix bug that could cause fatal errors when activating without BuddyPress.
* Improve data passed to filters.
* Fix invalid form markup.
* Introduce new filters for disabling "Email Notice" and "Welcome Email" sections
* Add CSS clases to HTML elements in digests.
* Improve handling of deleted activity items when generating digests.
* Fix some spelling errors.
* Improve handling of default subscription level filters.
= 3.7.1 =
* Fix incorrect activity comment permalinks in digest emails.
* Use login redirect links in digest emails, for improved navigation when not logged in.
* Improve compatibility with non-standard Multisite configurations.
* Improve compatibility with PHP 7.1+.
* Improve compatibility with BP 2.5+ function signatures.
* Improve HTML character encoding in digests.
= 3.7.0 =
* Add support for BuddyPress HTML emails, available since BuddyPress 2.5. (View the accompanying wiki article for more info - https://github.com/boonebgorges/buddypress-group-email-subscription/wiki/Email-Tokens)
* Reduce the amount of code loaded by GES on any given page.
* Fix issue with the email options popup being displayed automatically when changing the group filter or when clicking on a paginated link.
* Do not send email to a banned group member.
* Improve JavaScript event binding for better compatibility with AJAX page loading
* Pass user information to 'ass_welcome_email' filter.
* Add Catalan translation
* Admin menu moved to "Settings > BP Group Email Options" for those using BP 1.6+.
* Drop support for BuddyPress 1.2.
= 3.6.1 =
* Fix bug that could cause fatal error when sending digests in some cases.
* Improve appearance of "Get email updates" link in directories when using Twenty* themes.
* Add filter that enables JS/CSS assets to be loaded in custom locations.
* Update Swedish translation.
* Update German translation.
= 3.6.0 =
* Introduce `ass_generate_notification()`, a generic handler for sending notifications.
* Add Hebrew translation.
= 3.5.2 =
* Adds a filter to control whether a specific user should receive immediate email notification of a given item.
* Fixes bug that prevented users from saving the "No email" setting in some cases.
* Reorders the way the group extension is bootstrapped.
* Removes hardcoded reference to default group setting, in case this value is filtered by a plugin.
* Fix incorrect group link in digest emails.
= 3.5.1 =
* Localization improvements
* Fixes bug that could cause fatal error in some bbPress configurations
* Fixes bug that caused incorrect links in some digest emails
* Fixes bug that caused some email subscription settings not to be saved in some cases
= 3.5 =
* Fixes bug so that user no longer gets an email for their own group activity update
* Improved email content parsing, so that the URLs contained in links are not completely removed from the email
* Improved JavaScript and CSS asset loading, for better cache busting
* Fixed bug that caused email footer to be repeated multiple times in certain cases
* Better support for plugin white labelling & changed directory names
* Improved compatibility with the WP Better Emails plugin
* Update JS not to use deprecated jQuery.live()
* Improved compatibility with BuddyPress 2.2
* Better filters for customizing the format of digest emails, nav item visibility, and redirect URLs
= 3.4 =
* Reinstate bbPress "Subscribe" option in forum threads for group members not subscribed to "All Mail"
* Performance improvements in daily and weekly digests
* Add support to manage each group member's subscription in the WP admin dashboard's "Groups" backend interface (only in BP 1.8+)
* Improves redirect behavior for group notification links
* Use native BP user meta functions for better multi-network compatibility
* Fixes bug where users may have received other user's digests
* Fixes bug where group creator was not subscribed to the email setting selected during group creation
* Fixes bug where self-notifications may not have worked in some instances
* Fixes bug with quotes and apostrophes not being stripped from admin notices and welcome emails
= 3.3.3 =
* Updated nl_NL translation
= 3.3.2 =
* Updated nl_NL translation
* Updated de_DE translation
* Fixed some textdomains
= 3.3.1 =
* Fixes a bug that caused duplicate bbPress 2.x digest notifications
* Improved compatibility with PHP 5.4 and WP 3.5
= 3.3 =
* Better support for bbPress 2.x group forums
* Fixes Weekly Summary emails
* Improves redirect behavior in View links related to forum topics in private/hidden groups
* Added filters to digest content for improved customizability
* Improved behavior with BP_ENABLE_MULTIBLOG mode
= 3.2.3 =
* Fixes lame duplicate bug reintroduced in 3.2.2
* Updates Danish translation
= 3.2.2 =
* Fixes main site link in digest emails
* Breaks up email content cleanup for better control by plugins
* Abstracts activity_type checking into a separate function, for greater control by plugins and themes
* Disables topic subscription in bbPress 2.x when inside of a group, to avoid duplicate messages
= 3.2.1 =
* Fixes bug in the implementation of forum post digests
* Fixes backward compatibility issue with filters in forum reply and topic functions
= 3.2 =
* Rewrote digest emailer to use wp_mail(), for better compatibility with WP SMTP plugins
* Better compatibility with BP 1.5+ native functions
* Refactored forum notification function, to work around bugs related to double posts. Many thanks to r-a-y for his work on this
= 3.1.2 =
* Corrected a bug in the way digest links are constructed
* Added Lithuanian translation
= 3.1.1 =
* Improved styling of subscription settings popup on My Groups pages
* More attempts at improving the loading of JS and CSS across BP versions
= 3.1 =
* Added the ability to unsubscribe from single group notifications directly from the email without needing to be logged in. This is on by default. * Also added the ability to unsubscribe from all group email notifications. This feature needs to be enabled in the plugin admin page.
* Added a new group welcome email that gets sent out the moment someone joins a group - regardless of the email subscription setting. Edit this in the group admin -> email options.
= 3.0.1 =
* Fixes bug that may have caused deleted activity items to appear in digests in some cases
* Fixes some notices
= 3.0 =
* Adds filter for email digest CSS
* Rewrites digest logic for fewer bugs and greater efficiency
= 2.9.9 =
* Added Danish translation, new subject filters
= 2.9.8 =
* Fixes bug that prevented admin/manage-members/ action links from working
= 2.9.7 =
* More fixes for 1.5+ compatibility. Props king76
= 2.9.6 =
* Fixed a number of PHP notices
* Fixed the admin Send To Group functionality in BP 1.5+
= 2.9.5 =
* Added Farsi translation. Thanks, Vahid!
= 2.9.4 =
* Added additional filters to digest builder
= 2.9.3 =
* Added updated Spanish translation
= 2.9.2 =
* Fixed some syntax errors that may have caused problems with digest formatting
= 2.9.1 =
* Fixed bug that may have caused scripts and styles not to be loaded on BP 1.2.x
* Fixed some PHP notices
* Fixed bug that might have caused BPGES javascript to load before jQuery in some cases
= 2.9 =
* Full support for BuddyPress 1.5
* Code cleanup and normalization
= 2.8.7 =
* Tweaked email text so that contentless notifications don't get empty quotation marks
= 2.8.6 =
* Added simple activity item caching to digests to reduce database queries at digest time
* Fixed bug that caused hidden items not to be sent in digests
= 2.8.5 =
* Added better brazilian portuguese translation, improved error checking to see if user has email before emailing them
= 2.8.5 =
* Fixed bug introduced in latest BP version where when an group admin manually removes a group member in Group Admin -> Manage Members -> Remove from group, the user kept getting emails
* Added translation strings for the javascript mute/follow
* Minor code cleanup to how digest/summaries are stored
* Added Russian translation
* Added filter to digest subject line
* Fixed error where only site admins could send out instant emails and not group admins
= 2.8.4 =
* Added German Translation
= 2.8.3 =
* Fixed issue where activity updates had html in the email subject line
= 2.8.2 =
* Fixes Dashboard panel to be compatible with WP 3.1/BP 1.2.8 multisite. Also adds a helpful "settings saved" message to dashboard panel.
= 2.8.1 =
* Fixed issue when plugin was hiding new group activity update comments
= 2.8 =
* Group activity replies are now registered in the plugin and emailed/digested accordingly
* Users can now choose to get emails for posts they make (in their settings page)
* Useful filters were added - you can now add a header or footer to the digest emails
* Fixed a bug where group names were sometimes missing for private groups in the digest
* Fixed minor bug where people on weekly digest who followed a single topic don't get any emails
* Added swedish translation.
= 2.7.9 =
* Now translated in japanese, spanish, french, portuguese, italian and dutch. no changes to the code on this update.
= 2.7.8 =
* Internationalization bug finally fixed. Spanish and Italian now included. 'Email Options' is now translatable
= 2.7.7 =
* Internationalization bug fixed.
= 2.7.6 =
* The cron schedule is now fully fixed, thanks to gvvaughan. plus the plugin is now fully internationalized thanks to chestnut_jp.
= 2.7.5 =
* The plugin is now fully internationalized thanks to chestnut_jp! Please send other language po and mo files to [email protected] and i'll include them.
* load_plugin_textdomain is used also. NOTE: due to a bug in buddypress 1.2.6 users will not be able to see their notifications page (see here for a fix http://trac.buddypress.org/changeset/3375)
= 2.7.3 =
* Fixed bug where hidden groups would not have names in digest, added link to view digest queue in back end (add ?sum=1 to your url to see queue)
= 2.7.2 =
* Fixed bug causing wp_cron to misbehave
= 2.7.1 =
* Fixed bug where digests were not fired - the next digest will combine all missed ones.
* Fixed bug where edited topics were removed from digest, added note and link at end of users' notification settings pointing them to place they can edit their group subscriptions
= 2.7 =
* Major re-write to the digest code, implemented caching and drastically sped up processing, other minor changes.
* See (but not send) what is in the digest queue by visiting mydomain.com/sum=1
= 2.6.4 =
* Added 'change email options' link under each group in digest
= 2.6.3 =
* Rewrote the email sending so digest emails are read properly in Outlook.
* Added a link at bottom of digests to go to my groups to edit notification settings.
= 2.6.2 =
* Fixed sneaky bug where people who requested access to a private group were subscribed to default setting.
= 2.6.1 =
* Improves wording of join pull down menu, fix bad follow/mute link.
= 2.6 =
* Allow site admins to set the subscription level for all current users of a group (in manage members)
= 2.5.5 =
* Put back text domain, added more translation hooks
= 2.5.4 =
* Added css class names, fixed duplication in email display when sending New Topics email
= 2.5.2 =
* Fixed class name
= 2.5.1 =
* Fixed silly bug where "th" tag was not showing up in group forum directory to match the extra td tag for follow/mute. sorry for the delay.
= 2.5 =
* Fixed a bug where digest emails were cumulative. fixed bug where editing an item would resend the notification email.
* Added filter hooks to digest section
= 2.4.4 =
* Improved the "Follow this topic" text in New Topic subscription emails so the user knows they won't get replies and gives them instructions if they do.
= 2.4.3 =
* Added ability for group admins to change the subscription settings for users in their group. Added backend options to enable or disable this function.
* Also added backend options to enable group admin override emails.
= 2.4.2 =
* Fixed minor bug about leaving groups your not subscribed to
= 2.4.1 =
* Made daily digests and weekly summaries HTML/Plain text multipart emails
= 2.3.4 =
* Added quotes around topic name in emails and added setting status at bottom of emails
= 2.3.2 =
* Javascript fix for subscribe options. removed beta notice.
= 2.3 =
* Plugin finished and ready for public usage.
= 2.2 =
* Plugin complete re-write finished.
* Digest function added, plus too many features to list here.
= 2.1 =
* Group admins can set default subscription level
= 2.0 =
* Plugin totally re-written by Deryk Wenaus, with new structure and name
= 1.3 =
* Added support for topic-by-topic settings for forum notifications
= 1.2 =
* Tagged stable release.
* Added Boone Gorges as an author.
* Made "do a dance" installation step optional.
= 1.1 =
* Fixed directory rename causing white screen of death.
= 1.0 =
* Initial release. Please test and provide feedback. Not recommended for production sites.