You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Dirk-Jan C. Binnema b7cda29b96 mu-runtime: include string 3 days ago
.github Create issue_template.md 3 years ago
build-aux build: add dummy config.rpath 1 year ago
contrib Support gmime 3.0 2 years ago
guile mu: ensure we build with --enabled-shared for guile 1 week ago
lib mu-runtime: include string 3 days ago
m4 guile: add some more m4 for guile detection 1 year ago
man mu: Default to XDG Base Directory Specification 1 week ago
mu mu: Default to XDG Base Directory Specification 1 week ago
mu4e mu: Default to XDG Base Directory Specification 1 week ago
perl perl: Add a .gitignore file with the MYMETA build assets 2 years ago
toys toys: fix compiler warnings 1 year ago
www web: update index.md 3 months ago
.editorconfig editorconfig: update with elisp settings 3 months ago
.gitignore gitignore: update 1 week ago
.travis.yml Travis: use recent autoconf 2.69 and recent autoconf-archive 2 years ago
AUTHORS * initial import of mu - the next generation 9 years ago
COPYING * initial import of mu - the next generation 9 years ago
ChangeLog Fix incorrect ChangeLog. 4 years ago
HACKING update HACKING 3 months ago
Makefile.am perl: disable build 1 year ago
NEWS Add the missing NEWS 4 years ago
NEWS.org doc: document the new contacts handling 2 months ago
README Two minor fixes to README 2 years ago
README.org Two minor fixes to README 2 years ago
TODO * update TODO 6 years ago
autogen.sh mu: ensure we build with --enabled-shared for guile 1 week ago
c.cfg Add uncrustify configuration for C code 4 years ago
configure.ac configure.ac: bump version to 1.3.3 1 week ago
gtest.mk * gtest.mk: fix for magical cd 7 years ago

README

                                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] 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. See the [mu cheatsheet] for some
examples. =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):

- mu-for-emacs ([mu4e]): a full-featured e-mail client that runs inside emacs
- [mu-guile]: bindings for the Guile/Scheme programming language (version 2.0
and later)
- a toy GTK+-interface called 'mug' (in the 'toys/' subdir)

=mu= is written in C and a bit of C++ (to interface with Xapian), 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=;
apparently because they don't like short names. It's also possible to confuse
that name with the [GNU Mailutils] project (which is totally unrelated) - but
now you have been warned.


[mu]: http://www.djcbsoftware.nl/code/mu
[mu cheatsheet]: http://www.djcbsoftware.nl/code/mu/cheatsheet.html
[Xapian]: http://www.xapian.org
[mu4e]: http://www.djcbsoftware.nl/code/mu/mu4e.html
[mu-guile]: http://www.djcbsoftware.nl/code/mu/mu-guile.html
[Emacs-Lisp]: http://en.wikipedia.org/wiki/Emacs-Lisp
[GNU Mailutils]: http://mailutils.org/