Wiki source code of Mail Archive Operations Guide
Last modified by Jeremie Bousquet on 2012/09/14 13:46
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
3.1 | 1 | {{velocity}}$xwiki.ssx.use('Extension.Mail Archive Documentation'){{/velocity}} |
| |
1.1 | 2 | |
| 3 | = Manual loading = | ||
| 4 | |||
| |
3.1 | 5 | Browse to page MailArchive.Loading. |
| |
1.1 | 6 | |
| 7 | [[image:MA_OP_Manual_1.png]] | ||
| 8 | |||
| 9 | This page lists defined servers, and allows you to setup some loading parameters, check connections, load emails, or swith some server state. | ||
| 10 | |||
| 11 | == Loading Parameters == | ||
| 12 | |||
| 13 | * Max number of emails to load: only this number of emails will be loaded during a session, even if more are available. | ||
| 14 | * 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 !) | ||
| 15 | * 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. | ||
| 16 | * Load all mails: by default only mails with "unread" flag will be treated, with this option all mails will be taken into account. | ||
| 17 | * Focus on recent mails: will treat more recent mails in priority. | ||
| 18 | * 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. | ||
| 19 | |||
| 20 | {{info}} | ||
| 21 | The recommended setting for loading are the default ("load all mails" and "focus on recent mails" unchecked). | ||
| 22 | Use debug and simulation modes for first loading sessions, then remove them when everything seems ok. | ||
| 23 | {{/info}} | ||
| 24 | |||
| 25 | == Actions == | ||
| 26 | |||
| 27 | * Check: will test connection to the server, and if ok displays the number of messages available on it (that is, messages with "unread" flag) | ||
| 28 | * Load: start a new mail loading session, using parameters defined. | ||
| 29 | * 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. | ||
| 30 | |||
| 31 | When loading session is finished, please go back to the MailArchive.WebHome page in order to check that emails were successfully loaded. | ||
| 32 | |||
| 33 | |||
| 34 | = Automatic loading = | ||
| 35 | |||
| |
5.1 | 36 | Browse to the bottom of page MailArchive.Operate. |
| |
1.1 | 37 | |
| 38 | [[image:MA_OP_Auto_1.png]] | ||
| 39 | |||
| 40 | This part will mainly: | ||
| 41 | * Display the parameters in use for the automatic loading job in the Scheduler | ||
| 42 | * 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 | ||
| 43 | |||
| 44 | = Purge = | ||
| 45 | |||
| |
4.1 | 46 | Some purge operations are available in page MailArchive.Purge. |
| |
1.1 | 47 | |
| 48 | = Backup / Reload = | ||
| 49 | |||
| 50 | == Backup == | ||
| 51 | |||
| 52 | The mail archive application creates wiki pages for loaded topics / emails, so usual backup operations can be put in place (sql dumps, xar exports, ...). | ||
| 53 | |||
| 54 | 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. | ||
| 55 | |||
| 56 | == Restore == | ||
| 57 | |||
| 58 | Same remarks as for backup. Later, there will be the possibility to selectively reload part or the whole emails from the Javamail Store. | ||
| 59 | This feature will allow to: | ||
| 60 | * Reload emails deleted by error | ||
| 61 | * Migrate the mail archive if some further versions require it | ||
| 62 | * Re-assign new mailing-lists or mail types that would have been created after concerned emails were loaded | ||
| 63 | |||
| 64 | For all these reasons, it is highly recommended to check option to backup in store in admin parameters. | ||
| 65 |
