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.
13 KiB
13 KiB
MELI(1) General Commands Manual MELI(1)
NAME
meli – Meli Mail User Agent. meli is the Greek word for honey
SYNOPSIS
meli [--help | -h] [--version | -v] [--create-config [path]]
[--test-config [path]] [--config path] [--print-default-theme]
[--print-loaded-themes]
--help | -h
Show help message and exit.
--version | -v
Show version and exit.
--create-config [path]
Create configuration file in path if given, or at
$XDG_CONFIG_HOME/meli/config.toml
--test-config [path]
Test a configuration file for syntax issues or missing
options.
--config path
Start meli with given configuration file.
--print-default-theme
Print default theme keys and values in TOML syntax, to
be used as a blueprint.
--print-loaded-themes
Print all loaded themes in TOML syntax.
DESCRIPTION
meli is a terminal mail client aiming for extensive and user-frendly
configurability.
^^ .-=-=-=-. ^^
^^ (`-=-=-=-=-`) ^^
(`-=-=-=-=-=-=-`) ^^ ^^
^^ (`-=-=-=-=-=-=-=-`) ^^
( `-=-=-=-(@)-=-=-` ) ^^
(`-=-=-=-=-=-=-=-=-`) ^^
(`-=-=-=-=-=-=-=-=-`) ^^
(`-=-=-=-=-=-=-=-=-`)
^^ (`-=-=-=-=-=-=-=-=-`) ^^
^^ (`-=-=-=-=-=-=-=-`) ^^
(`-=-=-=-=-=-=-`) ^^
^^ (`-=-=-=-=-`)
`-=-=-=-=-` ^^
STARTING WITH meli
When launched for the first time, meli will search for its configuration
directory, $XDG_CONFIG_HOME/meli/. If it doesn't exist, you will be
asked if you want to create one along with a sample configuration. The
sample configuration $XDG_CONFIG_HOME/meli/config.toml includes comments
with the basic settings required for setting up accounts allowing you to
copy and edit right away. See meli.conf(5) for the available
configuration options.
At any time, you may press ? to show a searchable list of all available
actions and shortcuts, along with every possible setting and command that
your version supports.
The main visual navigation tool is the left-side sidebar. The menu's
visibility may be toggled with ` (shortcuts.listing:
toggle_menu_visibility).
The view into each folder has 4 modes: plain, threaded, conversations and
compact. Plain views each mail indvidually, threaded shows their thread
relationship visually, and conversations includes one entry per thread of
emails (compact is one row per thread).
If you're using a light color palette in your terminal, you may set theme
= light in the terminal section of your configuration. See
meli-themes(5) for complete documentation on user themes.
VIEWING MAIL
Open attachments by typing their index in the attachments list and then
a. meli will attempt to open text inside its pager and other content via
xdg-open. Press m instead to use the mailcap entry for the MIME type of
the attachment, if any. See FILES for the location of the mailcap files
and mailcap(5) for their syntax.
SEARCH
Each e-mail storage backend has its default search method. IMAP uses the
SEARCH command, notmuch uses libnotmuch and Maildir/mbox have to do a
slow linear search. Thus it is advised to use a cache on Maildir/mbox
accounts. meli, if built with sqlite3, includes the ability to perform
full text search on the following fields: From, To, Cc, Bcc, In-Reply-To,
References, Subject and Date. The message body (in plain text human
readable form) and the flags can also be queried. To enable sqlite3
indexing for an account set cache_type to sqlite3 in the configuration
file and to create the sqlite3 index issue command index ACCOUNT_NAME.
To search in the message body type your keywords without any special
formatting. To search in specific fields, prepend your search keyword
with "field:" like so:
subject:helloooo or subject:"call for help" or "You remind me today
of a small, Mexican chihuahua."
not ((from:unrealistic and (to:complex or not query )) or
flags:seen,draft)
alladdresses:mailing@list.tld and cc:me@domain.tld
Boolean operators are or, and and not (alias: !) String keywords with
spaces must be quoted. Quotes should always be escaped.
Important Notice about IMAP/JMAP
To prevent downloading all your messages from your IMAP/JMAP server,
don't set cache_type to sqlite3. meli will relay your queries to the
IMAP server. Expect a delay between query and response. Sqlite3 on the
contrary at reasonable mailbox sizes should have a non noticable delay.
TAGS
meli supports tagging in notmuch and IMAP/JMAP backends. Tags can be
searched with the `tags:` or `flags:` prefix in a search query, and can
be modified by tag add TAG and tag remove TAG (see meli.conf(5) TAGS,
settings colors and ignore_tags for how to set tag colors and tag
visiblity)
COMPOSING
To send mail, press m while viewing the appropriate account to open a new
composing tab. To reply to a mail, press R. You may edit some of the
header fields from within the view, by selecting with the arrow keys and
pressing enter to enter INSERT mode. At any time you may press e to
launch your editor (see meli.conf(5) COMPOSING, setting editor_cmd for
how to select which editor to launch). Attachments may be handled with
the add-attachment, remove-attachment commands (see below). Finally,
pressing s will send your message by piping it into a binary of your
choosing (see meli.conf(5) COMPOSING, setting mailer_cmd). To save your
draft without sending it, issue command close and select 'save as draft'.
With no Draft or Sent folder, meli tries first saving mail in your INBOX
and then at any other folder. On complete failure to save your draft or
sent message it will be saved in your tmp directory instead and you will
be notified of its location.
To open a draft for editing later, select your draft in the mail listing
and press e.
Your editor can be used in meli's embed terminal emulator by setting
embed to true in your composing settings. When launched, your editor
captures all input until it exits or stops. To stop your editor and
return to meli issue Ctrl-z and to resume editing press the edit_mail
command again (default e).
CONTACTS
meli supports two kinds of contact backends:
1. an internal format that gets saved under
$XDG_DATA_HOME/meli/account_name/addressbook.
2. vCard files (v3, v4) through the vcard_folder option in the
account section. The path defined as vcard_folder can hold
multiple vCards per file. They are loaded read only.
See meli.conf(5) ACCOUNTS for the complete account configuration values.
EXECUTE mode
Commands are issued in EXECUTE mode, by default started with Space and
exited with Escape key.
the following commands are valid in the mail listing context:
set plain | threaded | compact | conversations
set the way mailboxes are displayed
┌──────────────┬─────────────────────────────────────────────────┐
│conversations │ shows one entry per thread │
├──────────────┼─────────────────────────────────────────────────┤
│compact │ shows one row per thread │
├──────────────┼─────────────────────────────────────────────────┤
│threaded │ shows threads as a tree structure │
├──────────────┼─────────────────────────────────────────────────┤
│plain │ shows one row per mail, regardless of threading │
└──────────────┴─────────────────────────────────────────────────┘
sort subject | date asc | desc sort mail listing
subsort subject | date asc | desc sorts only the first level of
replies.
go n where n is a mailbox prefixed with
the n number in the side menu for
the current account
toggle_thread_snooze don't issue notifications for
thread under cursor in thread
listing
filter STRING filter mailbox with STRING key.
Escape exits filter results
set read, set unread
create-folder ACCOUNT FOLDER_PATH create folder with given path. Be
careful with backends and separator
sensitivity (eg IMAP)
subscribe-folder ACCOUNT FOLDER_PATH subscribe to folder with given path
unsubscribe-folder ACCOUNT FOLDER_PATH
unsubscribe to folder with given
path
rename-folder ACCOUNT FOLDER_PATH_SRC FOLDER_PATH_DEST
rename folder
delete-folder ACCOUNT FOLDER_PATH delete folder
envelope view commands:
pipe EXECUTABLE ARGS pipe pager contents to binary
list-post post in list of viewed envelope
list-unsubscribe unsubscribe automatically from list
of viewed envelope
list-archive open list archive with xdg-open
composing mail commands:
add-attachment PATH in composer, add PATH as an
attachment
remove-attachment INDEX remove attachment with given index
toggle sign toggle between signing and not
signing this message. If the gpg
invocation fails then the mail
won't be sent.
generic commands:
open-in-tab opens envelope view in new tab
close closes closeable tabs
setenv KEY=VALUE set environment variable KEY to
VALUE
printenv KEY print environment variable KEY
SHORTCUTS
Non-complete list of shortcuts and their default values.
open_thread '\n'
exit_thread 'i'
create_contact 'c'
edit_contact 'e'
prev_page PageUp,
next_page PageDown
prev_folder 'K'
next_folder 'J'
prev_account 'l'
next_account 'h'
new_mail 'm'
scroll_up 'k'
scroll_down 'j'
page_up PageUp
page_down PageDown
toggle-menu-visibility '`'
select 'v'
` toggles hiding of sidebar in mail
listings
? opens up a shortcut window that
shows available actions in the
current component you are using (eg
mail listing, contact list, mail
composing)
m starts a new mail composer
R replies to the viewed mail.
u displays numbers next to urls in
the body text of an email and ng
opens the nth url with xdg-open
na opens the nth attachment.
nm opens the nth attachment according
to its mailcap entry.
v (un)selects mail entries in mail
listings
EXIT STATUS
meli exits with 0 on a successful run. Other exit statuses are:
1 catchall for general errors
ENVIRONMENT
EDITOR Specifies the editor to use
MELI_CONFIG Override the configuration file
NO_COLOR When present (regardless of its
value), prevents the addition of
ANSI color. The configuration
value use_color overrides this.
FILES
meli uses the following parts of the XDG standard:
XDG_CONFIG_HOME defaults to ~/.config/
XDG_CACHE_HOME defaults to ~/.cache/
and appropriates the following locations:
$XDG_CONFIG_HOME/meli/ User configuration directory.
$XDG_CONFIG_HOME/meli/config.toml
User configuration file. See
meli.conf(5) for its syntax and
values.
$XDG_CONFIG_HOME/meli/hooks/* Reserved for event hooks.
$XDG_CONFIG_HOME/meli/plugins/* Reserved for plugin files.
$XDG_CACHE_HOME/meli/* Internal cached data used by meli.
$XDG_DATA_HOME/meli/* Internal data used by meli.
$XDG_DATA_HOME/meli/meli.log Operation log.
/tmp/meli/* Temporary files generated by meli.
Mailcap entries are searched for in the following files, in this order:
1. $XDG_CONFIG_HOME/meli/mailcap
2. $XDG_CONFIG_HOME/.mailcap
3. $HOME/.mailcap
4. /etc/mailcap
5. /usr/etc/mailcap
6. /usr/local/etc/mailcap
SEE ALSO
meli.conf(5), meli-themes(5), xdg-open(1), mailcap(5)
CONFORMING TO
XDG Standard
⟨https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html⟩,
maildir ⟨https://cr.yp.to/proto/maildir.html⟩, IMAPv4rev1 RFC3501, The
JSON Meta Application Protocol (JMAP) RFC8620, The JSON Meta Application
Protocol (JMAP) for Mail RFC8621.
AUTHORS
Copyright 2017-2019 Manos Pitsidianakis ⟨epilys@nessuent.xyz⟩ Released
under the GPL, version 3 or greater. This software carries no warranty
of any kind. (See COPYING for full copyright and warranty notices.)
⟨https://meli.delivery⟩
Debian July 29, 2019 Debian