Go to file
Ben Swift 85b94edfa4 add CI: run tests suite with GitHub actions
currently this runs tests on the latest Ubuntu LTS and the latest macOS

should be straightforward to run tests on any of the other [supported
environments](https://github.com/actions/virtual-environments) or in a Docker
container
2020-06-12 07:14:49 +10:00
.github add CI: run tests suite with GitHub actions 2020-06-12 07:14:49 +10:00
build-aux build: add dummy config.rpath 2018-05-29 10:59:20 +03:00
contrib Support gmime 3.0 2017-07-30 16:47:38 +02:00
guile rework logging system 2020-05-30 13:29:44 +03:00
lib mu-msg-sexp: correctly mask date/time bits 2020-06-10 21:50:23 +03:00
m4 Add m4/host-cpu-c-abi.m4 2020-04-08 11:26:32 +02:00
man lib: follow symlinks in maildirs 2020-05-26 19:22:41 +03:00
mu test-mu-cmd: temporarily turn off test 2020-06-11 21:49:55 +03:00
mu4e mu4e: mu4e-info is not interactive 2020-06-08 19:52:19 +03:00
toys rework logging system 2020-05-30 13:29:44 +03:00
www Fix typos 2020-05-12 23:56:55 +02:00
.dir-locals.el mu4e: Enforce use of spaces for indentation 2020-02-17 14:28:00 +01:00
.editorconfig editorconfig: Don't misconfigure indentation for Emacs lisp files 2020-02-17 14:27:54 +01:00
.gitignore lib/utils: build s-expression programmatically building 2020-06-06 14:27:25 +03:00
.mailmap Add .mailmap file 2020-02-17 14:28:00 +01:00
.travis.yml Travis: use recent autoconf 2.69 and recent autoconf-archive 2016-12-14 01:57:33 +01: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 Fix incorrect ChangeLog. 2015-08-08 08:54:33 +07:00
HACKING rework logging system 2020-05-30 13:29:44 +03:00
Makefile.am README: Use org format, slight updates 2020-05-25 21:09:38 +03:00
NEWS Add the missing NEWS 2015-06-09 21:08:02 +03:00
NEWS.org NEWS.org: a few more typographical updates 2020-06-07 18:28:59 +03:00
README.org README: Use org format, slight updates 2020-05-25 21:09:38 +03:00
TODO * update TODO 2012-12-02 22:57:47 +02:00
autogen.sh Fix typos 2019-11-06 16:13:39 +01:00
c.cfg Fix typos 2019-11-06 16:13:39 +01:00
configure.ac build: bump version to 1.5.2 2020-06-07 09:57:49 +03:00
gtest.mk mu: allow for code-coverage reports 2020-01-01 15:56:48 +02:00

README.org

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.4.x Release Branch 1.4.x Release Branch or to pick up one of the 1.4.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 2.2 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. The all of the code is distributed under the terms of the GNU General Public License version 3 (or higher).