Changes between Version 4 and Version 5 of MailArchivePlugin


Ignore:
Timestamp:
Jun 7, 2015, 9:55:59 AM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • MailArchivePlugin

    v4 v5  
    55== Description
    66
    7 This plugin adds a new main menu item ''Mail Archive'' that can be used to browse and view archived emails and email attachments.
     7This plugin adds a new main menu item '''Mail Archive''' that can be used to browse and view archived emails and email attachments.
    88
    9 === Features
     9Key features:
    1010* Import emails to Trac's database from an IMAP account
    1111* A new `mailarchive` resource realm
     
    1717
    1818=== Known Problems
    19 * A reset of uids on the IMAP server could lead to problems (e.g. duplicate / unarchived emails). #11535
     19
     20* A reset of uids on the IMAP server could lead to problems, eg duplicate / unarchived emails (#11535)
    2021
    2122== !Bugs/Feature Requests
     
    2526
    2627If you have any issues, create a
    27 [http://trac-hacks.org/newticket?component=MailArchivePlugin&owner=lucid new ticket].
     28[/newticket?component=MailArchivePlugin new ticket].
     29
     30[[TicketQuery(component=MailArchivePlugin,group=type,format=progress)]]
    2831
    2932== Download
     
    3740== Installation
    3841
    39 Installation of the plugin requires the usual step, e.g. `easy_install http://trac-hacks.org/svn/mailarchiveplugin/trunk` and enable it in Trac's plugin admin page or by adding `mailarchive.* = enabled` to the `[components]` section in trac.ini.
     42Installation of the plugin requires the usual step, e.g. `easy_install http://trac-hacks.org/svn/mailarchiveplugin/trunk` and enable it in Trac's plugin admin page or by adding `mailarchive.* = enabled` to the `[components]` section in the `trac.ini` file.
    4043
    41 A database upgrade will be required as usual (`trac-admin path-to-your-trac-environment upgrade`).
     44A database upgrade will be required as usual: `trac-admin path-to-your-trac-environment upgrade`.
    4245
    43 Assign the new `MAIL_ARCHIVE_VIEW` permission to the appropriate Trac groups / users (e.g. in Trac's permission admin page).
     46Assign the new `MAIL_ARCHIVE_VIEW` permission to the appropriate Trac groups / users, eg in Trac's permission admin page.
    4447
    4548Additionally 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.
     
    4750Actually 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.
    4851
    49 Example: Schedule a task to call the following command every 15 minutes: `trac-admin path-to-your-trac-environment mailarchive fetch imap.example.com trac-archive@example.com password123`
     52== Example
    5053
    51 Make sure that the emails to be archived are marked as unseen / unread (or very recent, i.e. from today) as only such mails will be considered for archiving.
     54Schedule a task to call the following command every 15 minutes: `trac-admin path-to-your-trac-environment mailarchive fetch imap.example.com trac-archive@example.com password123`
    5255
     56Make 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.
    5357
    5458== Recent Changes