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.
 
 
 
 
Manos Pitsidianakis 48e7a493a9
Add reload-config command
3 days ago
benches melib: remove BackendOpGenerator 1 year ago
contrib melib/imap: implement OAUTH2 authentication 1 week ago
debian debian/: bump version to 0.6.2 2 months ago
docs Add reload-config command 3 days ago
fuzz Add cargo-fuzz targets 7 months ago
melib melib/imap: remove DoubleEndedIterator for ImapLineIterator 3 days ago
scripts Add pre-push git hook 11 months ago
src Add reload-config command 3 days ago
tests Fix test errors and warnings 2 weeks ago
tools Fix test errors and warnings 2 weeks ago
.gdbinit small fixes 1 year ago
.gitignore debian/: add build artifacts to .gitignore 10 months ago
CHANGELOG.md compose: add `add-attachment-file-picker` command 1 month ago
COPYING mailbox: add threads 1 year ago
Cargo.lock Update xdg-util dependency to 0.4.0 1 week ago
Cargo.toml Update smallvec dependency to 1.5.0 1 week ago
Makefile Makefile: add CARGO_ARGS env var 1 month ago
README.md README: replace svg with webp screenshots 1 month ago
build.rs cli-docs: compress included text 1 month ago
config_macros.rs compose: add key selection state for gpg operations 1 month ago
rustfmt.toml rustfmt.toml: set edition = 2018 5 months ago

README.md

meli GitHub license Crates.io

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

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

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

Install

Documentation

See also Quickstart tutorial.

After installing meli, see meli(1), meli.conf(5) and meli-themes(5) for documentation. Sample configuration and theme files can be found in the 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.39 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 (off 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]
  • svgscreenshot provides support for taking screenshots of the current view of meli and saving it as SVG files. Its only purpose is taking screenshots for the official meli webpage. (off by default)
  • debug-tracing enables various trace debug logs from various places around the meli code base. The trace log is printed in stderr. (off 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.

Building with JMAP

To build with JMAP support, prepend the environment variable MELI_FEATURES='jmap' to your make invocation:

MELI_FEATURES="jmap" make

or if building directly with cargo, use the flag `--features="jmap"'.

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, thus you can run meli with a redirection (i.e 2> log)

Code style follows the default rustfmt profile.

Testing

How to run specific tests:

cargo test -p {melib, meli} (-- --nocapture) (--test test_name)

Profiling

perf record -g target/debug/bin
perf script | stackcollapse-perf | rust-unmangle | flamegraph > perf.svg

Running fuzz targets

Note: cargo-fuzz requires the nightly toolchain.

cargo +nightly fuzz run envelope_parse -- -dict=fuzz/envelope_tokens.dict