[Assorted-commits] SF.net SVN: assorted: [720] mailing-list-filter/trunk/README

[<yan...@us...>]

Revision: 720
          http://assorted.svn.sourceforge.net/assorted/?rev=720&view=rev
Author:   yangzhang
Date:     2008-05-08 01:04:04 -0700 (Thu, 08 May 2008)

Log Message:
-----------
added todos and setup to readme

Modified Paths:
--------------
    mailing-list-filter/trunk/README

Modified: mailing-list-filter/trunk/README
===================================================================
--- mailing-list-filter/trunk/README	2008-05-08 08:03:44 UTC (rev 719)
+++ mailing-list-filter/trunk/README	2008-05-08 08:04:04 UTC (rev 720)
@@ -1,6 +1,3 @@
-% Mailing List Filter
-% Yang Zhang
-
 Overview
 --------
 
@@ -35,3 +32,32 @@
 keep those active so that I can get immediate first-pass filtering. I execute
 this script on a daily basis to perform second-pass filtering/unfiltering to
 catch those false negatives that may have been missed.
+
+Setup
+-----
+
+Requirements:
+
+- [argparse](http://argparse.python-hosting.com/)
+- [Python Commons](http://assorted.sf.net/python-commons/) 0.4
+- [path](http://www.jorendorff.com/articles/python/path/)
+
+Install the program using the standard `setup.py` program.
+
+Future Work Ideas
+-----------------
+
+- Currently, we assume that the server specification points to a mailbox
+  containing all messages (both sent and received), and a message is determined
+  to have been sent by you by looking at the From: header field. This works
+  well with Gmail. An alternative strategy is to look through two folders, one
+  that's the Inbox and one that's the Sent mailbox, and treat all messages in
+  Sent as having been sent by you. This is presumably how most other IMAP
+  servers work.
+
+- Implement incremental maintenance of local cache.
+
+- Accept custom operations for filtered/unfiltered messages
+  (trashing/untrashing, labeling/unlabeling, etc.).
+
+- Refactor the message fetching/management part out into its own library.


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.