mu/README.org

3.2 KiB

#+TITLE:Mu https://img.shields.io/github/license/djcb/mu?logo=gnu&.svg https://img.shields.io/badge/Made%20with-C/CPP-1f425f?logo=c&.svg https://img.shields.io/github/v/release/djcb/mu.svg https://img.shields.io/github/contributors/djcb/mu.svg https://img.shields.io/github/issues/djcb/mu.svg https://img.shields.io/github/issues/djcb/mu/rfe?color=008b8b.svg https://img.shields.io/badge/PRs-welcome-brightgreen.svg
https://img.shields.io/badge/Emacs-25.3-922793?logo=gnu-emacs&logoColor=b39ddb&.svg https://img.shields.io/badge/Platform-Linux-2e8b57?logo=linux&.svg https://img.shields.io/badge/Platform-FreeBSD-8b3a3a?logo=freebsd&logoColor=c32136&.svg https://img.shields.io/badge/Platform-macOS-101010?logo=apple&logoColor=ffffff&.svg

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.6.x Release Branch or to pick up one of the 1.6.x 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. 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):

  • mu4e: a full-featured e-mail client that runs inside emacs
  • mu-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).