terminal e-mail client and e-mail client library https://meli.delivery
 
 
 
 
 
 
Go to file
Manos Pitsidianakis f81a1e2338
Tests / Test on ${{ matrix.build }} (linux-amd64, ubuntu-latest, stable, x86_64-unknown-linux-gnu) (push) Successful in 13m6s Details
Build release binary / Build on ${{ matrix.build }} (meli-linux-amd64, linux-amd64, ubuntu-latest, stable, x86_64-unknown-linux-gnu) (push) Failing after 10m49s Details
Bump version to 0.8.4
0.8.3 had a misbehaving test.

Signed-off-by: Manos Pitsidianakis <manos@pitsidianak.is>
2023-11-22 21:48:59 +02:00
.cargo Enable "static" build for C library dependencies by default 2023-11-22 15:26:16 +02:00
.gitea .gitea: update PULL_REQUEST_TEMPLATE.md 2023-08-26 11:31:30 +03:00
benches melib: remove BackendOpGenerator 2019-07-18 20:14:14 +03:00
contrib melib/imap: implement OAUTH2 authentication 2020-11-24 14:28:28 +02:00
debian debian/: update fix-prefix-for-debian.patch 2023-03-06 09:52:51 +02:00
fuzz melib/build.rs: add feature to use cache instead of downloading unicode data 2023-09-01 15:55:43 +03:00
meli Bump version to 0.8.4 2023-11-22 21:48:59 +02:00
melib Bump version to 0.8.4 2023-11-22 21:48:59 +02:00
scripts Add scripts/make_html_manual_page.py 2023-08-29 14:55:16 +03:00
tools Move managesieve-client binary to tools/ 2023-11-22 15:10:23 +02:00
.gdbinit small fixes 2019-11-21 15:44:18 +02:00
.gitignore chore: Add `.idea` (CLion) to `.gitignore`. 2023-05-17 09:22:12 +00:00
CHANGELOG.md listing: add relative_list_indices setting for thread listing 2023-07-16 14:13:55 +03:00
COPYING mailbox: add threads 2019-06-10 19:11:47 +03:00
Cargo.lock Bump version to 0.8.4 2023-11-22 21:48:59 +02:00
Cargo.toml melib: update to 2021 edition 2023-09-13 18:47:00 +03:00
Cross.toml Add Cross.toml for aarch64-unknown-linux-gnu builds 2023-09-05 15:33:28 +03:00
DEVELOPMENT.md Update README.md relative file paths 2023-07-16 20:06:44 +03:00
Makefile melib/utils/xdg: fix doc test compilation 2023-09-22 12:26:42 +02:00
README.md Enable "static" build for C library dependencies by default 2023-11-22 15:26:16 +02:00
rustfmt.toml Clippy fixes 2023-04-30 20:47:53 +03:00

README.md

meli GitHub license Crates.io IRC channel

BSD/Linux terminal email client with support for multiple accounts and Maildir / mbox / notmuch / IMAP / JMAP / NNTP (usenet).

Community links: mailing lists | #meli on OFTC IRC | Report bugs and/or feature requests in meli's issue tracker

Main repository: https://git.meli.delivery/meli/meli

Official mirrors: https://github.com/meli/meli

Main view screenshot Compact main view screenshot Compose with embed terminal editor screenshot
Main view Compact main view Compose with embed terminal editor

Description

meli aims for configurability, extensibility with sane defaults, and modern practices. It is a mail client for both casual and power users of the terminal.

A variety of email workflows and software stacks should be usable with meli. Integrate e-mail storage, sync, tagging system, SMTP client, contact management and editor of your choice to replace the defaults.

Supported E-mail backends

Protocol Support
IMAP full
Maildir full
notmuch full*
mbox read-only
JMAP functional
NNTP / Usenet functional
  • there's no support for searching through all email directly, you'd have to create a mailbox with a notmuch query that returns everything and search inside that mailbox.

E-mail Submission backends


  • SMTP
  • Pipe to shell script
  • Server-side submission

