xF2 Add-on What's New Digest 5.0.6

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

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.

Fixed typo in XF\EmailUnsubscribe\Processor::applyUserUnsubscribeAction - thanks to @Mouth for finding the bug!

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.

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

• bugfix: was trying to filter new or updated threads even if none were found

5.0.1 bugfix

• bugfix: missing use statement in XF\EmailUnsubscribe\Processor

Thanks to @Wutime for finding and reporting this bug!

v5.0.0b bugfix

• Fixed a bug with the display of HTML in emails

v5.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

Important breaking changes:

1. 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.
2. 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.

bugfix: wrong visibility on function userSaveProcess

Click to expand...