26b3110b8f
Previously, we would conduct regular expression searches by enumerating all values of a given term, manually regex-matching each one against our search regular expression, remember all the term values that matched our regular expression, then do a big Xapian OR-query that matched any of those term values. In constructing this OR-query, however, we would split each term value on space and add a separate Xapian phrase search term for each resulting word. This approach worked fine most of the time, beacuse when we index a term, we index both each word in a term and the whole term by itself. This word splitting produced false negatives in some matches, however, because Xapian and the Mu-level word splitting code do word splitting slightly differently and apply different transformations to the text while splitting. (For example, Xapian transforms fancy Unicode apostrophes to ASCII apostrophes.) This patch avoids the problem by not word splitting when constructing the big Xapian OR-query for finding the results of regular expression matching. |
||
---|---|---|
.github | ||
build-aux | ||
contrib | ||
guile | ||
lib | ||
man | ||
mu | ||
mu4e | ||
.editorconfig | ||
.gitignore | ||
.mailmap | ||
AUTHORS | ||
COPYING | ||
ChangeLog | ||
Makefile | ||
NEWS | ||
NEWS.org | ||
README.org | ||
autogen.sh | ||
meson.build | ||
meson_options.txt |
README.org
Welcome to mu
!
Note: you are looking at the development branch, which is where new code is being developed and tested, and which may occasionally break.
Distribution and non-adventurous users are instead recommended to use the 1.8 Release Branch or to pick up one of the 1.8 Releases.
Given the enormous amounts of e-mail many people gather and the importance of e-mail message in our work-flows, it's essential to quickly deal with all that mail - in particular, to instantly find that one important e-mail you need right now, and quickly file away message for later use.
mu
is a tool for dealing with e-mail messages stored in the Maildir-format. mu
's
purpose in life is to help you to quickly find the messages you need; in
addition, it allows you to view messages, extract attachments, create new
maildirs, and so on. mu
is fully documented.
After indexing your messages into a Xapian-database, you can search them using a custom query language. You can use various message fields or words in the body text to find the right messages.
Built on top of mu
are some extensions (included in this package):
mu4e
: a full-featured e-mail client that runs inside emacsmu-guile
: bindings for the Guile/Scheme programming language (version 3.0 and later)
mu
is written in C and C++; mu4e
is written in elisp
and mu-guile
in a mix of C++ and
Scheme.
Note, mu
is available in Linux distributions (e.g. Debian/Ubuntu and Fedora)
under the name maildir-utils
; apparently because they don't like short names.
All of the code is distributed under the terms of the GNU General Public License
version 3 (or higher).
Installation
Note: building from source is an advanced subject; esp. if something goes wrong. The below simple examples are a start, but all tools involved have many options; there are differences between systems, versions etc. So if this is all a bit daunting we recommend to wait for someone else to build it for you, such as a Linux distribution. Many have packages available.
Requirements
To be able to build mu
, ensure you have:
- a C++17 compiler (
gcc
orclang
are known to work) - development packages for Xapian and GMime and GLib (see
meson.build
for the versions) - basic tools such as
make
,sed
,grep
meson
For mu4e
, you also need emacs
.
Building
$ git clone git://github.com/djcb/mu.git $ cd mu
Now, you have a choice. mu
uses meson
for building, but includes a good-old
Makefile
with some useful targets, which should work for typical cases.
$ ./autogen.sh && make $ sudo make install
Alternatively, for more control, you can run meson
directly:
$ meson build && ninja -C build $ ninja -C build install
This allows for passing various meson
options, such as --prefix
. Consult the
meson
documentation for details.