Changes between Version 7 and Version 8 of MailArchivePlugin

Timestamp:

Dec 18, 2016, 4:02:32 PM (7 years ago)

Author:

figaro

Comment:

Moved example to functional description

MailArchivePlugin

@@ -5 +5 @@
 == Description
 
-This plugin adds a new main menu item '''Mail Archive''' that can be used to browse and view archived emails and email attachments.
+This plugin allows you to browse and view archived emails and email attachments. It adds a new item '''Mail Archive''' to the main menu.
 
 Key features:
-* Import emails to Trac's database from an IMAP account
-* A new `mailarchive` resource realm
-* `mailarchive:` wiki links (plus `mail:`, `email:`, and `emailarchive:` synonyms)
-* `[[MailQuery(searchterm)]]` macro
-* New `trac-admin mailarchive fetch` command
-* New Trac permission `MAIL_ARCHIVE_VIEW`
-* Trac Search integration
+* Import emails to Trac's database from an IMAP account.
+* A new `mailarchive` resource realm.
+* `mailarchive:` wiki links, plus `mail:`, `email:`, and `emailarchive:` synonyms.
+* The macro `[[MailQuery(searchterm)]]` in your wiki page allows you to search archived mails.
+* New `trac-admin mailarchive fetch` command.
+* New Trac permission `MAIL_ARCHIVE_VIEW`.
+* Trac Search integration.
+
+For example, you can schedule a task to call the following command every 15 minutes:
+{{{#!sh
+$ trac-admin path/to/trac/environment mailarchive fetch imap.example.com trac-archive@example.com password123
+}}}
+
+Make sure that the emails to be archived are marked as unread or very recent, ie from today, as only such emails will be considered for archiving.
 
 === Known Problems
 
-* A reset of uids on the IMAP server could lead to problems, eg duplicate / unarchived emails (#11535)
+* A reset of uids on the IMAP server could lead to problems, eg duplicate / unarchived emails (#11535).
 
 == !Bugs/Feature Requests
@@ -48 +55 @@
 }}}
 
-A database upgrade will be required as usual: `trac-admin path/to/trac/environment upgrade`.
+A database upgrade will be required as usual: 
+{{{#!sh
+$ trac-admin path/to/trac/environment upgrade
+}}}
+
+== Configuration
 
 Assign the new `MAIL_ARCHIVE_VIEW` permission to the appropriate Trac groups / users, eg in Trac's permission admin page.
@@ -54 +66 @@
 Additionally you need an email IMAP account that only contains all the emails you want to archive. If you don't already have this, you could create a new separate email account (e.g. `trac-archive@example.com`) and copy all emails you want to appear in Trac's mail archive to that account.
 
-Actually archiving the emails from that IMAP account into Trac's database must be done separately using a new `trac-admin mailarchive fetch <host> <username> <password>` command. You should configure (e.g. using a cron job in Unix, or using a scheduled task in Windows) it to be periodically called. Replace `<host>`, `<username>` and `<password>` with your email host, username and password.
-
-== Example
-
-Schedule a task to call the following command every 15 minutes: `trac-admin path/to/trac/environment mailarchive fetch imap.example.com trac-archive@example.com password123`
-
-Make sure that the emails to be archived are marked as unread or very recent, ie from today, as only such emails will be considered for archiving.
+Actually archiving the emails from that IMAP account into Trac's database must be done separately using a new `trac-admin mailarchive fetch <host> <username> <password>` command. You should configure it to be periodically called, for example by using a cron job in Unix or using a scheduled task in Windows. Replace `<host>`, `<username>` and `<password>` with your email host, username and password.
 
 == Recent Changes