2020-01-24 01:31:23 +02:00
. \" meli - meli.conf.5
2019-09-16 14:07:38 +03:00
. \"
. \" Copyright 2017-2019 Manos Pitsidianakis
. \"
. \" This file is part of meli.
. \"
. \" meli is free software: you can redistribute it and/or modify
. \" it under the terms of the GNU General Public License as published by
. \" the Free Software Foundation, either version 3 of the License, or
. \" (at your option) any later version.
. \"
. \" meli is distributed in the hope that it will be useful,
. \" but WITHOUT ANY WARRANTY; without even the implied warranty of
. \" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
. \" GNU General Public License for more details.
. \"
. \" You should have received a copy of the GNU General Public License
. \" along with meli. If not, see <http://www.gnu.org/licenses/>.
. \"
2024-03-06 16:28:27 +02:00
.de HorizontalRule
2024-03-10 21:34:29 +02:00
. \"\l'\n(.l\(ru1.25'
2024-03-06 16:28:27 +02:00
.sp
. .
.de LiteralStringValue
.Sm
.Po Qo
.Em Li \\ $1
.Qc Pc
.Sm
. .
.de LiteralStringValueRenders
.LiteralStringValue \\ $1
.shift 1
.Bo
.Sm
Rendered as:
.Li r##
.Qo
\\ $1
.Qc
.Li ##
.Bc
.Sm
. .
2024-03-10 21:34:29 +02:00
. \".Dd November 11, 2022
.Dd March 10 , 2024
2019-09-16 14:07:38 +03:00
.Dt MELI.CONF 5
2019-11-22 13:12:44 +02:00
.Os
2019-09-16 14:07:38 +03:00
.Sh NAME
.Nm meli.conf
2022-11-11 16:48:11 +02:00
.Nd configuration file for the
.Xr meli 1
terminal e-mail client
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
. \"
. \"
2019-09-16 14:07:38 +03:00
.Sh SYNOPSIS
2020-01-28 00:32:40 +02:00
.Pa $XDG_CONFIG_HOME/meli/config.toml
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
. \"
. \"
2019-09-16 14:07:38 +03:00
.Sh DESCRIPTION
2023-11-23 15:29:54 +02:00
Configuration for
.Sy meli
is written in
.Tn TOML
which has a few things to consider (quoting the specification):
.sp
2024-03-10 21:34:29 +02:00
.Bl -dash -compact
2019-09-16 14:07:38 +03:00
.It
2023-11-23 15:29:54 +02:00
.Tn TOML
is case sensitive.
.It
A
.Tn TOML
file must be a valid
.Tn UTF-8
encoded Unicode document.
.It
White-space means
.Sy tab
.Pq Li 0 x09
or
.Sy space
.Pq Li 0 x20 Ns
\& .
2019-09-16 14:07:38 +03:00
.It
2023-11-23 15:29:54 +02:00
Newline means
.Sy LF
.Pq Li 0 x0A
or
.Sy CRLF
.Pq Li 0 x0D 0 x0A Ns
\& .
2019-09-16 14:07:38 +03:00
.El
2020-01-28 18:43:14 +02:00
.sp
2023-11-23 15:29:54 +02:00
Refer to
.Tn TOML
documentation for valid
.Tn TOML
syntax.
.sp
Though not part of
.Tn TOML
syntax,
2019-11-27 22:13:14 +02:00
.Nm
2020-01-29 05:54:13 +02:00
can have nested configuration files by using the following
.Xr m4 1
include macro:
2023-11-23 15:29:54 +02:00
.sp
2020-01-29 05:54:13 +02:00
.Dl include(\&"/path/to/file\&")
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
. \"
. \"
2019-09-16 14:07:38 +03:00
.Sh SECTIONS
2023-11-23 15:29:54 +02:00
The top level sections of the configuration are:
2024-03-10 21:34:29 +02:00
.Bl -dash -compact
2020-05-28 16:02:57 +03:00
.It
accounts
.It
shortcuts
.It
notifications
.It
pager
.It
listing
.It
composing
.It
pgp
.It
terminal
.It
log
.El
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
. \"
. \"
2020-01-28 18:43:14 +02:00
.Sh EXAMPLES
2023-11-23 15:29:54 +02:00
An example configuration:
. \"
. \"
. \"
2019-09-16 14:07:38 +03:00
.Bd -literal
# Setting up a Maildir account
[accounts.account-name]
2020-02-26 10:54:10 +02:00
root_mailbox = "/path/to/root/folder"
2019-09-16 14:07:38 +03:00
format = "Maildir"
2022-03-20 16:31:55 +02:00
listing.index_style = "Compact"
2021-01-13 20:59:23 +02:00
identity="email@example.com"
2020-02-26 10:54:10 +02:00
subscribed_mailboxes = ["folder", "folder/Sent"] # or [ "*", ] for all mailboxes
2019-09-16 14:07:38 +03:00
display_name = "Name"
2020-02-26 10:54:10 +02:00
# Set mailbox-specific settings
[accounts.account-name.mailboxes]
2019-12-18 15:40:57 +02:00
"INBOX" = { alias="Inbox" } #inline table
"drafts" = { alias="Drafts" } #inline table
2020-02-26 10:54:10 +02:00
[accounts.account-name.mailboxes."foobar-devel"] # or a regular table
ignore = true # don't show notifications for this mailbox
2019-09-16 14:07:38 +03:00
# Setting up an mbox account
[accounts.mbox]
2020-02-26 10:54:10 +02:00
root_mailbox = "/var/mail/username"
2019-09-16 14:07:38 +03:00
format = "mbox"
2022-03-20 16:31:55 +02:00
listing.index_style = "Compact"
2019-09-16 14:07:38 +03:00
identity="username@hostname.local"
2020-07-15 15:19:27 +03:00
composing.send_mail = { hostname = "localhost", port = 25, auth = { type = "none" }, security = { type = "none" } }
2019-09-16 14:07:38 +03:00
[pager]
2020-05-31 22:37:06 +03:00
filter = "COLUMNS=72 /usr/local/bin/pygmentize -l email"
2019-10-03 19:51:34 +03:00
html_filter = "w3m -I utf-8 -T text/html"
2019-09-16 14:07:38 +03:00
[notifications]
script = "notify-send"
2019-09-27 12:48:48 +03:00
[composing]
2019-09-16 14:07:38 +03:00
# required for sending e-mail
2020-07-15 15:19:27 +03:00
send_mail = 'msmtp --read-recipients --read-envelope-from'
2021-01-13 20:59:23 +02:00
#send_mail = { hostname = "smtp.example.com", port = 587, auth = { type = "auto", username = "user", password = { type = "command_eval", value = "gpg2 --no-tty -q -d ~/.passwords/user.gpg" } }, security = { type = "STARTTLS" } }
2020-07-08 12:09:37 +03:00
editor_command = 'vim +/^$'
2019-09-16 14:07:38 +03:00
[shortcuts]
2019-11-27 01:43:03 +02:00
[shortcuts.composing]
2023-06-22 13:23:27 +03:00
edit = 'e'
2019-11-27 01:43:03 +02:00
[shortcuts.listing]
new_mail = 'm'
set_seen = 'n'
2019-10-06 10:58:47 +03:00
[terminal]
theme = "light"
2019-09-16 14:07:38 +03:00
.Ed
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
.sp
2020-07-15 20:20:37 +03:00
Available options are listed below.
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
. \"
. \"
2019-09-16 14:07:38 +03:00
.Sh ACCOUNTS
2024-03-06 16:28:27 +02:00
.Ss Account configuration settings
2023-05-16 13:17:13 +03:00
Default values are shown in parentheses.
2019-11-22 13:12:44 +02:00
.Bl -tag -width 36 n
2020-02-26 10:54:10 +02:00
.It Ic root_mailbox Ar String
2023-11-23 15:29:54 +02:00
The backend-specific path of the root_mailbox, usually
.Sy INBOX Ns
\& .
2024-03-16 15:01:28 +02:00
.It Ic default_mailbox Ar String
.Pq Em optional
The mailbox that is the default to open or view for this account.
Must be a valid mailbox path.
If not specified, the default will be the root mailbox.
2019-12-13 00:13:54 +02:00
.It Ic format Ar String Op maildir mbox imap notmuch jmap
2020-07-15 20:20:37 +03:00
The format of the mail backend.
2020-02-26 10:54:10 +02:00
.It Ic subscribed_mailboxes Ar [String,]
2020-07-15 20:20:37 +03:00
An array of mailbox paths to display in the UI.
2023-11-23 15:29:54 +02:00
Paths are relative to the root mailbox (e.g.
.Sy INBOX/Sent Ns
, not
.Sy Sent Ns
).
2019-11-24 20:44:24 +02:00
The glob wildcard
.Em \& *
2020-02-26 10:54:10 +02:00
can be used to match every mailbox name and path.
2019-11-22 13:12:44 +02:00
.It Ic identity Ar String
2023-11-23 15:29:54 +02:00
Your e-mail address that is inserted in the
.Li From Ns
:
headers of outgoing mail.
2022-03-21 20:53:37 +02:00
.It Ic extra_identities Ar [String,]
Extra e-mail address identities.
2023-11-23 15:29:54 +02:00
When replying to an e-mail addressed to one of these identities, the
.Li From Ns
:
header will be adjusted to its value instead of the default identity.
2019-09-16 14:07:38 +03:00
.El
2019-11-22 13:12:44 +02:00
.Bl -tag -width 36 n
.It Ic display_name Ar String
2020-07-15 20:20:37 +03:00
.Pq Em optional
2023-11-23 15:29:54 +02:00
A name which can be combined with your address:
.Qq Li Name <email@example.com> Ns
\& .
2019-11-22 13:12:44 +02:00
.It Ic read_only Ar boolean
2020-07-15 20:20:37 +03:00
Attempt to not make any changes to this account.
2019-09-16 14:07:38 +03:00
.Pq Em false
2020-01-08 21:41:57 +02:00
.It Ic manual_refresh Ar boolean
2020-07-15 20:20:37 +03:00
.Pq Em optional
2023-11-23 15:29:54 +02:00
If true, do not monitor account for changes
.Po
you can use shortcut
.Li listing.refresh
.Pc Ns
\& .
2020-01-08 21:41:57 +02:00
.Pq Em false
.It Ic refresh_command Ar String
2020-07-15 20:20:37 +03:00
.Pq Em optional
2023-11-23 15:29:54 +02:00
command to execute when manually refreshing
.Po
shortcut
.Li listing.refresh
.Pc
2020-01-08 21:41:57 +02:00
.Pq Em None
2020-07-16 23:57:00 +03:00
.It Ic search_backend Ar String
2020-07-15 20:20:37 +03:00
.Pq Em optional
2020-07-16 23:57:00 +03:00
Choose which search backend to use.
2023-11-23 15:29:54 +02:00
Available options are
.Qq Li none
and
.Qq Li sqlite3 Ns
\& .
.Pq Qq sqlite3
2019-11-27 01:39:06 +02:00
.It Ic vcard_folder Ar String
2020-07-15 20:20:37 +03:00
.Pq Em optional
2023-11-23 15:29:54 +02:00
Folder that contains
.Sy .vcf
files.
2020-01-28 18:43:14 +02:00
They are parsed and imported read-only.
2022-12-23 02:32:22 +02:00
.It Ic mutt_alias_file Ar String
.Pq Em optional
Path of
.Xr mutt 1
compatible alias file in the option
They are parsed and imported read-only.
2020-02-26 10:54:10 +02:00
.It Ic mailboxes Ar mailbox
2020-07-15 20:20:37 +03:00
.Pq Em optional
Configuration for each mailbox.
2020-01-28 18:43:14 +02:00
Its format is described below in
2020-02-26 10:54:10 +02:00
.Sx mailboxes Ns
2019-09-16 14:07:38 +03:00
\& .
.El
2020-07-15 15:19:27 +03:00
.Ss notmuch only
2024-03-06 16:28:27 +02:00
.HorizontalRule
2023-11-23 15:29:54 +02:00
notmuch is supported by loading the dynamic library
.Sy libnotmuch Ns
\& .
2022-09-02 13:07:15 +03:00
If its location is missing from your library paths, you must add it yourself.
Alternatively, you can specify its path by using a setting.
2023-11-23 15:29:54 +02:00
.sp
notmuch mailboxes are virtual, since they are defined by user-given notmuch
queries.
2020-07-15 20:20:37 +03:00
You must explicitly state the mailboxes you want in the
2020-02-26 10:54:10 +02:00
.Ic mailboxes
2019-11-22 13:12:44 +02:00
field and set the
2019-11-14 17:55:06 +02:00
.Ar query
2020-01-28 18:43:14 +02:00
property to each of them.
2022-12-04 16:07:32 +02:00
To create a tree hierarchy with virtual mailboxes, define the
.Ar parent
2023-11-23 15:29:54 +02:00
property to a mailbox as the name of the parent mailbox you have used in your
configuration.
.sp
2022-12-04 16:07:32 +02:00
Account properties:
.Bl -tag -width 36 n
.It Ic root_mailbox
points to the directory which contains the
.Pa .notmuch/
subdirectory.
2022-09-02 13:07:15 +03:00
.It Ic library_file_path Ar Path
2023-11-23 15:29:54 +02:00
Use an arbitrary location of
.Sy libnotmuch
by specifying its full filesystem path.
2022-09-02 13:07:15 +03:00
.Pq Em optional
.El
2022-12-04 16:07:32 +02:00
Mailbox properties:
.Bl -tag -width 36 n
.It Ic query Ar String
2023-11-23 15:29:54 +02:00
The
.Sy notmuch
query that defines what content this virtual mailbox has.
2022-12-04 16:07:32 +02:00
Refer to
.Xr notmuch-search-terms 7
2023-11-23 15:29:54 +02:00
for
.Sy notmuch Ns
\& 's search syntax.
2022-12-04 16:07:32 +02:00
.It Ic parent Ar String
2023-11-23 15:29:54 +02:00
If you wish to build a mailbox hierarchy, define the name of a parent mailbox
you have used in your configuration.
2022-12-04 16:07:32 +02:00
.Pq Em optional
.El
2023-11-23 15:29:54 +02:00
.sp
2020-01-28 18:43:14 +02:00
Example:
2023-11-23 15:29:54 +02:00
.sp
. \"
. \"
. \"
2019-11-14 17:55:06 +02:00
.Bd -literal
[accounts.notmuch]
format = "notmuch"
2022-09-02 13:07:15 +03:00
#library_file_path = "/opt/homebrew/lib/libnotmuch.5.dylib"
2019-11-14 17:55:06 +02:00
\& ...
2020-02-26 10:54:10 +02:00
[accounts.notmuch.mailboxes]
2019-11-14 17:55:06 +02:00
"INBOX" = { query="tag:inbox", subscribe = true }
"Drafts" = { query="tag:draft", subscribe = true }
2021-01-13 20:59:23 +02:00
"Sent" = { query="from:username@example.com from:username2@example.com", subscribe = true }
2022-12-04 16:07:32 +02:00
"Archives" = { query="tag:archived", subscribe = true }
"Archives/2019" = { query="tag:archived date:01-2019..12-2019", parent="Archives", subscribe = true }
2019-11-14 17:55:06 +02:00
.Ed
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2020-07-15 15:19:27 +03:00
.Ss IMAP only
2024-03-06 16:28:27 +02:00
.HorizontalRule
2023-11-23 15:29:54 +02:00
.Tn IMAP
specific options are:
2019-11-22 13:12:44 +02:00
.Bl -tag -width 36 n
.It Ic server_hostname Ar String
2019-09-16 14:07:38 +03:00
example:
2021-01-13 20:59:23 +02:00
.Qq mail.example.com
2019-11-22 13:12:44 +02:00
.It Ic server_username Ar String
2020-07-15 20:20:37 +03:00
Server username
2019-11-22 13:12:44 +02:00
.It Ic server_password Ar String
2020-07-15 20:20:37 +03:00
Server password
2020-03-12 09:45:18 +02:00
.It Ic server_password_command Ar String
2020-07-15 20:20:37 +03:00
.Pq Em optional
Use instead of
2020-03-12 09:45:18 +02:00
.Ic server_password
2019-11-22 13:12:44 +02:00
.It Ic server_port Ar number
2020-07-15 20:20:37 +03:00
.Pq Em optional
The port to connect to
2023-07-15 19:32:39 +03:00
.Pq Em 143 \" default value
2019-11-22 13:12:44 +02:00
.It Ic use_starttls Ar boolean
2020-07-15 20:20:37 +03:00
.Pq Em optional
2023-11-23 15:29:54 +02:00
If port is
.Li 993
and
.Qq Li use_starttls
is unspecified, it becomes false by default.
2023-07-15 19:32:39 +03:00
.Pq Em true \" default value
2023-06-14 12:44:04 +03:00
.It Ic use_tls Ar boolean
.Pq Em optional
2023-11-23 15:29:54 +02:00
Connect with
.Tn TLS
.Po
or upgrade from plain connection to
.Tn TLS
if
.Tn STARTTLS
is set.
.Pc
2023-07-15 19:32:39 +03:00
.Pq Em true \" default value
2019-11-22 13:12:44 +02:00
.It Ic danger_accept_invalid_certs Ar boolean
2020-07-15 20:20:37 +03:00
.Pq Em optional
2023-11-23 15:29:54 +02:00
Do not validate
.Tn TLS
certificates.
2023-07-15 19:32:39 +03:00
.Pq Em false \" default value
2020-07-27 14:59:49 +03:00
.It Ic use_idle Ar boolean
.Pq Em optional
2023-11-23 15:29:54 +02:00
Use
.Tn IDLE
extension.
.Pq Em true \" default value
2020-11-24 12:04:04 +02:00
.It Ic use_condstore Ar boolean
.Pq Em optional
2023-11-23 15:29:54 +02:00
Use
.Tn CONDSTORE
extension.
.Pq Em true \" default value
2020-07-28 16:16:08 +03:00
.It Ic use_deflate Ar boolean
.Pq Em optional
2023-11-23 15:29:54 +02:00
Use
.Tn COMPRESS=DEFLATE
extension
.Po if built with
.Tn DEFLATE
support
.Pc
.Pq Em true \" default value
2020-11-24 12:04:04 +02:00
.It Ic use_oauth2 Ar boolean
.Pq Em optional
2023-11-23 15:29:54 +02:00
Use
.Tn OAUTH2
authentication.
2020-11-24 12:04:04 +02:00
Can only be used with
.Ic server_password_command
2023-11-23 15:29:54 +02:00
which should return a base64-encoded
.Tn OAUTH2
token ready to be passed to
.Tn IMAP Ns
\& .
For help on setup with
.Tn Gmail Ns
, see
.Tn Gmail
section below.
2023-07-15 19:32:39 +03:00
.Pq Em false \" default value
2020-09-12 22:05:48 +03:00
.It Ic timeout Ar integer
.Pq Em optional
Timeout to use for server connections in seconds.
2023-11-23 15:29:54 +02:00
A timeout of
.Li 0
seconds means there is no timeout.
2023-07-15 19:32:39 +03:00
.Pq Em 16 \" default value
2019-09-16 14:07:38 +03:00
.El
2020-11-24 12:04:04 +02:00
.Ss Gmail
2024-03-06 16:28:27 +02:00
.HorizontalRule
2023-11-23 15:29:54 +02:00
.Tn Gmail
has non-standard
.Tn IMAP
behaviors that need to be worked around.
2020-11-24 12:04:04 +02:00
.Ss Gmail - sending mail
2024-03-06 16:28:27 +02:00
.HorizontalRule
2020-11-24 12:04:04 +02:00
Option
.Ic store_sent_mail
2023-11-23 15:29:54 +02:00
should be disabled since
.Tn Gmail
auto-saves sent mail by its own.
2020-11-24 12:04:04 +02:00
.Ss Gmail OAUTH2
2024-03-06 16:28:27 +02:00
.HorizontalRule
2023-11-23 15:29:54 +02:00
To use
.Tn OAUTH2 Ns
, you must go through a process to register your own private
.Qq application
with
.Tn Google
that can use
.Tn OAUTH2
2024-03-17 14:07:07 +02:00
tokens,
and set the option
.Ic use_oauth2
as
.Ql true
in the account configuration section.
2023-11-23 15:29:54 +02:00
For convenience in the
.Sy meli
repository under the
2020-11-24 12:04:04 +02:00
.Pa contrib/
2023-11-23 15:29:54 +02:00
directory you can find a
.Sy python3
file named
.Li oauth2.py
to generate and request the appropriate data to perform
.Tn OAUTH2
authentication.
.sp
2020-11-24 12:04:04 +02:00
Steps:
2024-03-10 21:34:29 +02:00
.Bl -dash -compact
2020-11-24 12:04:04 +02:00
.It
2023-11-23 15:29:54 +02:00
In
.Tn Google API Ns
s, create a custom OAuth client ID and note down the Client ID and Client
Secret.
You may need to create a consent screen; follow the steps described in the
website.
.It
Run the
.Li oauth2.py
script as follows
.Pq after adjusting binary paths and credentials Ns
:
.sp
2020-11-24 12:04:04 +02:00
.Cm python3 oauth2.py --user=xxx@gmail.com --client_id=1038[...].apps.googleusercontent.com --client_secret=VWFn8LIKAMC-MsjBMhJeOplZ --generate_oauth2_token
and follow the instructions.
Note down the refresh token.
.It
In
.Ic server_password_command
2023-11-23 15:29:54 +02:00
enter a command like this
.Pq after adjusting binary paths and credentials Ns
:
.sp
2020-11-24 12:04:04 +02:00
.Cm TOKEN=$(python3 oauth2.py --user=xxx@gmail.com --quiet --client_id=1038[...].apps.googleusercontent.com --client_secret=VWFn8LIKAMC-MsjBMhJeOplZ --refresh_token=1/Yzm6MRy4q1xi7Dx2DuWXNgT6s37OrP_DW_IoyTum4YA) && python3 oauth2.py --user=xxx@gmail.com --generate_oauth2_string --quiet --access_token=$TOKEN
.It
2023-11-23 15:29:54 +02:00
On startup,
.Sy meli
should evaluate this command which if successful must only return a
.Tn base64 Ns
-encoded token ready to be passed to
.Tn IMAP.
2024-03-17 14:07:07 +02:00
.Pp
Your account section should look like this:
.Bd -literal
[accounts."gmail"]
root_mailbox = '[Gmail]'
format = "imap"
server_hostname='imap.gmail.com'
server_username="username@gmail.com"
use_oauth2 = true
server_password_command = "TOKEN=$(py...th2_string --quiet --access_token=$TOKEN"
server_port="993"
listing.index_style = "Conversations"
identity = "username@gmail.com"
display_name = "Name Name"
subscribed_mailboxes = ["*" ]
composing.store_sent_mail = false
composing.send_mail = { hostname = "smtp.gmail.com", port = 587, auth = { type = "xoauth2", token_command = "...", require_auth = true }, security = { type = "STARTTLS" } }
.Ed
2020-11-24 12:04:04 +02:00
.El
2020-07-15 15:19:27 +03:00
.Ss JMAP only
2024-03-06 16:28:27 +02:00
.HorizontalRule
2023-11-23 15:29:54 +02:00
.Tn JMAP
specific options
2019-12-13 00:13:54 +02:00
.Bl -tag -width 36 n
2022-10-13 10:40:13 +03:00
.It Ic server_url Ar String
2019-12-13 00:13:54 +02:00
example:
2022-10-13 10:40:13 +03:00
.Qq http://mail.example.com
.Qq http://mail.example.com:8080
.Qq https://mail.example.com
2019-12-13 00:13:54 +02:00
.It Ic server_username Ar String
2020-07-15 20:20:37 +03:00
Server username
2019-12-13 00:13:54 +02:00
.It Ic server_password Ar String
2020-07-15 20:20:37 +03:00
Server password
2019-12-13 00:13:54 +02:00
.It Ic danger_accept_invalid_certs Ar boolean
2020-07-15 20:20:37 +03:00
.Pq Em optional
2023-11-23 15:29:54 +02:00
Do not validate
.Tn TLS
certificates.
2023-07-15 19:32:39 +03:00
.Pq Em false \" default value
2019-12-13 00:13:54 +02:00
.El
2020-07-15 15:19:27 +03:00
.Ss mbox only
2024-03-06 16:28:27 +02:00
.HorizontalRule
2023-11-23 15:29:54 +02:00
.Tn mbox
specific options:
2020-06-20 11:52:05 +03:00
.Bl -tag -width 36 n
.It Ic prefer_mbox_type Ar String
2020-07-15 20:20:37 +03:00
.Pq Em optional
2023-11-23 15:29:54 +02:00
Prefer specific
.Tn mbox
format reader for each message.
Default is
.Qq Li mboxcl2
format.
If the preferred format fails, the message is retried with mboxrd and then if
it fails again there is a recover attempt, which discards the invalid message.
.sp
2020-07-15 20:20:37 +03:00
Valid values
2024-03-10 21:34:29 +02:00
.Bl -dash -compact
2020-06-20 11:52:05 +03:00
.It
.Ar auto
.It
.Ar mboxo
.It
.Ar mboxrd
.It
.Ar mboxcl
.It
.Ar mboxcl2
.El
2023-07-15 19:32:39 +03:00
.Pq Em auto \" default value
2020-06-20 11:52:05 +03:00
.El
2023-11-23 15:29:54 +02:00
To set multiple mailboxes, you have to explicitly state the mailboxes you want
in the
2020-06-20 14:49:02 +03:00
.Ic mailboxes
field and set the
.Ar path
property to each of them.
Example:
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2020-06-20 14:49:02 +03:00
.Bd -literal
[accounts.mbox]
format = "mbox"
mailboxes."Python mailing list" = { path = "~/.mail/python.mbox", subscribe = true, autoload = true }
.Ed
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2021-09-04 00:32:57 +03:00
.Ss NNTP
2024-03-06 16:28:27 +02:00
.HorizontalRule
2023-11-23 15:29:54 +02:00
.Tn NNTP
specific options
2021-09-04 00:32:57 +03:00
.Bl -tag -width 36 n
.It Ic server_hostname Ar String
example:
.Qq nntp.example.com
.It Ic server_username Ar String
Server username
.It Ic server_password Ar String
Server password
2024-03-06 16:28:27 +02:00
.It Ic require_auth Ar boolean
2021-09-04 00:32:57 +03:00
.Pq Em optional
2023-11-23 15:29:54 +02:00
require authentication in every case
.Pq Em true \" default value
2021-09-04 00:32:57 +03:00
.It Ic use_tls Ar boolean
.Pq Em optional
2023-11-23 15:29:54 +02:00
Connect with
.Tn TLS Ns
\& .
2023-07-15 19:32:39 +03:00
.Pq Em false \" default value
2021-09-04 00:32:57 +03:00
.It Ic server_port Ar number
.Pq Em optional
The port to connect to
2023-07-15 19:32:39 +03:00
.Pq Em 119 \" default value
2021-09-04 00:32:57 +03:00
.It Ic danger_accept_invalid_certs Ar boolean
.Pq Em optional
2023-11-23 15:29:54 +02:00
Do not validate
.Tn TLS
certificates.
2023-07-15 19:32:39 +03:00
.Pq Em false \" default value
2023-07-16 11:37:09 +03:00
.It Ic store_flags_locally Ar boolean
.Pq Em optional
2023-11-23 15:29:54 +02:00
Store seen status locally in an
.Sy sqlite3
database.
2023-07-16 11:37:09 +03:00
.Pq Em true \" default value
2021-09-04 00:32:57 +03:00
.El
.Pp
You have to explicitly state the groups you want to see in the
.Ic mailboxes
field.
Example:
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2021-09-04 00:32:57 +03:00
.Bd -literal
[accounts.sicpm.mailboxes]
"sic.all" = {}
.Ed
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2021-09-04 00:32:57 +03:00
.Pp
2023-11-23 15:29:54 +02:00
To submit articles directly to the
.Tn NNTP
server, you must set the special value
2021-09-04 00:32:57 +03:00
.Em server_submission
in the
.Ic send_mail
field.
Example:
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2021-09-04 00:32:57 +03:00
.Bd -literal
composing.send_mail = "server_submission"
.Ed
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2020-07-15 20:20:37 +03:00
.Ss MAILBOXES
2024-03-06 16:28:27 +02:00
.HorizontalRule
2019-11-22 13:12:44 +02:00
.Bl -tag -width 36 n
2019-12-18 15:40:57 +02:00
.It Ic alias Ar String
2020-07-15 20:20:37 +03:00
.Pq Em optional
2023-11-23 15:29:54 +02:00
Show a different name for this mailbox in the
.Tn UI Ns
\& .
2019-11-22 13:12:44 +02:00
.It Ic autoload Ar boolean
2020-07-15 20:20:37 +03:00
.Pq Em optional
Load this mailbox on startup
2023-07-15 19:32:39 +03:00
.Pq Em true \" default value
2022-08-15 16:32:28 +03:00
.It Ic collapsed Ar boolean
.Pq Em optional
Collapse this mailbox subtree in menu.
2023-07-15 19:32:39 +03:00
.Pq Em false \" default value
2019-11-22 13:12:44 +02:00
.It Ic subscribe Ar boolean
2020-07-15 20:20:37 +03:00
.Pq Em optional
2023-11-23 15:29:54 +02:00
Watch this mailbox for updates.
2023-07-15 19:32:39 +03:00
.Pq Em true \" default value
2019-11-22 13:12:44 +02:00
.It Ic ignore Ar boolean
2020-07-15 20:20:37 +03:00
.Pq Em optional
2023-11-23 15:29:54 +02:00
Silently insert updates for this mailbox, if any.
2023-07-15 19:32:39 +03:00
.Pq Em false \" default value
2019-11-22 13:12:44 +02:00
.It Ic usage Ar boolean
2020-07-15 20:20:37 +03:00
.Pq Em optional
special usage of this mailbox.
2020-01-28 18:43:14 +02:00
Valid values are:
2024-03-10 21:34:29 +02:00
.Bl -dash -compact
2019-09-16 14:07:38 +03:00
.It
.Ar Normal
2020-07-15 20:20:37 +03:00
.Pq Em default
2019-09-16 14:07:38 +03:00
.It
.Ar Inbox
.It
.Ar Archive
.It
.Ar Drafts
.It
.Ar Flagged
.It
.Ar Junk
.It
.Ar Sent
.It
.Ar Trash
.El
2020-02-26 10:54:10 +02:00
otherwise usage is inferred from the mailbox title.
2023-11-23 15:29:54 +02:00
If for example your Sent folder is not named
.Qq Li Sent Ns
, you must explicitly set it.
2019-11-22 13:12:44 +02:00
.It Ic conf_override Ar boolean
2020-07-15 20:20:37 +03:00
.Pq Em optional
Override global settings for this mailbox.
2020-01-28 18:43:14 +02:00
Available sections to override are
2019-09-27 12:48:48 +03:00
.Em pager, notifications, shortcuts, composing
2019-09-16 14:07:38 +03:00
and the account options
2022-03-20 17:11:46 +02:00
.Em identity Ns
2020-01-28 18:43:14 +02:00
\& .
Example:
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2019-09-16 14:07:38 +03:00
.Bd -literal
2021-09-13 13:34:10 +03:00
[accounts."imap.example.com".mailboxes]
"INBOX" = { index_style = "plain" }
"INBOX/Lists/devlist" = { autoload = false, pager = { filter = "pygmentize -l diff -f 256"} }
2019-09-16 14:07:38 +03:00
.Ed
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2021-10-31 18:15:11 +02:00
.It Ic sort_order Ar unsigned integer
.Pq Em optional
Override sort order on the sidebar for this mailbox.
Example:
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2021-10-31 18:15:11 +02:00
.Bd -literal
[accounts."imap.example.com".mailboxes]
"INBOX" = { index_style = "plain" }
"INBOX/Sent" = { sort_order = 0 }
"INBOX/Drafts" = { sort_order = 1 }
"INBOX/Lists" = { sort_order = 2 }
.Ed
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2023-04-09 00:03:20 +03:00
.It Ic encoding Ar String
.Pq Em optional
2023-11-23 15:29:54 +02:00
Override the default
.Tn UTF-8
charset for the mailbox name.
Useful only for
.Tn UTF-7
mailboxes.
2023-07-15 19:32:39 +03:00
.Pq Em "utf7" , "utf-7" , "utf8" , "utf-8" \" default value
2019-09-16 14:07:38 +03:00
.El
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
. \"
. \"
2019-09-27 12:48:48 +03:00
.Sh COMPOSING
2024-03-06 16:28:27 +02:00
.Ss Composing specific configuration settings
2023-05-16 13:17:13 +03:00
Default values are shown in parentheses.
2019-11-22 13:12:44 +02:00
.Bl -tag -width 36 n
2020-07-15 15:19:27 +03:00
.It Ic send_mail Ar String|SmtpServerConf
2023-11-23 15:29:54 +02:00
Command to pipe new mail to
.Po
exit code must be
.Li 0
for success
.Pc
or settings for an
.Tn SMTP
server connection.
2020-07-15 15:19:27 +03:00
See section
.Sx SMTP Connections
for its fields.
2020-07-08 12:09:37 +03:00
.It Ic editor_command Ar String
2020-07-15 20:20:37 +03:00
Command to launch editor.
2020-01-28 18:43:14 +02:00
Can have arguments.
Draft filename is given as the last argument.
2023-11-23 15:29:54 +02:00
If it's missing, the environment variable
.Ev EDITOR
is looked up.
.It Ic embedded_pty Ar boolean
2020-07-15 20:20:37 +03:00
.Pq Em optional
2023-11-23 15:29:54 +02:00
Embedded editor within
.Sy meli Ns
\& .
Editor must be
.Sy xterm
compliant.
2023-07-15 19:32:39 +03:00
.Pq Em false \" default value
2019-11-22 13:12:44 +02:00
.It Ic format_flowed Ar boolean
2020-07-15 20:20:37 +03:00
.Pq Em optional
2023-11-23 15:29:54 +02:00
Set
.Li format=flowed
.Bq RFC3676
in
.Li text/plain
attachments.
2023-07-15 19:32:39 +03:00
.Pq Em true \" default value
2020-08-18 12:07:50 +03:00
.It Ic insert_user_agent Ar boolean
.Pq Em optional
2023-11-23 15:29:54 +02:00
Add
.Sy meli
.Li User-Agent
header in new drafts.
2023-07-15 19:32:39 +03:00
.Pq Em true \" default value
2020-03-01 17:45:55 +02:00
.It Ic default_header_values Ar hash table String[String]
2022-09-02 09:50:07 +03:00
.Pq Em optional
2020-03-01 17:45:55 +02:00
Default header values used when creating a new draft.
2023-07-15 19:32:39 +03:00
.Pq Em [] \" default value
2022-09-02 09:50:07 +03:00
.It Ic wrap_header_preamble Ar Option<(String, String)>
.Pq Em optional
2023-11-23 15:29:54 +02:00
Wrap header pre-ample when editing a draft in an editor.
This allows you to write non-plain text email without the preamble creating
syntax errors.
2022-09-02 09:50:07 +03:00
They are stripped when you return from the editor.
The values should be a two element array of strings, a prefix and suffix.
2023-11-23 15:29:54 +02:00
This can be useful when for example you're writing Markdown; you can set the
value to
2022-09-02 09:50:07 +03:00
.Em ["<!--",\ "-->" ]
2023-11-23 15:29:54 +02:00
which wraps the headers in an
.Tn HTML
comment.
2023-07-15 19:32:39 +03:00
.Pq Em None \" default value
2020-11-09 22:22:11 +02:00
.It Ic store_sent_mail Ar boolean
.Pq Em optional
Store sent mail after successful submission.
2023-11-23 15:29:54 +02:00
This setting is meant to be disabled for non-standard behaviour in
.Tn Gmail Ns
, which auto-saves sent mail on its own.
2023-07-15 19:32:39 +03:00
.Pq Em true \" default value
2021-01-08 14:56:47 +02:00
.It Ic attribution_format_string Ar String
.Pq Em optional
The attribution line appears above the quoted reply text.
The format specifiers for the replied address are:
2024-03-10 21:34:29 +02:00
.Bl -dash -compact
2021-01-08 14:56:47 +02:00
.It
.Li %+f
— the sender's name and email address.
.It
.Li %+n
— the sender's name (or email address, if no name is included).
.It
.Li %+a
— the sender's email address.
.El
The format string is passed to
.Xr strftime 3
with the replied envelope's date.
2023-07-15 19:32:39 +03:00
.Pq Em "On %a, %0e %b %Y %H:%M, %+f wrote:%n" \" default value
2021-01-08 14:56:47 +02:00
.It Ic attribution_use_posix_locale Ar boolean
.Pq Em optional
2023-11-23 15:29:54 +02:00
Whether the
.Xr strftime 3
call for the attribution string uses the
.Tn POSIX
locale instead of the user's active locale.
2023-07-15 19:32:39 +03:00
.Pq Em true \" default value
2021-10-02 13:38:50 +03:00
.It Ic forward_as_attachment Ar boolean or "ask"
.Pq Em optional
Forward emails as attachment? (Alternative is inline).
2023-07-15 19:32:39 +03:00
.Pq Em ask \" default value
2022-08-31 22:33:02 +03:00
.It Ic reply_prefix_list_to_strip Ar [String]
.Pq Em optional
Alternative lists of reply prefixes (etc. ["Re:", "RE:", ...]) to strip.
2023-07-15 19:32:39 +03:00
.Dl Em [Re:, RE:, Fwd:, Fw:, 回复:, 回覆:, SV:, Sv:, VS:, Antw:, Doorst:, VS:, VL:, REF:, TR:, TR:, AW:, WG:, ΑΠ:, Απ:, απ:, ΠΡΘ:, Πρθ:, πρθ:, ΣΧΕΤ:, Σχετ:, σχετ:, ΠΡΘ:, Πρθ:, πρθ:, Vá:, Továbbítás:, R:, I:, RIF:, FS:, BLS:, TRS:, VS:, VB:, RV:, RES:, Res, ENC:, Odp:, PD:, YNT:, İLT:, ATB:, YML:] \" default value
2022-08-31 22:33:02 +03:00
.It Ic reply_prefix Ar String
.Pq Em optional
The prefix to use in reply subjects.
2024-03-10 21:34:29 +02:00
The default prefix is
.Ns Ql Re: Ns
\& .
.Pq Ql Re: \" default value
2022-08-31 22:33:02 +03:00
.Pp
RFC 2822, "Internet Message Format" has this to say on the matter:
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2022-08-31 22:33:02 +03:00
.Bd -literal -offset indent -compact
When used in a reply, the field body MAY start with the string "Re: " (from
the Latin "res", in the matter of) followed by the contents of the "Subject:"
field body of the original message.
.Ed
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2023-05-19 10:34:32 +03:00
.It Ic custom_compose_hooks Ar [{ name = String, command = String }]
.Pq Em optional
Custom compose-hooks that run shell scripts.
compose-hooks run before submitting an e-mail.
They perform draft validation and/or transformations.
2023-11-23 15:29:54 +02:00
If a custom hook exits with an error status or prints output to stdout and
stderr, it will show up in the UI as a notification.
.sp
2023-05-19 10:34:32 +03:00
Example:
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2023-05-19 10:34:32 +03:00
.Bd -literal
[composing]
editor_cmd = '~/.local/bin/vim +/^$'
embed = true
custom_compose_hooks = [ { name ="spellcheck", command="aspell --mode email --dont-suggest --ignore-case list" }]
.Ed
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2023-05-16 13:17:13 +03:00
.It Ic disabled_compose_hooks Ar [String]
.Pq Em optional
Disabled compose-hooks.
compose-hooks run before submitting an e-mail.
They perform draft validation and/or transformations.
If a hook encounters an error or warning, it will show up as a notification.
The currently available hooks are:
2024-03-10 21:34:29 +02:00
.Bl -dash -compact
2023-05-16 13:17:13 +03:00
.It
.Ic past-date-warn
2023-11-23 15:29:54 +02:00
— Warn if
.Li Date
header value is far in the past or future.
2023-05-16 13:17:13 +03:00
.It
.Ic important-header-warn
2023-11-23 15:29:54 +02:00
— Warn if important headers
.Po
.Li From Ns
,
.Li Date Ns
,
.Li To Ns
,
.Li Cc Ns
,
.Li Bcc
.Pc
are missing or invalid.
2023-05-16 13:17:13 +03:00
.It
.Ic missing-attachment-warn
2023-11-23 15:29:54 +02:00
— Warn if
.Li Subject Ns
or draft body mention attachments but they are missing.
2023-05-16 13:17:13 +03:00
.It
.Ic empty-draft-warn
— Warn if draft has no subject and no body.
.El
2019-09-16 14:07:38 +03:00
.El
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
. \"
. \"
2019-09-16 14:07:38 +03:00
.Sh SHORTCUTS
2024-03-06 16:28:27 +02:00
.Ss Values corresponding to keyboard keys, keycodes
2019-09-16 14:07:38 +03:00
Shortcuts can take the following values:
2024-03-06 16:28:27 +02:00
.sp
2024-03-10 21:34:29 +02:00
.Bl -dash -compact
2020-07-15 20:20:37 +03:00
.It
.Em Backspace
.It
.Em Left
.It
.Em Right
.It
.Em Up
.It
.Em Down
.It
.Em Home
.It
.Em End
.It
.Em PageUp
.It
.Em PageDown
.It
.Em Delete
.It
.Em Insert
.It
.Em Enter
.It
.Em Tab
.It
.Em Esc
.It
.Em F1..F12
.It
.Em M-char
.It
.Em C-char
.It
.Em char
.El
2020-01-28 18:43:14 +02:00
.sp
2024-03-06 16:28:27 +02:00
Where
.Em char
is a single character string, maximum 4 bytes long, like the corresponding type
in Rust.
.Pp
In the next subsection, you will find lists for each shortcut category.
2020-01-28 18:43:14 +02:00
The headings before each list indicate the map key of the shortcut list.
For example for the first list titled
2019-11-27 01:43:03 +02:00
.Em general
the configuration is typed as follows:
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2019-11-27 01:43:03 +02:00
.Bd -literal
[shortcuts.general]
next_tab = 'T'
.Ed
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2020-01-28 18:43:14 +02:00
.sp
2019-11-27 01:43:03 +02:00
and for
2022-09-04 18:28:36 +03:00
.Em listing Ns
2019-11-27 01:43:03 +02:00
:
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2019-11-27 01:43:03 +02:00
.Bd -literal
2022-09-04 18:28:36 +03:00
[shortcuts.listing]
open_entry = "Enter"
exit_entry = 'i'
2020-01-28 18:43:14 +02:00
.Ed
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2020-01-28 18:43:14 +02:00
.sp
2019-12-18 15:40:57 +02:00
.Pp
2024-01-05 12:31:48 +02:00
.Em commands
.sp
2024-03-06 16:28:27 +02:00
In addition, each shortcuts section supports a TOML array of commands to
associate a key to an array of
2024-01-05 12:31:48 +02:00
.Em COMMAND
2024-03-06 16:28:27 +02:00
mode commands.
2024-01-05 12:31:48 +02:00
.sp
. \"
. \"
. \"
.Bd -literal
[shortcuts.listing]
commands = [ { command = [ "tag remove trash", "flag unset trash" ], shortcut = "D" },
{ command = [ "tag add trash", "flag set trash" ], shortcut = "d" } ]
.Ed
. \"
. \"
. \"
2024-03-06 16:28:27 +02:00
.Ss Shortcut configuration settings
.HorizontalRule
Default values are shown in parentheses.
.sp
2020-01-28 18:43:14 +02:00
.Em general
2019-11-27 01:43:03 +02:00
.Bl -tag -width 36 n
2020-08-25 15:48:38 +03:00
.It Ic toggle_help
Toggle help and shortcuts view.
2023-07-15 19:32:39 +03:00
.Pq Em \& ? \" default value
2020-07-25 13:24:42 +03:00
.It Ic enter_command_mode
Enter
.Em COMMAND
mode.
2023-11-23 15:29:54 +02:00
.Pq Em \& : \" default value
.It Ic quit
Quit meli.
.Pq Em q \" default value
2019-11-27 01:43:03 +02:00
.It Ic go_to_tab
2020-01-28 18:43:14 +02:00
Go to the
2019-11-27 01:43:03 +02:00
.Em n Ns
th tab
2022-03-20 17:11:46 +02:00
.Pq Em M-n
2023-11-23 15:29:54 +02:00
.It Ic next_tab
Go to the next tab.
.Pq Em T \" default value
2022-03-20 17:11:46 +02:00
.It Ic scroll_right
Generic scroll right (catch-all setting)
2023-11-23 15:29:54 +02:00
.Pq Em l \" default value
2022-03-20 17:11:46 +02:00
.It Ic scroll_left
Generic scroll left (catch-all setting)
2023-11-23 15:29:54 +02:00
.Pq Em h \" default value
2022-03-20 17:11:46 +02:00
.It Ic scroll_up
Generic scroll up (catch-all setting)
2023-07-15 19:32:39 +03:00
.Pq Em k \" default value
2022-03-20 17:11:46 +02:00
.It Ic scroll_down
Generic scroll down (catch-all setting)
2023-07-15 19:32:39 +03:00
.Pq Em j \" default value
2022-11-28 16:18:49 +02:00
.It Ic next_page
Go to next page.
(catch-all setting)
2023-07-15 19:32:39 +03:00
.Pq Em PageDown \" default value
2022-11-28 16:18:49 +02:00
.It Ic prev_page
Go to previous page.
(catch-all setting)
2023-07-15 19:32:39 +03:00
.Pq Em PageUp \" default value
2022-11-28 16:18:49 +02:00
.It Ic home_page
Go to first page.
(catch-all setting)
2023-07-15 19:32:39 +03:00
.Pq Em Home \" default value
2022-11-28 16:18:49 +02:00
.It Ic end_page
2023-11-23 15:29:54 +02:00
Go to last page. (catch-all setting)
2023-07-15 19:32:39 +03:00
.Pq Em End \" default value
2022-11-28 16:18:49 +02:00
.It Ic open_entry
2023-11-23 15:29:54 +02:00
Open list entry. (catch-all setting)
2023-07-15 19:32:39 +03:00
.Pq Em Enter \" default value
2021-09-05 12:49:58 +03:00
.It Ic info_message_next
2023-11-23 15:29:54 +02:00
Show next info message, if any.
.Pq Em M-> \" default value
2021-09-05 12:49:58 +03:00
.It Ic info_message_previous
2023-11-23 15:26:42 +02:00
Show previous info message, if any.
.Pq Em M-< \" default value
.It Ic focus_in_text_field
Focus on a text field.
.Pq Em Enter \" default value
.It Ic next_search_result
Scroll to next search result.
.Pq Em n \" default value
.It Ic previous_search_result
Scroll to previous search result.
.Pq Em N
2019-11-27 01:43:03 +02:00
.El
2020-01-28 18:43:14 +02:00
.sp
.Em listing
2019-11-22 13:12:44 +02:00
.Bl -tag -width 36 n
2022-03-20 17:11:46 +02:00
.It Ic scroll_up
Scroll up list.
2023-07-15 19:32:39 +03:00
.Pq Em k \" default value
2022-03-20 17:11:46 +02:00
.It Ic scroll_down
Scroll down list.
2023-07-15 19:32:39 +03:00
.Pq Em j \" default value
2019-11-22 13:12:44 +02:00
.It Ic next_page
2019-09-16 14:07:38 +03:00
Go to next page.
2023-07-15 19:32:39 +03:00
.Pq Em PageDown \" default value
2022-03-20 17:11:46 +02:00
.It Ic prev_page
Go to previous page.
2023-07-15 19:32:39 +03:00
.Pq Em PageUp \" default value
2022-03-20 17:11:46 +02:00
.It Ic new_mail
Start new mail draft in new tab.
2023-07-15 19:32:39 +03:00
.Pq Em m \" default value
2022-03-20 17:11:46 +02:00
.It Ic next_account
Go to next account.
2023-11-13 15:52:11 +02:00
.Pq Em H \" default value
2019-11-22 13:12:44 +02:00
.It Ic prev_account
2019-09-16 14:07:38 +03:00
Go to previous account.
2023-11-13 15:52:11 +02:00
.Pq Em L \" default value
2022-03-20 17:11:46 +02:00
.It Ic next_mailbox
Go to next mailbox.
2023-07-15 19:32:39 +03:00
.Pq Em J \" default value
2022-03-20 17:11:46 +02:00
.It Ic prev_mailbox
Go to previous mailbox.
2023-07-15 19:32:39 +03:00
.Pq Em K \" default value
2022-03-20 17:11:46 +02:00
.It Ic open_mailbox
Open selected mailbox
2023-07-15 19:32:39 +03:00
.Pq Em Enter \" default value
2022-08-15 16:32:28 +03:00
.It Ic toggle_mailbox_collapse
Toggle mailbox visibility in menu.
2023-07-15 19:32:39 +03:00
.Pq Em Space \" default value
2022-03-20 17:11:46 +02:00
.It Ic search
Search within list of e-mails.
2023-07-15 19:32:39 +03:00
.Pq Em / \" default value
2020-01-08 21:41:57 +02:00
.It Ic refresh
2020-02-26 10:54:10 +02:00
Manually request a mailbox refresh.
2023-07-15 19:32:39 +03:00
.Pq Em F5 \" default value
2022-03-20 17:11:46 +02:00
.It Ic set_seen
Set thread as seen.
2023-07-15 19:32:39 +03:00
.Pq Em n \" default value
2022-03-20 17:11:46 +02:00
.It Ic union_modifier
Union modifier.
2023-07-15 19:32:39 +03:00
.Pq Em C-u \" default value
2022-03-20 17:11:46 +02:00
.It Ic diff_modifier
Difference modifier.
2023-07-15 19:32:39 +03:00
.Pq Em C-d \" default value
2022-03-20 17:11:46 +02:00
.It Ic intersection_modifier
Intersection modifier.
2023-07-15 19:32:39 +03:00
.Pq Em i \" default value
2022-03-20 17:11:46 +02:00
.It Ic select_entry
Select thread entry.
2023-07-15 19:32:39 +03:00
.Pq Em v \" default value
2022-02-25 16:40:27 +02:00
.It Ic increase_sidebar
Increase sidebar width.
2023-07-15 19:32:39 +03:00
.Pq Em C-f \" default value
2022-02-25 16:40:27 +02:00
.It Ic decrease_sidebar
Decrease sidebar width.
2023-07-15 19:32:39 +03:00
.Pq Em C-d \" default value
2023-06-19 22:15:06 +03:00
.It Ic next_entry
2023-11-23 15:29:54 +02:00
When reading a mail item, change focus on next entry according to the current
sorting.
2023-07-15 19:32:39 +03:00
.Pq Em C-n \" default value
2023-06-19 22:15:06 +03:00
.It Ic previous_entry
2023-11-23 15:29:54 +02:00
When reading a mail item, change focus on previous entry according to the
current sorting.
2023-07-15 19:32:39 +03:00
.Pq Em C-p \" default value
2022-03-20 17:11:46 +02:00
.It Ic toggle_menu_visibility
Toggle visibility of side menu in mail list.
2024-03-10 21:34:29 +02:00
.Pq Em \(ga \" default value
2022-09-07 16:39:15 +03:00
.It Ic focus_left
Switch focus on the left.
2023-07-15 19:32:39 +03:00
.Pq Em Left \" default value
2022-09-07 16:39:15 +03:00
.It Ic focus_right
Switch focus on the right.
2023-07-15 19:32:39 +03:00
.Pq Em Right \" default value
2022-09-04 18:28:36 +03:00
.It Ic exit_entry
Exit e-mail entry.
2023-07-15 19:32:39 +03:00
.Pq Em i \" default value
2022-09-04 18:28:36 +03:00
.It Ic open_entry
Open e-mail entry.
2023-07-15 19:32:39 +03:00
.Pq Em Enter \" default value
2019-11-27 01:43:03 +02:00
.El
2020-01-28 18:43:14 +02:00
.sp
.Em pager
2019-11-27 01:43:03 +02:00
.Bl -tag -width 36 n
2019-11-22 13:12:44 +02:00
.It Ic scroll_up
2019-09-16 14:07:38 +03:00
Scroll up pager.
2023-07-15 19:32:39 +03:00
.Pq Em k \" default value
2019-11-22 13:12:44 +02:00
.It Ic scroll_down
2019-09-16 14:07:38 +03:00
Scroll down pager.
2023-07-15 19:32:39 +03:00
.Pq Em j \" default value
2019-11-22 13:12:44 +02:00
.It Ic page_up
2019-09-16 14:07:38 +03:00
Go to previous pager page
2023-07-15 19:32:39 +03:00
.Pq Em PageUp \" default value
2019-11-22 13:12:44 +02:00
.It Ic page_down
2019-09-16 14:07:38 +03:00
Go to next pager pag
2023-07-15 19:32:39 +03:00
.Pq Em PageDown \" default value
2019-11-27 01:43:03 +02:00
.El
2020-01-28 18:43:14 +02:00
.sp
.Em contact-list
2019-11-27 01:43:03 +02:00
.Bl -tag -width 36 n
2022-03-20 17:11:46 +02:00
.It Ic scroll_up
Scroll up list.
2023-07-15 19:32:39 +03:00
.Pq Em k \" default value
2022-03-20 17:11:46 +02:00
.It Ic scroll_down
Scroll down list.
2023-07-15 19:32:39 +03:00
.Pq Em j \" default value
2019-11-22 13:12:44 +02:00
.It Ic create_contact
2019-09-16 14:07:38 +03:00
Create new contact.
2023-07-15 19:32:39 +03:00
.Pq Em c \" default value
2019-11-22 13:12:44 +02:00
.It Ic edit_contact
2022-03-20 17:11:46 +02:00
Edit contact under cursor.
2023-07-15 19:32:39 +03:00
.Pq Em e \" default value
2023-08-23 17:27:48 +03:00
.It Ic delete_contact
Delete contact under cursor.
.Pq Em d \" default value
2019-11-27 01:43:03 +02:00
.It Ic mail_contact
2022-03-20 17:11:46 +02:00
Mail contact under cursor.
2023-07-15 19:32:39 +03:00
.Pq Em m \" default value
2022-03-20 17:11:46 +02:00
.It Ic next_account
Go to next account.
2023-11-13 15:52:11 +02:00
.Pq Em H \" default value
2022-03-20 17:11:46 +02:00
.It Ic prev_account
Go to previous account.
2023-11-13 15:52:11 +02:00
.Pq Em L \" default value
2019-11-27 01:43:03 +02:00
.It Ic toggle_menu_visibility
Toggle visibility of side menu in mail list.
2024-03-10 21:34:29 +02:00
.Pq Em \(ga \" default value
2019-11-27 01:43:03 +02:00
.El
2020-01-28 18:43:14 +02:00
.sp
.sp
.Em composing
2019-11-27 01:43:03 +02:00
.Bl -tag -width 36 n
2023-06-22 13:23:27 +03:00
.It Ic edit
2022-03-20 17:11:46 +02:00
Edit mail.
2023-07-15 19:32:39 +03:00
.Pq Em e \" default value
2019-11-27 01:43:03 +02:00
.It Ic send_mail
Deliver draft to mailer
2023-07-15 19:32:39 +03:00
.Pq Em s \" default value
2022-03-20 17:11:46 +02:00
.It Ic scroll_up
Change field focus.
2023-07-15 19:32:39 +03:00
.Pq Em k \" default value
2022-03-20 17:11:46 +02:00
.It Ic scroll_down
Change field focus.
2023-07-15 19:32:39 +03:00
.Pq Em j \" default value
2019-09-16 14:07:38 +03:00
.El
2020-01-28 18:43:14 +02:00
.sp
.Em envelope-view
2019-12-18 15:40:57 +02:00
.Pp
2023-11-23 15:29:54 +02:00
To select an attachment, type its index (you will see the typed result in the
command buffer on the bottom right of the status line), then issue the
corresponding command.
2019-11-27 01:43:03 +02:00
.Bl -tag -width 36 n
.It Ic add_addresses_to_contacts Ns
Select addresses from envelope to add to contacts.
2023-07-15 19:32:39 +03:00
.Pq Em c \" default value
2022-03-20 17:11:46 +02:00
.It Ic edit
Open envelope in composer.
2023-07-15 19:32:39 +03:00
.Pq Em e \" default value
2022-03-20 17:11:46 +02:00
.It Ic go_to_url
Go to url of given index (with the command
.Ic url_launcher
setting in
.Sx PAGER
section)
2023-07-15 19:32:39 +03:00
.Pq Em g \" default value
2022-03-20 17:11:46 +02:00
.It Ic open_attachment
Opens selected attachment with
.Cm xdg-open
2023-07-15 19:32:39 +03:00
.Pq Em a \" default value
2022-03-20 17:11:46 +02:00
.It Ic open_mailcap
Opens selected attachment according to its mailcap entry.
See
.Xr meli 1 FILES
for the mailcap file locations.
2023-07-15 19:32:39 +03:00
.Pq Em m \" default value
2023-08-19 14:57:28 +03:00
.It Ic open_html
Opens html attachment in the default browser.
.Pq Em v \" default value
2019-11-27 01:43:03 +02:00
.It Ic reply
Reply to envelope.
2023-07-15 19:32:39 +03:00
.Pq Em R \" default value
2021-10-02 13:38:50 +03:00
.It Ic reply_to_author
Reply to author.
2023-07-15 19:32:39 +03:00
.Pq Em C-r \" default value
2021-10-02 13:38:50 +03:00
.It Ic reply_to_all
Reply to all/Reply to list/Follow up.
2023-07-15 19:32:39 +03:00
.Pq Em C-g \" default value
2021-10-02 13:38:50 +03:00
.It Ic forward
Forward email.
2023-07-15 19:32:39 +03:00
.Pq Em C-f \" default value
2019-11-27 01:43:03 +02:00
.It Ic return_to_normal_view
Return to envelope if viewing raw source or attachment.
2023-07-15 19:32:39 +03:00
.Pq Em r \" default value
2022-03-20 17:11:46 +02:00
.It Ic toggle_expand_headers
Expand extra headers (References and others)
2023-07-15 19:32:39 +03:00
.Pq Em h \" default value
2019-11-27 01:43:03 +02:00
.It Ic toggle_url_mode
2020-01-28 18:43:14 +02:00
Toggles url open mode.
2023-11-23 15:29:54 +02:00
When active, it prepends an index next to each url that you can select by
typing the index and open by issuing
2019-11-27 01:43:03 +02:00
.Ic go_to_url
2023-07-15 19:32:39 +03:00
.Pq Em u \" default value
2022-03-20 17:11:46 +02:00
.It Ic view_raw_source
View raw envelope source in a pager.
2023-07-15 19:32:39 +03:00
.Pq Em M-r \" default value
2023-04-10 11:42:50 +03:00
.It Ic change_charset
Force attachment charset for decoding.
2023-07-15 19:32:39 +03:00
.Pq Em d \" default value
2019-11-27 01:43:03 +02:00
.El
2020-01-28 18:43:14 +02:00
.sp
.Em thread-view
2019-11-27 01:43:03 +02:00
.Bl -tag -width 36 n
2022-03-20 17:11:46 +02:00
.It Ic scroll_up
Scroll up list.
2023-07-15 19:32:39 +03:00
.Pq Em k \" default value
2022-03-20 17:11:46 +02:00
.It Ic scroll_down
Scroll down list.
2023-07-15 19:32:39 +03:00
.Pq Em j \" default value
2019-11-27 01:43:03 +02:00
.It Ic collapse_subtree
2023-09-02 21:47:14 +03:00
collapse thread branches.
2023-07-15 19:32:39 +03:00
.Pq Em h \" default value
2022-03-20 17:11:46 +02:00
.It Ic next_page
Go to next page.
2023-07-15 19:32:39 +03:00
.Pq Em PageDown \" default value
2019-11-27 01:43:03 +02:00
.It Ic prev_page
Go to previous page.
2023-07-15 19:32:39 +03:00
.Pq Em PageUp \" default value
2022-03-20 17:11:46 +02:00
.It Ic reverse_thread_order
2023-09-02 21:47:14 +03:00
reverse thread order.
2023-07-15 19:32:39 +03:00
.Pq Em C-r \" default value
2022-03-20 17:11:46 +02:00
.It Ic toggle_mailview
2023-09-02 21:47:14 +03:00
toggle mail view visibility.
2023-07-15 19:32:39 +03:00
.Pq Em p \" default value
2022-03-20 17:11:46 +02:00
.It Ic toggle_threadview
2023-09-02 21:47:14 +03:00
toggle thread view visibility.
2023-07-15 19:32:39 +03:00
.Pq Em t \" default value
2023-09-02 21:47:14 +03:00
.It Ic toggle_layout
Toggle between horizontal and vertical layout.
.Pq Em Space \" default value
2019-11-27 01:43:03 +02:00
.El
2020-01-28 18:43:14 +02:00
.sp
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
. \"
. \"
2019-09-16 14:07:38 +03:00
.Sh NOTIFICATIONS
2024-03-06 16:28:27 +02:00
.Ss Notification configuration settings
2023-05-16 13:17:13 +03:00
Default values are shown in parentheses.
2019-11-22 13:12:44 +02:00
.Bl -tag -width 36 n
.It Ic enable Ar boolean
2020-09-10 20:31:12 +03:00
Enable notifications.
2023-07-15 19:32:39 +03:00
.Pq Em true \" default value
2019-11-22 13:12:44 +02:00
.It Ic script Ar String
2020-07-15 20:20:37 +03:00
.Pq Em optional
Script to pass notifications to, with title as 1st arg and body as 2nd
2023-07-15 19:32:39 +03:00
.Pq Em none \" default value
2022-09-19 21:58:59 +03:00
.It Ic new_mail_script Ar String
.Pq Em optional
A command to pipe new mail notifications through (preferred over
.Ic script Ns
), with title as 1st arg and body as 2nd.
2023-07-15 19:32:39 +03:00
.Pq Em none \" default value
2019-11-22 13:12:44 +02:00
.It Ic xbiff_file_path Ar String
2020-07-15 20:20:37 +03:00
.Pq Em optional
File that gets its size updated when new mail arrives.
2019-09-16 14:07:38 +03:00
.Pq Em none
2023-07-15 19:32:39 +03:00
.It Ic play_sound Ar boolean \" default value
2020-07-15 20:20:37 +03:00
.Pq Em optional
Play theme sound in notifications if possible.
2019-09-16 14:07:38 +03:00
.Pq Em false
2023-07-15 19:32:39 +03:00
.It Ic sound_file Ar String \" default value
2020-07-15 20:20:37 +03:00
.Pq Em optional
Play sound file in notifications if possible.
2023-07-15 19:32:39 +03:00
.Pq Em none \" default value
2019-09-16 14:07:38 +03:00
.El
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
. \"
. \"
2019-09-16 14:07:38 +03:00
.Sh PAGER
2024-03-06 16:28:27 +02:00
.Ss Pager (viewing text) configuration settings
2023-05-16 13:17:13 +03:00
Default values are shown in parentheses.
2019-11-22 13:12:44 +02:00
.Bl -tag -width 36 n
2023-06-14 12:24:20 +03:00
.It Ic sticky_headers Ar boolean
2020-07-15 20:20:37 +03:00
.Pq Em optional
Always show headers when scrolling.
2023-09-07 12:33:51 +03:00
.Pq Em false \" default value
2019-11-22 13:12:44 +02:00
.It Ic html_filter Ar String
2020-07-15 20:20:37 +03:00
.Pq Em optional
Pipe html attachments through this filter before display
2023-07-15 19:32:39 +03:00
.Pq Em none \" default value
2022-09-19 21:40:12 +03:00
.It Ic html_open Ar String
.Pq Em optional
A command to open html files.
2023-07-15 19:32:39 +03:00
.Pq Em none \" default value
2019-11-22 13:12:44 +02:00
.It Ic filter Ar String
2020-07-15 20:20:37 +03:00
.Pq Em optional
A command to pipe mail output through for viewing in pager.
2023-07-15 19:32:39 +03:00
.Pq Em none \" default value
2024-03-06 16:28:27 +02:00
.It Ic format_flowed Ar boolean
2020-07-15 20:20:37 +03:00
.Pq Em optional
Respect format=flowed
2023-07-15 19:32:39 +03:00
.Pq Em true \" default value
2024-03-06 16:28:27 +02:00
.It Ic split_long_lines Ar boolean
2020-07-15 20:20:37 +03:00
.Pq Em optional
Split long lines that would overflow on the x axis.
2023-07-15 19:32:39 +03:00
.Pq Em true \" default value
2019-11-22 13:12:44 +02:00
.It Ic minimum_width Ar num
2020-07-15 20:20:37 +03:00
.Pq Em optional
Minimum text width in columns.
2023-07-15 19:32:39 +03:00
.Pq Em 80 \" default value
2020-07-15 20:20:37 +03:00
.It Ic auto_choose_multipart_alternative Ar boolean
.Pq Em optional
2023-11-23 15:29:54 +02:00
Choose
.Li text/html
alternative if
.Li text/plain
is empty in
.Li multipart/alternative
attachments.
2023-07-15 19:32:39 +03:00
.Pq Em true \" default value
2021-09-15 22:19:19 +03:00
.It Ic show_date_in_my_timezone Ar boolean
.Pq Em optional
2023-11-23 15:29:54 +02:00
Show
.Li Date Ns
: in local timezone
2023-07-15 19:32:39 +03:00
.Pq Em true \" default value
2021-09-16 16:43:43 +03:00
.It Ic url_launcher Ar String
.Pq Em optional
A command to launch URLs with.
The URL will be given as the first argument of the command.
2023-07-15 19:32:39 +03:00
.Pq Em xdg-open \" default value
2023-05-31 19:10:51 +03:00
.It Ic show_extra_headers Ar [String]
.Pq Em optional
2023-11-23 15:29:54 +02:00
Extra headers to display, if present, in the default header preamble of the
pager.
2023-05-31 19:10:51 +03:00
This setting is useful especially when used per-folder or per-account.
For example, if you use
2023-11-23 15:29:54 +02:00
.Sy rss2email
2023-05-31 19:10:51 +03:00
.Pq See Xr r2e 1
the e-mail you will receive will have the
2023-11-23 15:29:54 +02:00
.Sy X-RSS-Feed
2023-05-31 19:10:51 +03:00
header by default.
You can show them only in the folder where you keep your feed items:
.Pp
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2023-05-31 19:10:51 +03:00
.Bd -literal -compact
[accounts."personal".mailboxes]
INBOX = {}
"INBOX/Sent" = { sort_order=0 }
"INBOX/Feeds" = { pager.show_extra_headers = ["X-RSS-Feed"] }
.Ed
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2023-07-15 19:32:39 +03:00
.Pq Em empty \" default value
2019-09-16 14:07:38 +03:00
.El
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
. \"
. \"
2020-01-08 21:41:57 +02:00
.Sh LISTING
2024-03-06 16:28:27 +02:00
.Ss Listing (lists of e-mail entries in a mailbox) configuration settings
2023-05-16 13:17:13 +03:00
Default values are shown in parentheses.
2020-01-08 21:41:57 +02:00
.Bl -tag -width 36 n
2022-09-09 02:03:13 +03:00
.It Ic show_menu_scrollbar Ar boolean
.Pq Em optional
Show auto-hiding scrollbar in accounts sidebar menu.
2023-07-15 19:32:39 +03:00
.Pq Em true \" default value
2020-01-08 21:41:57 +02:00
.It Ic datetime_fmt Ar String
2020-07-15 20:20:37 +03:00
.Pq Em optional
2023-11-23 15:29:54 +02:00
Datetime formatting passed verbatim to
.Xr strftime 3 Ns
\& .
2023-07-15 19:32:39 +03:00
.Pq Em \& %Y-\&%m-\&%d \& %T \" default value
2020-01-08 21:41:57 +02:00
.It Ic recent_dates Ar Boolean
2020-07-15 20:20:37 +03:00
.Pq Em optional
2024-03-10 21:34:29 +02:00
Show recent dates as
.Ns Ql X {minutes,hours,days} ago
.Ns , up to 7 days.
2023-07-15 19:32:39 +03:00
.Pq Em true \" default value
2020-03-01 20:24:00 +02:00
.It Ic filter Ar Query
2020-07-15 20:20:37 +03:00
.Pq Em optional
Show only envelopes matching this query.
.Po
For query syntax see
.Xr meli 1 QUERY ABNF SYNTAX
.Pc
2023-07-15 19:32:39 +03:00
.Pq Em None \" default value
2020-03-01 20:24:00 +02:00
.Pp
Example:
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2020-03-01 20:24:00 +02:00
.Bd -literal
filter = "not flags:seen" # show only unseen messages
.Ed
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2020-09-17 16:49:19 +03:00
.It Ic index_style Ar String
Sets the way mailboxes are displayed.
2024-03-10 21:34:29 +02:00
.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
2020-09-17 16:49:19 +03:00
.It Ic sidebar_mailbox_tree_has_sibling Ar String
.Pq Em optional
2023-11-23 15:29:54 +02:00
Sets the string to print in the mailbox tree for a level where its root has a
sibling.
2020-09-17 16:49:19 +03:00
See example below for a clear explanation and examples.
.It Ic sidebar_mailbox_tree_no_sibling Ar String
.Pq Em optional
2023-11-23 15:29:54 +02:00
Sets the string to print in the mailbox tree for a level where its root has no
sibling.
2020-09-17 16:49:19 +03:00
.It Ic sidebar_mailbox_tree_has_sibling_leaf Ar String
.Pq Em optional
2023-11-23 15:29:54 +02:00
Sets the string to print in the mailbox tree for a leaf level where its root
has a sibling.
2020-09-17 16:49:19 +03:00
.It Ic sidebar_mailbox_tree_no_sibling_leaf Ar String
.Pq Em optional
2023-11-23 15:29:54 +02:00
Sets the string to print in the mailbox tree for a leaf level where its root
has no sibling.
2020-11-24 23:39:02 +02:00
.It Ic sidebar_divider Ar char
.Pq Em optional
2023-11-23 15:29:54 +02:00
Sets the character to print as the divider between the accounts list and the
message list.
2022-02-25 16:20:08 +02:00
.It Ic sidebar_ratio Ar Integer
.Pq Em optional
This is the width of the right container to the entire screen width.
2023-07-15 19:32:39 +03:00
.Pq Em 90 \" default value
2022-09-09 02:03:13 +03:00
.It Ic unseen_flag Ar Option<String>
Flag to show if thread entry contains unseen mail.
2023-07-15 19:32:39 +03:00
.Pq Em "●" \" default value
2022-09-09 02:03:13 +03:00
.It Ic thread_snoozed_flag Ar Option<String>
Flag to show if thread has been snoozed.
2024-03-06 16:28:27 +02:00
.LiteralStringValueRenders 💤\e\uu{FE0E} 💤︎ \" default value
2022-09-09 02:03:13 +03:00
.It Ic selected_flag Ar Option<String>
Flag to show if thread entry has been selected.
2024-03-06 16:28:27 +02:00
.LiteralStringValueRenders ☑️ \e\uu{2007} ☑️
2022-09-09 02:03:13 +03:00
.It Ic attachment_flag Ar Option<String>
Flag to show if thread entry contains attachments.
2024-03-06 16:28:27 +02:00
.LiteralStringValueRenders 📎\e\uu{FE0E} 📎︎ \" default value
2024-03-01 22:55:37 +02:00
.It Ic highlight_self_flag Ar Option<String>
Flag to show if any thread entry contains your address as a receiver.
Useful to make mailing list threads that CC you stand out.
.Pq Em "✸" \" default value
.It Ic highlight_self Ar boolean
Show
.Ic highlight_self_flag
or not.
.Pq Em false \" default value
2024-03-06 16:28:27 +02:00
.It Ic thread_subject_pack Ar boolean
2023-11-23 15:29:54 +02:00
Should threads with differentiating Subjects show a list of those subjects on
the entry title?
2024-03-06 16:28:27 +02:00
.Pq Em true \" default value
.It Ic threaded_repeat_identical_from_values Ar boolean
2023-06-19 09:50:17 +03:00
In threaded listing style, repeat identical From column values within a thread.
2023-11-23 15:29:54 +02:00
Not repeating adds empty space in the From column which might result in less
visual clutter.
2024-03-06 16:28:27 +02:00
.Pq Em false \" default value
.It Ic relative_menu_indices Ar boolean
2023-07-16 14:13:55 +03:00
Show relative indices in menu mailboxes to quickly help with jumping to them.
.Pq Em true \" default value
2024-03-06 16:28:27 +02:00
.It Ic relative_list_indices Ar boolean
2023-07-16 14:13:55 +03:00
Show relative indices in listings to quickly help with jumping to them.
.Pq Em true \" default value
2024-03-06 16:28:27 +02:00
.It Ic hide_sidebar_on_launch Ar boolean
2023-09-07 12:33:51 +03:00
Start app with sidebar hidden.
.Pq Em false \" default value
2020-01-08 21:41:57 +02:00
.El
2020-09-17 16:49:19 +03:00
.Ss Examples of sidebar mailbox tree customization
2024-03-06 16:28:27 +02:00
.HorizontalRule
2020-09-17 16:49:19 +03:00
The default values
2020-10-16 22:28:00 +03:00
.sp
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2020-10-16 22:28:00 +03:00
.Bd -literal
2020-09-17 16:49:19 +03:00
has_sibling = " "
no_sibling = " ";
has_sibling_leaf = " "
no_sibling_leaf = " "
.Ed
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2020-10-16 22:28:00 +03:00
.sp
2020-09-17 16:49:19 +03:00
render a mailbox tree like the following:
2020-10-16 22:28:00 +03:00
.sp
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2020-09-17 16:49:19 +03:00
.Bd -literal
0 Inbox 3
1 Archive
2 Drafts
3 Lists
4 example-list-a
5 example-list-b
2020-10-16 22:28:00 +03:00
6 Sent
2020-09-17 16:49:19 +03:00
7 Spam
8 Trash
.Ed
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2020-10-16 22:28:00 +03:00
.sp
2020-09-17 16:49:19 +03:00
Other possible trees:
2020-10-16 22:28:00 +03:00
.sp
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2020-09-17 16:49:19 +03:00
.Bd -literal
has_sibling = " ┃"
no_sibling = " "
has_sibling_leaf = " ┣━"
no_sibling_leaf = " ┗━"
.Ed
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2020-10-16 22:28:00 +03:00
.sp
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2020-09-17 16:49:19 +03:00
.Bd -literal
0 Inbox 3
1 ┣━Archive
2 ┣━Drafts
3 ┣━Lists
4 ┃ ┣━example-list-a
5 ┃ ┗━example-list-b
2020-10-16 22:28:00 +03:00
6 ┣━Sent
2020-09-17 16:49:19 +03:00
7 ┣━Spam
8 ┗━Trash
.Ed
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2020-10-16 22:28:00 +03:00
.sp
2020-09-17 16:49:19 +03:00
A completely ASCII one:
2020-10-16 22:28:00 +03:00
.sp
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2020-09-17 16:49:19 +03:00
.Bd -literal
has_sibling = " |"
no_sibling = " "
has_sibling_leaf = " |\\ _"
no_sibling_leaf = " \\ _"
.Ed
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2020-10-16 22:28:00 +03:00
.sp
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2020-09-17 16:49:19 +03:00
.Bd -literal
0 Inbox 3
1 |\\ _Archive
2 |\\ _Drafts
3 |\\ _Lists
4 | |\\ _example-list-a
5 | \\ _example-list-b
2020-10-16 22:28:00 +03:00
6 |\\ _Sent
2020-09-17 16:49:19 +03:00
7 |\\ _Spam
8 \\ _Trash
.Ed
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2020-10-16 22:28:00 +03:00
.sp
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
. \"
. \"
2019-12-08 11:26:15 +02:00
.Sh TAGS
2024-03-06 16:28:27 +02:00
.Ss Tags (e-mail metadata in backends that support them) configuration settings
2023-05-16 13:17:13 +03:00
Default values are shown in parentheses.
2019-12-08 11:26:15 +02:00
.Bl -tag -width 36 n
.It Ic colours Ar hash table String[Color]
2020-07-15 20:20:37 +03:00
.Pq Em optional
Set UI colors for tags
2019-12-16 00:14:55 +02:00
.It Ic ignore_tags Ar Array String
2020-07-15 20:20:37 +03:00
.Pq Em optional
Hide tags (not the tagged messages themselves)
2019-12-16 00:14:55 +02:00
.El
2020-01-28 18:43:14 +02:00
.sp
2020-07-15 20:20:37 +03:00
Example:
2020-01-28 18:43:14 +02:00
.sp
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2019-12-08 11:26:15 +02:00
.Bd -literal
[tags]
# valid inputs: #HHHHHH, #ABC -> #AABBCC, XTERM_NAME, 0-255 byte
colors = { signed="#Ff6600", replied="DeepSkyBlue4", draft="#f00", replied="8" }
[accounts.dummy]
2020-01-28 00:32:40 +02:00
\& ...
2020-02-26 10:54:10 +02:00
[accounts.dummy.mailboxes]
# per mailbox override:
2024-03-10 21:34:29 +02:00
"INBOX" = { tags.ignore_tags=["inbox", ] }
2019-12-08 11:26:15 +02:00
.Ed
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
. \"
. \"
2019-09-26 12:10:36 +03:00
.Sh PGP
2023-05-16 13:17:13 +03:00
Default values are shown in parentheses.
2019-11-22 13:12:44 +02:00
.Bl -tag -width 36 n
2023-07-15 19:32:39 +03:00
. \" #[serde(default = "true_val", alias = "auto-verify-signatures")]
. \" pub auto_verify_signatures: bool,
2019-11-22 13:12:44 +02:00
.It Ic auto_verify_signatures Ar boolean
2020-07-15 20:20:37 +03:00
Auto verify signed e-mail according to RFC3156
2023-07-15 19:32:39 +03:00
.Pq Em true \" default value
. \" #[serde(default = "true_val", alias = "auto-decrypt")]
. \" pub auto_decrypt: bool,
.It Ic auto_decrypt Ar boolean
.Pq Em optional
Always decrypt encrypted e-mail
.Pq Em true \" default value
. \" #[serde(default = "false_val", alias = "auto-sign")]
. \" pub auto_sign: bool,
2019-11-22 13:12:44 +02:00
.It Ic auto_sign Ar boolean
2020-07-15 20:20:37 +03:00
.Pq Em optional
Always sign sent messages
2023-07-15 19:32:39 +03:00
.Pq Em false \" default value
. \" #[serde(default = "false_val", alias = "auto-encrypt")]
. \" pub auto_encrypt: bool,
.It Ic auto_encrypt Ar boolean
.Pq Em optional
Always encrypt sent messages
.Pq Em false \" default value
. \" #[serde(default = "none", alias = "sign-key")]
. \" pub sign_key: Option<String>,
.It Ic sign_key Ar String
.Pq Em optional
ID of key to be used for signatures
.Pq Em none \" default value
. \" #[serde(default = "none", alias = "decrypt-key")]
. \" pub decrypt_key: Option<String>,
.It Ic decrypt_key Ar String
.Pq Em optional
ID of key to be used for decryption
.Pq Em none \" default value
. \" #[serde(default = "none", alias = "encrypt-key")]
. \" pub encrypt_key: Option<String>,
.It Ic encrypt_key Ar String
.Pq Em optional
ID of key to be used for encryption
.Pq Em none \" default value
. \" #[serde(default = "internal_value_false", alias = "allow-remote-lookups")]
. \" pub allow_remote_lookup: ToggleFlag,
.It Ic auto_remote_lookup Ar boolean
.Pq Em optional
Allow remote lookups
.Pq Em false \" default value
. \" pub remote_lookup_mechanisms: melib::gpgme::LocateKey,
.It Ic remote_lookup_mechanisms Ar LocateKey
.Pq Em optional
Remote lookup mechanisms.
Use comma to separate values.
.Pq Em Local,WKD \" default value
.Pp
Possible mechanisms:
2024-03-10 21:34:29 +02:00
.Bl -dash -compact
2023-07-15 19:32:39 +03:00
.It
.Em cert
.It
.Em pka
.It
.Em dane
.It
.Em wkd
.It
.Em ldap
.It
.Em keyserver
.It
.Em keyserver-url
.It
.Em local
.El
2019-09-26 12:10:36 +03:00
.El
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
. \"
. \"
2019-10-06 10:58:47 +03:00
.Sh TERMINAL
2024-03-06 16:28:27 +02:00
.Ss Note about emojis and other multi-width characters in string values
Some useful unicode combining marks
.Po
invisible characters that modify the presentation of visible characters before
them
.Pc
are:
.sp
.Bl -tag -width 15 n
.It Ns
.Li \e \u u{FE0E}
Emoji variation sequence select 15: renders an emoji as text style (monochrome)
.It Ns
.Li \e \u u{FE0F}
Emoji variation sequence select 16: renders an emoji in color
.It Ns
.Li \e \u u{2007}
Figure space, a space character with the width of a digit in a monospace
typeface
.El
.sp
.Ss Terminal configuration settings
.HorizontalRule
2023-05-16 13:17:13 +03:00
Default values are shown in parentheses.
2019-11-22 13:12:44 +02:00
.Bl -tag -width 36 n
.It Ic theme Ar String
2020-07-15 20:20:37 +03:00
.Pq Em optional
Theme name to use.
2023-07-15 19:32:39 +03:00
.Pq Em dark \" default value
2019-11-22 13:12:44 +02:00
.It Ic ascii_drawing Ar boolean
2020-07-15 20:20:37 +03:00
.Pq Em optional
2023-11-23 15:29:54 +02:00
If true, box drawing will be done with ASCII characters.
2023-07-15 19:32:39 +03:00
.Pq Em false \" default value
2020-01-28 00:32:40 +02:00
.It Ic use_color Ar boolean
2020-07-15 20:20:37 +03:00
.Pq Em optional
2024-03-10 21:34:29 +02:00
If false, no
.Tn ANSI
colors are used.
2023-07-15 19:32:39 +03:00
.Pq Em true \" default value
2019-11-22 13:12:44 +02:00
.It Ic window_title Ar String
2020-07-15 20:20:37 +03:00
.Pq Em optional
2023-11-23 15:29:54 +02:00
Set window title in xterm compatible terminals An empty string means no window
title is set.
2023-07-15 19:32:39 +03:00
.Pq Em "meli" \" default value
2020-10-09 21:21:15 +03:00
.It Ic file_picker_command Ar String
.Pq Em optional
Set command that prints file paths in stderr, separated by NULL bytes.
Used with
.Ic add-attachment-file-picker
when composing new mail.
2023-07-15 19:32:39 +03:00
.Pq Em None \" default value
2020-01-28 00:32:40 +02:00
.It Ic themes Ar hash table String[String[Attribute]]
2023-11-23 15:29:54 +02:00
Define
.Tn UI
themes.
2020-01-28 18:43:14 +02:00
See
2020-01-28 00:32:40 +02:00
.Xr meli-themes 5
for details.
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2020-01-28 00:32:40 +02:00
.Bd -literal
[terminal]
theme = "themeB"
[terminal.themes.themeA]
"mail.view.body" = {fg = "HotPink3", bg = "LightSalmon1"}
\& ...
[terminal.themes.themeB]
"mail.view.body" = {fg = "CadetBlue", bg = "White"}
\& ...
[terminal.themes.themeC]
\& ...
.Ed
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2024-03-06 16:28:27 +02:00
.It Ic use_mouse Ar boolean
2020-10-16 22:28:00 +03:00
Use mouse events.
This will disable text selection, but you will be able to resize some widgets.
This setting can be toggled with
.Cm toggle mouse Ns
\& .
2023-07-15 19:32:39 +03:00
.Pq Em false \" default value
2020-10-16 22:28:00 +03:00
.It Ic mouse_flag Ar String
String to show in status bar if mouse is active.
2023-07-15 19:32:39 +03:00
.Pq Em 🖱️ \" default value
2021-01-10 23:38:13 +02:00
.It Ic progress_spinner_sequence Ar Either \& < Integer, ProgressSpinner \& >
2023-11-23 15:29:54 +02:00
Choose between 37 built in sequences (integers between 0-36) or define your own
list of strings for the progress spinner animation.
2020-10-16 15:47:00 +03:00
Set to an empty array to disable the progress spinner.
2023-07-15 19:32:39 +03:00
.Pq Em 20 \" default value
2023-11-23 15:29:54 +02:00
.sp
Built-in sequences are:
.sp
. \"
. \"
. \"
2020-10-16 15:47:00 +03:00
.Bd -literal
2021-01-10 23:38:13 +02:00
0 ["-", "\\ ", "|", "/"]
1 ["▁", "▂", "▃", "▄", "▅", "▆", "▇", "█"]
2 ["⣀", "⣄", "⣤", "⣦", "⣶", "⣷", "⣿"]
3 ["⣀", "⣄", "⣆", "⣇", "⣧", "⣷", "⣿"]
4 ["○", "◔", "◐", "◕", "⬤"]
5 ["□", "◱", "◧", "▣", "■"]
6 ["□", "◱", "▨", "▩", "■"]
7 ["□", "◱", "▥", "▦", "■"]
8 ["░", "▒", "▓", "█"]
9 ["░", "█"]
10 ["⬜", "⬛"]
11 ["▱", "▰"]
12 ["▭", "◼"]
13 ["▯", "▮"]
14 ["◯", "⬤"]
15 ["⚪", "⚫"]
16 ["▖", "▗", "▘", "▝", "▞", "▚", "▙", "▟", "▜", "▛"]
17 ["|", "/", "-", "\\ "]
18 [".", "o", "O", "@", "*"]
19 ["◡◡", "⊙⊙", "◠◠", "⊙⊙"]
20 ["◜ ", " ◝", " ◞", "◟ "]
21 ["←", "↖", "↑", "↗", "→", "↘", "↓", "↙"]
22 ["▁", "▃", "▄", "▅", "▆", "▇", "█", "▇", "▆", "▅", "▄", "▃"]
23 [ "▉", "▊", "▋", "▌", "▍", "▎", "▏", "▎", "▍", "▌", "▋", "▊", "▉" ]
24 ["▖", "▘", "▝", "▗"]
25 ["▌", "▀", "▐", "▄"]
26 ["┤", "┘", "┴", "└", "├", "┌", "┬", "┐"]
27 ["◢", "◣", "◤", "◥"]
28 ["⠁", "⠂", "⠄", "⡀", "⢀", "⠠", "⠐", "⠈"]
29 ["⢎⡰", "⢎⡡", "⢎⡑", "⢎⠱", "⠎⡱", "⢊⡱", "⢌⡱", "⢆⡱"]
30 [".", "o", "O", "°", "O", "o", "."]
31 ["㊂", "㊀", "㊁"]
32 ["💛 ", "💙 ", "💜 ", "💚 ", "❤️ "]
33 [ "🕛 ", "🕐 ", "🕑 ", "🕒 ", "🕓 ", "🕔 ", "🕕 ", "🕖 ", "🕗 ", "🕘 ", "🕙 ", "🕚 " ]
34 ["🌍 ", "🌎 ", "🌏 "]
35 [ "[ ]", "[= ]", "[== ]", "[=== ]", "[ ===]", "[ ==]", "[ =]", "[ ]", "[ =]", "[ ==]", "[ ===]", "[====]", "[=== ]", "[== ]", "[= ]" ]
36 ["🌑 ", "🌒 ", "🌓 ", "🌔 ", "🌕 ", "🌖 ", "🌗 ", "🌘 "]
2020-10-16 15:47:00 +03:00
.Ed
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
.sp
Or, define an array of strings each consisting of a frame in the progress
sequence indicator for a custom spinner:
2021-01-10 23:38:13 +02:00
.Bl -tag -width 36 n
.It Ic interval_ms Ar u64
.Pq Em optional
Frame interval.
2023-07-15 19:32:39 +03:00
.Pq 50 \" default value
2021-01-10 23:38:13 +02:00
.It Ic frames Ar [String]
The animation frames.
.El
.Pp
Example:
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2020-10-16 15:47:00 +03:00
.Bd -literal
2021-01-10 23:38:13 +02:00
progress_spinner_sequence = { interval_ms = 150, frames = [ "-", "=", "≡" ] }
2020-10-16 15:47:00 +03:00
.Ed
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2019-10-06 11:28:12 +03:00
.El
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
. \"
. \"
2020-05-28 16:02:57 +03:00
.Sh LOG
2024-03-06 16:28:27 +02:00
.Ss Logging configuration settings
2023-05-16 13:17:13 +03:00
Default values are shown in parentheses.
2020-05-28 16:02:57 +03:00
.Bl -tag -width 36 n
.It Ic log_file Ar String
2020-07-15 20:20:37 +03:00
.Pq Em optional
path of the log file
2023-07-15 19:32:39 +03:00
.Pq Pa $XDG_DATA_HOME/meli/meli.log \" default value
2020-05-28 16:02:57 +03:00
.It Ic maximum_level Ar String
2020-07-15 20:20:37 +03:00
.Pq Em optional
maximum level of messages to log.
All levels less or equal to the
2020-05-28 16:02:57 +03:00
.Ic maximum_level
2020-07-15 20:20:37 +03:00
will be appended to the log file.
Available levels are, in partial order:
2024-03-10 21:34:29 +02:00
.Bl -dash -compact
2020-05-28 16:02:57 +03:00
.It
.Em OFF
.It
.Em ERROR
.It
.Em WARN
.It
.Em INFO
.It
.Em DEBUG
.It
.Em TRACE
.El
This means that to turn logging off, set
.Ic maximum_level
to
.Em OFF Ns
\& .
2023-07-15 19:32:39 +03:00
.Pq Em INFO \" default value
2020-05-28 16:02:57 +03:00
.El
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
. \"
. \"
2020-07-15 15:19:27 +03:00
.Sh SMTP Connections
2024-03-06 16:28:27 +02:00
.Ss SMTP configuration settings
2023-05-16 13:17:13 +03:00
Default values are shown in parentheses.
2020-07-15 15:19:27 +03:00
.Bl -tag -width 36 n
.It Ic hostname Ar String
server hostname
.It Ic port Ar Integer
server port
.It Ic envelope_from Ar String
2020-07-15 20:20:37 +03:00
.Pq Em optional
address to set as sender in SMTP transactions
2023-07-15 19:32:39 +03:00
.Pq Em none \" default value
2020-07-15 15:19:27 +03:00
.It Ic auth Ar SmtpAuth
2023-11-23 15:29:54 +02:00
.Tn SMTP
server authentication.
2020-07-15 15:19:27 +03:00
See
.Sx SmtpAuth
subsection.
.It Ic security Ar SmtpSecurity
2020-07-15 20:20:37 +03:00
.Pq Em optional
2023-11-23 15:29:54 +02:00
.Sy gpg
binary name or file location to use.
2023-07-15 19:32:39 +03:00
.Po see \" default value
2020-07-15 15:19:27 +03:00
.Sx SmtpSecurity
subsection
.Pc
.It Ic extensions Ar SmtpExtensions
2020-07-15 20:20:37 +03:00
.Pq Em optional
2023-11-23 15:29:54 +02:00
set support for
.Tn SMTP
extensions if they are advertised by the server.
2023-07-15 19:32:39 +03:00
.Po see \" default value
2020-07-15 15:19:27 +03:00
.Sx SmtpExtensions
subsection
.Pc
.El
.Ss SmtpAuth
.Bl -tag -width 36 n
2020-11-30 03:25:57 +02:00
.It Ic type Ar "none" | "auto" | "xoauth2"
2020-07-15 15:19:27 +03:00
.El
.Pp
2023-11-23 15:29:54 +02:00
For type
.Qq auto Ns
:
2020-07-15 15:19:27 +03:00
.Bl -tag -width 36 n
.It Ic username Ar String
2020-10-30 22:40:56 +02:00
.It Ic password Ar SmtpPassword
2024-03-06 16:28:27 +02:00
.It Ic require_auth Ar boolean
2020-07-15 20:20:37 +03:00
.Pq Em optional
2023-11-23 15:29:54 +02:00
require authentication in every case.
2023-07-15 19:32:39 +03:00
.Pq Em true \" default value
2020-07-15 15:19:27 +03:00
.El
2020-10-30 22:40:56 +02:00
.sp
2023-11-23 15:29:54 +02:00
For type
.Qq xoauth2 Ns
:
2020-11-30 03:25:57 +02:00
.Bl -tag -width 36 n
.It Ic token_command Ar String
2023-11-23 15:29:54 +02:00
Command to evaluate that returns an
.Tn XOAUTH2
token.
2024-03-06 16:28:27 +02:00
.It Ic require_auth Ar boolean
2020-11-30 03:25:57 +02:00
.Pq Em optional
2023-11-23 15:29:54 +02:00
require authentication in every case.
2023-07-15 19:32:39 +03:00
.Pq Em true \" default value
2020-11-30 03:25:57 +02:00
.El
.sp
2020-10-30 22:40:56 +02:00
Examples:
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2020-10-30 22:40:56 +02:00
.Bd -literal
auth = { type = "auto", username = "user", password = { type = "raw", value = "hunter2" } }
.Ed
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2020-10-30 22:40:56 +02:00
.Bd -literal
auth = { type = "auto", username = "user", password = "hunter2" }
.Ed
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2020-10-30 22:40:56 +02:00
.Bd -literal
auth = { type = "none" }
.Ed
2020-11-30 03:25:57 +02:00
.sp
2023-11-23 15:29:54 +02:00
For
.Tn Gmail
(see
2020-11-30 03:25:57 +02:00
.Sx Gmail OAUTH2
for details on the authentication token command):
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2020-11-30 03:25:57 +02:00
.Bd -literal
auth = { type = "xoauth2", token_command = "TOKEN=$(python3 oauth2.py --user=xxx@gmail.com --quiet --client_id=1038[...].apps.googleusercontent.com --client_secret=[..] --refresh_token=[..] && python3 oauth2.py --user=xxx@gmail.com --generate_oauth2_string --quiet --access_token=$TOKEN" }
.Ed
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2020-07-15 15:19:27 +03:00
.Ss SmtpPassword
.Bl -tag -width 36 n
.It Ic type Ar "raw" | "command_evaluation"
.It Ic value Ar String
Either a raw password string, or command to execute.
.El
2020-10-30 22:40:56 +02:00
.sp
Examples:
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2020-10-30 22:40:56 +02:00
.Bd -literal
password = { type = "raw", value = "hunter2" }
.Ed
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2020-10-30 22:40:56 +02:00
.Bd -literal
password = { type = "command_eval", value = "gpg2 --no-tty -q -d ~/.passwords/user.gpg" }
.Ed
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
2020-07-15 15:19:27 +03:00
.Ss SmtpSecurity
Default security type is
.Em auto Ns
\& .
.Bl -tag -width 36 n
.It Ic type Ar "none" | "auto" | "starttls" | "tls"
2024-03-06 16:28:27 +02:00
.It Ic danger_accept_invalid_certs Ar boolean
2023-11-23 15:29:54 +02:00
Accept invalid
.Tn SSL
/
.Tn TLS
certificates
2023-07-15 19:32:39 +03:00
.Pq Em false \" default value
2020-07-15 15:19:27 +03:00
.El
.Ss SmtpExtensions
.Bl -tag -width 36 n
2024-03-06 16:28:27 +02:00
.It Ic pipelining Ar boolean
2023-11-23 15:29:54 +02:00
RFC2920
2023-07-15 19:32:39 +03:00
.Pq Em true \" default value
2024-03-06 16:28:27 +02:00
.It Ic chunking Ar boolean
2023-11-23 15:29:54 +02:00
RFC3030
2023-07-15 19:32:39 +03:00
.Pq Em true \" default value
2024-03-06 16:28:27 +02:00
.It Ic prdr Ar boolean
2020-07-15 15:19:27 +03:00
draft-hall-prdr-00
2023-07-15 19:32:39 +03:00
.Pq Em true \" default value
2020-07-15 15:19:27 +03:00
.It Ic dsn_notify Ar String
RFC3461
2023-07-15 19:32:39 +03:00
.Pq Em FAILURE \" default value
2020-07-15 15:19:27 +03:00
.El
2023-11-23 15:29:54 +02:00
. \"
. \"
. \"
. \"
. \"
2019-09-16 14:07:38 +03:00
.Sh SEE ALSO
2020-01-28 00:32:40 +02:00
.Xr meli 1 ,
.Xr meli-themes 5
2024-03-10 21:34:29 +02:00
.Sh STANDARDS
.Bl -item -compact
.It
2023-11-23 15:29:54 +02:00
.Tn TOML
Standard
.Li v.0.5.0
.Lk https://toml.io/en/v0.5.0
2024-03-10 21:34:29 +02:00
.El
2019-09-16 14:07:38 +03:00
.Sh AUTHORS
2024-03-10 21:34:29 +02:00
Copyright 2017\(en 2024
.An Manos Pitsidianakis Aq Mt manos@pitsidianak.is
.Pp
2020-01-28 18:43:14 +02:00
Released under the GPL, version 3 or greater.
This software carries no warranty of any kind.
2024-03-10 21:34:29 +02:00
.Po
See
.Pa COPYING
for full copyright and warranty notices.
.Pc
.Ss Links
.Bl -item -compact
.It
.Lk https://meli\-email.org "Website"
.It
.Lk https://git.meli\-email.org/meli/meli "Main\ git\ repository\ and\ issue\ tracker"
.It
.Lk https://codeberg.org/meli/meli "Official\ read-only\ git\ mirror\ on\ codeberg.org"
.It
.Lk https://github.com/meli/meli "Official\ read-only\ git\ mirror\ on\ github.com"
.It
.Lk https://crates.io/crates/meli "meli\ crate\ on\ crates.io"
.El