unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
* [ANNOUNCE] notmuchfs - A virtual maildir file system for notmuch queries
@ 2012-09-29 12:35 Tim Stoakes
  2012-10-01  0:55 ` David Bremner
  2012-10-01  9:40 ` Vladimir Marek
  0 siblings, 2 replies; 6+ messages in thread
From: Tim Stoakes @ 2012-09-29 12:35 UTC (permalink / raw)
  To: notmuch

Hello fellow notmuch-ers,

What is notmuchfs?
------------------
Notmuchfs implements a virtual file system which creates maildirs from notmuch
mail query results. This is useful for using notmuch with tools which are not
aware of notmuch, only maildirs - such as mutt.

Basically you 'mkdir' your query strings, then point your tool of choice at
that directory, and it turns into a virtual maildir containing the query
results.


How does it work?
-----------------
A notmuchfs virtual file system is mounted referencing a particular existing
(real) directory called the 'backing store'.

Directories created within the backing store, when read, appear to have the
standard maildir format (e.g. cur/, new/, tmp/ sub-directories).

Notmuchfs interprets the names of these backing store directories as notmuch
queries, and fills the cur/ virtual maildir sub-directory with virtual messages
which are the result of executing that query (at the instant in time that the
directory is read).

Each virtual maildir message file, when read, appears to have the exact content
of the message referenced by the notmuch query, augmented with an 'X-Label'
header generated automatically by notmuchfs, containing the notmuch tags of
that message.


Additional 'glue' scripts are provided to augment this, to integrate it more
tightly with MUA-like tools, specifically 'mutt', giving the ability to alter
notmuch tags, create new queries, etc.



Why?
----
I wanted to use notmuch with mutt. I didn't feel that ploughing though mutt's
codebase to add tight integration was the quickest way to a result, so
notmuchfs was born.

I developed notmuchfs in 2011, but I am only now able to release it. In the
mean-time, the excellent 'mutt-kz' was released, scratching my initial itch.

Notmuchfs solves a broader problem - e.g. a notmuch-aware courier-imap is not
too much of a stretch - so I think there is room for the different approaches.


More information
----------------
 https://github.com/tsto/notmuchfs
 https://github.com/tsto/notmuchfs/blob/master/README.md
 https://github.com/tsto/notmuchfs/blob/master/README.MUTT.md
 https://github.com/tsto/notmuchfs/blob/master/ISSUES



Perhaps this will scratch someone else's itch too.

Tim

-- 
Tim Stoakes

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [ANNOUNCE] notmuchfs - A virtual maildir file system for notmuch queries
  2012-09-29 12:35 [ANNOUNCE] notmuchfs - A virtual maildir file system for notmuch queries Tim Stoakes
@ 2012-10-01  0:55 ` David Bremner
  2012-10-01  7:30   ` Felipe Contreras
  2012-10-01  9:40 ` Vladimir Marek
  1 sibling, 1 reply; 6+ messages in thread
From: David Bremner @ 2012-10-01  0:55 UTC (permalink / raw)
  To: Tim Stoakes, notmuch

Tim Stoakes <notmuch@stoakes.net> writes:

> Hello fellow notmuch-ers,
>
> What is notmuchfs?
> ------------------
> Notmuchfs implements a virtual file system which creates maildirs from notmuch
> mail query results. This is useful for using notmuch with tools which are not
> aware of notmuch, only maildirs - such as mutt.
>
> Basically you 'mkdir' your query strings, then point your tool of choice at
> that directory, and it turns into a virtual maildir containing the query
> results.
>

Well, since nobody else said it, let me be the first to say, that's a
pretty cool hack!

All the best,

David

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [ANNOUNCE] notmuchfs - A virtual maildir file system for notmuch queries
  2012-10-01  0:55 ` David Bremner
@ 2012-10-01  7:30   ` Felipe Contreras
  0 siblings, 0 replies; 6+ messages in thread
From: Felipe Contreras @ 2012-10-01  7:30 UTC (permalink / raw)
  To: David Bremner; +Cc: notmuch

On Mon, Oct 1, 2012 at 2:55 AM, David Bremner <david@tethera.net> wrote:
> Tim Stoakes <notmuch@stoakes.net> writes:
>
>> Hello fellow notmuch-ers,
>>
>> What is notmuchfs?
>> ------------------
>> Notmuchfs implements a virtual file system which creates maildirs from notmuch
>> mail query results. This is useful for using notmuch with tools which are not
>> aware of notmuch, only maildirs - such as mutt.
>>
>> Basically you 'mkdir' your query strings, then point your tool of choice at
>> that directory, and it turns into a virtual maildir containing the query
>> results.
>>
>
> Well, since nobody else said it, let me be the first to say, that's a
> pretty cool hack!

I agree. Genius :)

-- 
Felipe Contreras

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [ANNOUNCE] notmuchfs - A virtual maildir file system for notmuch queries
  2012-09-29 12:35 [ANNOUNCE] notmuchfs - A virtual maildir file system for notmuch queries Tim Stoakes
  2012-10-01  0:55 ` David Bremner
@ 2012-10-01  9:40 ` Vladimir Marek
  2012-10-01 10:43   ` Tim Stoakes
  1 sibling, 1 reply; 6+ messages in thread
From: Vladimir Marek @ 2012-10-01  9:40 UTC (permalink / raw)
  To: notmuch

Hi,

[...]

> Why?
> ----
> I wanted to use notmuch with mutt. I didn't feel that ploughing though mutt's
> codebase to add tight integration was the quickest way to a result, so
> notmuchfs was born.

Someone else already created mutt's fork using notmuch directly.

https://github.com/karelzak/mutt-kz/wiki

Just saying ...

-- 
	Vlad

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [ANNOUNCE] notmuchfs - A virtual maildir file system for notmuch queries
  2012-10-01  9:40 ` Vladimir Marek
@ 2012-10-01 10:43   ` Tim Stoakes
  2012-10-01 11:13     ` Vladimir Marek
  0 siblings, 1 reply; 6+ messages in thread
From: Tim Stoakes @ 2012-10-01 10:43 UTC (permalink / raw)
  To: notmuch

Vladimir Marek(Vladimir.Marek@Oracle.COM)@011012-11:40:
> > Why?

I know - proceed to the next paragraph for my explanation. Summary -
mutt-kz wasn't done when I did this.

Tim

-- 
Tim Stoakes

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [ANNOUNCE] notmuchfs - A virtual maildir file system for notmuch queries
  2012-10-01 10:43   ` Tim Stoakes
@ 2012-10-01 11:13     ` Vladimir Marek
  0 siblings, 0 replies; 6+ messages in thread
From: Vladimir Marek @ 2012-10-01 11:13 UTC (permalink / raw)
  To: Tim Stoakes; +Cc: notmuch

> > > Why?
> 
> I know - proceed to the next paragraph for my explanation. Summary -
> mutt-kz wasn't done when I did this.

Uh, oh, overlooked that. Sorry for the noise
-- 
	Vlad

^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2012-10-01 11:15 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2012-09-29 12:35 [ANNOUNCE] notmuchfs - A virtual maildir file system for notmuch queries Tim Stoakes
2012-10-01  0:55 ` David Bremner
2012-10-01  7:30   ` Felipe Contreras
2012-10-01  9:40 ` Vladimir Marek
2012-10-01 10:43   ` Tim Stoakes
2012-10-01 11:13     ` Vladimir Marek

Code repositories for project(s) associated with this public inbox

	https://yhetil.org/notmuch.git/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).