MailArchive Application

Last modified by Thomas Mortagne on 2023/07/08 08:55

email_addAn application to manage a mail archive inside XWiki
Developed by

Jeremie Bousquet

0 Votes
LicenseGNU Lesser General Public License 2.1

Tested on XWiki Enterprise 4.4.1

Installable with the Extension Manager



This application allows to persist emails read from configured server(s) into XWiki pages.

  • This component is still in BETA stage
  • Use it with caution and expect big api breakages until version 1.0 is reached
  • This application is far from final and not everything works
  • When upgrading to next versions of this application you may have to purge all mails that were persisted as there might not be an automated migration procedure

If you still want to test take a look at it and maybe contribute to make the final version better. Please continue reading ! emoticon_smile


This application allows managing a mail archive into XWiki and offers the following possibilities:

  • ADMINISTRATE: configure connections to mail servers, mailing-lists, mail types, parameterize the way emails are stored and presented, etc.
  • OPERATE: based on what is configured, allows you to create loading sessions, automate them, debug them, etc.
  • CONSULT: for end-users, various screens allow to navigate loaded emails (something close to famous nabble, markmail, and so on...)
  • It is highly recommended that you read the Documentation before installing and using this application
  • This is not the kind of application that can be used without initial configuration, using only default values emoticon_wink
  • Currently this is really only an archive - there is no possibility to post a reply from the Mail Archive. It may be implemented in a (hopefully not too far) future.

The Design page can also be interesting reading and gives more details about the development progress and link to the JIRA project.

To know what is already implemented, what to expect to work and what is known not to work at all, please consult the release notes of each version below.


It would be too long to list all of the available screens, so here are some basic screenshots. You should consult the Documentation for more details.

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

  1. Log in the wiki with a user having Administration rights
  2. Go to the Administration page and select the Import category
  3. Follow the on-screen instructions to upload the downloaded XAR
  4. Click on the uploaded XAR and follow the instructions
  5. You'll also need to install all dependent Extensions that are not already installed in your wiki

Once the XAR file is imported proceed to MailArchive.Admin.

Release Notes





Known Issues on JIRA


First (beta) release:

  • What you can expect to WORK:
    • You should be able to configure servers, mailing-lists and mail types
    • You should be able to download emails and have them persisted in XWiki
    • You should be able to browse the archive, the topics, and the emails
  • What will NOT work:
    • Display of emails details/headers is broken
    • Statistics may be broken or feel unfinished
    • Some options/objects in administration part may not be saved when required, so you might have to use "edit objects" on conf pages to force saving of needed values
    • Sometimes, parsing of emails break depending on email content, so some mails may not be loaded properly
    • Loading UI is unfinished, and for now it's not possible to automate email loading using XWiki scheduler
    • TimeLine view does not work
    • The "Feeds Generator" does not use configured types, but a built-in list not matching anything useful. By the way, in fact, the "Feeds Generator" is mostly broken
    • See open issues in JIRA project
    • There may be quite a few others I don't know or remember ...


Dependencies for this extension (org.xwiki.contrib.mailarchive:xwiki-contrib-mailarchive-ui 0.2):

  • org.xwiki.contrib.mailarchive:xwiki-contrib-mailarchive-api 0.2
  • coldserenity:tabs-macro 1.0.1

Get Connected