MailArchivePlugin
Summary
It is a plug-in to keep the mail such as ML, and to display and to retrieve it with Trac. There is ML has already been used by the project, and it uses it to unitary manage the content with Trac. (The function to turn on mail to the ticket like EmailtoTracScript is not provided. )
A strong link function of Trac can be used. For instance, the link where specific mail is shown with Wiki can be made, and the numbers of the ticket written in the text in mail be linked. Moreover, it corresponds to the basic function of Trac of search and timeline.
Function
- Import of mail
The import of the mail of the unixmail form is done. The attached file is managed as Attachement of Trac.
- Mail reception from mail server
Mail can be received directly from the server with pop3.
- Thread tree display of read mail
Mail is displayed in the thread each ML name and every month.
- Wiki display of mail text
The mail text is interpreted by the wiki syntax of Trac, and it converts it into the link. For instance, it converts it into the link of the ticket to #1 if there is a character of #1 in the mail text.
- Search mail
Subject and the text in mail can be retrieved by the search function of Trac.
- Line display of time of mail
It is possible to display it as a time line by the line function of the time of Trac based
on the day of the transmission of mail. The registration of the ticket, committing the repository, and the day of the transmission of mail can be displayed together.
- It specifies it with Wiki the link
A strong link function of Trac is applied to mail. The link to do the mail unit can be specified for Wiki. The subject ([aaa:001] and [aaa 001], etc.) used well with Message-ID and ML is linked.
Setup
Download
Please download it as follows.
- MailArchivePlugin Version 0.1-r52
Installation
Let's install MailArchive Plugin.
(1) Installation of egg
Please defrost zip. Please move to the src directory under the control of the folder that can be done by defrosting. Please execute the following commands:
$ python setup.py bdist_egg
The dist folder is made.
Please copy *.egg file that is onto the plugins directory of TracEnv in that.
(2) Upgrade of TracEnv
To add the table for MailArchivePlugin to DB, upgrade should do TracEnv. Please execute the following commands.
$ trac-admin [TracEnv Directory] upgrade
(3) Installation of mailarchive-amin.py
Please copy mailarchive-admin.py right under the src directory onto the directory executed easily.
(4) Set of Trac.ini
Please add the following to the components category of Trac.ini to enable the use of MailArchiv ePlugin. (unnecessary when putting it on plugin folder)
[componets] mailarchiveplugin.* = enabled
The installation of MailArchivePlugin ends here. I think that the menu "Mail warehouse" is added to the main menu. However, even if the menu is pushed, nothing is displayed because mail has not been done importing yet. Please do the import of the setting and the mail to do mail continuously importing.
Import of mail
Explanation
First of all, it is necessary to take the mail data into Trac to display and to retrieve mail with MailArchivePlugin (= import is done). Mail can be importing done by two methods. It is a reception of mail from the import of the mail file of the unixmail form and the pop3 server. "Only one of methods are used" is possible, and the usage "Mail will be received with pop3 in the future after the current mail is importing done first" is possible.
Attention:
- The data of mail is preserved in the data base of TracEnv. Please note the amount of the disk use. Mostly because mail is larger than the data accumulated in Trac. 。
- The attached file of mail is preserved as Attachment of Trac. An attached file that is bigger than the size described to Trac.ini is taken and not made. You will enlarge max_size of attachment of Trac.ini (Default is 262,144 bytes).
- The E-mail of the HTML form is taken and not made.
- The unique key of the mail data is Message-ID. When the mail of same Message-ID as DB already exists in DB, it overwrites with the mail newly taken.