This XenForo 2.0 addon sends a daily or weekly email to users with a list of top new threads and top updated threads. ( XF v2.0.6 minimum )
Configuration settings :
A test tool is included to validate settings and to send test emails :
Users can set their preferred email delivery period, daily or weekly (or none!) :
Example email (Thunderbird) ... note that my forum is called "XenForo Test (2.0.6)" - this will show your forum name
... unsubscribe links are fully supported.
Example email (Gmail on Android) :
Version 4.1.0 update :
New features :
added an admin interface to edit user preference
number of threads to send is now configurable
number of emails to send in test mode is now configurable to avoid flooding
option to send digest emails to all users, not just recently active users
option to exclude discouraged users from receiving digest emails
Bug fixes :
fixed font awesome icon
fixed some hard-coded strings which should have been phrases.
Version 4.1.1 bugfix : fixes some missed phrases.
Version 4.1.2 bugfix : bugfix: wrong visibility on function userSaveProcess.
Version 5.0.0 major update :
Major new release - completely rewritten for compatibility with both XF 2.1 and 2.2
Version 5.0.1 bugfix : missing use statement in XF\EmailUnsubscribe\Processor.
Version 5.0.2 bugfix : was trying to filter new or updated threads even if none were found
Version 5.0.3 Critical Bugfix :
Critical bugfix release - all users of v5.x should update to this version immediately
rewrite job to fix some logic issues
fix repo query which wasn't counting users the same way that we were selecting them
remove redundant PreferenceFieldId helper class - field no longer used
remove redundant listener function - has been moved to adapter addon
Version 5.0.3a : No changes to functionality - but I removed all of the testing code from the release package.
There is no need to install this version if you already have v5.0.3 installed - it won't fix the problem and there is no new code.
If you have already installed 5.0.3 and you want to clean up the additional files, you can safely remove the following files and directories under
The upgrade process doesn't delete the additional files, but it won't do any harm to leave them there.
Version 5.0.4 bugfix : Fixed typo in XF\EmailUnsubscribe\Processor::applyUserUnsubscribeAction - thanks to @Mouth for finding the bug !
Version 5.0.5 bugfix :
- The test tool was not respecting the exclude forums list from the options - that is now fixed.
- Note that this bug did not affect the emails sent to users - that did use the exclude forums list correctly.
XenForo 2.2.14 adds new functionality for adding one-click unsubscribe headers to emails. Unfortunately, the code released in 2.2.14PL2 breaks functionality by removing a core option.
This release of WND fixes the errors by relying on XF 2.2.14 to set the headers for us - which should work in the majority of cases.
Note: if you are not planning to upgrade to XF 2.2.14 yet, I recommend you do not install v5.0.6 of this addon. Installing 5.0.6 with XF 2.2.13 or earlier won't break anything - but the one-click unsubscribe headers won't be added to your digest emails, which is not ideal.
So I currently recommend:
Configuration settings :
A test tool is included to validate settings and to send test emails :
Users can set their preferred email delivery period, daily or weekly (or none!) :
Example email (Thunderbird) ... note that my forum is called "XenForo Test (2.0.6)" - this will show your forum name
... unsubscribe links are fully supported.
Example email (Gmail on Android) :
Version 4.1.0 update :
New features :
added an admin interface to edit user preference
number of threads to send is now configurable
number of emails to send in test mode is now configurable to avoid flooding
option to send digest emails to all users, not just recently active users
option to exclude discouraged users from receiving digest emails
Bug fixes :
fixed font awesome icon
fixed some hard-coded strings which should have been phrases.
Version 4.1.1 bugfix : fixes some missed phrases.
Version 4.1.2 bugfix : bugfix: wrong visibility on function userSaveProcess.
Version 5.0.0 major update :
Major new release - completely rewritten for compatibility with both XF 2.1 and 2.2
- bugfix: admin edit fields weren't appearing in the correct place
- bugfix: admin edits weren't being saved
- update: now uses a job to find users and queue emails
- update: list unsubscribe header now gets added to outbound email
- update: in test mode the prefix [Test] is added to the subject line
- update: better support for processing user unsubscribes
- update: SparkPost support now moved to a separate addon so we can support XF 2.2
- update: tested on XF 2.2
- feature: option to honour the Receive admin emails setting
- feature: support for monthly digest emails
- feature: widget to encourage users to opt in to digest emails
- feature: add any HTML to the top or bottom of emails
- the default option is now to honour the "Receive new and update emails" option in user preferences. You will need to turn this off in the settings to retain the previous behaviour.
- if you use either of my SparkPostMail addons (v1.x or v2.x), you must install the What's New Digest adapter for SparkPost addon - some integration functionality has been removed from this addon to the separate adapter addon to maximise compatibility across XF versions.
Version 5.0.1 bugfix : missing use statement in XF\EmailUnsubscribe\Processor.
Version 5.0.2 bugfix : was trying to filter new or updated threads even if none were found
Version 5.0.3 Critical Bugfix :
Critical bugfix release - all users of v5.x should update to this version immediately
rewrite job to fix some logic issues
fix repo query which wasn't counting users the same way that we were selecting them
remove redundant PreferenceFieldId helper class - field no longer used
remove redundant listener function - has been moved to adapter addon
Version 5.0.3a : No changes to functionality - but I removed all of the testing code from the release package.
There is no need to install this version if you already have v5.0.3 installed - it won't fix the problem and there is no new code.
If you have already installed 5.0.3 and you want to clean up the additional files, you can safely remove the following files and directories under
src/addons/Hampel/WhatsNewDigest/...:
composer.json
composer.lock
phpunit.xml
tests/
vendor/
The upgrade process doesn't delete the additional files, but it won't do any harm to leave them there.
Version 5.0.4 bugfix : Fixed typo in XF\EmailUnsubscribe\Processor::applyUserUnsubscribeAction - thanks to @Mouth for finding the bug !
Version 5.0.5 bugfix :
- The test tool was not respecting the exclude forums list from the options - that is now fixed.
- Note that this bug did not affect the emails sent to users - that did use the exclude forums list correctly.
XenForo 2.2.14 adds new functionality for adding one-click unsubscribe headers to emails. Unfortunately, the code released in 2.2.14PL2 breaks functionality by removing a core option.
This release of WND fixes the errors by relying on XF 2.2.14 to set the headers for us - which should work in the majority of cases.
Note: if you are not planning to upgrade to XF 2.2.14 yet, I recommend you do not install v5.0.6 of this addon. Installing 5.0.6 with XF 2.2.13 or earlier won't break anything - but the one-click unsubscribe headers won't be added to your digest emails, which is not ideal.
So I currently recommend:
- XF <= 2.2.13, you remain on WND 5.0.5
- XF >= 2.2.14, install WND 5.0.6
- update helper_account template modification to work with both XF2.3 and earlier versions
- listen for sparkpostmail_non_transactional_stop_map event and use the whatsnewdigest email stopper
- tweak unsubscribe confirmation message
- separate out getMail function so we can over-ride it and add functionality
Attachments
-
Hampel-WhatsNewDigest-4.0.3.zip36.3 KB · Views: 0
-
Hampel-WhatsNewDigest-4.1.2.zip37.2 KB · Views: 0
-
Hampel-WhatsNewDigest-5.0.2.zip39.3 KB · Views: 0
-
Hampel-WhatsNewDigest-5.0.3.zip2.7 MB · Views: 0
-
Hampel-WhatsNewDigest-5.0.3a.zip39.1 KB · Views: 0
-
Hampel-WhatsNewDigest-5.0.4.zip39.2 KB · Views: 0
-
Hampel-WhatsNewDigest-5.0.5.zip39.2 KB · Views: 0
-
Hampel-WhatsNewDigest-5.0.6.zip39.2 KB · Views: 0
-
Hampel-WhatsNewDigest-5.1.0.zip39.6 KB · Views: 0