Go to file
djcb 0c34661d6d * mu_index: fix error handling 2012-01-22 10:25:12 +02:00
contrib * gmime-test: whitespace fixes 2011-08-29 23:41:33 +03:00
emacs * mu4e.el: "Flags" => "Flgs" 2012-01-22 10:19:28 +02:00
guile * add org2mu4e example script 2012-01-21 14:20:07 +02:00
m4 * m4/Makefile.am: use explicit names for m4 files 2010-12-11 13:59:09 +02:00
man * make colorized output the default 2012-01-21 12:12:41 +02:00
src * mu_index: fix error handling 2012-01-22 10:25:12 +02:00
toys * mug2/mug-query-bar.c: fix compiler warning 2011-12-30 13:39:03 +02:00
widgets * updates for new APIs (mu-date.h) 2011-07-21 00:39:00 +03:00
www * index.org: minor 2012-01-21 16:29:50 +02:00
.gitignore * update gitignore 2011-12-14 09:13:41 +02:00
AUTHORS * initial import of mu - the next generation 2009-11-25 22:55:06 +02:00
COPYING * initial import of mu - the next generation 2009-11-25 22:55:06 +02:00
ChangeLog * cosmetics 2011-05-18 22:14:52 +03:00
HACKING * preparing for 0.9.7-pre 2011-07-31 12:59:16 +03:00
Makefile.am * Makefile.am: exempt big case-statement in mu-guile-message from pmccabe check 2012-01-15 14:11:48 +02:00
NEWS * update www page for new release 2011-12-31 16:06:33 +02:00
README * updated README 2012-01-21 12:25:14 +02:00
TODO * update TODO 2012-01-09 08:24:32 +02:00
autogen.sh * add a dummy autogen.sh 2010-12-05 14:40:02 +02:00
configure.ac * configure.ac: bump version to beta2 2012-01-21 16:29:41 +02:00
gtest.mk * gtest.mk: test timezone, locale to something predictable for the tests 2011-07-21 21:57:45 +03:00

README

Welcome to mu!
--------------

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.

mu[1] is a tool for dealing with e-mail messages stored in the Maildir-format. mu's
main purpose is to help you to quickly find the messages you need; in addition,
it allows you to view messages, extract attachments, create new maildirs, … See
the mu cheatsheet[2] for some examples.

Searching works by first indexing your messages into a Xapian-database, which
can then be queried using a custom query language.

Built on top of mu there are some extensions:

  * mu-for-emacs (mu4e)[3]: a full-features e-mail client that runs inside emacs
  * mu-guile[4]: bindings for the Guile/Scheme programming language

And, there is a toy GTK+-interface called 'mug' (in the 'toys/' subdir)

Mu is written in C and a bit of C++, with mu4e written in Emacs-lisp and
mu-guile in a mix of C and Scheme.

Note, mu is available in Debian/Ubuntu under the name "maildir-utils" because
they don't like short names.

[1] http://www.djcbsoftware.nl/code/mu/
[2] http://www.djcbsoftware.nl/code/mu/cheatsheet.html
[3] http://www.djcbsoftware.nl/code/mu/mu4e.html
[4] http://www.djcbsoftware.nl/code/mu/mu-guile.html