10 KiB
10 KiB
MELI.CONF(5) File Formats Manual MELI.CONF(5)
NAME
meli.conf – configuration file for the Meli Mail User Agent
SYNOPSIS
$XDG_CONFIG_HOME/meli/config
DESCRIPTION
Configuration for meli is written in TOML. Few things to consider before
writing TOML (quoting the spec):
• TOML is case sensitive.
• A TOML file must be a valid UTF-8 encoded Unicode document.
• Whitespace means tab (0x09) or space (0x20).
• Newline means LF (0x0A) or CRLF (0x0D 0x0A).
Refer to TOML documentation for valid TOML syntax.
SECTIONS
The top level sections of the config are accounts, shortcuts,
notifications, pager, composing, pgp, terminal.
example configuration
# Setting up a Maildir account
[accounts.account-name]
root_folder = "/path/to/root/folder"
format = "Maildir"
index_style = "Compact"
identity="email@address.tld"
subscribed_folders = ["folder", "folder/Sent"]
display_name = "Name"
# Set folder-specific settings
[accounts.account-name.folders]
"INBOX" = { rename="Inbox" } #inline table
"drafts" = { rename="Drafts" } #inline table
[accounts.account-name.folders."foobar-devel"] # or a regular table
ignore = true # don't show notifications for this folder
# Setting up an mbox account
[accounts.mbox]
root_folder = "/var/mail/username"
format = "mbox"
index_style = "Compact"
identity="username@hostname.local"
[pager]
filter = "/usr/bin/pygmentize"
html_filter = "w3m -I utf-8 -T text/html"
[notifications]
script = "notify-send"
[composing]
# required for sending e-mail
mailer_cmd = 'msmtp --read-recipients --read-envelope-from'
editor_cmd = 'vim +/^$'
[shortcuts]
scroll_up = 'k'
scroll_down = 'j'
page_up = PageUp
page_down = PageDown
[terminal]
theme = "light"
available options are listed below. default values are shown in
parentheses.
ACCOUNTS
root_folder String the backend-specific
path of the
root_folder, usually
INBOX.
format String [maildir mbox imap notmuch] the format of the mail
backend.
subscribed_folders [String,] an array of folder
paths to display in the
UI. Paths are relative
to the root folder (eg
"INBOX/Sent", not
"Sent")
identity String your e-mail address
that is inserted in the
From: headers of
outgoing mail
index_style String set the way mailboxes
are displayed
plain shows
one row
per
mail,
regardless
of
threading
threaded shows
threads
as a
tree
structure,
with one
row per
thread
entry
conversations shows
one
entry
per
thread
compact shows
one row
per
thread
display_name String (optional) a name which
can be combined with
your address: "Name
<email@address.tld>"
read_only boolean attempt to not make any
changes to this
account. (false)
cache_type String choose which cache
backend to use.
Available options are
'none' and 'sqlite3'
(sqlite3)
folders folder_config (optional)
configuration for each
folder. Its format is
described below in
FOLDERS.
notmuch only
root_folder points to the directory which contains the .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 folders field and set the query property to each of them.
Example:
[accounts.notmuch]
format = "notmuch"
...
[accounts.notmuch.folders]
"INBOX" = { query="tag:inbox", subscribe = true }
"Drafts" = { query="tag:draft", subscribe = true }
"Sent" = { query="from:username@server.tld from:username2@server.tld", subscribe = true }
IMAP only
IMAP specific options are:
server_hostname String example: "mail.example.tld"
server_username String
server_password String
server_port number (optional) (143)
use_starttls boolean (optional) if port is 993 and
use_starttls is unspecified,
it becomes false by default.
(true)
danger_accept_invalid_certs boolean (optional) do not validate
TLS certificates. (false)
FOLDERS
rename String (optional) show a different
name for this folder in the
UI
autoload boolean (optional) load this folder
on startup (not functional
yet)
subscribe boolean (optional) watch this folder
for updates (true)
ignore boolean (optional) silently insert
updates for this folder, if
any (false)
usage boolean (optional) special usage of
this folder. valid values
are:
• Normal
• Inbox
• Archive
• Drafts
• Flagged
• Junk
• Sent
• Trash
otherwise usage is inferred
from the folder title.
conf_override boolean (optional) override global
settings for this folder.
available sections to
override are pager,
notifications, shortcuts,
composing and the account
options identity and
index_style. example:
[accounts."imap.domain.tld".folders."INBOX"]
index_style = "plain"
[accounts."imap.domain.tld".folders."INBOX".pager]
filter = ""
COMPOSING
mailer_cmd String command to pipe new mail to,
exit code must be 0 for
success.
editor_cmd String 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.
embed boolean (optional) embed editor
within meli (false)
format_flowed boolean (optional) set format=flowed
[RFC367] in text/plain
attachments. (true)
SHORTCUTS
Shortcuts can take the following values: "Backspace" "Left" "Right" "Up"
"Down" "Home" "End" "PageUp" "PageDown" "Delete" "Insert" "Esc" and
"char", where char is a single character string.
prev_page Go to previous page.
next_page Go to next page.
prev_folder Go to previous folder.
next_folder Go to next folder.
prev_account Go to previous account.
next_account Go to next account.
new_mail Start new mail draft in new
tab
open_thread Open thread.
exit_thread Exit thread view
scroll_up Scroll up pager.
scroll_down Scroll down pager.
page_up Go to previous pager page
page_down Go to next pager pag
create_contact Create new contact.
edit_contact Edit contact under cursor
NOTIFICATIONS
enable boolean enable freedesktop-spec
notifications. this is
usually what you want (true)
script String (optional) script to pass
notifications to, with title
as 1st arg and body as 2nd
(none)
xbiff_file_path String (optional) file that gets its
size updated when new mail
arrives (none)
play_sound boolean (optional) play theme sound
in notifications if possible
(false)
sound_file String (optional) play sound file in
notifications if possible
(none)
PAGER
pager_context num (optional) number of context
lines when going to next
page. (0)
headers_sticky boolean (optional) always show
headers when scrolling.
(false)
html_filter String (optional) pipe html
attachments through this
filter before display (none)
filter String (optional) a command to pipe
mail output through for
viewing in pager. (none)
PGP
auto_verify_signatures boolean auto verify signed e-mail
according to RFC3156 (true)
auto_sign boolean (optional) always sign sent
messages (false)
key String (optional) key to be used
when signing/encrypting (not
functional yet) (none)
gpg_binary String (optional) gpg binary name or
file location to use (gpg2)
TERMINAL
theme String (optional) select between
these themes: light / dark
(dark)
ascii_drawing boolean (optional) if true, box
drawing will be done with
ascii characters. (false)
window_title String (optional) set window title
in xterm compatible terminals
(empty string means no window
title is set) (meli)
SEE ALSO
meli(1)
CONFORMING TO
TOML Standard v.0.5.0 https://github.com/toml-
lang/toml/blob/master/versions/en/toml-v0.5.0.md
AUTHORS
Copyright 2017-2019 Manos Pitsidianakis ⟨epilys@nessuent.xyz⟩ Released
under the GPL, version 3 or greater. This software carries no warranty of
any kind. (See COPYING for full copyright and warranty notices.)
⟨https://meli.delivery⟩
Linux September 16, 2019 Linux