Non-exhaustive List of Features

  • TLS
  • email threading support
  • multithreaded, async operation
  • optionally run your editor of choice inside meli, with an embedded xterm-compatible terminal emulator
  • plain text configuration in TOML
  • ability to open emails in UI tabs and switch to them
  • optional sqlite3 index search
  • override almost any setting per mailbox, per account
  • contact list (+read-only vCard and mutt alias file support)
  • forced UTF-8 (other encodings are read-only)
  • configurable shortcuts
  • theming
  • NO_COLOR support
  • ascii-only drawing characters option
  • view text/html attachments through an html filter command (w3m by default)
  • pipe attachments/mail to stuff
  • use external attachment file picker instead of typing in an attachment's full path
  • GPG signing, encryption, signing + encryption
  • GPG signature verification

Install

Documentation

See a comprehensive tour of meli in the manual page meli(7).

See also the Quickstart tutorial online.

After installing meli, see meli(1), meli.conf(5), meli(7) and meli-themes(5) for documentation. Sample configuration and theme files can be found in the meli/docs/samples/ subdirectory. Manual pages are also hosted online.

meli by default looks for a configuration file in this location: $XDG_CONFIG_HOME/meli/config.toml

You can run meli with arbitrary configuration files by setting the $MELI_CONFIG environment variable to their locations, i.e.:

MELI_CONFIG=./test_config cargo run

Build

For a quick start, build and install locally:

 PREFIX=~/.local make install

Available subcommands for make are listed with make help. The Makefile should be POSIX portable and not require a specific make version.

meli requires rust 1.65 and rust's package manager, Cargo. Information on how to get it on your system can be found here: https://doc.rust-lang.org/cargo/getting-started/installation.html

With Cargo available, the project can be built with make and the resulting binary will then be found under target/release/meli. Run make install to install the binary and man pages. This requires root, so I suggest you override the default paths and install it in your $HOME: make PREFIX=$HOME/.local install.

You can build and run meli with one command: cargo run --release.

Build features

Some functionality is held behind "feature gates", or compile-time flags. The following list explains each feature's purpose:

  • gpgme enables GPG support via libgpgme (on by default)
  • dbus-notifications enables showing notifications using dbus (on by default)
  • notmuch provides support for using a notmuch database as a mail backend (on by default)
  • jmap provides support for connecting to a jmap server and use it as a mail backend (on by default)
  • sqlite3 provides support for builting fast search indexes in local sqlite3 databases (on by default)
  • cli-docs includes the manpage documentation compiled by either mandoc or man binary to plain text in meli's command line. Embedded documentation can be viewed with the subcommand meli man [PAGE] (on by default).
  • regexp provides experimental support for theming some e-mail fields based on regular expressions. It uses the pcre2 library. Since it's actual use in the code is very limited, it is not recommended to use this (off by default).
  • static and *-static bundle C libraries in dependencies so that you don't need them installed in your system (on by default).

Build Debian package (deb)

Building with Debian's packaged cargo might require the installation of these two packages: librust-openssl-sys-dev librust-libdbus-sys-dev

A *.deb package can be built with make deb-dist

Using notmuch

To use the optional notmuch backend feature, you must have libnotmuch5 installed in your system. In Debian-like systems, install the libnotmuch5 packages. meli detects the library's presence on runtime.

Using GPG

To use the optional gpg feature, you must have libgpgme installed in your system. In Debian-like systems, install the libgpgme11 package. meli detects the library's presence on runtime.

HTML Rendering

HTML rendering is achieved using w3m by default. You can use the pager.html_filter setting to override this (for more details you can consult meli.conf(5)).

Development

Development builds can be built and/or run with

cargo build
cargo run

There is a debug/tracing log feature that can be enabled by using the flag --feature debug-tracing after uncommenting the features in Cargo.toml. The logs are printed in stderr when the env var MELI_DEBUG_STDERR is defined, thus you can run meli with a redirection (i.e 2> log).

Code style follows the rustfmt.toml file.