A virtual maildir filesystem for mu
queries. Create directories with names that are mu queries, and
those directories will be populated with the query results on
retrieval. Movement of mail within the query directory (e.g. from
new to cur, or renaming in order to change flags) propagates to
the underlying maildir, too.
make
sudo make install
Create a backing directory:
$ mkdir fsmu-bd
Mount the filesystem:
$ fsmu --backing-dir=./fsmu-bd ./fsmu
Create and retrieve a query directory:
$ cd fsmu
$ mkdir 'maildir:+Inbox AND date:3m..'
$ ls 'maildir:+Inbox AND date:3m..'
cur new
$ mutt -f 'maildir:+Inbox AND date:3m..'
...
mkdir can be used at the top-level to create query directories. Any
+ character in the directory name will be converted into a /
before being used as a query, to work around / not being permitted
in file/directory names.
If a directory name at the top-level is not a valid query, then attempting to access that directory will lead to an "operation not permitted" error message.
rmdir can be used to remove a query directory, regardless of whether
it has been populated.
Whenever cur or new within the query directory is accessed, the
query results are refreshed if that hasn't happened within the last 30
seconds. This value can be changed by way of the --refresh-timeout
option. A query directory can be forcibly refreshed by attempting to
read a file named .refresh at the top-level of the query directory,
so it's possible e.g. to set the refresh timeout to a high value, and
then refresh the query directories as part of mail retrieval, so that
it doesn't happen in the interactive path.
Movement of mail within a query directory is supported, and propagates
to the underlying maildir, as well as to any other query directories
that have the same message. This means that changes to a message's
flags, as well as movement from new to cur and vice-versa, take
effect on the message in those other locations. If the movement is
such that the only change to the filename is to its maildir flags,
then propagation applies that change to the original filename in the
maildir and any other affected query directories, rather than using
the target filename from the first movement operation.
By default, deletion is not supported. To have deletion take effect
in both the query directory and the underlying maildir, pass the
--delete-remove option.
The path to the mu executable can be set by using the --mu option,
and the muhome configuration option (passed to the mu commands)
can be set by using the --muhome option.
There is roughly 20kB worth of disk overhead for each mail item present in the query directories.
Debug and error information is logged using syslog.
See the GitHub issue tracker.
- Most of the general approach/interface here follows notmuchfs.
See LICENCE.