Release Notes for XWiki 6.4 RC 1

Version 19.1 by Pascal Bastien on 2015/01/12

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

<feature N>

<description of feature N>

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
    mail.sender.sendWaitTime = 10000

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


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


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


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


  • A "Wikis" category has been created in the administration, where the configuration have been moved and split in different sections:
    Left menuRight menu

Extension Manager incompatible exceptions

When trying to install an incompatible extension (i.e. you are running XWiki 6.2.4 and want to install FAQ Application 6.3), you are now displayed a proper error instead of having to read through the install log to understand what went wrong, and you are instructed to use the Description > Stable Versions section to manually (for now) find a compatible version of the extension that you want to install.



  • A click to the Document Index does not leads to an other space anymore.
  • Tag Cloud Macro has now a new parameter (spaces) to display a tags cloud from multiple spaces.

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>


The following dependencies have been upgraded:

  • <list libraries that have been upgraded>


  • You can now control in which order the sections added via the ConfigurableClass are displayed in the administration.
  • New APIs to generate unescaped display user name:
    • com.xpn.xwiki.XWiki#getPlainUserName(DocumentReference userReference, XWikiContext context)
    • com.xpn.xwiki.XWiki#getUserName(DocumentReference userReference, String format, boolean link, boolean escapeXML, XWikiContext context)
    • com.xpn.xwiki.api.#getPlainUserName(DocumentReference userReference)
  • New script oriented APIs to get document author/contentAuthor/creator as DocumentReference


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, and web.xml files with the newest version since some configuration parameters may have been modified or added. Note that you should add 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>

Get Connected