You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Go to file
Manos Pitsidianakis 4bdfb3a31b
melib/connections.rs: disable Nagle's algorithm by default
Signed-off-by: Manos Pitsidianakis <manos@pitsidianak.is>
1 day ago
.cargo Enable "static" build for C library dependencies by default 6 months ago
.gitea CI: fix lints.yaml rustup install step 2 months ago
benches melib: remove BackendOpGenerator 5 years ago
contrib melib/imap: implement OAUTH2 authentication 4 years ago
debian Bump version to 0.8.5 2 weeks ago
fuzz Make unicode-segmentation a hard dependency 1 month ago
meli conf.rs: Add ErrorKind::Platform 5 days ago
melib melib/connections.rs: disable Nagle's algorithm by default 1 day ago
scripts Various manpage touchups and URL updates 2 months ago
tools Make unicode-segmentation a hard dependency 1 month ago
.gdbinit small fixes 5 years ago
.git-blame-ignore-revs Add .git-blame-ignore-revs file 5 months ago
.gitignore chore: Add `.idea` (CLion) to `.gitignore`. 1 year ago
BUILD.md Update MSRV to 1.70.0 2 weeks ago
CHANGELOG.md Bump version to 0.8.5 2 weeks ago
COPYING mailbox: add threads 5 years ago
Cargo.lock melib: update mailin-embedded dependency to 0.8.2 3 days ago
Cargo.toml melib: update to 2021 edition 8 months ago
Cross.toml Add Cross.toml for aarch64-unknown-linux-gnu builds 9 months ago
DEVELOPMENT.md Update README.md, DEVELOPMENT.md and create BUILD.md 4 months ago
Makefile melib/imap: remove unused imap_trace! and fix comp 2 months ago
README.md Update MSRV to 1.70.0 2 weeks ago
cliff.toml Update all instances of old domains with meli-email.org 2 months ago
codemeta.json Bump version to 0.8.5 2 weeks ago
rustfmt.toml Clippy fixes 1 year ago

README.md

meli Established, created in 2017 Minimum Supported Rust Version GitHub license Crates.io IRC channel

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

Try an old online interactive web demo powered by WebAssembly!

Table of contents:

Install

Build

Run cargo build --release --bin meli or make.

For detailed building instructions, see BUILD.md

Quick start

# Create configuration file in ${XDG_CONFIG_HOME}/meli/config.toml:
$ meli create-config
# Edit configuration in ${EDITOR} or ${VISUAL}:
$ meli edit-config
# Optionally, install manual pages if installed via cargo:
$ meli install-man
# Ready to go.
$ meli

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

See meli(7) for an extensive tutorial and meli.conf(5) for all configuration values.

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

Supported E-mail backends

Protocol Support
IMAP full
Maildir full
notmuch full1
mbox read-only
JMAP functional
NNTP / Usenet functional

E-mail submission backends

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

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

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)).

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, or use the [-c, --config] argument:

MELI_CONFIG=./test_config meli

or

meli -c ./test_config

  1. 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. ↩︎