@ -55,17 +55,17 @@ includes comments with the basic settings required for setting up accounts allow
.Xrmeli.conf5
for the available configuration options.
.Pp
At any time, you can press
At any time, you may press
.Cm\&?
to show a searchable list of all available actions and shortcuts, along with every possible setting and command that your version supports.
.Pp
The main visual navigation tool is the left-side sidebar. The menu's visibility can be toggled (default shortcut
The main visual navigation tool is the left-side sidebar. The menu's visibility may be toggled (default shortcut
.Cm`Ns
).
.Pp
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).
.Pp
If you're using a light color palette in your terminal, you can set
If you're using a light color palette in your terminal, you may set
.Emtheme="light"
in the
.Emterminal
@ -97,7 +97,7 @@ will attempt to open text inside its pager and other content via
.Cmm
instead to use the mailcap entry for the MIME type of the attachment, if any. See
.SxFILES
for the location of the mailcap files and
for the location of the mailcap files and
.Xrmailcap5
for their syntax.
.ShCOMPOSING
@ -105,32 +105,30 @@ To send mail, press
.Cmm
while viewing the appropriate account to open a new composing tab. To reply to a mail, press
.CmRNs
\&. You can edit some of the header fields from within the view, by selecting with the arrow keys and pressing
\&. You may edit some of the header fields from within the view, by selecting with the arrow keys and pressing
.Cmenter
to enter
.ArINSERT
mode. At any time you can press
mode. At any time you may press
.Cme
to launch your editor (see
.Xrmeli.conf5
.EmCOMPOSING
for how to select which editor to launch). Attachments can be handled with the
.Xrmeli.conf5COMPOSING
for how to select which editor to launch). Attachments may be handled with the
.Emadd-attachmentNs
,
.Emremove-attachment
commands (see below). Finally, pressing
.Ars
.Cms
will send your message by piping it into a binary of your choosing (see
.Xrmeli.conf5
.EmCOMPOSINGNs
.Xrmeli.conf5COMPOSINGNs
, setting
.Emmailer_cmdNs
). To save your draft without sending it, issue command
.Cmclose
and select 'save as draft'.
.Pp
If there is no Draft or Sent folder,
.Nm
With no Draft or Sent folder,
.Nm
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
.Emtmp
directory instead and you will be notified of its location.
@ -145,16 +143,16 @@ uses the SEARCH command,
.Emnotmuch
uses libnotmuch and
.EmMaildir/mbox
have to perform a very slow and I/O bound linear search. Thus it is advised to use a cache on
have to do a slow linear search. Thus it is advised to use a cache on
.EmMaildir/mbox
accounts.
accounts.
.NmNs
, 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
.Emcache_type
to
.Emsqlite3
.Emsqlite3
in the configuration file and to create the sqlite3 index issue command
.IcindexArACCOUNT_NAMENs\&.
.CmindexArACCOUNT_NAMENs\&.
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:
@ -172,94 +170,96 @@ Boolean operators are
and
.Emnot
.Po
alias:
.Em!
alias:
.Em\&!
.Pc
String keywords with spaces must be quoted. Quotes should always be escaped.
.sp
.SyImportantNoticeaboutIMAP
To prevent downloading all your messages from your IMAP server, don't set
.sp
To prevent downloading all your messages from your IMAP server, don't set
.Emcache_type
to
.Emsqlite3Ns
\&.
\&.
.Nm
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.
.ShEXECUTEmode
Commands are issued in EXECUTE mode, by default started with the space character and exited with Escape key.
Commands are issued in EXECUTE mode, by default started with Space and exited with Escape key.
.Pp
the following commands are valid in the mail listing context:
the backend-specific path of the root_folder, usually INBOX.
.ItCmformatArStringOpmaildirmboximapnotmuch
.ItIcformatArStringOpmaildirmboximapnotmuch
the format of the mail backend.
.ItCmsubscribed_foldersAr[String,]
.ItIcsubscribed_foldersAr[String,]
an array of folder paths to display in the UI. Paths are relative to the root folder (eg "INBOX/Sent", not "Sent")
.ItCmidentityArString
.ItIcidentityArString
your e-mail address that is inserted in the From: headers of outgoing mail
.ItCmindex_styleArString
.ItIcindex_styleArString
set the way mailboxes are displayed
.Bl-tag-width"conversations"-compact
.ItCmplain
shows one row per mail, regardless of threading
.ItCmthreaded
shows threads as a tree structure, with one row per thread entry
.ItCmconversations
shows one entry per thread
.ItCmcompact
shows one row per thread
.El
.ItCmdisplay_nameArString
.TS
allbox tab(:);
lb l.
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
.TE
.Bl-tag-width36n
.ItIcdisplay_nameArString
(optional) a name which can be combined with your address:
"Name <email@address.tld>"
.ItCmread_onlyArboolean
.ItIcread_onlyArboolean
attempt to not make any changes to this account.
.PqEmfalse
.ItCmcache_typeArString
.ItIccache_typeArString
choose which cache backend to use. Available options are 'none' and 'sqlite3'
.PqEm"sqlite3"
.ItCmfoldersArfolder_config
.ItIcfoldersArfolder_config
(optional) configuration for each folder. Its format is described below in
.SxFOLDERSNs
\&.
.El
.Pp
.Shnotmuchonly
.Cmroot_folder
points to the directory which contains the
.Icroot_folder
points to the directory which contains the
.Pa.notmuch/
subdirectory. notmuch folders are virtual, since they are defined by user-given notmuch queries. Thus you have to explicitly state the folders you want in the
command to pipe new mail to, exit code must be 0 for success.
.ItCmeditor_cmdArString
.ItIceditor_cmdArString
command to launch editor. Can have arguments. Draft filename is given as the last argument. If it's missing, the environment variable $EDITOR is looked up.
.ItCmembedArboolean
.ItIcembedArboolean
(optional) embed editor within meli
.\" default value
.PqEmfalse
.ItCmformat_flowedArboolean
(optional) set format=flowed [RFC367] in text/plain attachments.
.ItIcformat_flowedArboolean
(optional) set format=flowed [RFC3676] in text/plain attachments.
.\" default value
.PqEmtrue
.El
@ -249,110 +247,122 @@ Shortcuts can take the following values: