Go to file
djcb ecee4831ef * minor change to mu-completion.zsh 2012-04-30 08:17:43 +03:00
contrib * minor change to mu-completion.zsh 2012-04-30 08:17:43 +03:00
emacs * update docs 2012-04-30 08:16:44 +03:00
guile * guile/examples/msg-graphs: show years correctly in graphs, add year-month period 2012-04-28 23:03:22 +03:00
m4 * m4/Makefile.am: use explicit names for m4 files 2010-12-11 13:59:09 +02:00
man * mu-server.1: update manpage for the mu client/server protocol changes 2012-04-29 17:37:27 +03:00
src * don't concatenate all text parts in message body 2012-04-28 13:48:52 +03:00
toys * msg2pdf.c: make a bit more robust 2012-04-29 17:31:54 +03:00
widgets * cosmetic 2012-04-21 09:27:49 +03:00
www * update webpage 2012-04-29 22:06:44 +03:00
.gitignore * update gitignore 2012-04-17 20:37:18 +03: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 * updated the HACKING instructions 2012-03-24 11:17:11 +02:00
Makefile.am * mu4e: restructure code a bit and enable byte-compilation 2012-04-09 16:34:52 +03:00
NEWS * update NEWS 2012-04-28 14:22:05 +03: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 * mu4e-proc, mu-cmd-server: update server output 2012-04-28 09:05:05 +03: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