1#+TITLE:MU
2[[https://github.com/djcb/mu/blob/master/COPYING][https://img.shields.io/github/license/djcb/mu?logo=gnu&.svg]]
3[[https://en.cppreference.com][https://img.shields.io/badge/Made%20with-C/CPP-1f425f?logo=c&.svg]]
4[[https://img.shields.io/github/v/release/djcb/mu][https://img.shields.io/github/v/release/djcb/mu.svg]]
5[[https://github.com/djcb/mu/graphs/contributors][https://img.shields.io/github/contributors/djcb/mu.svg]]
6[[https://github.com/djcb/mu/issues][https://img.shields.io/github/issues/djcb/mu.svg]]
7[[https://github.com/djcb/mu/issues?q=is%3Aissue+is%3Aopen+label%3Arfe][https://img.shields.io/github/issues/djcb/mu/rfe?color=008b8b.svg]]
8[[https://github.com/djcb/mu/pull/new][https://img.shields.io/badge/PRs-welcome-brightgreen.svg]]\\
9[[https://melpa.org/#/?q=mu4e&sort=version&asc=false][https://img.shields.io/badge/Emacs-25.3-922793?logo=gnu-emacs&logoColor=b39ddb&.svg]]
10[[https://www.djcbsoftware.nl/code/mu/mu4e/Installation.html#Dependencies-for-Debian_002fUbuntu][https://img.shields.io/badge/Platform-Linux-2e8b57?logo=linux&.svg]]
11[[https://www.djcbsoftware.nl/code/mu/mu4e/Installation.html#Building-from-a-release-tarball-1][https://img.shields.io/badge/Platform-FreeBSD-8b3a3a?logo=freebsd&logoColor=c32136&.svg]]
12[[https://formulae.brew.sh/formula/mu#default][https://img.shields.io/badge/Platform-macOS-101010?logo=apple&logoColor=ffffff&.svg]]
13[[https://github.com/msys2-unofficial/MSYS2-packages/blob/master/mu/README.org][https://img.shields.io/badge/Platform-Windows-00bfff?logo=windows&logoColor=00bfff&.svg]]
14
15Welcome to ~mu~!
16
17*Note*: you are looking at the *development* branch, which is where new
18code is being developed and tested, and which may occasionally break.
19
20Distribution and non-adventurous users are instead recommended to use
21the [[https://github.com/djcb/mu/tree/release/1.6.x][1.6.x Release Branch]] or to pick up one of the [[https://github.com/djcb/mu/releases][1.6.x Releases]].
22
23Given the enormous amounts of e-mail many people gather and the
24importance of e-mail message in our work-flows, it's essential to
25quickly deal with all that mail - in particular, to instantly find
26that one important e-mail you need right now, and quickly file away
27message for later use.
28
29~mu~ is a tool for dealing with e-mail messages stored in the
30Maildir-format. ~mu~'s purpose in life is to help you to quickly find
31the messages you need; in addition, it allows you to view messages,
32extract attachments, create new maildirs, and so on. See the [[www/cheatsheet.md][mu
33cheatsheet]] for some examples. =mu= is fully documented.
34
35After indexing your messages into a [[http://www.xapian.org][Xapian]]-database, you can search
36them using a custom query language. You can use various message fields
37or words in the body text to find the right messages.
38
39Built on top of ~mu~ are some extensions (included in this package):
40
41- mu4e: a full-featured e-mail client that runs inside emacs
42
43- mu-guile: bindings for the Guile/Scheme programming language (version 2.2 and later)
44
45~mu~ is written in C and C++; ~mu4e~ is written in elisp, and ~mu-guile~ in
46a mix of C and Scheme.
47
48Note, ~mu~ is available in Linux distributions (e.g. Debian/Ubuntu and
49Fedora) under the name ~maildir-utils~; apparently because they don't
50like short names. All of the code is distributed under the terms
51of the [[https://www.gnu.org/licenses/gpl-3.0.en.html][GNU General Public License version 3]] (or higher).
52