This is the release notes for XWiki Commons, XWiki Rendering, XWiki Platform and XWiki Enterprise. They share the same release notes as they are released together and have the same version.

<insert description of release here>

New and Noteworthy (since XWiki <version - 1>)

Full list of issues fixed and Dashboard for <version>.

Mail Sender API Improvements

  • You can now specify the delay to wait between each mail being sent, in milliseconds. This is done to support mail throttling and not be considered a spammer by mail servers. For example if you wish to wait 10 seconds (if not specified the default is 8 seconds, which is 450 mails per hour), set the following in your xwiki.properties:
    mail.sender.sendWaitTime = 10000

    The configuration parameter can also be changed from the Mail Admin UI:

    sendmailwait.png

  • We now save both an error summary and a full error description when a mail fails to be sent when using the Database Mail Listener. This allows to see the full stack trace of the problem to more easily debug it.

    sendmailerror.png

  • The Mail Type is now displayed in the Mail Sender Status Admin UI:

    mailtype.png

  • The MailResult.isSent() API has been renamed to MailResult.isProcessed() to avoid thinking that it'll return true if all mails have been sent successfully. What it does is simply return true when all mails have been processed, whether they've been sent successfully or not.
  • A new scripting API has been added to set the mail type:
    $message.setType("Some type")
  • In the Mail Sender Status Admin UI we now only display mails sent by the current wiki unless we're on the main wiki.
  • The Mail Application doesn't require Programming Rights for installation anymore.
  • Account Validation email results are now saved and visible in the Mail Application.
  • Some new Mail Sender Storage script services have been added: ability to delete mail statuses for a single mail and for a whole batch, and ability to load mail statuses with criteria.
  • When messages are sent with the API they are now persisted locally before they are effectively sent, one by one. This means that even if XWiki crashes when mails are being sent, their statuses will be correctly displayed in the Mail Sender Status Admin UI and can be resent.
  • The Java API has been modified to use Strings in all places where it was previously using a UUID, in order to allow for change in unique id generation in the future.
  • The wiki is not displayed in the Mail Sender Status Admin UI

    mailwiki.png

     

Miscellaneous

<insert misc user stuff and important bug fix descriptions here in a list, when they are too small to warrant a section by themselves - Change the version in the URL below!>

See the full list of JIRA issues fixed in this release.

For Developers

<developer feature N>

<description of developer feature N>

Deprecated and Retired projects

<description of deprecated and retired projects>

Upgrades

The following dependencies have been upgraded:

  • <list libraries that have been upgraded>

Miscellaneous

  • it's now possible to provide metadatas to MacroContentParser#parse API

Translations

The following translations have been updated: 

Tested Browsers & Databases

Performances tests compared to <last super stable version>

<a summary of the comparison with latest super stable version>

More details on <link to the test report>.

Known issues

Backward Compatibility and Migration Notes

General Notes

When upgrading make sure you compare your xwiki.cfg, xwiki.properties and web.xml files with the newest version since some configuration parameters may have been modified or added. Note that you should add xwiki.store.migration=1 so that XWiki will attempt to automatically migrate your current database to the new schema. Make sure you backup your Database before doing anything.

Issues specific to XWiki <version>

<issues specific to the project>

API Breakages

The following APIs were modified since <project> <version - 1>:

<clirr output here>
Tags:
   

Get Connected