MELI.CONF(5)

๐Ÿ“ฆ
version 0.8.13 ยท 3 versions
, in alpine 3.24, nixos 26.05, nixpkgs unstable, ubuntu resolute, ubuntu stonking

๐ŸŽ€ MELI.CONF(5) ๐ŸŽ€

File Formats Manual ยท MELI.CONF(5)

okay bestie so this is the manual page for meli.conf โ€” the configuration file for the meli(1) terminal e-mail client ๐Ÿ’Œโœจ

โœจ NAME โœจ

meli.conf โ€” configuration file for the meli(1) terminal e-mail client ๐Ÿฆ‹

๐ŸŒธ SYNOPSIS ๐ŸŒธ

$XDG_CONFIG_HOME/meli/config.toml

๐Ÿ’– DESCRIPTION ๐Ÿ’–

So meli's config is written in TOML, and there's a few things you gotta know about it (this is straight from the spec, no cap):

  • TOML is case sensitive. case sensitive!! don't be out here capitalizing stuff and wondering why nothing works ๐Ÿ˜ญ
  • A TOML file must be a valid UTF-8 encoded Unicode document.
  • White-space means tab (0x09) or space (0x20).
  • Newline means LF (0x0A) or CRLF (0x0D 0x0A).

Go check the TOML documentation if you want the full valid-syntax tea โ˜•

Now here's the fun part โ€” even though it's not technically part of TOML syntax, meli.conf can have nested configuration files using this m4(1) include macro:

include("/path/to/file")

the way that just works?? obsessed ๐Ÿ’…

๐Ÿฆ‹ SECTIONS ๐Ÿฆ‹

The top level sections of the config are:

  • accounts
  • shortcuts
  • notifications
  • pager
  • listing
  • composing
  • pgp
  • terminal
  • log

๐ŸŒˆ EXAMPLES ๐ŸŒˆ

Here's an example configuration, bestie โ€” take notes ๐Ÿ“โœจ

# Setting up a Maildir account
[accounts.account-name]
root_mailbox = "/path/to/root/folder"
format = "Maildir"
listing.index_style = "Compact"
identity="email@example.com"
subscribed_mailboxes = ["folder", "folder/Sent"] # or [ "*", ] for all mailboxes
display_name = "Name"
send_mail = 'msmtp --read-recipients --read-envelope-from'
#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" } }

# Set mailbox-specific settings
  [accounts.account-name.mailboxes]
  "INBOX" = { alias="Inbox" } #inline table
  "drafts" = { alias="Drafts" } #inline table
  [accounts.account-name.mailboxes."foobar-devel"] # or a regular table
    ignore = true # don't show notifications for this mailbox

# Setting up an mbox account
[accounts.mbox]
root_mailbox = "/var/mail/username"
format = "mbox"
listing.index_style = "Compact"
identity="username@hostname.local"
send_mail = { hostname = "localhost", port = 25, auth = { type = "none" }, security = { type = "none" } }

[pager]
filter = "COLUMNS=72 /usr/local/bin/pygmentize -l email"
html_filter = "w3m -I utf-8 -T text/html"

[notifications]
script = "notify-send"

[composing]
editor_command = 'vim +/^$'

[shortcuts]
[shortcuts.composing]
edit = 'e'

[shortcuts.listing]
new_mail = 'm'
set_seen = 'n'

[terminal]
theme = "light"

Available options are listed below ๐Ÿ‘‡

๐Ÿ‘‘ ACCOUNTS ๐Ÿ‘‘

๐Ÿงš Account configuration settings

