Mail Archive Operations Guide

Last modified by Jeremie Bousquet on 2012/09/14 13:46

Failed to execute the [velocity] macro. Cause: [The execution of the [velocity] script macro is not allowed in [extensions:Extension.Mail Archive Operations Guide]. Check the rights of its last author or the parameters if it's rendered from another script.]. Click on this message for details.

Manual loading

Browse to page MailArchive.Loading.

MA_OP_Manual_1.png

This page lists defined servers, and allows you to setup some loading parameters, check connections, load emails, or swith some server state. 

Loading Parameters

  • Max number of emails to load: only this number of emails will be loaded during a session, even if more are available.
  • Debug mode: option for debugging, useful for first tries or in case of error. Will increase log levels for mail archive components, and will store each email in a .eml file in server startup folder (again, careful with disk space on server !)
  • Simulate: option for simulation mode, useful for first tries. Will do everything during a loading session, except creating pages in xwiki for topics and emails.
  • Load all mails: by default only mails with "unread" flag will be treated, with this option all mails will be taken into account.
  • Focus on recent mails: will treat more recent mails in priority.
  • Delete mails after successful load: by default once loaded emails will get the "read" flag, with this option they will also be deleted - be careful with this option if you don't have any backup of loaded emails.

The recommended setting for loading are the default ("load all mails" and "focus on recent mails" unchecked).
Use debug and simulation modes for first loading sessions, then remove them when everything seems ok.

Actions

  • Check: will test connection to the server, and if ok displays the number of messages available on it (that is, messages with "unread" flag)
  • Load: start a new mail loading session, using parameters defined.
  • Switch state: changes the state of the server between enabled/disabled. Please note that this will only impact automatic loading (that will take into account only "enabled" servers), not manual loading.

When loading session is finished, please go back to the MailArchive.WebHome page in order to check that emails were successfully loaded.

Automatic loading

Browse to the bottom of page MailArchive.Operate.

MA_OP_Auto_1.png

This part will mainly:

  • Display the parameters in use for the automatic loading job in the Scheduler
  • Allow you to update these parameters, using parameters defined in upper part of the page, for manual loading (click on button "User parameters..." to do so

Purge

Some purge operations are available in page MailArchive.Purge.

Backup / Reload

Backup

The mail archive application creates wiki pages for loaded topics / emails, so usual backup operations can be put in place (sql dumps, xar exports, ...).

Additionally it is possible to backup all successfully loaded emails in a Javamail Store. Please check the Administration Guide for more details on this option.

Restore

Same remarks as for backup. Later, there will be the possibility to selectively reload part or the whole emails from the Javamail Store.
This feature will allow to:

  • Reload emails deleted by error
  • Migrate the mail archive if some further versions require it
  • Re-assign new mailing-lists or mail types that would have been created after concerned emails were loaded

For all these reasons, it is highly recommended to check option to backup in store in admin parameters.

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected