id = "mutt"
name = "Mutt"
homepage = "https://mutt.org/"
description = "A small but very powerful text-based mail client."
executables = ["mutt"]

[dotfiles]

# https://mutt.org/doc/manual/ documents the user config search order:
# ~/.muttrc, ~/.mutt/muttrc, then $XDG_CONFIG_HOME/mutt/muttrc. Versioned
# variants are deliberately omitted because their names depend on the local
# Mutt version.
paths = []
exclude = []

# Mutt's initialization file commonly carries IMAP/SMTP passwords and account
# URLs. Keep each documented user config location as a whole-file secret.
secret = ["~/.muttrc", "~/.mutt/muttrc", "[configHome]/mutt/muttrc"]
side_effect = false

[commands]
format = 1
label = "Mutt"
description = "Compose a message or open a mailbox. Attachments (-a, which needs a trailing --), debug logging and alias or config queries are left out."
quality = "ai-draft"
parser = { end_of_options = "--", interleave = "permute", long_equals = false, short_attached = false, short_bundles = false }

[[commands.source]]
id = "man"
kind = "manual"
url = "https://manpages.debian.org/unstable/mutt/mutt.1.en.html"
evidence = """
-b bcc-addr
-c cc-addr
-e command
-f mailbox
-F rcfile
-H draft
-i include
-n
-R
-s subject
-y
Specify a blind carbon copy (BCC) address.
Specify a carbon copy (CC) address.
Specify a configuration command to be run after processing of initialization files.
Specify a mailbox to load.
Use rcfile instead of the user configuration file.
Specify a draft file which contains header and body to use to send a message.
Specify an include file to be inserted into the body of a message.
Do not read the system-wide Muttrc configuration file.
Open a mailbox in read-only mode.
Specify the subject of the message. Must be enclosed in quotes if it contains spaces.
Start Mutt with a listing of all mailboxes specified by the mailboxes configuration command.
"""

[[commands.field]]
id = "to"
label = "Recipients"
description = "Addresses to send to. Leave empty when opening a mailbox."
type = "string"
position = 0
multiple = true
sources = ["man"]

[[commands.field]]
id = "subject"
label = "Subject"
type = "string"
option = ["-s"]
sources = ["man"]

[[commands.field]]
id = "cc"
label = "Cc address"
type = "string"
option = ["-c"]
sources = ["man"]

[[commands.field]]
id = "bcc"
label = "Bcc address"
type = "string"
option = ["-b"]
sources = ["man"]

[[commands.field]]
id = "include"
label = "Include file in body"
type = "path"
option = ["-i"]
path = { kind = "file", role = "input" }
sources = ["man"]

[[commands.field]]
id = "draft"
label = "Draft file"
type = "path"
option = ["-H"]
path = { kind = "file", role = "input" }
sources = ["man"]

[[commands.field]]
id = "mailbox"
label = "Mailbox to open"
type = "path"
option = ["-f"]
path = { kind = "any", role = "input" }
sources = ["man"]

[[commands.field]]
id = "read_only"
label = "Open read-only"
type = "boolean"
option = ["-R"]
sources = ["man"]

[[commands.field]]
id = "rcfile"
label = "Config file"
type = "path"
option = ["-F"]
path = { kind = "file", role = "input" }
sources = ["man"]

[[commands.field]]
id = "no_system_rc"
label = "Skip system-wide Muttrc"
type = "boolean"
option = ["-n"]
sources = ["man"]

[[commands.field]]
id = "config_command"
label = "Extra config command"
type = "string"
option = ["-e"]
sources = ["man"]

[[commands.field]]
id = "mailbox_list"
label = "Start at mailbox list"
type = "boolean"
option = ["-y"]
sources = ["man"]

[[commands.task]]
id = "compose"
label = "Compose a message"
fields = ["to", "subject", "cc", "bcc", "include"]
required = ["to"]

[[commands.task]]
id = "open"
label = "Open a mailbox read-only"
fields = ["mailbox", "read_only"]
required = ["mailbox"]
set = { read_only = [true] }

[[commands.group]]
id = "basic"
label = "Basic"
fields = ["to", "subject", "cc", "bcc", "include", "mailbox", "read_only"]

[[commands.group]]
id = "advanced"
label = "Advanced"
fields = ["draft", "rcfile", "no_system_rc", "config_command", "mailbox_list"]