Default values are shown in parentheses, bestie.

  • root_mailbox String โ€” The backend-specific path of the root_mailbox, usually INBOX.
  • send_mail String|SmtpServerConf โ€” Command to pipe new mail to (exit code must be 0 for success) or settings for an SMTP server connection. See section "SMTP Connections" for its fields.
  • default_mailbox String โ€” (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.
  • format String [maildir mbox imap notmuch jmap] โ€” The format of the mail backend.
  • subscribed_mailboxes [String,] โ€” An array of mailbox paths to display in the UI. Paths are relative to the root mailbox (e.g. INBOX/Sent, not Sent). The glob wildcard * can be used to match every mailbox name and path.
  • identity String โ€” Your e-mail address that is inserted in the From: headers of outgoing mail.
  • extra_identities [String,] โ€” Extra e-mail address identities. When replying to an e-mail addressed to one of these identities, the From: header will be adjusted to its value instead of the default identity.
  • display_name String โ€” (optional) A name which can be combined with your address: "Name <email@example.com>".
  • read_only boolean โ€” Attempt to not make any changes to this account. (false)
  • manual_refresh boolean โ€” (optional) If true, do not monitor account for changes (you can use shortcut listing.refresh). (false)
  • refresh_command String โ€” (optional) command to execute when manually refreshing (shortcut listing.refresh) (None)
  • search_backend String โ€” (optional) Choose which search backend to use. Available options are "none" and "sqlite3". ("sqlite3")
  • vcard_folder String โ€” (optional) Folder that contains .vcf files. They are parsed and imported read-only.
  • mutt_alias_file String โ€” (optional) Path of mutt(1) compatible alias file in the option They are parsed and imported read-only.
  • notmuch_address_book_query String โ€” (optional) Query passed to "notmuch address" to import contacts into meli. Contacts are parsed and imported read-only.
  • mailboxes mailbox โ€” (optional) Configuration for each mailbox. Its format is described below in "mailboxes".

๐Ÿ“ notmuch only

notmuch is supported by loading the dynamic library libnotmuch. If its location is missing from your library paths, you must add it yourself. Alternatively, you can specify its path by using a setting. iykyk โœจ

notmuch mailboxes are virtual, since they are defined by user-given notmuch queries. You must explicitly state the mailboxes you want in the mailboxes field and set the query property to each of them. To create a tree hierarchy with virtual mailboxes, define the parent property to a mailbox as the name of the parent mailbox you have used in your configuration. ๐ŸŒณ

Account properties:

  • root_mailbox โ€” points to the directory which contains the .notmuch/ subdirectory.
  • library_file_path Path โ€” Use an arbitrary location of libnotmuch by specifying its full filesystem path. (optional)

Mailbox properties:

  • query String โ€” The notmuch query that defines what content this virtual mailbox has. Refer to notmuch-search-terms(7) for notmuch's search syntax.
  • parent String โ€” If you wish to build a mailbox hierarchy, define the name of a parent mailbox you have used in your configuration. (optional)

Example:

[accounts.notmuch]
format = "notmuch"
#library_file_path = "/opt/homebrew/lib/libnotmuch.5.dylib"
...
  [accounts.notmuch.mailboxes]
  "INBOX" = {  query="tag:inbox", subscribe = true }
  "Drafts" = {  query="tag:draft", subscribe = true }
  "Sent" = {  query="from:username@example.com from:username2@example.com", subscribe = true }
  "Archives" = {  query="tag:archived", subscribe = true }
  "Archives/2019" = {  query="tag:archived date:01-2019..12-2019", parent="Archives", subscribe = true }

๐Ÿ’œ IMAP only

IMAP specific options are, like, right here ๐Ÿ’…:

  • server_hostname String โ€” example: "mail.example.com"
  • server_username String โ€” Server username
  • server_password String โ€” Server password
  • server_password_command String โ€” (optional) Use instead of server_password
  • server_port number โ€” (optional) The port to connect to (143)
  • use_starttls boolean โ€” (optional) If port is 993 and "use_starttls" is unspecified, it becomes false by default. (true)
  • use_tls boolean โ€” (optional) Connect with TLS (or upgrade from plain connection to TLS if STARTTLS is set.) (true)
  • danger_accept_invalid_certs boolean โ€” (optional) Do not validate TLS certificates. (false) โš ๏ธ
okay so danger_accept_invalid_certs is literally named danger for a reason bestie โ€” it turns off TLS certificate validation. the girlies are NOT doing that in prod, fr fr ๐Ÿ™ˆ
  • offline_cache boolean โ€” (optional) Keep mail headers in an sqlite3 database. (true)
  • use_idle boolean โ€” (optional) Use IDLE extension. (true)
  • use_condstore boolean โ€” (optional) Use CONDSTORE extension. (true)
  • use_deflate boolean โ€” (optional) Use COMPRESS=DEFLATE extension (if built with DEFLATE support) (true)
  • use_oauth2 boolean โ€” (optional) turn on OAUTH2 auth ๐Ÿ’… bestie this one only works alongside server_password_command, and that command has to hand back a base64-encoded OAUTH2 token that's ready to be yeeted straight into IMAP. Wanna set it up with Gmail? The Gmail section down below has your back. Default: false
  • use_auth_anonymous boolean โ€” (optional) use the AUTH=ANONYMOUS extension for authentication. Default: false
  • use_id boolean โ€” (optional) use the ID extension to grab server metadata (you can peek at it on the account status page ๐Ÿ‘€). Turning this on does not send any info to the server, so chill. Default: false
  • use_connection_pool boolean โ€” (optional) use a connection pool with more than one server connection, so you don't get time-outs while doing a bunch of operations back to back. Here's the tea ๐Ÿ“: IMAP connections are stateful and can only handle one mailbox at a time, so using a connection means locking it. Having a pool of spare connections that get created on demand โ€” in case they're ready faster than the main connection can be unlocked โ€” might ease up that lock contention. Default: true
  • timeout integer โ€” (optional) how long (in seconds) to wait on server connections before giving up. A timeout of 0 seconds means there is no timeout at all, live your truth. Default: 16

๐ŸŽ€ Gmail ๐ŸŽ€

Gmail has non-standard IMAP behaviors that need to be worked around. Not Gmail being quirky again ๐Ÿ˜ญ

โœจ Gmail - sending mail โœจ

The store_sent_mail option should be disabled, because Gmail auto-saves sent mail all by its own self. Let it cook ๐Ÿซถ

๐Ÿ’– Gmail OAUTH2 ๐Ÿ’–

To use OAUTH2, you have to go through a whole process to register your own private "application" with Google that can use OAUTH2 tokens, and then set the option use_oauth2 to 'true' in the account configuration section. For convenience, in the meli repository under the contrib/ directory you can find a python3 file named oauth2.py to generate and request the appropriate data to perform OAUTH2 authentication. Little gift from us to you ๐Ÿ’

Steps:

  1. In Google APIs, create a custom OAuth client ID and note down the Client ID and Client Secret. You may need to create a consent screen; just follow the steps described in the website.
  2. Run the oauth2.py script as follows (after adjusting binary paths and credentials):
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.

  1. In server_password_command enter a command like this (after adjusting binary paths and credentials):
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
  1. On startup, meli should evaluate this command which if successful must only return a base64-encoded token ready to be passed to IMAP.

Your account section should look like this:

[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 = ["*" ]
send_mail = { hostname = "smtp.gmail.com", port = 587, auth = { type = "xoauth2", token_command = "...", require_auth = true }, security = { type = "STARTTLS" } }
composing.store_sent_mail = false

๐Ÿฆ‹ JMAP only ๐Ÿฆ‹

JMAP specific options, bestie. Only for the JMAP girlies โœจ

  • server_url String โ€” example: "http://mail.example.com" "http://mail.example.com:8080" "https://mail.example.com"
  • server_username String โ€” Server username
  • server_password String โ€” Server password
  • server_password_command String โ€” (optional) Use instead of server_password
  • use_token boolean โ€” Authenticate using the API Bearer token method. If enabled, the token value must be provided as the configured password. Default: false
  • danger_accept_invalid_certs boolean โ€” (optional) Do not validate TLS certificates. Default: false
  • timeout integer โ€” (optional) Timeout to use for server connections in seconds. A timeout of 0 seconds means there is no timeout. Default: 16

๐ŸŒธ mbox only ๐ŸŒธ

mbox specific options:

  • prefer_mbox_type String โ€” (optional) Prefer a specific mbox format reader for each message. Default is "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. ๐Ÿ˜ญ

Valid values:

  • auto
  • mboxo
  • mboxrd
  • mboxcl
  • mboxcl2

Default: auto

To set multiple mailboxes, you have to explicitly state the mailboxes you want in the mailboxes field and set the path property to each of them. Example:

[accounts.mbox]
format = "mbox"
mailboxes."Python mailing list" = { path = "~/.mail/python.mbox", subscribe = true, autoload = true }

๐Ÿ’œ NNTP ๐Ÿ’œ

NNTP specific options, no cap ๐Ÿ“ฐ

  • server_hostname String โ€” example: "nntp.example.com"
  • server_username String โ€” Server username
  • server_password String โ€” Server password
  • require_auth boolean โ€” (optional) require authentication in every case. Default: true
  • use_tls boolean โ€” (optional) Connect with TLS. Default: false
  • server_port number โ€” (optional) The port to connect to. Default: 119
  • danger_accept_invalid_certs boolean โ€” (optional) Do not validate TLS certificates. Default: false
  • store_flags_locally boolean โ€” (optional) Store seen status locally in an sqlite3 database. Default: true
  • timeout integer โ€” (optional) Timeout to use for server connections in seconds. A timeout of 0 seconds means there is no timeout. Default: 16

You have to explicitly state the groups you want to see in the mailboxes field. Example:

[accounts.sicpm.mailboxes]
  "sic.all" = {}

To submit articles directly to the NNTP server, you must set the special value server_submission in the account send_mail field. Example:

send_mail = "server_submission"

๐Ÿ‘‘ MAILBOXES ๐Ÿ‘‘

  • alias String โ€” (optional) Show a different name for this mailbox in the UI. Glow-up your folder names ๐Ÿ’…
  • autoload boolean โ€” (optional) Load this mailbox on startup. Default: true
  • collapsed boolean โ€” (optional) Collapse this mailbox subtree in the menu. Default: false
  • subscribe boolean โ€” (optional) Watch this mailbox for updates. Default: true
  • ignore boolean โ€” (optional) Silently insert updates for this mailbox, if any. Default: false
  • usage boolean โ€” (optional) special usage of this mailbox. Valid values are:
    • Normal (default)
    • Inbox
    • Archive
    • Drafts
    • Flagged
    • Junk
    • Sent
    • Trash

otherwise usage is inferred from the mailbox title. So if, for example, your Sent folder is not named "Sent", you must explicitly set it. Fr fr, it won't guess for you ๐Ÿ™ˆ

  • conf_override boolean โ€” (optional) Override global settings for this mailbox. The available sections to override are pager, notifications, shortcuts, composing and the account options identity. Example:

...and the rest of that example goes a little something like this, bestie:

[accounts."imap.example.com".mailboxes]
  "INBOX" = { index_style = "plain" }
  "INBOX/Lists/devlist" = { autoload = false, pager = { filter = "pygmentize -l diff -f 256"} }
  • sort_order unsigned integer โ€” (optional) okay so this one lets you override the sort order for this specific mailbox in the sidebar โœจ. You're basically telling the sidebar "no babe, this is the order, respect it." Here's the vibe:
[accounts."imap.example.com".mailboxes]
  "INBOX" = { index_style = "plain" }
  "INBOX/Sent" = { sort_order = 0 }
  "INBOX/Drafts" = { sort_order = 1 }
  "INBOX/Lists" = { sort_order = 2 }

So INBOX/Sent gets to be first, Drafts is right behind it, and Lists brings up the rear โ€” main character, supporting cast, and the group chat, fr fr. ๐Ÿ‘‘

  • encoding String โ€” (optional) this one overrides the default UTF-8 charset for the mailbox name ๐ŸŽ€. And lowkey, it's only useful for UTF-7 mailboxes โ€” like, don't come for it if you're living that UTF-8 life, it's not for you ๐Ÿ’….

The values it takes are: utf7, utf-7, utf8, utf-8.

UTF-7 mailboxes are genuinely giving cursed energy but we support them anyway because we're nothing if not inclusive ๐Ÿฆ‹

๐Ÿ’Œ COMPOSING ๐Ÿ’Œ

โœจ Composing specific configuration settings โœจ

bestie this is the part where you tell meli how to write your emails for you and honestly it's giving main character energy. Default values are shown in parentheses, so when you see (false) just know that's what meli does when you say absolutely nothing. ๐Ÿ’…

  • editor_command String โ€” the command that launches your editor. It can totally have arguments, it's fine. Your draft's filename gets handed over as the last argument. If this setting is just... not there, meli goes looking for the environment variable EDITOR instead.
  • embedded_pty boolean โ€” (optional) an embedded editor living inside meli. Your editor has to be xterm compliant for this to work. (false)
  • format_flowed boolean โ€” (optional) sets format=flowed [RFC3676] in text/plain attachments. (true)
  • insert_user_agent boolean โ€” (optional) adds the meli User-Agent header to your shiny new drafts. (true)
  • default_header_values hash table String[String] โ€” (optional) the default header values meli uses when it's creating a new draft. ({})
  • wrap_header_preamble Option<(String, String)> โ€” (optional) wraps the header pre-ample when you're editing a draft in an editor. This is the slay trick that lets you write non-plain text email without the preamble creating syntax errors. They get stripped when you come back from the editor, don't worry. The value should be a two element array of strings: a prefix and a suffix. Super useful when you're writing Markdown for example โ€” set the value to ["<!--", "-->"] and boom, your headers are wrapped in an HTML comment. (None)
  • store_sent_mail boolean โ€” (optional) stores your sent mail after a successful submission. Lowkey this setting exists so you can disable it for non-standard behaviour in Gmail, since Gmail auto-saves sent mail all on its own. (true)
  • attribution_format_string String โ€” (optional) the attribution line, aka the little text that appears above the quoted reply. The format specifiers for the replied address are:
    • %+f โ€” the sender's name and email address.
    • %+n โ€” the sender's name (or the email address, if no name is included).
    • %+a โ€” the sender's email address.

The format string gets passed to strftime(3) along with the replied envelope's date. (On %a, %0e %b %Y %H:%M, %+f wrote:%n)

  • attribution_use_posix_locale boolean โ€” (optional) whether that strftime(3) call for the attribution string uses the POSIX locale instead of the user's active locale. (true)
  • forward_as_attachment boolean or ask โ€” (optional) forwarding emails as an attachment? (the alternative is inline, fyi). (ask)
  • reply_prefix_list_to_strip [String] โ€” (optional) alternative lists of reply prefixes (like ["Re:", "RE:", ...]) to strip. Here's the default, in all its multilingual glory:
[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:]
  • reply_prefix String โ€” (optional) the prefix to use in reply subjects. The default prefix is 'Re:'. ('Re:')

and ok because the manpage is a nerd, RFC 2822, "Internet Message Format" has this to say on the matter:

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.
  • custom_compose_hooks [{ name = String, command = String }] โ€” (optional) custom compose-hooks that run shell scripts. compose-hooks run before submitting an e-mail, and they do draft validation and/or transformations. 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. ๐Ÿ‘€

Example:

[composing]
editor_cmd = '~/.local/bin/vim +/^$'
embedded_pty = true
custom_compose_hooks = [ { name ="spellcheck", command="aspell --mode email --dont-suggest --ignore-case list" }]
  • disabled_compose_hooks [String] โ€” (optional) disabled compose-hooks. compose-hooks run before submitting an e-mail and 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:
    • past-date-warn โ€” warns you if the Date header value is far in the past or future.
    • important-header-warn โ€” warns you if important headers (From, Date, To, Cc, Bcc) are missing or invalid.
    • missing-attachment-warn โ€” warns you if Subject or draft body mention attachments but they are missing. ๐Ÿ˜ญ
    • empty-draft-warn โ€” warns you if the draft has no subject and no body.
  • signature_file Path โ€” (optional) a plain text file with a signature that will pre-populate an email draft. Signatures must be explicitly enabled to be used, otherwise this setting just gets ignored, periodt. (None)
  • use_signature bool โ€” pre-populate email drafts with a signature, if any. meli will lookup the signature value in this order:
    1. The signature_file setting.
    2. ${XDG_CONFIG_DIR}/meli/<account>/signature
    3. ${XDG_CONFIG_DIR}/meli/signature
    4. ${XDG_CONFIG_DIR}/signature
    5. ${HOME}/.signature
    6. No signature otherwise.

(false)

  • signature_delimiter String โ€” (optional) the signature delimiter, that is, the text that gets prefixed to your signature to separate it from the email body. ('\n\n-- \n')
  • allow_reply_to_self boolean โ€” (optional) when you're replying to an e-mail authored by our main identity or one of our extra identities, reply to those addresses instead of reusing the receivers of the original e-mail we're replying to. The default is false, because the intuitive behavior when replying to ourselves is to follow-up on an e-mail we sent. (false)

โœจ SHORTCUTS โœจ

okay bestie, this is the part where you get to tell meli which keys do what. shortcuts are fully customizable and it's giving main character energy. ๐Ÿ’…

๐ŸŽน Values corresponding to keyboard keys, keycodes

Shortcuts can take the following values:

  • Backspace
  • Left
  • Right
  • Up
  • Down
  • Home
  • End
  • PageUp
  • PageDown
  • Delete
  • Insert
  • Enter
  • Tab
  • Esc
  • F1..F12
  • M-char
  • C-char
  • char

Where char is a single character string, maximum 4 bytes long, like the corresponding type in Rust.

In the next subsection, you will find lists for each shortcut category. The headings before each list indicate the map key of the shortcut list. For example for the first list titled general the configuration is typed as follows:

[shortcuts.general]
next_tab = 'T'

and for listing:

[shortcuts.listing]
open_entry = "Enter"
exit_entry = 'i'

commands

In addition, each shortcuts section supports a TOML array of commands to associate a key to an array of COMMAND mode commands.

[shortcuts.listing]
commands = [ { command = [ "tag remove trash", "flag unset trash" ], shortcut = "D" },
                    { command = [ "tag add trash", "flag set trash" ], shortcut = "d" } ]

โš™๏ธ Shortcut configuration settings

Default values are shown in parentheses.

general

  • toggle_help โ€” Pops open the help and shortcuts view. (?)
  • enter_command_mode โ€” Drops you into COMMAND mode. (:)
  • quit โ€” Says bye to meli. (q)
  • go_to_tab โ€” Jumps to the nth tab (M-n)
  • next_tab โ€” Slides over to the next tab. (T)
  • scroll_right โ€” Generic scroll right (catch-all setting). (l)
  • scroll_left โ€” Generic scroll left (catch-all setting). (h)
  • scroll_up โ€” Generic scroll up (catch-all setting). (k)
  • scroll_down โ€” Generic scroll down (catch-all setting). (j)
  • next_page โ€” Go to next page (catch-all setting). (PageDown)
  • prev_page โ€” Go to previous page (catch-all setting). (PageUp)
  • home_page โ€” Go to first page (catch-all setting). (Home)
  • end_page โ€” Go to last page (catch-all setting). (End)
  • open_entry โ€” Open list entry (catch-all setting). (Enter)
  • info_message_next โ€” Show next info message, if any. (>)
  • info_message_previous โ€” Show previous info message, if any. (<)
  • focus_in_text_field โ€” Focus on a text field. (Enter)
  • next_search_result โ€” Scroll to next search result. (n)
  • previous_search_result โ€” Scroll to previous search result. (N)

listing

  • scroll_up โ€” Scroll up the list. (k)
  • scroll_down โ€” Scroll down the list. (j)
  • next_page โ€” Go to next page. (PageDown)
  • prev_page โ€” Go to previous page. (PageUp)
  • new_mail โ€” Start a new mail draft in a new tab. (m)
  • next_account โ€” Go to next account. (H)
  • prev_account โ€” Go to previous account. (L)
  • next_mailbox โ€” Go to next mailbox. (J)
  • prev_mailbox โ€” Go to previous mailbox. (K)
  • open_mailbox โ€” Open the selected mailbox. (Enter)
  • toggle_mailbox_collapse โ€” Toggle mailbox visibility in the menu. (Space)
  • search โ€” Search within the list of e-mails. (/)
  • refresh โ€” Manually request a mailbox refresh. (F5)
  • set_seen โ€” Set thread as seen. (n)
  • send_to_trash โ€” Send entry to the trash folder. (D)
  • union_modifier โ€” Union modifier. (C-u)
  • diff_modifier โ€” Difference modifier. (C-d)
  • intersection_modifier โ€” Intersection modifier. (i)
  • select_entry โ€” Select (or toggle) a thread entry. (V)
  • select_motion โ€” Perform a select motion with a movement. (v)
  • increase_sidebar โ€” Increase sidebar width. (C-f)
  • decrease_sidebar โ€” Decrease sidebar width. (C-d)
  • next_entry โ€” When reading a mail item, change focus to the next entry according to the current sorting. (C-n)
  • previous_entry โ€” When reading a mail item, change focus to the previous entry according to the current sorting. (C-p)
  • toggle_menu_visibility โ€” Toggle visibility of the side menu in the mail list. (`)
  • focus_left โ€” Switch focus to the left. (Left)
  • focus_right โ€” Switch focus to the right. (Right)
  • exit_entry โ€” Exit e-mail entry. (i)
  • open_entry โ€” Open e-mail entry. (Enter)

pager

  • page_down โ€” Go to next page. (PageDown)
  • page_up โ€” Go to previous page. (PageUp)
  • scroll_down โ€” Scroll down the pager. (j)
  • scroll_up โ€” Scroll up the pager. (k)
  • select_filter โ€” Select content filter. (f) See also named_filters setting.

contact-list

  • scroll_up โ€” Scroll up the list. (k)
  • scroll_down โ€” Scroll down the list. (j)
  • create_contact โ€” Create a new contact. (c)
  • edit_contact โ€” Edit the contact under the cursor. (e)
  • export_contact โ€” Export the contact under the cursor to .vcf. (E)
  • delete_contact โ€” Delete the contact under the cursor. (d)
  • mail_contact โ€” Mail the contact under the cursor. (m)
  • next_account โ€” Go to next account. (H)
  • prev_account โ€” Go to previous account. (L)
  • toggle_menu_visibility โ€” Toggle visibility of the side menu in the mail list. (`)

composing

  • edit โ€” Edit mail. (e)
  • send_mail โ€” Deliver draft to mailer. (s)
  • scroll_up โ€” Change field focus. (k)
  • scroll_down โ€” Change field focus. (j)

envelope-view

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.

  • add_addresses_to_contacts โ€” Select addresses from the envelope to add to contacts. (c)
  • edit โ€” Open envelope in the composer. (e)
  • go_to_url โ€” Go to the url of the given index (with the command url_launcher setting in the โ€œPAGERโ€ section). (g)
  • open_attachment โ€” Opens the selected attachment with xdg-open. (a)
  • open_mailcap โ€” Opens the selected attachment according to its mailcap entry. See meli(1) FILES for the mailcap file locations. (m)
  • open_html โ€” Opens the html attachment in the default browser. (v)
  • reply โ€” Reply to envelope. (R)
  • reply_to_author โ€” Reply to author. (C-r)
  • reply_to_all โ€” Reply to all/Reply to list/Follow up. (C-g)
  • forward โ€” Forward email. (C-f)
  • return_to_normal_view โ€” Return to envelope if viewing raw source or attachment. (r)
  • toggle_expand_headers โ€” Expand extra headers (References and others). (h)
  • toggle_url_mode โ€” Toggles url open mode. When active, it prepends an index next to each url that you can select by typing the index and open by issuing go_to_url. (u)
  • view_raw_source โ€” View raw envelope source in a pager. (M-r)
  • change_charset โ€” Force attachment charset for decoding. (d)

thread-view

  • scroll_up โ€” Scroll up the list. (k)
  • scroll_down โ€” Scroll down the list. (j)
  • collapse_subtree โ€” Collapse thread branches. (h)
  • next_page โ€” Go to next page. (PageDown)
  • prev_page โ€” Go to previous page. (PageUp)
  • reverse_thread_order โ€” Reverse thread order. (C-r)
  • toggle_mailview โ€” Toggle mail view visibility. (p)
  • toggle_threadview โ€” Toggle thread view visibility. (t)
  • toggle_layout โ€” Toggle between horizontal and vertical layout. (Space)

๐Ÿ”” NOTIFICATIONS ๐Ÿ””

โœจ System notifications โœจ

okay so meli(1) can display notifications for asynchronous, out-of-band events that happen. These events can be any event of interest that is not a direct result of the user's interaction with the user interface, like for example receiving a new e-mail, or an SMTP server accepting an e-mail for delivery, or a backend watch mechanism error. The used notification mechanism is dbus if it is available on your system and if meli(1) has been compiled with support for it (check output of compiled-with CLI subcommand). Otherwise the fallback mechanism is calling a script to display a notification. If script is defined in your configuration, this mechanism will be preferred even if dbus is available.

On macos, without a script configured, meli(1) calls the osascript binary to display notifications:

osascript -e 'display_notification "<MESSAGE>" with title "<TITLE>" subtitle "<SUBTITLE>"'

You can override the script setting with variations of this command for customization.

๐Ÿ’Œ UI notifications ๐Ÿ’Œ

Information that is in response to user interface actions should be instead shown within the user interface as floating message boxes. If you don't want UI notifications to be displayed, you can set the ui_notifications option to hide to hide them, or system to display them as system notifications.

Even when UI notifications are not displayed, you can still browse through them manually using shortcuts.general.info_message_next and shortcuts.general.info_message_previous shortcuts. iykyk ๐Ÿ’…

๐ŸŽ€ Notification configuration settings ๐ŸŽ€

Default values are shown in parentheses.

  • enable boolean โ€” (optional) Enable notifications. Default: true.
  • script String โ€” (optional) Script to pass notifications to, with title as 1st arg and body as 2nd. Default: none.
  • new_mail_script String โ€” (optional) A command to pipe new mail notifications through (preferred over script), with title as 1st arg and body as 2nd. Default: none.
  • xbiff_file_path String โ€” (optional) File that gets its size updated when new mail arrives. Default: none.
  • play_sound boolean โ€” (optional) Play theme sound in notifications if possible. Default: false.
  • sound_file String โ€” (optional) Play sound file in notifications if possible. Default: none.
  • ui_notifications UINotifications โ€” (optional) How to handle UI notifications. Default: show. Valid values:
    • show โ€” Always show.
    • hide โ€” Hide from UI.
    • system โ€” Show them as system notifications.

๐Ÿ“– PAGER ๐Ÿ“–

๐ŸŒธ Pager (viewing text) configuration settings ๐ŸŒธ

Default values are shown in parentheses.

  • sticky_headers boolean โ€” (optional) Always show headers when scrolling. Default: false.
  • html_filter String โ€” (optional) Pipe html attachments through this filter before display. Default: none.
  • html_open String โ€” (optional) A command to open html files. Default: none.
  • filter String โ€” (optional) A command to pipe mail output through for viewing in pager.
  • named_filters String[String] โ€” (optional) Named filter commands to use at will. Default: empty.

Show menu with an empty filter command. Example:

[pager]
named_filters = { diff = "pygmentize -l diff -f 256", par = "par 72" }
  • format_flowed boolean โ€” (optional) Respect format=flowed. Default: true.
  • split_long_lines boolean โ€” (optional) Split long lines that would overflow on the x axis. Default: true.
  • minimum_width num โ€” (optional) Minimum text width in columns. Default: 80.
  • auto_choose_multipart_alternative boolean โ€” (optional) Choose text/html alternative if text/plain is empty in multipart/alternative attachments. Default: true.
  • show_date_in_my_timezone boolean โ€” (optional) Show Date: in local timezone. Default: true.
  • url_launcher String โ€” (optional) A command to launch URLs with. The URL will be given as the first argument of the command. Default: xdg-open.
  • show_extra_headers [String] โ€” (optional) Extra headers to display, if present, in the default header preamble of the pager. Default: empty.

This setting is useful especially when used per-folder or per-account. For example, if you use rss2email (See r2e(1)) the e-mail you will receive will have the X-RSS-Feed header by default. You can show them only in the folder where you keep your feed items:

[accounts."personal".mailboxes]
INBOX = {}
"INBOX/Sent" = { sort_order=0 }
"INBOX/Feeds" = { pager.show_extra_headers = ["X-RSS-Feed"] }

๐Ÿ—‚๏ธ LISTING

ok so this whole section is about Listing โ€” aka the actual list of e-mail entries chillin' in a mailbox. This is the main character of your screen fr fr. Default values are in parentheses, bestie, don't forget.

  • show_menu_scrollbar boolean โ€” (optional) show an auto-hiding scrollbar in the accounts sidebar menu. (true)
  • datetime_fmt String โ€” (optional) datetime formatting, passed verbatim to strftime(3). (%Y-%m-%d %T)
  • recent_dates Boolean โ€” (optional) show recent dates like 'X {minutes,hours,days} ago', but only up to 7 days. (true)
  • filter Query โ€” (optional) show only envelopes matching this query. (For query syntax, go peek at meli(1) QUERY ABNF SYNTAX.) (None)

Example:

filter = "not flags:seen" # show only unseen messages
  • index_style String โ€” sets the way mailboxes are displayed. โœจ
    • conversations โ€” shows one entry per thread
    • compact โ€” shows one row per thread
    • threaded โ€” shows threads as a tree structure
    • plain โ€” shows one row per mail, regardless of threading
  • sidebar_mailbox_tree_has_sibling String โ€” (optional) sets the string to print in the mailbox tree for a level where its root has a sibling. (See the example below for a clear explanation and examples. ๐Ÿ‘‡)
  • sidebar_mailbox_tree_no_sibling String โ€” (optional) sets the string to print in the mailbox tree for a level where its root has no sibling.
  • sidebar_mailbox_tree_has_sibling_leaf String โ€” (optional) sets the string to print in the mailbox tree for a leaf level where its root has a sibling.
  • sidebar_mailbox_tree_no_sibling_leaf String โ€” (optional) sets the string to print in the mailbox tree for a leaf level where its root has no sibling.
  • sidebar_divider char โ€” (optional) sets the character to print as the divider between the accounts list and the message list.
  • sidebar_ratio Integer โ€” (optional) this is the width of the right container to the entire screen width. (90)
  • unseen_flag Option<String> โ€” flag to show if a thread entry contains unseen mail. (โ—)
  • thread_snoozed_flag Option<String> โ€” flag to show if a thread has been snoozed. ("๐Ÿ’ค\u{FE0E}") [Rendered as: r##"๐Ÿ’ค"##]
  • selected_flag Option<String> โ€” flag to show if a thread entry has been selected. ("โ˜‘ \u{2007}") [Rendered as: r##"โ˜‘ "##]
  • attachment_flag Option<String> โ€” flag to show if a thread entry contains attachments. ("๐Ÿ“Ž\u{FE0E}") [Rendered as: r##"๐Ÿ“Ž"##]
  • highlight_self_flag Option<String> โ€” flag to show if any thread entry contains your address as a receiver. Super useful for making mailing-list threads that CC you stand out. (โœธ)
  • highlight_self boolean โ€” show highlight_self_flag or not. (false)
  • thread_subject_pack boolean โ€” should threads with differentiating Subjects show a list of those subjects on the entry title? (true)
  • threaded_repeat_identical_from_values boolean โ€” in threaded listing style, repeat identical From column values within a thread. Not repeating adds empty space in the From column, which might result in less visual clutter. (false)
  • relative_menu_indices boolean โ€” show relative indices in menu mailboxes to quickly help with jumping to them. (true)
  • relative_list_indices boolean โ€” show relative indices in listings to quickly help with jumping to them. (true)
  • hide_sidebar_on_launch boolean โ€” start the app with the sidebar hidden. (false)
  • mail_view_divider char โ€” character to show in the divider space between mail view and listing. (' ')
  • thread_layout โ€” auto | vertical | horizontal. Force a specific layout in thread view. You can also toggle the layout at runtime with the listing.toggle_layout shortcut. (auto)

๐ŸŒธ Examples of sidebar mailbox tree customization

The default values, bestie:

 has_sibling = " "
 no_sibling = " ";
 has_sibling_leaf = " "
 no_sibling_leaf = " "

and that renders a mailbox tree like this:

0  Inbox 3
1   Archive
2   Drafts
3   Lists
4    example-list-a
5    example-list-b
6   Sent
7   Spam
8   Trash

Other possible trees ๐Ÿฆ‹:

has_sibling = " โ”ƒ"
no_sibling = "  "
has_sibling_leaf = " โ”ฃโ”"
no_sibling_leaf = " โ”—โ”"
0  Inbox 3
1   โ”ฃโ”Archive
2   โ”ฃโ”Drafts
3   โ”ฃโ”Lists
4   โ”ƒ โ”ฃโ”example-list-a
5   โ”ƒ โ”—โ”example-list-b
6   โ”ฃโ”Sent
7   โ”ฃโ”Spam
8   โ”—โ”Trash

And a completely ASCII one, for the purists ๐Ÿ’…:

has_sibling = " |"
no_sibling = "  "
has_sibling_leaf = " |\_"
no_sibling_leaf = " \_"
0  Inbox 3
1   |\_Archive
2   |\_Drafts
3   |\_Lists
4   | |\_example-list-a
5   |  \_example-list-b
6   |\_Sent
7   |\_Spam
8    \_Trash

๐Ÿท๏ธ TAGS

ok so Tags = e-mail metadata, but only in backends that actually support them, no cap. Default values are in parentheses, as always. ๐Ÿ’–

  • colours hash table String[Color] โ€” (optional) set UI colors for tags
  • ignore_tags Array String โ€” (optional) hide tags (not the tagged messages themselves ๐Ÿ‘€)

Example:

[tags]
# valid inputs: #HHHHHH, #ABC -> #AABBCC, XTERM_NAME, 0-255 byte
colors = { signed="#Ff6600", replied="DeepSkyBlue4", draft="#f00", replied="8" }
[accounts.dummy]
...
  [accounts.dummy.mailboxes]
  # per mailbox override:
  "INBOX" = { tags.ignore_tags=["inbox", ] }

๐Ÿ’Œ PGP ๐Ÿ’Œ

okay bestie, this is where you tell meli how to handle your โœจsecret agentโœจ mail. defaults are chillin' in parentheses, as always.

  • auto_verify_signatures boolean โ€” auto-verify signed e-mail according to RFC3156 (true). she checks the vibes (and the crypto) for you ๐Ÿ’…
  • auto_decrypt boolean โ€” (optional) always decrypt encrypted e-mail (true). no cap, it just does it ๐Ÿ”“
  • auto_sign boolean โ€” (optional) always sign sent messages (false). main character energy requires a signature, but she won't do it unless you say so โœ๏ธ
  • auto_encrypt boolean โ€” (optional) always encrypt sent messages (false)
  • sign_key String โ€” (optional) ID of key to be used for signatures (none)
  • decrypt_key String โ€” (optional) ID of key to be used for decryption (none)
  • encrypt_key String โ€” (optional) ID of key to be used for encryption (none)
  • auto_remote_lookup boolean โ€” (optional) allow remote lookups (false). say yes and she'll go hunting for keys across the internet ๐Ÿ•ต๏ธโ€โ™€๏ธ
  • remote_lookup_mechanisms LocateKey โ€” (optional) remote lookup mechanisms. use a comma to separate values. (Local,WKD)

possible mechanisms:

  • cert
  • pka
  • dane
  • wkd
  • ldap
  • keyserver
  • keyserver-url
  • local

๐ŸŒˆ TERMINAL ๐ŸŒˆ

๐ŸŽ€ Note about emojis and other multi-width characters in string values ๐ŸŽ€

some unicode combining marks are lowkey iconic (they're invisible little characters that change how the visible character before them shows up). here are the useful ones:

  • \u{FE0E} โ€” Emoji variation sequence select 15: renders an emoji as text style (monochrome)
  • \u{FE0F} โ€” Emoji variation sequence select 16: renders an emoji in color
  • \u{2007} โ€” Figure space, a space character with the width of a digit in a monospace typeface

โœจ Terminal configuration settings โœจ

defaults live in parentheses, you know the drill ๐Ÿ’–

  • theme String โ€” (optional) theme name to use. (dark)
  • tab_width u8 โ€” how many cells a tab character occupies. (4)
  • ascii_drawing boolean โ€” (optional) if true, box drawing will be done with ASCII characters. (false)
  • use_color boolean โ€” (optional) if false, no ANSI colors are used. (true)
  • force_text_presentation boolean โ€” (optional) if true, text presentations of color symbols and emoji will be enforced as much as possible. might not work on all non-text symbols and is experimental. (false)
  • window_title String โ€” (optional) set window title in xterm compatible terminals. an empty string means no window title is set. (meli)
  • file_picker_command String โ€” (optional) set command that prints file paths in stdout, separated by NUL bytes. used with add-attachment-file-picker when composing new mail. (None)
  • themes hash table String[String[Attribute]] โ€” define UI themes. see meli-themes(5) for details.
[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]
...
  • use_mouse boolean โ€” use mouse events. this will disable text selection, but you will be able to resize some widgets. this setting can be toggled with toggle mouse. (false)
bestie. read that again. mouse mode = no text selection. choose wisely ๐Ÿ™ˆ
  • mouse_flag String โ€” string to show in status bar if mouse is active. (๐Ÿ–ฑ)
  • progress_spinner_sequence Either < Integer, ProgressSpinner > โ€” choose between 37 built in sequences (integers between 0-36) or define your own list of strings for the progress spinner animation. set to an empty array to disable the progress spinner. (20)

built-in sequences are:

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  ["๐ŸŒ‘ ", "๐ŸŒ’ ", "๐ŸŒ“ ", "๐ŸŒ” ", "๐ŸŒ• ", "๐ŸŒ– ", "๐ŸŒ— ", "๐ŸŒ˜ "]

or, define an array of strings each consisting of a frame in the progress sequence indicator for a custom spinner:

  • interval_ms u64 โ€” (optional) frame interval. (50)
  • frames [String] โ€” the animation frames.

example:

progress_spinner_sequence = { interval_ms = 150, frames = [ "-", "=", "โ‰ก" ] }
spinner 32 through 36? absolutely ate. 32 is giving heart-eyes every single frame ๐Ÿ’›๐Ÿ’™๐Ÿ’œ๐Ÿ’šโค๏ธ

๐Ÿ“œ LOG ๐Ÿ“œ

Logging configuration settings

Default values are shown in parentheses. As always, bestie ๐Ÿ’…

  • log_file String โ€” (optional) where your log file lives. Default is ($XDG_DATA_HOME/meli/meli.log). Yes she keeps receipts ๐Ÿ’–
  • maximum_level String โ€” (optional) the max level of messages to log. Every level less than or equal to maximum_level gets appended to the log file. The available levels are, in partial order:
    • OFF
    • ERROR
    • WARN
    • INFO
    • DEBUG
    • TRACE

Which means: to turn logging off, set maximum_level to OFF. Default is (INFO).

ngl the "partial order" thing is doing a lot of work here but it just means higher levels include all the chattier stuff below them, okay? ๐Ÿซถ

๐Ÿ’Œ SMTP Connections ๐Ÿ’Œ

SMTP configuration settings

Default values are shown in parentheses. It's giving "let me send this email for you" energy fr fr โœจ

  • hostname String โ€” server hostname.
  • port Integer โ€” server port.
  • envelope_from String โ€” (optional) the address to set as sender in SMTP transactions. Default: (none).
  • auth SmtpAuth โ€” SMTP server authentication. Go read the โ€œSmtpAuthโ€ subsection, she's iconic ๐Ÿ‘‘
  • security SmtpSecurity โ€” (optional) gpg binary name or file location to use. (see โ€œSmtpSecurityโ€ subsection). Yeah, that's literally what the page says, I'm not making this up ๐Ÿ™ˆ no cap.
  • extensions SmtpExtensions โ€” (optional) set support for SMTP extensions if they're advertised by the server. (see โ€œSmtpExtensionsโ€ subsection).

SmtpAuth

type none | auto | xoauth2

For type "auto":

  • username String
  • password SmtpPassword
  • require_auth boolean โ€” (optional) require authentication in every case. Default (true).

For type "xoauth2":

  • token_command String โ€” Command to evaluate that returns an XOAUTH2 token.
  • require_auth boolean โ€” (optional) require authentication in every case. Default (true).

Examples, copy them exactly bestie, don't freestyle ๐Ÿ’€:

auth = { type = "auto", username = "user", password = { type = "raw", value = "hunter2" } }
auth = { type = "auto", username = "user", password = "hunter2" }
auth = { type = "none" }

For Gmail (peep โ€œGmail OAUTH2โ€ for the details on the authentication token command):

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" }

SmtpPassword

type raw | command_evaluation
  • value String โ€” Either a raw password string, or command to execute.

Examples:

password = { type = "raw", value = "hunter2" }
password = { type = "command_eval", value = "gpg2 --no-tty -q -d ~/.passwords/user.gpg" }
๐Ÿ”ฅ pro move honestly, piping your password through gpg2 instead of pasting it everywhere.

SmtpSecurity

Default security type is auto. ๐Ÿ’…

type none | auto | starttls | tls
  • danger_accept_invalid_certs boolean โ€” Accept invalid SSL / TLS certificates. Default (false).
๐Ÿšจ bestie the word danger is RIGHT THERE in the option name. Turning this on means accepting certs that did not pass the vibe check. Do it only if you know exactly why, okay? ๐Ÿ˜ญ

SmtpExtensions

  • pipelining boolean โ€” RFC2920. Default (true).
  • chunking boolean โ€” RFC3030. Default (true).
  • prdr boolean โ€” draft-hall-prdr-00. Default (true).
  • dsn_notify String โ€” RFC3461. Default (FAILURE).

๐Ÿ‘€ SEE ALSO ๐Ÿ‘€

meli(1), meli-themes(5)

๐Ÿ“ STANDARDS ๐Ÿ“

TOML Standard v.0.5.0 https://toml.io/en/v0.5.0

๐Ÿซถ AUTHORS ๐Ÿซถ

Copyright 2017โ€“2024 Manos Pitsidianakis <manos@pitsidianak.is>

Released under the GPL, version 3 or greater. This software carries no warranty of any kind. (See COPYING for full copyright and warranty notices.)

And that's a wrap on MELI.CONF(5), bestie!! ๐ŸŽ€โœจ This page is from the Debian section of the manual, dated May 20, 2024, and it's literally the MELI.CONF(5) man page โ€” go configure something slay, you got this ๐Ÿ’–๐Ÿฆ‹๐ŸŒธ

๐Ÿ“ฆ where this page comes from