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 2433cf7b89 build: bump version to 1.8.5 21 hours ago
.github github: update bug template 21 hours ago
build-aux build: don't install-info with DESTDIR 21 hours ago
contrib tests: move to subdir, move to meson 8 months ago
guile build: use install-info when installing mu4e/guile 6 days ago
lib mu-server: more informative error message 2 days ago
m4 autotools: improve build 2 months ago
man man/mu-index.1: update 4 weeks ago
mu config: remove help_enabled flag 7 days ago
mu4e mu4e-helpers: fix mu4e-is-mode-or-derived-p 2 days ago
.editorconfig tweak coding style / configuration 5 months ago
.gitignore mu4e: use mu4e-config instead of mu4e-meta 1 month ago
.mailmap Add .mailmap file 2 years ago
AUTHORS * initial import of mu - the next generation 13 years ago
COPYING * initial import of mu - the next generation 13 years ago
ChangeLog Fix incorrect ChangeLog. 7 years ago
Makefile.am autotools: improve build 2 months ago
Makefile.meson meson: improve coverage target 7 days ago
NEWS Add the missing NEWS 7 years ago
NEWS.org NEWS.org: update 1 week ago
README.org README.org: update 4 days ago
TODO * update TODO 10 years ago
autogen.sh build: fix macos/clang build (disable guile) 9 months ago
configure.ac build: bump version to 1.8.5 21 hours ago
gtest.mk mu: allow for code-coverage reports 3 years ago
meson.build build: bump version to 1.8.5 21 hours ago
meson_options.txt build: add 'lispdir' option 4 days ago
version.texi.in meson: Generate version.texi for guile, mu4e 1 year ago

README.org

#+TITLE:mu <img src=" title="https://img.shields.io/github/license/djcb/mu?logo=gnu&.svg" /> <a href=https://img.shields.io/badge/Made%20with-C/CPP-1f425f?logo=c&.svg" title="https://img.shields.io/badge/Made%20with-C/CPP-1f425f?logo=c&.svg" /> <img src=" title="https://img.shields.io/github/v/release/djcb/mu.svg" /> <img src=" title="https://img.shields.io/github/contributors/djcb/mu.svg" /> <img src=" title="https://img.shields.io/github/issues/djcb/mu.svg" /> <img src=" title="https://img.shields.io/github/issues/djcb/mu/rfe?color=008b8b.svg" /> <img src=" title="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" />
<img src=" title="https://img.shields.io/badge/Emacs-25.3-922793?logo=gnu-emacs&logoColor=b39ddb&.svg" /> <img src=" title="https://img.shields.io/badge/Platform-Linux-2e8b57?logo=linux&.svg" /> <img src=" title="https://img.shields.io/badge/Platform-FreeBSD-8b3a3a?logo=freebsd&logoColor=c32136&.svg" /> <img src=" title="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.8 Release Branch or to pick up one of the 1.8 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. 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).

Installation

Note: building from source is an advanced subject; esp. if something goes wrong. The below simple examples are a start, but all tools involved have many options; there are differences between systems, versions etc. So if this is all a bit daunting we recommend to wait for someone else to build it for you, such as a Linux distribution. Many have packages available.

Requirements

To be able to build mu, ensure you have:

  • a C++17 compiler (gcc or clang are known to work)

  • development packages for Xapian and GMime and GLib (see meson.build for the versions)

  • basic tools such as make, sed, grep

  • meson

For mu4e, you also need emacs.

Building

$ git clone git://github.com/djcb/mu.git
$ cd mu

Now, you have a choice. mu uses meson for building, but includes a good-old Makefile with some useful targets, which should work for typical cases.

$ ./autogen.sh && make
$ sudo make install

Alternatively, for more control, you can run meson directly:

$ meson build && ninja -C build
$ ninja -C build install

This allows for passing various meson options, such as --prefix. Consult the meson documentation for details.