Changes between Version 1 and Version 2 of MailToTracPlugin

Timestamp:

Apr 23, 2009, 4:33:59 PM (15 years ago)

Author:

Jeff Hammel

Comment:

--

MailToTracPlugin

@@ -3 +3 @@
 == Description ==
 
-provides a command line script and extension point that allows email messages to be handled by Trac plugins
+provides a command line script and extension point that allows email messages to be handled by Trac plugins.  This ticket provides a command-line script, `mail2trac` which may be called by an [http://en.wikipedia.org/wiki/Mail_transfer_agent MTA] (e.g. [http://www.postfix.org/ postfix]) to open a Trac environment and run through each enabled [source:mailtotracplugin/0.11/mail2trac/interface.py IEmailHandler] and executes its `invoke()` method if its `match()` method returns `True`.  If invoke returns an [http://docs.python.org/library/email email] message, then subsequent `IEmailHandler`s will also process the message.  If `None` is returned, then the message is consumed and execution stops.
+
+To enable the plugin for `postfix`, add an appropriate line to the aliases file (usually `/etc/aliases` or `/etc/postfix/aliases` and then refreshing the aliases database (see [http://www.postfix.org/aliases.5.html man aliases]).  The `mail2trac` script takes a `-p` command line argument for the path to the project environment.  The incoming email address should equal
+
+{{{
+[notification]
+smtp_replyto =
+}}}
+
+in the [http://trac.edgewall.org/wiki/TracIni trac.ini] file.
+
+As an example, if `smtp_replyto` is set to `foo@example.com` and the project is in `/var/trac/bar`, the `aliases` file on `example.com` should have a line like
+
+{{{
+foo: "|/path/to/mail2trac -p /var/trac/bar"
+}}}
+
 
 == Bugs/Feature Requests == 
@@ -19 +35 @@
 == Source ==
 
-You can check out MailToTracPlugin from [http://trac-hacks.org/svn/mailtotracplugin here] using Subversion, or [source:mailtotracplugin browse the source] with Trac.
+You can check out MailToTracPlugin from [http://trac-hacks.org/svn/mailtotracplugin/0.11 here] using Subversion, or [source:mailtotracplugin browse the source] with Trac.
 
 == Example ==
 
-The email2ticket is an example plugin to convert an email message to a ticket.  This plugin is still in a very fledgling state and doesn't have much functionality as of yet.
+[source:mailtotracplugin/0.11/mail2trac/email2ticket.py email2ticket] is an example [source:mailtotracplugin/0.11/mail2trac/interface.py IEmailHandler] plugin to convert an email message to a ticket.
 
 == Recent Changes ==