meli - Tutorial for the meli terminal e-mail client
MELI(7) Miscellaneous Information Manual MELI(7)
NAME
meli — Tutorial for the meli terminal e−mail client
SYNOPSIS
meli [...]
DESCRIPTION
meli is a terminal mail client aiming for extensive and user−friendly configurability.
ˆˆ
.-=-=-=-. ˆˆ
ˆˆ (‘-=-=-=-=-‘) ˆˆ
(‘-=-=-=-=-=-=-‘) ˆˆ ˆˆ
ˆˆ (‘-=-=-=-=-=-=-=-‘) ˆˆ
( ‘-=-=-=-(@)-=-=-‘ ) ˆˆ
(‘-=-=-=-=-=-=-=-=-‘) ˆˆ
(‘-=-=-=-=-=-=-=-=-‘) ˆˆ
(‘-=-=-=-=-=-=-=-=-‘)
ˆˆ (‘-=-=-=-=-=-=-=-=-‘) ˆˆ
ˆˆ (‘-=-=-=-=-=-=-=-‘) ˆˆ
(‘-=-=-=-=-=-=-‘) ˆˆ
ˆˆ (‘-=-=-=-=-‘)
‘-=-=-=-=-‘ ˆˆ
INTRODUCTION
To quit meli press ⟨q⟩ (
shortcuts.general.quit ) at any time. 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 and presented with a sample configuration file ($XDG_CONFIG_HOME/meli/config.toml) that includes 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 ⟨?⟩ (
shortcuts.general.toggle_help ) for a searchable list of all available actions and shortcuts, along with every possible setting and command that your version supports.
Each time a shortcut is mentioned in this document, you will find a parenthesis next to it with the name of the shortcut setting along with its section in the configuration settings so that you can modify it if you wish.
For example, to set the toggle_help shortcut mentioned in the previous paragraph, add the following to your configuration:
[shortcuts]
general.toggle_help = ’F1’
Or alternatively:
[shortcuts.general]
toggle_help = ’F1’
To go to the next tab on the right, press ⟨T⟩ (
shortcuts.general.next_tab ).
INTERACTING WITH meli
You will be interacting with
meli in four primary ways:
1. keyboard shortcuts in NORMAL mode.
2. commands with arguments in COMMAND mode.
3. regular text input in text input widgets in INSERT
mode.
4. any kind of input that gets passed directly into an
embedded terminal in EMBED mode.
MODES
meli is a modal application, just like vi(1). This means that pressing the same keys in different modes would yield different results. This allows you to separate how the input is interpreted without the need to focus your input with a mouse.
NORMAL
This is the default mode of meli. All keyboard shortcuts work in this mode.
COMMAND
Commands are issued in COMMAND mode, by default started with ⟨:⟩ (
shortcuts.general.enter_command_mode ) and exited with ⟨Esc⟩ key.
EMBED
This is the mode of the embed terminal emulator. To exit an embedded application, issue ⟨Ctrl−C⟩ to kill it or ⟨Ctrl−Z⟩ to stop the program and follow the instructions on meli to exit.
INSERT
This mode is entered when pressing ⟨Enter⟩ on a cursor selected text input field, and it captures all input as text input. It is exited with the ⟨Esc⟩ key.
ACTIVE SHORTCUTS POPUP
By pressing ⟨?⟩ (
shortcuts.general.toggle_help ) at any time, the shortcuts popup display status gets toggled. You can find all valid shortcuts for the current UI state you are in.
ââshortcutsââPress
? to
closeâââââââââââââââââââââââââââââââââ
â ââ
â use COMMAND "search" to find shortcuts
ââ
â Use Up, Down, Left, Right to scroll. ââ
â ââ
â pager ââ
â ââ
â PageDown page_down ââ
â PageUp page_up â
â j scroll_down â
â k scroll_up â
â â
â view mail â
â â
â c add_addresses_to_contacts â
â e edit â
â u toggle_url_mode â
â a open_attachment â
â m open_mailcap â
â R reply â
â C-r reply_to_author â
â C-g reply_to_all â
â C-f forward â
â M-r view_raw_source â
â h toggle_expand_headers ââ
ââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââ
Shows active shortcuts in order of the widget hierarchy.
MAIN VIEW
âââââââââââââââââââââââââ
ââââââ¼âââââââââââââââââââ¤
â___ â ___________ â
â _ â _______________ â
â _ â__________________â
â _ â ___________ â
â â _____ â
â â â
ââââââ´âââââââââââââââââââ
The main view’s layout.
This is the view you will spend more time with in meli.
Press ⟨`⟩ (
shortcuts.listing.toggle_menu_visibility ) to toggle the sidebars visibility.
Press ⟨Left⟩ (
shortcuts.listing.focus_right ) to switch focus
on the sidebar menu. Press ⟨Right⟩ (
shortcuts.listing.focus_left ) to switch focus on the
e−mail list.
On the e−mail list, press ⟨k⟩ (
shortcuts.listing.scroll_up ) to scroll up, and
⟨j⟩ (
shortcuts.listing.scroll_down ) to scroll down. Press
⟨Enter⟩ (
shortcuts.listing.open_entry ) to open an e−mail
entry and ⟨i⟩ (
shortcuts.listing.exit_entry ) to exit it.
The sidebar.
ââââââââââââââââââââ
â mailâ contact liâ
âpersonal account â
â 0 INBOX â
â 1 â£âSent â
â 2 â£âLists â
â 3 â â£âmeli-dev â
â 4 â ââmeli â
â 5 â£âDrafts â
â 6 â£âTrash â
â 7 ââfoobar â
â 8 Trash â
â â â â â â â
â â â
Press ⟨k⟩ (
shortcuts.listing.scroll_up ) to scroll up, and
⟨j⟩ (
shortcuts.listing.scroll_down ) to scroll down.
Press ⟨Enter⟩ (
shortcuts.listing.open_mailbox ) to open an entry (either a mailbox or an account name). Entering an account name will show you a page with details about the account and its network connection, depending on the backend.
While focused in the sidebar, you can “collapse” a mailbox tree, if it has children, and you can open it with ⟨Space⟩ (
shortcuts.listing.toggle_mailbox_collapse ). You can have mailbox trees collapsed on startup by default by setting a mailbox’s collapsed setting to true. See meli.conf(5) section MAILBOXES for details.
You can increase the sidebar’s width with ⟨Ctrl−p⟩ (
shortcuts.listing.increase_sidebar ) and decrease
with ⟨Ctrl−o⟩ (
shortcuts.listing.decrease_sidebar ).
The status bar.
âââââââââââââââââââââââââââââââââââââââââââââââââââââââ
âNORMAL | Mailbox: Inbox, Messages: 25772, New: 3006
âââââââââââââââââââââââââââââââââââââââââââââââââââââââ
The status bar shows which mode you are, and the status message of the current view. In the pictured example, it shows the status of a mailbox called “Inbox” with lots of e−mails.
The number modifier buffer.
âââââââââââââââ
12 â
âââââââââââââââ
Some commands may accept a number modifier. For example, scroll down commands can receive a multiplier n to scroll down n entries. Another use of the number buffer is opening URLs inside the pager. See “PAGER” for an explanation of interacting with URLs in e−mails.
Pressing numbers in NORMAL mode will populate this buffer. To erase it, press the ⟨Esc⟩ key.
MAIL LIST
There are four different list styles:
−
"plain" which shows one line per e−mail.
−
"threaded" which shows a threaded view with drawn tree structure.
−
"compact" which shows one line per thread which can include multiple e−mails.
−
"conversations" which shows more than one line per thread which can include multiple e−mails with more details about the thread.
Plain view.
â42 Fri,
02 Sep 2022 19:51 xxxxxxxxxxxxx < [PATCH 3/8] â
â43 Fri, 02 Sep 2022 19:51 xxxxxxxxxxxxx < [PATCH
2/8] â
â44 Fri, 02 Sep 2022 19:51 xxxxxxxxxxxxx < [PATCH
1/8] â
|45 Fri, 02 Sep 2022 19:51 xxxxxxxxxxxxx < [PATCH 0/8] |
â46 Fri, 02 Sep 2022 18:18 xxxxxxxx <xxxxx Re:
[PATCH 3â
Threaded view.
â12 9
hours ago xxxxxxxxxxxxxxx [PATCH v3 0â
â13 9 hours ago xxxxxxxxxxxxxxx
ââ>[PATCH â
â14 9 hours ago xxxxxxxxxxxxxxx
ââ>[PATCH â
|15 9 hours ago xxxxxxxxxxxxxxx ââ>[PATCH |
â16 9 hours ago xxxxxxxxxxxxxxx
ââ>[PATCH â
â17 9 hours ago xxxxxxxxxxxxxxx
ââ>[PATCH â
â18 2022-08-23 01:23:51 xxxxxxxxxxxxxxx [RFC v4
00/â
â19 2022-08-23 01:23:52 xxxxxxxxxxxxxxx
ââ>[RFC v4â
|20 2022-08-30 10:30:16 xxxxxxxxxxxxxxx â
ââ> |
â21 6 days ago xxxxxxxxxxxxxxx â
ââ> â
â22 2022-08-23 01:23:53 xxxxxxxxxxxxxxx
ââ>[RFC v4â
Compact view.
â18
2022-â¦:38 xxxxxxxxxxxxxxx [PATCH v3 3/3]
uâ¦_l() (2) â
|19 2022-â¦:49 xxxxxxxxxxxxxxx [PATCH v8 0/7]
Aâ¦e (3) |
â20 2022-â¦:10 xxxxxxxxxxxxxxx [PATCH v8
2/7] fâ¦s (2) â
â21 2022-â¦:38 xxxxxxxxxxxxxxx [PATCH v8
3/7] bâ¦s (2) â
â22 2022-â¦:53 xxxxxxxxxxxxxxx [PATCH v6
00/10] pâ¦g (31) â
Conversations view.
â[PATCH
v2] xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx (5) â
|1 day agoââââxxxxxxxxxxxxx
<xxxxxxxxxxxxx@xxxxxxxxxx>, xxxxxâ
â |
â[PATCH v2 0/8]
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxâ
â1 day agoââââxxxxxxxxxxxxxxx
<xxxxxxxxxx@xxxxxxxxxxxxxx>, xxâ
| â
â[PATCH 0/2] xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
(4) |
â2 days
agoââââxxxxxxxxxxxxxxxx
<xxxxxxxx@xxxxxxxxxxx>, xxxxxâ
â â
â[PATCH 0/8] xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
(12) â
â2 days agoââââxxxxxxxxxxxxx
<xxxxxxxx@xxxxxxxxxx>, xxxxxxxxxâ
Performing actions on entries and/or selections.
Press ⟨V⟩ (
shortcuts.listing.select_entry ) to toggle the
selection of a single entry. ⟨v⟩ (
shortcuts.listing.select_motion ) can be prefixed by a
number modifier and affixed by a scrolling motion (up or
down) to select multiple entries. Simple set operations can
be performed on a selection with these shortcut
modifiers:
−
Union modifier: ⟨Ctrl−u⟩ (
shortcuts.listing.union_modifier )
−
Difference modifier: ⟨Ctrl−d⟩ (
shortcuts.listing.diff_modifier )
−
Intersection modifier: ⟨Ctrl−i⟩ (
shortcuts.listing.intersection_modifier )
To set an entry as "read" , use the ⟨n⟩ (
shortcuts.listing.set_seen ) shortcut. To set an entry as "unread" , use the command
set unseen
which also has its complement
set seen
action.
For e−mail backends that support flags you can use the following commands on entries and selections to modify them:
flag set FLAG
flag unset FLAG
For e−mail backends that support tags (
like "IMAP" or "notmuch" ) you can use the following commands on entries and selections to modify them:
tag add TAG
tag remove TAG
(see meli.conf(5) TAGS, settings colors and ignore_tags for how to set tag colors and tag visibility) You can clear the selection with the ⟨Esc⟩ key.
PAGER
You can open an e−mail entry by pressing ⟨Enter⟩ (
shortcuts.listing.open_entry ). This brings up the e−mail view with the e−mail content inside a pager.
ââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââ
âDate: Sat, 21 May 2022 16:16:11 +0300 ââ
âFrom: Narrator <[email protected]>
ââ
âTo: Stanley <[email protected]> ââ
âSubject: The e-mail ending ââ
âMessage-ID: <[email protected]>
ââ
â ââ
âThe story, and the choices, or what have you, and
thereforeââ
âby becoming it is! So on and so forth, until
inevitably, we â
âall until the end of time. At which time, everything
all at â
âonce, so now you see? Blah, blah, blah, rah, rah,
rah... â
âWe’ve eaten too much and it can’t be just
yet. No, no! â
âUntil two-hundred and forty-five! But the logic of
â
âelimination, working backwards, the deduction
therefore â
âbecomes impossible to manufacture. It went on for
nearly â
âten thousand years, until just yesterday. Here and
there, â
âforward and back, and never a moment before
lunchtime. It â
âcan’t be! It’s the only thing there is!
How many billions â
âleft until so much more than forever ago! Which is
why I â
âsay: â
â â
âThe story, and the choices, or what have you, and
therefore â
âby becoming it is! So on and so forth, until
inevitably, weââ
ââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââ
The pager displaying an e−mail.
The pager is simple to use. Scroll with the following:
Go to next pager page
⟨PageDown⟩ (
shortcuts.pager.page_down )
Go to previous pager page
⟨PageUp⟩ (
shortcuts.pager.page_up )
Scroll down pager.
⟨j⟩ (
shortcuts.pager.scroll_down )
Scroll up pager.
⟨k⟩ (
shortcuts.pager.scroll_up )
All scrolling shortcuts can be prefixed with a number modifier which will act as a multiplier.
The pager can enter a special url mode which will prefix all detected hyperlinks and e−mail addresses with a number inside square brackets ⟨u⟩ (
shortcuts.pager.toggle_url_mode ). Writing down a
chosen number as a number modifier and pressing
⟨g⟩ (
shortcuts.envelope_view.go_to_url ) will attempt to open
the link with the system’s default open command (
xdg-open(1) in supported OSes, and open(1) on
MacOS ). To override with a custom launcher, see "
pager " configuration setting "
url_launcher " (
see meli.conf(5) PAGER for more details ).
MAIL VIEW
Other things you can do when viewing e−mail:
−
Most importantly, you can exit the mail view with: ⟨i⟩ (
shortcuts.listing.exit_entry )
−
Add addresses from the e−mail headers to contacts: ⟨c⟩ (
shortcuts.envelope_view.add_addresses_to_contacts
)
−
Open an attachment by entering its index as a number modifier and pressing: ⟨a⟩ (
shortcuts.envelope_view.open_attachment )
−
Open an attachment by its mailcap(4) entry by entering its index as a number modifier and pressing: ⟨m⟩ (
shortcuts.envelope_view.open_mailcap )
−
Reply to envelope: ⟨R⟩ (
shortcuts.envelope_view.reply )
−
Reply to author: ⟨Ctrl−r⟩ (
shortcuts.envelope_view.reply_to_author )
−
Reply to all/Reply to list/Follow up: ⟨Ctrl−g⟩ (
shortcuts.envelope_view.reply_to_all )
−
Forward e−mail: ⟨Ctrl−f⟩ (
shortcuts.envelope_view.forward )
−
Expand extra headers: (References and others) ⟨h⟩ (
shortcuts.envelope_view.toggle_expand_headers )
−
View envelope source in a pager: (toggles between raw and decoded source) ⟨M−r⟩ (
shortcuts.envelope_view.view_raw_source )
−
Return to envelope_view if viewing raw source or attachment: ⟨r⟩ (
shortcuts.envelope_view.return_to_normal_view )
COMPOSING
To compose an e−mail, you can either start with an empty draft by pressing ⟨m⟩ (
shortcuts.listing.new_mail ) which opens a composer view in a new tab. To reply to a specific e−mail, when in envelope view you can select the specific action you want to take:
−
Reply to envelope. ⟨R⟩ (
shortcuts.envelope_view.reply )
−
Reply to author. ⟨Ctrl−r⟩ (
shortcuts.envelope_view.reply_to_author )
−
Reply to all. ⟨Ctrl−g⟩ (
shortcuts.envelope_view.reply_to_all )
To launch your editor, press ⟨e⟩ (
shortcuts.composing.edit ). To send your draft,
press ⟨s⟩ (
shortcuts.composing.send_mail ). To save the draft
without submission, enter the command
close
and select "save as draft". You can return to the draft by going to your "Drafts" mailbox and selecting ⟨e⟩ (
shortcuts.envelope_view.edit ).
ââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââ
â mailâ contact list â composing
âââââââââââââââââââââââââ
â COMPOSING MESSAGE â
â Date Mon, 05 Sep 2022 17:49:19 +0300 â
â From myself
<[email protected]>ââââ
â
â To friend <[email protected]>ââ
â
â Cc
âââââââââââââââââââââââââââââââ
â
â Bcc
âââââââââââââââââââââââââââââââ
â
â Subject This is my
subject!ââââââââââââ
â
â â
â no attachments â
â â don’t sign â
â â don’t encrypt â
â â
â Hello
friend!ââââââââââââââââââââââââââââ
â
â
âââââââââââââââââââââââââââââââââââââââââ
â
â
âââââââââââââââââââââââââââââââââââââââââ
â
â â
âNORMAL | Mailbox: Inbox, Messages: 25772, New: 3006
â
ââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââ
The lightly highlighted cells represent text input fields.
If you enable the embed terminal option, you can launch your terminal editor of choice when you press edit.
ââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââ
â mailâ contact list â composing
âââââââââââââââââââââââââ
â âCOMPOSING
MESSAGEââââââââââââââââââââââââââââââââââââ
â
â â
p/v/f/h/5/T/m/07f56b6e-ec09-49d9-b8d8-f0c5a81e7826 â
â
â â 7 Date: Mon, 05 Sep 2022 18:43:10 +0300
â â
â â 6 From: Mister Cardholder
<[email protected]> â â
â â 5 To: â â
â â 4 Cc: â â
â â 3 Bcc: â â
â â 2 Subject: â â
â â 1 User-Agent: meli 0.7.2 â â
â â8 â â â
â ☠â â
â ☠â â
â ☠â â
â ☠â â
â â Nâ¦
<6e-ec09-49d9-b8d8-f0c5a81e7826 100% ã:8
â:1â â
â
ââââââââââââââââââââââââââââââââââââââââââââââââââââââ
â
â â
â â
â â don’t sign â
â â don’t encrypt â
â no attachments â
â â
âEMBED | Mailbox: Inbox, Messages: 25772, New: 3006
â
ââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââââ
nvim(1) running inside the composing tab. The double line border annotates the area of the embedded terminal, the actual embedding is seamless.
composing mail commands
add−attachment PATH
in composer, add PATH as an attachment
add−attachment < CMD ARGS
in composer, pipe CMD ARGS output into an attachment
add−attachment−file−picker
Launch command defined in the configuration value file_picker_command in meli.conf(5) TERMINAL
add−attachment−file−picker < CMD ARGS
Launch command CMD ARGS. The command should print file paths in stdout, separated by NUL bytes. Example usage with fzf:
add-attachment-file-picker < fzf --print0
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. See meli.conf(5) PGP for PGP configuration.
save−draft
saves a copy of the draft in the Draft folder
THEMES
See meli-themes(5) for documentation on how to theme meli.
SEE ALSO
meli(1), meli.conf(5), meli-themes(5), xdg-open(1), mailcap(5)
AUTHORS
Copyright 2017–2024 Manos Pitsidianakis <[email protected]>
Released under the GPL, version 3 or greater. This software carries no warranty of any kind. (
See COPYING for full copyright and warranty notices. )
Links
Website:
https://meli−email.org
Main git repository and issue tracker:
https://git.meli−email.org/meli/meli
Official read-only git mirror on codeberg.org:
https://codeberg.org/meli/meli
Official read-only git mirror on github.com:
https://github.com/meli/meli
meli crate on crates.io:
https://crates.io/crates/meli GNU March 10, 2024
MELI(7)