[ANNOUNCE] notmuchfs - A virtual maildir file system for notmuch queries
authorTim Stoakes <notmuch@stoakes.net>
Sat, 29 Sep 2012 12:35:06 +0000 (22:05 +0930)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:49:38 +0000 (09:49 -0800)
e9/d707549d78203e6b025760dc16242972437796 [new file with mode: 0644]

diff --git a/e9/d707549d78203e6b025760dc16242972437796 b/e9/d707549d78203e6b025760dc16242972437796
new file mode 100644 (file)
index 0000000..4b2cc10
--- /dev/null
@@ -0,0 +1,112 @@
+Return-Path: <notmuch@stoakes.net>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id 83BA5431FB6\r
+       for <notmuch@notmuchmail.org>; Sat, 29 Sep 2012 05:35:08 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 1.363\r
+X-Spam-Level: *\r
+X-Spam-Status: No, score=1.363 tagged_above=-999 required=5\r
+       tests=[RDNS_DYNAMIC=0.363, TO_NO_BRKTS_DYNIP=1] autolearn=unavailable\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id 4AsUOBVNBWaS for <notmuch@notmuchmail.org>;\r
+       Sat, 29 Sep 2012 05:35:08 -0700 (PDT)\r
+Received: from narco.pvt.stoakes.net (dsl-202-173-137-105.sa.westnet.com.au\r
+       [202.173.137.105])\r
+       by olra.theworths.org (Postfix) with ESMTP id E9FF1431FAE\r
+       for <notmuch@notmuchmail.org>; Sat, 29 Sep 2012 05:35:07 -0700 (PDT)\r
+Received: by narco.pvt.stoakes.net (Postfix, from userid 1000)\r
+       id 0DCA0E5E5F; Sat, 29 Sep 2012 22:05:06 +0930 (CST)\r
+Date: Sat, 29 Sep 2012 22:05:06 +0930\r
+From: Tim Stoakes <notmuch@stoakes.net>\r
+To: notmuch@notmuchmail.org\r
+Subject: [ANNOUNCE] notmuchfs - A virtual maildir file system for notmuch\r
+       queries\r
+Message-ID: <20120929123506.GM27230@mail.stoakes.net>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain; charset=us-ascii\r
+Content-Disposition: inline\r
+User-Agent: Mutt/1.5.21 (2010-09-15)\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+       <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Sat, 29 Sep 2012 12:35:08 -0000\r
+\r
+Hello fellow notmuch-ers,\r
+\r
+What is notmuchfs?\r
+------------------\r
+Notmuchfs implements a virtual file system which creates maildirs from notmuch\r
+mail query results. This is useful for using notmuch with tools which are not\r
+aware of notmuch, only maildirs - such as mutt.\r
+\r
+Basically you 'mkdir' your query strings, then point your tool of choice at\r
+that directory, and it turns into a virtual maildir containing the query\r
+results.\r
+\r
+\r
+How does it work?\r
+-----------------\r
+A notmuchfs virtual file system is mounted referencing a particular existing\r
+(real) directory called the 'backing store'.\r
+\r
+Directories created within the backing store, when read, appear to have the\r
+standard maildir format (e.g. cur/, new/, tmp/ sub-directories).\r
+\r
+Notmuchfs interprets the names of these backing store directories as notmuch\r
+queries, and fills the cur/ virtual maildir sub-directory with virtual messages\r
+which are the result of executing that query (at the instant in time that the\r
+directory is read).\r
+\r
+Each virtual maildir message file, when read, appears to have the exact content\r
+of the message referenced by the notmuch query, augmented with an 'X-Label'\r
+header generated automatically by notmuchfs, containing the notmuch tags of\r
+that message.\r
+\r
+\r
+Additional 'glue' scripts are provided to augment this, to integrate it more\r
+tightly with MUA-like tools, specifically 'mutt', giving the ability to alter\r
+notmuch tags, create new queries, etc.\r
+\r
+\r
+\r
+Why?\r
+----\r
+I wanted to use notmuch with mutt. I didn't feel that ploughing though mutt's\r
+codebase to add tight integration was the quickest way to a result, so\r
+notmuchfs was born.\r
+\r
+I developed notmuchfs in 2011, but I am only now able to release it. In the\r
+mean-time, the excellent 'mutt-kz' was released, scratching my initial itch.\r
+\r
+Notmuchfs solves a broader problem - e.g. a notmuch-aware courier-imap is not\r
+too much of a stretch - so I think there is room for the different approaches.\r
+\r
+\r
+More information\r
+----------------\r
+ https://github.com/tsto/notmuchfs\r
+ https://github.com/tsto/notmuchfs/blob/master/README.md\r
+ https://github.com/tsto/notmuchfs/blob/master/README.MUTT.md\r
+ https://github.com/tsto/notmuchfs/blob/master/ISSUES\r
+\r
+\r
+\r
+Perhaps this will scratch someone else's itch too.\r
+\r
+Tim\r
+\r
+-- \r
+Tim Stoakes\r