[JAMES-2699] Deprecation without documentation

• Type: Bug
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 3.4.0
• Fix Version/s: 3.3.1
• Component/s: Matchers/Mailets (bundled)
• Assignee: Unassigned
• Reporter: Amichai Rothman
• Created: 25/Mar/19 10:04
• Updated: 01/Apr/19 17:16
• Resolved: 01/Apr/19 15:39

Description

In the current Mailet API there are many deprecated classes and methods marked with the @Deprecated annotation and some also with the @deprecated javadoc tag. However, very few of these have any related documentation on what to use instead, or at least why it is deprecated if there is no alternative. As it is, someone using or implementing the API has no idea what the migration path should be to avoid using these deprecated APIs which may disappear in the future.

Please document all deprecations, most importantly with what is the recommended way to migrate away from them.

This may be true for other modules as well, but certainly is in this central API.