Skip to main content

rmut_core/
config.rs

1//! TOML configuration from $RMUT_CONFIG or ~/.config/rmut/config.toml.
2//!
3//! ```toml
4//! [identity]
5//! name = "Jane Doe"
6//! email = "jane@example.com"
7//! reverse_name = false  # reply From = the address the mail came to
8//!
9//! [[identities]]        # conditional identity (folder-/send-hook)
10//! folder = "*work*"     # glob on the open mailbox, and/or:
11//! recipient = "*@work.example.com"   # glob on a draft recipient
12//! name = "Jane Work"
13//! email = "jane@work.example.com"
14//!
15//! [mail]
16//! alternates = ["jane@old\\.example\\.com"]  # my other addresses
17//! my_hdr = ["Organization: Acme"]        # on every draft
18//! mailboxes = ["~/Maildir", "~/Maildir/.Sent"]
19//! sent = "~/Maildir/.Sent"
20//! postponed = "~/Maildir/.Drafts"
21//! sendmail = "/usr/sbin/sendmail"
22//! editor = "vim"
23//! poll_seconds = 5
24//! print = "lpr"
25//!
26//! [index]
27//! format = "%4C %Z %-6d %-15.15L (%?l?%4l&%4c?) %s"
28//!
29//! [ui]
30//! theme = "default"   # or "mono"
31//!
32//! [colors]            # overrides: status_fg status_bg deleted flagged header
33//! deleted = "red"
34//!
35//! [keys.index]        # action = key, e.g. sync = "w", delete = "ctrl+d"
36//! [keys.pager]
37//!
38//! [[accounts]]        # remote account, opened as imap:name/FOLDER
39//! name = "work"
40//! user = "jane@example.com"
41//! password_command = "pass show mail/work"   # or: password = "..."
42//! imap_host = "imap.example.com"   # imap_port = 993, imap_tls = true
43//! smtp_host = "smtp.example.com"   # smtp_port = 587, smtp_tls = true
44//! sent_folder = "Sent"             # Fcc target via IMAP APPEND
45//!
46//! [[folder_hooks]]      # mutt's folder-hook, any `:` command line
47//! folder = "*work*"
48//! command = "set index_format=\"%4C %Z %-6d %-20.20F %s\""
49//!
50//! [[message_hooks]]     # applied while the message is selected
51//! pattern = "~f boss@example.com"
52//! command = "set pager_context=5"
53//!
54//! [[reply_hooks]]       # applied while a reply to it is built
55//! pattern = "~t @work.example.com"
56//! command = "set from=jane@work.example.com"
57//!
58//! [[fcc_hooks]]         # where the sent copy goes
59//! pattern = "~t @work.example.com"
60//! mailbox = "~/Maildir/.WorkSent"
61//!
62//! [[crypt_hooks]]       # encrypt to this key for this recipient
63//! address = "boss@example.com"
64//! key = "0xDEADBEEF"
65//!
66//! [pgp]
67//! command = "gpg"              # runs via $PATH; passphrases come from
68//! sign_key = "jane@example.com"  # the gpg agent, never from rmut
69//! sign_by_default = false
70//! encrypt_by_default = false
71//! ```
72
73use std::collections::HashMap;
74use std::path::PathBuf;
75
76use anyhow::{Context, Result, ensure};
77use serde::Deserialize;
78
79#[derive(Debug, Clone, Default, Deserialize)]
80#[serde(default)]
81pub struct Config {
82    pub identity: Identity,
83    pub mail: Mail,
84    pub index: Index,
85    pub pager: Pager,
86    pub ui: Ui,
87    pub gui: Gui,
88    pub net: Net,
89    pub sidebar: Sidebar,
90    pub colors: HashMap<String, String>,
91    /// Pattern → color rules for index lines, evaluated in order.
92    pub color_index: Vec<ColorRule>,
93    /// Regex → color rules for pager body spans (mutt's `color body`),
94    /// applied in order; `pattern` here is a plain regex, not a
95    /// message pattern.
96    pub color_body: Vec<ColorRule>,
97    /// MIME type → shell command that renders the part (stdin → stdout),
98    /// e.g. "text/html" = "w3m -dump -T text/html", mutt's auto_view.
99    /// Applied to matching parts wherever they sit in the message,
100    /// preferred in multipart/alternative, and used in the attachment
101    /// viewer. An empty command means mutt's arrangement: the command
102    /// comes from mailcap, from the first `copiousoutput` entry for
103    /// the type; a type with no such entry simply does not autoview.
104    pub filters: HashMap<String, String>,
105    pub keys: Keys,
106    /// Macros: a key that replays a sequence of keys, per menu:
107    /// [macros.index] / [macros.pager], `key = "sequence"`. The
108    /// sequence is literal characters plus `<enter>`/`<esc>`/
109    /// `<ctrl+x>`/... names in angle brackets; it feeds the input
110    /// queue, so it can drive prompts.
111    pub macros: Keys,
112    pub accounts: Vec<Account>,
113    /// Conditional identities, applied in order over `identity` when
114    /// their globs match: the minimal folder-hook / send-hook.
115    pub identities: Vec<IdentityRule>,
116    /// mutt's folder-hook with an arbitrary command: enter-command
117    /// lines run when a matching mailbox is opened.
118    pub folder_hooks: Vec<FolderHook>,
119    /// mutt's message-hook: lines applied while a matching message is
120    /// the selected one, and taken back off when it stops matching.
121    pub message_hooks: Vec<MessageHook>,
122    /// mutt's reply-hook: lines applied while a reply to a matching
123    /// message is built.
124    pub reply_hooks: Vec<MessageHook>,
125    /// mutt's fcc-hook: where a matching outgoing message's copy goes.
126    pub fcc_hooks: Vec<FccHook>,
127    /// mutt's crypt-hook: the PGP key to encrypt to for a recipient.
128    pub crypt_hooks: Vec<CryptHook>,
129    pub pgp: Pgp,
130}
131
132/// One `[[folder_hooks]]` entry: mutt's folder-hook. Like mutt, a
133/// folder-hook is not undone when you leave the mailbox, so a
134/// catch-all entry (`folder = "*"`) is the way to put a setting back.
135#[derive(Debug, Clone, Default, Deserialize)]
136#[serde(default)]
137pub struct FolderHook {
138    /// Glob (`*`) on the opened mailbox: a path or an `imap:` spec.
139    pub folder: String,
140    /// One enter-command line, e.g. `set index_format="%s"`.
141    pub command: String,
142}
143
144/// One `[[message_hooks]]` or `[[reply_hooks]]` entry: a message
145/// pattern and the enter-command line it runs.
146#[derive(Debug, Clone, Default, Deserialize)]
147#[serde(default)]
148pub struct MessageHook {
149    pub pattern: String,
150    pub command: String,
151}
152
153/// One `[[fcc_hooks]]` entry: the mailbox a matching outgoing
154/// message's copy goes to (a local maildir path).
155#[derive(Debug, Clone, Default, Deserialize)]
156#[serde(default)]
157pub struct FccHook {
158    /// Message pattern matched against the draft being sent.
159    pub pattern: String,
160    pub mailbox: String,
161}
162
163/// One `[[crypt_hooks]]` entry: encrypt to `key` for any recipient
164/// address matching `address` (a case-insensitive regex).
165#[derive(Debug, Clone, Default, Deserialize)]
166#[serde(default)]
167pub struct CryptHook {
168    pub address: String,
169    pub key: String,
170}
171
172#[derive(Debug, Clone, Default, Deserialize)]
173#[serde(default)]
174pub struct Identity {
175    pub name: Option<String>,
176    pub email: Option<String>,
177    /// mutt's reverse_name: a reply's From becomes whichever of your
178    /// addresses the original was sent to.
179    pub reverse_name: bool,
180    /// mutt's $reverse_realname: the display name comes over with the
181    /// address reverse_name found. True unless set otherwise, as in
182    /// mutt; false keeps the configured name and takes the address
183    /// alone.
184    pub reverse_realname: Option<bool>,
185}
186
187/// One `[[identities]]` entry. With both globs set, both must match;
188/// with neither, it always applies. Unset name/email keep the value
189/// from the layer below.
190#[derive(Debug, Clone, Default, Deserialize)]
191#[serde(default)]
192pub struct IdentityRule {
193    /// Glob (`*`) on the open mailbox: a path or an `imap:` spec.
194    pub folder: Option<String>,
195    /// Glob (`*`) on any recipient address of the draft.
196    pub recipient: Option<String>,
197    pub name: Option<String>,
198    pub email: Option<String>,
199}
200
201#[derive(Debug, Clone, Default, Deserialize)]
202#[serde(default)]
203pub struct Mail {
204    /// mutt's $folder: where mailboxes live, so `=x` and `+x` name a
205    /// mailbox under it, at a prompt or in a macro. An IMAP account
206    /// spec works too ("imap:work"), making `=Archive` mean
207    /// imap:work/Archive.
208    pub folder: Option<String>,
209    pub mailboxes: Vec<String>,
210    pub sent: Option<String>,
211    pub postponed: Option<String>,
212    pub sendmail: Option<String>,
213    pub editor: Option<String>,
214    /// mutt's $ispell: the spell checker the compose menu's `i` runs
215    /// over the draft, as `ispell -x FILE`. "ispell" when unset.
216    pub ispell: Option<String>,
217    pub poll_seconds: Option<u64>,
218    /// Shell command the printed message is piped to (default lpr).
219    pub print: Option<String>,
220    /// mutt's $pipe_decode: pipe the decoded message (brief headers,
221    /// decoded body) rather than the raw one. Off by default.
222    pub pipe_decode: Option<bool>,
223    /// mutt's $print_decode: print the decoded message. On by
224    /// default, as in mutt.
225    pub print_decode: Option<bool>,
226    /// mutt's $pipe_split / $print_split: run the command once per
227    /// tagged message instead of once over them all. Off by default.
228    pub pipe_split: Option<bool>,
229    pub print_split: Option<bool>,
230    /// mutt's $pipe_sep: what separates concatenated messages in one
231    /// pipe run. Newline by default.
232    pub pipe_sep: Option<String>,
233    /// Default target offered by `s` (save message to a mailbox).
234    pub save: Option<String>,
235    /// "inline" (quoted text, the default) or "attach" (the original
236    /// goes along as a message/rfc822 part, mutt's mime_forward).
237    pub forward: Option<String>,
238    /// mutt's query_command: external address lookup for Tab
239    /// completion at the To prompt (`%s` = the word, or appended),
240    /// e.g. "khard email --parsable %s".
241    pub query_command: Option<String>,
242    /// mutt's $trash: purged messages move here (a maildir path, or
243    /// `imap:account/folder` of the open account) instead of being
244    /// erased; purging inside the trash itself deletes for real.
245    pub trash: Option<String>,
246    /// mutt's edit_headers (default false, like mutt): true puts the
247    /// draft's header block (From/To/Cc/Subject, Attach: lines) into
248    /// the editor buffer. Off, the prompts set To/Subject and
249    /// attachments go through the compose menu's a.
250    pub edit_headers: Option<bool>,
251    /// notmuch(1) search (`X`): false disables the key; unset/true
252    /// leaves it on (notmuch itself must be installed; keep the
253    /// database fresh with `notmuch new` in a hook or cron).
254    pub notmuch: Option<bool>,
255    /// mutt's $fast_reply: replies skip the To and Subject prompts,
256    /// forwards skip Subject (the ask-yes questions still run).
257    pub fast_reply: bool,
258    /// mutt's $quit: "yes" (the default) leaves at once, "no"
259    /// refuses, "ask-yes" and "ask-no" ask first.
260    pub quit: Option<String>,
261    /// mutt's $postpone: leaving a draft. "ask-yes" (the default) and
262    /// "ask-no" ask whether to postpone (else discard); "yes"
263    /// postpones without asking, "no" discards without asking.
264    pub postpone: Option<String>,
265    /// mutt's $recall: composing when postponed drafts exist. "no"
266    /// never offers to recall (always a new message); "yes" recalls
267    /// the newest without asking; "ask-yes" / "ask-no" (the default
268    /// is to ask) offer the new/recall choice.
269    pub recall: Option<String>,
270    /// mutt's $confirmappend: ask before adding messages to a mailbox
271    /// that already exists. Off by default, where mutt asks: rmut has
272    /// never asked, and a save is one keystroke either way.
273    pub confirmappend: bool,
274    /// mutt's $save_name: the default save target is the sender's
275    /// local part under $folder, when such a mailbox exists.
276    pub save_name: bool,
277    /// mutt's $force_name: the same, whether or not it exists.
278    pub force_name: bool,
279    /// mutt's $mark_old: unread mail left behind in the mailbox ages
280    /// to old (O in the index, out of the new count) when you leave.
281    /// True unless set otherwise, as in mutt.
282    pub mark_old: Option<bool>,
283    /// mutt's $delete_untag: marking a tagged message for deletion
284    /// (d, or a save) takes its tag off. True unless set otherwise,
285    /// as in mutt.
286    pub delete_untag: Option<bool>,
287    /// mutt's $flag_safe: a flagged message cannot be marked for
288    /// deletion, by any of the ways of doing so. Off by default.
289    pub flag_safe: bool,
290    /// mutt's $maildir_trash: a purge gives deleted messages the
291    /// maildir T flag instead of unlinking them; they stay in the
292    /// index marked D. Maildir only. Off by default.
293    pub maildir_trash: bool,
294    /// mutt's $mail_check_recent: "new mail in X" only when X has
295    /// grown since the last look. False announces any mailbox holding
296    /// new mail, once, until it empties. True unless set otherwise.
297    pub mail_check_recent: Option<bool>,
298    /// mutt's $sort_alias: the order address completion offers alias
299    /// expansions in: "address" (by the expansion, the default here),
300    /// "alias" (by nick). "unsorted" reads as "alias": the alias file
301    /// is a map. A "reverse-" prefix flips it.
302    pub sort_alias: Option<String>,
303    /// mutt's $shell: what a bare `!` (an empty shell command) runs
304    /// interactively. $SHELL, then sh, when unset.
305    pub shell: Option<String>,
306    /// mutt's $tmpdir: where temporary files go (drafts on their way
307    /// to the editor, parts on their way to a viewer). $TMPDIR, then
308    /// /tmp, when unset.
309    pub tmpdir: Option<String>,
310    /// mutt's $check_new: look for mail delivered to the open maildir
311    /// while it is open. False stops the rescan (IMAP is unaffected,
312    /// as in mutt). True unless set otherwise.
313    pub check_new: Option<bool>,
314    /// mutt's $print: what `p` does. "ask-no" (the default) asks with
315    /// Enter declining, "ask-yes" asks with Enter printing, "yes"
316    /// prints without asking and "no" refuses to print at all.
317    pub print_confirm: Option<String>,
318    /// mutt's $alias_file: where aliases are read from and where
319    /// create-alias appends. $RMUT_ALIASES, then
320    /// ~/.config/rmut/aliases, when unset.
321    pub alias_file: Option<String>,
322    /// mutt's $attribution: the line a quoted reply opens with, over
323    /// the message being replied to (%a address, %n name, %f the From
324    /// header, %s subject, %i message-id, %d date, %{...} strftime).
325    pub attribution: Option<String>,
326    /// mutt's $indent_string: what each quoted line is prefixed with,
327    /// `"> "` by default.
328    pub indent_string: Option<String>,
329    /// mutt's $forward_format: the subject a forward carries, the
330    /// same format string over the message being forwarded.
331    pub forward_format: Option<String>,
332    /// mutt's $wrap_search: `n` wraps around the ends of the index.
333    /// True by default, as in mutt; false stops at the last / first
334    /// match instead.
335    pub wrap_search: Option<bool>,
336    /// mutt's $simple_search: the template a bare-word search expands
337    /// to, `%s` the word. Default `~f %s | ~s %s` (from or subject),
338    /// which is what a bare word already did; set it to add `~b %s`
339    /// for the body, say. Only a single word with no `~` expands.
340    pub simple_search: Option<String>,
341    /// mutt's $reply_regexp: what a reply's subject may already start
342    /// with ("Re:" with an optional [n], by default). Replying takes
343    /// it off and puts "Re: " on, so prefixes never pile up; a
344    /// locale's own prefixes go in as `^(re|aw|sv):[ \t]*`.
345    /// Case-insensitive unless the regex has an uppercase letter, as
346    /// mutt compiles it.
347    pub reply_regexp: Option<String>,
348    /// mutt's $include: quote the original in a reply? "ask-yes" (the
349    /// default) and "ask-no" ask, "yes" and "no" decide it.
350    pub include: Option<String>,
351    /// mutt's $forward_quote: the forwarded text inside the
352    /// "----- Forwarded message" markers is quoted with
353    /// $indent_string, the way a reply is.
354    pub forward_quote: bool,
355    /// mutt's $signature: a file whose contents end every new draft,
356    /// or, when the name ends in `|`, a command whose output does.
357    /// `~` is expanded. Unset (the default) appends nothing.
358    pub signature: Option<String>,
359    /// mutt's $sig_dashes: the signature is introduced by a line
360    /// holding "-- ". True unless set otherwise, as in mutt.
361    pub sig_dashes: Option<bool>,
362    /// mutt's $sig_on_top: the signature goes above the quoted
363    /// original rather than below it. Off by default, as in mutt.
364    pub sig_on_top: Option<bool>,
365    /// mutt's $hostname: the host in a generated Message-ID. The
366    /// system hostname when unset.
367    pub hostname: Option<String>,
368    /// mutt's $user_agent: add a `User-Agent: rmut/VERSION` header to
369    /// outgoing mail. Off by default, as neomutt has it.
370    pub user_agent: Option<bool>,
371    /// mutt's $abort_nosubject: a draft with an empty subject.
372    /// "ask-yes" (the default) asks with Enter aborting, "ask-no"
373    /// asks with Enter sending it on, "yes" aborts without asking,
374    /// "no" never asks.
375    pub abort_nosubject: Option<String>,
376    /// mutt's $abort_unmodified: the first editor pass came back with
377    /// the body untouched, so the draft is dropped. True unless set
378    /// otherwise, as in mutt; only the first edit is checked.
379    pub abort_unmodified: Option<bool>,
380    /// mutt's $askcc / $askbcc: ask for those recipients when a draft
381    /// is started, prefilled with what a group reply worked out.
382    pub ask_cc: bool,
383    pub ask_bcc: bool,
384    /// mutt's $autoedit (needs edit_headers): skip every initial
385    /// prompt and question, straight into the editor; the compose
386    /// menu follows as usual.
387    pub autoedit: bool,
388    /// mutt's $copy: false skips the sent copy (Fcc) entirely; an
389    /// Fcc set in the compose menu still wins.
390    pub copy: Option<bool>,
391    /// mutt's `lists`: address patterns naming mailing lists you know
392    /// of. They drive `~l`, the `L` list-reply target, and the
393    /// Mail-Followup-To rmut sets on mail to a list.
394    pub lists: Vec<String>,
395    /// mutt's `subscribe`: lists you are on. Subscribed lists count as
396    /// known lists too, and a reply to one leaves your own address out
397    /// of Mail-Followup-To, so the list copy is the only one you get.
398    pub subscribed: Vec<String>,
399    /// mutt's `alternates`: regexes matching your other addresses
400    /// (aliases, an old domain, a role address). They join the
401    /// identity addresses everywhere rmut asks "is this me?": `~p`
402    /// and `~P`, the `+`/`T`/`C`/`F` index marks, reverse_name, the
403    /// group-reply dedup, and Mail-Followup-To.
404    pub alternates: Vec<String>,
405    /// mutt's `my_hdr`: header lines added to every draft, e.g.
406    /// "Organization: Acme" or "Bcc: me@example.com". One naming a
407    /// header rmut already wrote replaces it (so `From:` and
408    /// `Reply-To:` win); To/Cc/Bcc gain the address instead.
409    pub my_hdr: Vec<String>,
410    /// mutt's $metoo: keep your own address among a group reply's
411    /// recipients instead of dropping it.
412    pub metoo: bool,
413    /// mutt's $text_flowed: outgoing text/plain is declared
414    /// `format=flowed` and space-stuffed (RFC 3676), so a reader can
415    /// rewrap it. The paragraphs themselves come from your editor,
416    /// which has to leave a trailing space on a line that continues.
417    pub text_flowed: bool,
418    /// Shell command run when new mail arrives (neomutt's
419    /// new_mail_command): `%f` = the mailbox, `%n` = how many, e.g.
420    /// "notify-send 'rmut: %n new in %f'". Fire-and-forget.
421    pub new_mail_command: Option<String>,
422    /// mutt's $delete (a quadoption): what `$` and quitting do with
423    /// messages marked for deletion. "ask" (the default) asks, with
424    /// Enter taking the yes; "yes" purges them without asking; "no"
425    /// never purges, so the marks stay for a later change of mind.
426    pub delete: Option<String>,
427    /// neomutt's $abort_noattach: what to do when the body mentions
428    /// an attachment and none is attached. "no" (the default) never
429    /// checks, "ask" asks before sending, "yes" refuses the send.
430    /// neomutt's ask-yes / ask-no both import as "ask".
431    pub abort_noattach: Option<String>,
432    /// neomutt's $abort_noattach_regex: what counts as mentioning one.
433    /// Case-insensitive; the default is
434    /// `\b(attach|attached|attaching|attachment|attachments)\b`.
435    pub attach_keyword: Option<String>,
436    /// Seconds a sent message waits before it actually goes out, so
437    /// `z` can take it back (rmut's own; mutt sends at once). 0 is
438    /// off. A held message is sent when the timer runs out or when
439    /// rmut exits; batch sends (-s and friends) never hold.
440    pub undo_send: u64,
441    /// mutt's $use_envelope_from: tell sendmail the envelope sender
442    /// (`-f`), which is `envelope_from_address` when set and the
443    /// message's From otherwise. Over SMTP the envelope sender is
444    /// always given; this only decides whether it is the From.
445    pub use_envelope_from: bool,
446    /// mutt's $envelope_from_address: the envelope sender (bounces
447    /// go there) when `use_envelope_from` is on.
448    pub envelope_from_address: Option<String>,
449    /// mutt's $dsn_notify: when delivery status notifications come
450    /// back, e.g. "failure,delay" (or "never"). Passed to sendmail as
451    /// `-N`, and to an SMTP server that offers DSN as NOTIFY=.
452    pub dsn_notify: Option<String>,
453    /// mutt's $dsn_return: how much of the message a notification
454    /// carries back, "hdrs" or "full". sendmail's `-R`, SMTP's RET=.
455    pub dsn_return: Option<String>,
456    /// mutt's $reply_self: a reply to a message I sent goes to me.
457    /// Off (mutt's default), it goes to that message's recipients.
458    pub reply_self: bool,
459    /// mutt's $fcc_attach (a quadoption, "yes" by default): whether
460    /// the sent copy keeps the attachments. "no" keeps the text
461    /// alone; "ask-yes" / "ask-no" ask at send time.
462    pub fcc_attach: Option<String>,
463    /// mutt's $fcc_clear: the sent copy of a signed or encrypted
464    /// message is kept in the clear.
465    pub fcc_clear: bool,
466    /// mutt's $forward_edit (a quadoption, "yes" by default): whether
467    /// a forward opens the editor before the compose menu.
468    pub forward_edit: Option<String>,
469    /// mutt's $mime_forward_rest (on by default): forwarding a part
470    /// that does not read as text from the attachment menu attaches
471    /// it; off, such a part is not forwarded.
472    pub mime_forward_rest: Option<bool>,
473}
474
475impl Mail {
476    /// The envelope a submission carries: the sender sendmail is told
477    /// about, and the DSN requests.
478    pub fn envelope(&self, from: &str) -> crate::smtp::Envelope {
479        let sender = self.use_envelope_from.then(|| {
480            self.envelope_from_address
481                .clone()
482                .filter(|a| !a.trim().is_empty())
483                .map(|a| crate::compose::bare_address(&a).unwrap_or(a))
484                .unwrap_or_else(|| from.to_string())
485        });
486        crate::smtp::Envelope {
487            sender,
488            notify: self.dsn_notify.clone().filter(|v| !v.trim().is_empty()),
489            ret: self.dsn_return.clone().filter(|v| !v.trim().is_empty()),
490        }
491    }
492}
493
494#[derive(Debug, Clone, Default, Deserialize)]
495#[serde(default)]
496pub struct Index {
497    pub format: Option<String>,
498    /// Initial sort: date/from/subject/size/threads, "reverse-" prefix
499    /// allowed (the `o` menu can still change it at runtime).
500    pub sort: Option<String>,
501    /// "last-date-sent" orders threads by their newest message instead
502    /// of the default oldest-first.
503    pub sort_aux: Option<String>,
504    /// chrono strftime string for the index date column (mutt's
505    /// date_format), e.g. "%d.%m.%Y"; default "%b %e", like mutt's
506    /// index date.
507    pub date_format: Option<String>,
508    /// mutt's $collapse_unread (default true, as in mutt): a thread
509    /// holding unread mail folds like any other. False leaves those
510    /// threads open when everything else folds.
511    pub collapse_unread: Option<bool>,
512    /// mutt's $uncollapse_jump: unfolding a thread puts the cursor on
513    /// its first unread message.
514    pub uncollapse_jump: bool,
515    /// mutt's $hide_thread_subject: a thread reply whose subject
516    /// matches its parent's shows a blank subject (just the tree
517    /// arrow). Off by default here, where mutt has it on, so rmut's
518    /// look is unchanged unless asked.
519    pub hide_thread_subject: Option<bool>,
520    /// mutt's $uncollapse_new: a collapsed thread that receives a new
521    /// message unfolds. True unless set otherwise, as in mutt.
522    pub uncollapse_new: Option<bool>,
523    /// mutt's $strict_threads: thread by In-Reply-To and References
524    /// only. False (the default, as in mutt) also groups a root whose
525    /// subject repeats one already in the mailbox, which is what
526    /// threads mail that arrives without those headers at all.
527    pub strict_threads: Option<bool>,
528    /// mutt's $sort_re: the subject grouping only takes a root whose
529    /// subject carries the $reply_regexp prefix. True by default, as
530    /// in mutt; false groups any equal subject, unrelated "hi" mail
531    /// included.
532    pub sort_re: Option<bool>,
533}
534
535#[derive(Debug, Clone, Default, Deserialize)]
536#[serde(default)]
537pub struct Pager {
538    /// Lines of the message index kept visible above the pager.
539    pub index_lines: u16,
540    /// Lines of overlap when paging (mutt's pager_context).
541    pub context: usize,
542    /// mutt's $search_context: lines of context kept above a pager
543    /// search hit scrolled toward the top. Default 0.
544    pub search_context: usize,
545    /// text/html with no auto_view filter renders through the
546    /// built-in html-to-text (not mutt's; links keep their targets,
547    /// blockquotes become `> `). `"raw"` restores mutt's literal
548    /// source view.
549    pub html: Option<String>,
550    /// mutt's $quote_regexp: classifies quoted body lines (depth =
551    /// quote characters in the match). Default `^([ \t]*[|>:}#])+`.
552    pub quote_regexp: Option<String>,
553    /// mutt's ignore list: header-name prefixes hidden from the brief
554    /// view (`*` = all). Unset keeps the classic view (everything
555    /// hidden except Date/From/To/Cc/Subject).
556    pub ignore: Option<Vec<String>>,
557    /// mutt's unignore list: prefixes shown even when ignored.
558    pub unignore: Option<Vec<String>>,
559    /// mutt's hdr_order: name prefixes sorting the brief view;
560    /// unlisted headers follow in message order.
561    pub hdr_order: Option<Vec<String>>,
562    /// mutt's $pager_format for the pager's bottom line; the default
563    /// reproduces the classic "---Message n/m: subject -- NN%".
564    pub format: Option<String>,
565    /// mutt's $wrap: wrap body text at N columns (negative = a right
566    /// margin of |N|); unset wraps at the window width.
567    pub wrap: Option<i64>,
568    /// mutt's $tilde: pad the rows below end-of-message with ~.
569    pub tilde: bool,
570    /// mutt's $pager_stop: paging past the end of a message stays
571    /// put instead of opening the next one.
572    pub pager_stop: bool,
573    /// mutt's $markers (default true, as in mutt): the `+` at the
574    /// start of a wrapped continuation line.
575    pub markers: Option<bool>,
576    /// mutt's $smart_wrap (default true, as in mutt): wrapped lines
577    /// break at a word boundary rather than at the column.
578    pub smart_wrap: Option<bool>,
579    /// mutt's $reflow_text (default true): a `format=flowed` part is
580    /// put back into paragraphs and wrapped at the display width
581    /// instead of keeping the sender's line breaks.
582    pub reflow_text: Option<bool>,
583    /// mutt's alternative_order: MIME types, most wanted first, that
584    /// decide which part of a multipart/alternative shows. `text/*`
585    /// wildcards allowed; consulted before the auto_view filters and
586    /// the built-in text ranking.
587    pub alternative_order: Vec<String>,
588}
589
590/// How long to wait on the network before saying so. A mail client
591/// that blocks has nothing to draw and no keys to read, so these are
592/// short by default: an unreachable server should cost seconds, not
593/// the OS default of about two minutes.
594#[derive(Debug, Clone, Deserialize)]
595#[serde(default)]
596pub struct Net {
597    /// Seconds to wait for a connection (mutt's $connect_timeout).
598    /// 0 waits as long as the OS does.
599    pub connect_timeout: u64,
600    /// Seconds to wait for data on a live connection. Never off:
601    /// IMAP IDLE uses it as its heartbeat, and anything under five
602    /// seconds is treated as five.
603    pub timeout: u64,
604    /// mutt's $ssl_usesystemcerts: trust the OS certificate store on
605    /// top of the built-in Mozilla roots. On by default, as in mutt.
606    pub system_cas: bool,
607    /// mutt's $certificate_file: a PEM file of extra roots to trust
608    /// (a private CA, a self-signed server's own cert). Added to the
609    /// Mozilla roots, never replacing them.
610    pub certificate_file: Option<String>,
611}
612
613impl Default for Net {
614    fn default() -> Self {
615        Net {
616            connect_timeout: 10,
617            timeout: 30,
618            system_cas: true,
619            certificate_file: None,
620        }
621    }
622}
623
624#[derive(Debug, Clone, Deserialize)]
625#[serde(default)]
626pub struct Ui {
627    pub theme: Option<String>,
628    /// mutt's status_format for the bottom line (see
629    /// format::DEFAULT_STATUS_FORMAT for the specifiers).
630    pub status_format: Option<String>,
631    /// Ring the terminal bell on error statuses (mutt's $beep).
632    pub beep: bool,
633    /// mutt's $beep_new: ring it when mail arrives, too. Off by
634    /// default, as in mutt.
635    pub beep_new: bool,
636    /// mutt's $wait_key: a shell escape ends with "Press Enter to
637    /// continue", so whatever it printed can be read before the
638    /// index paints over it. True unless set otherwise, as in mutt.
639    pub wait_key: Option<bool>,
640    /// mutt's $ts_enabled: set the terminal title (and icon) while
641    /// running. Off by default, as in mutt.
642    pub set_title: Option<bool>,
643    /// mutt's $ts_status_format: the title's format, the same
644    /// specifiers as status_format. Defaults to "rmut: %f".
645    pub title_format: Option<String>,
646    /// mutt's $history_file: where prompt history persists across
647    /// sessions. Unset means in-memory only, as rmut was before.
648    pub history_file: Option<String>,
649    /// mutt's $status_on_top: the status bar (and message line) sit at
650    /// the top, under the help bar, rather than the bottom. Off by
651    /// default, as in mutt.
652    pub status_on_top: Option<bool>,
653    /// mutt's $arrow_cursor: mark the selected row with an arrow
654    /// instead of reverse video. Off by default, as in mutt.
655    pub arrow_cursor: Option<bool>,
656    /// mutt's $menu_scroll: the index scrolls a line at a time when
657    /// the cursor leaves the screen; false shows the next page
658    /// instead. On by default here (rmut always scrolled), where mutt
659    /// pages.
660    pub menu_scroll: Option<bool>,
661    /// mutt's $menu_context: lines kept in view beyond the cursor
662    /// when the index scrolls or pages. 0 by default.
663    pub menu_context: usize,
664    /// mutt's $menu_move_off: the last message may scroll up past
665    /// the bottom of the screen; false keeps the index bottom-stuck
666    /// once it fills the screen. True unless set otherwise.
667    pub menu_move_off: Option<bool>,
668    /// mutt's $help: the key-help bar on the top line. True unless
669    /// set otherwise.
670    pub help: Option<bool>,
671    /// mutt's $sort_browser: the folder browser's order: "alpha" (the
672    /// default), "count" / "unread" (by new-mail count), "date" (by
673    /// the maildir's change time), "unsorted" (as configured, then as
674    /// found). A "reverse-" prefix flips it. "size" reads as alpha.
675    pub sort_browser: Option<String>,
676    /// mutt's $error_history: how many past errors error-history
677    /// shows. 0 disables it. 30 by default, as in mutt.
678    pub error_history: usize,
679    /// mutt's $status_chars: the characters `%r` shows for the
680    /// mailbox state: [0] unchanged, [1] changed (needs sync), [2]
681    /// read-only. Unset keeps rmut's own (nothing / `*` / `%`).
682    pub status_chars: Option<String>,
683    /// mutt's $save_history: entries kept per history bucket in the
684    /// file. Defaults to 100 (rmut's in-memory cap).
685    pub save_history: Option<usize>,
686    /// The terminal pager's URLs as OSC 8 hyperlinks, which a terminal
687    /// that knows them opens on a click (rmut's own; on by default).
688    /// false for a terminal that shows the sequence instead.
689    pub hyperlinks: Option<bool>,
690    /// What opens a URL from the URL list, the URL as its argument:
691    /// "xdg-open" by default ("open" on macOS).
692    pub url_command: Option<String>,
693}
694
695impl Default for Ui {
696    fn default() -> Self {
697        Ui {
698            theme: None,
699            status_format: None,
700            beep: true,
701            beep_new: false,
702            wait_key: None,
703            set_title: None,
704            title_format: None,
705            history_file: None,
706            save_history: None,
707            status_on_top: None,
708            arrow_cursor: None,
709            menu_scroll: None,
710            menu_context: 0,
711            menu_move_off: None,
712            help: None,
713            sort_browser: None,
714            error_history: 30,
715            status_chars: None,
716            hyperlinks: None,
717            url_command: None,
718        }
719    }
720}
721
722/// One `[[color_index]]` rule (mutt's `color index FG BG PATTERN`):
723/// index lines whose message matches `pattern` take these colors.
724/// First matching rule wins; rules are checked in config order.
725#[derive(Debug, Clone, Default, Deserialize)]
726#[serde(default)]
727pub struct ColorRule {
728    pub pattern: String,
729    pub fg: Option<String>,
730    pub bg: Option<String>,
731}
732
733/// The window front end (rmut-egui). The terminal front end never
734/// reads these.
735#[derive(Debug, Clone, Default, Deserialize)]
736#[serde(default)]
737pub struct Gui {
738    /// Text size in points (14 when unset). Ctrl+= / Ctrl+- / Ctrl+0
739    /// zoom the whole window at runtime on top of this.
740    pub size: Option<f32>,
741    /// Path to a .ttf/.otf file used as the window's monospace face
742    /// (egui's built-in face when unset).
743    pub font: Option<String>,
744    /// The terminal emulator that hosts $EDITOR and `!` commands
745    /// ($TERMINAL, then foot/alacritty/kitty/xterm, when unset).
746    pub terminal: Option<String>,
747    /// The window canvas: what the text sits on and its default ink
748    /// (named colors or `#rrggbb`; a dark gray on off-white unset).
749    pub background: Option<String>,
750    pub foreground: Option<String>,
751    /// "builtin" opens drafts in the window's own text editor;
752    /// anything else (the default) hosts $EDITOR in the terminal.
753    pub editor: Option<String>,
754    /// The message body in a proportional face; the index, headers
755    /// and indented (preformatted) lines stay monospace.
756    pub proportional: Option<bool>,
757    /// image/* parts drawn in the message body under their
758    /// `[-- Type: image/... --]` markers (on unless turned off).
759    pub inline_images: Option<bool>,
760    /// The window's own say over `[pager] html` (the Preferences
761    /// checkbox writes it here), so the terminal can keep raw while
762    /// the window renders, or the other way around.
763    pub html: Option<String>,
764    /// Window-only overrides of `[colors]`, same keys and values
765    /// (plus `#rrggbb`): the window can wear its own palette while
766    /// the terminal keeps the shared one.
767    pub colors: HashMap<String, String>,
768}
769
770/// The optional left pane listing `mail.mailboxes` with new-mail
771/// counts (toggle with B at runtime).
772#[derive(Debug, Clone, Deserialize)]
773#[serde(default)]
774pub struct Sidebar {
775    pub visible: bool,
776    pub width: u16,
777}
778
779impl Default for Sidebar {
780    fn default() -> Self {
781        Sidebar {
782            visible: false,
783            width: 24,
784        }
785    }
786}
787
788#[derive(Debug, Clone, Default, Deserialize)]
789#[serde(default)]
790pub struct Keys {
791    pub index: HashMap<String, String>,
792    pub pager: HashMap<String, String>,
793}
794
795/// One remote account: IMAP for reading, SMTP for sending. The
796/// password comes from `password_command` (preferred) or, when you
797/// accept a secret sitting in the config file, a literal `password`.
798#[derive(Debug, Clone, Deserialize)]
799pub struct Account {
800    pub name: String,
801    pub user: String,
802    /// Shell command whose first stdout line is the password
803    /// (pass(1)-style). Wins over `password` when both are set.
804    pub password_command: Option<String>,
805    /// Plaintext password. Convenient, but anyone who can read the
806    /// config can read your mail, so keep it at mode 600.
807    pub password: Option<String>,
808    pub imap_host: Option<String>,
809    #[serde(default = "default_imap_port")]
810    pub imap_port: u16,
811    /// Encrypt IMAP (default): TLS from the first byte on port 993,
812    /// STARTTLS on any other port. Disabling is for tests only.
813    #[serde(default = "default_true")]
814    pub imap_tls: bool,
815    pub smtp_host: Option<String>,
816    #[serde(default = "default_smtp_port")]
817    pub smtp_port: u16,
818    /// Encrypt SMTP (default): implicit TLS on port 465, STARTTLS
819    /// otherwise. Disabling is for tests only.
820    #[serde(default = "default_true")]
821    pub smtp_tls: bool,
822    /// "password" (default), "xoauth2", or "oauthbearer". The OAuth
823    /// mechanisms authenticate with an access token from
824    /// `token_command` instead of a password.
825    pub auth: Option<String>,
826    /// Shell command whose first stdout line is a *fresh* OAuth access
827    /// token (refresh is its business: oauth2ms, mutt_oauth2.py, ...).
828    /// Run for every connection; tokens expire, so it is never cached.
829    pub token_command: Option<String>,
830    /// IMAP folder that receives the Fcc copy of sent mail.
831    #[serde(default = "default_sent_folder")]
832    pub sent_folder: String,
833    /// From identity when composing from this account's mailboxes,
834    /// e.g. identity = { name = "Jane Work", email = "jane@work.example.com" }.
835    pub identity: Option<Identity>,
836}
837
838/// PGP via gpg(1). Decrypt/verify happens automatically when a viewed
839/// message is PGP; signing and encrypting are chosen at the send
840/// prompt. Passphrases are gpg-agent's business; rmut never sees them.
841#[derive(Debug, Clone, Deserialize)]
842#[serde(default)]
843pub struct Pgp {
844    /// The gpg executable (a name looked up in $PATH or a full path).
845    pub command: String,
846    /// Signing key for --local-user; gpg's default key when unset.
847    pub sign_key: Option<String>,
848    /// Preselect signing / encrypting for new drafts (the compose menu's
849    /// security menu can still change it per message).
850    pub sign_by_default: bool,
851    pub encrypt_by_default: bool,
852    /// mutt's $crypt_replysign: a reply to a signed message defaults
853    /// to signed. $crypt_replyencrypt: a reply to an encrypted one
854    /// defaults to encrypted (on in mutt, off here until asked).
855    /// $crypt_replysignencrypted: a reply to signed-and-encrypted
856    /// mail defaults to signed too. All off by default.
857    pub reply_sign: bool,
858    pub reply_encrypt: bool,
859    pub reply_sign_encrypted: bool,
860}
861
862impl Default for Pgp {
863    fn default() -> Self {
864        Pgp {
865            command: "gpg".into(),
866            sign_key: None,
867            sign_by_default: false,
868            encrypt_by_default: false,
869            reply_sign: false,
870            reply_encrypt: false,
871            reply_sign_encrypted: false,
872        }
873    }
874}
875
876fn default_imap_port() -> u16 {
877    993
878}
879
880fn default_smtp_port() -> u16 {
881    587
882}
883
884fn default_true() -> bool {
885    true
886}
887
888fn default_sent_folder() -> String {
889    "Sent".into()
890}
891
892/// How an account authenticates, from its `auth` key.
893#[derive(Clone, Copy, PartialEq, Eq, Debug)]
894pub enum AuthKind {
895    Password,
896    XOAuth2,
897    OAuthBearer,
898}
899
900impl AuthKind {
901    pub fn sasl_name(self) -> &'static str {
902        match self {
903            AuthKind::Password => "PLAIN",
904            AuthKind::XOAuth2 => "XOAUTH2",
905            AuthKind::OAuthBearer => "OAUTHBEARER",
906        }
907    }
908
909    /// The SASL initial response (before base64): RFC 7628 for
910    /// OAUTHBEARER, the Google shape for XOAUTH2.
911    pub fn initial_response(self, user: &str, token: &str, host: &str, port: u16) -> String {
912        match self {
913            AuthKind::XOAuth2 => format!("user={user}\x01auth=Bearer {token}\x01\x01"),
914            AuthKind::OAuthBearer => {
915                format!("n,a={user},\x01host={host}\x01port={port}\x01auth=Bearer {token}\x01\x01")
916            }
917            AuthKind::Password => String::new(),
918        }
919    }
920}
921
922/// First stdout line of a credential command.
923fn first_line_of(command: &str, what: &str, name: &str) -> Result<String> {
924    let out = std::process::Command::new("sh")
925        .arg("-c")
926        .arg(command)
927        .output()
928        .with_context(|| format!("running {what} for account {name}"))?;
929    ensure!(
930        out.status.success(),
931        "{what} for account {name} exited with {}",
932        out.status
933    );
934    let secret = String::from_utf8_lossy(&out.stdout)
935        .lines()
936        .next()
937        .unwrap_or("")
938        .to_string();
939    ensure!(
940        !secret.is_empty(),
941        "{what} for account {name} printed nothing"
942    );
943    Ok(secret)
944}
945
946impl Account {
947    /// First stdout line of `password_command`, or the stored
948    /// `password` when no command is configured.
949    pub fn password(&self) -> Result<String> {
950        let Some(command) = &self.password_command else {
951            return self
952                .password
953                .clone()
954                .filter(|p| !p.is_empty())
955                .with_context(|| {
956                    format!(
957                        "account {} has neither password_command nor password",
958                        self.name
959                    )
960                });
961        };
962        first_line_of(command, "password command", &self.name)
963    }
964
965    pub fn auth_kind(&self) -> Result<AuthKind> {
966        match self.auth.as_deref() {
967            None | Some("password") => Ok(AuthKind::Password),
968            Some("xoauth2") => Ok(AuthKind::XOAuth2),
969            Some("oauthbearer") => Ok(AuthKind::OAuthBearer),
970            Some(other) => anyhow::bail!("unknown auth {other:?} for account {}", self.name),
971        }
972    }
973
974    /// The credential matching `auth_kind`: the password, or a fresh
975    /// access token from `token_command`.
976    pub fn secret(&self) -> Result<String> {
977        match self.auth_kind()? {
978            AuthKind::Password => self.password(),
979            _ => {
980                let command = self.token_command.as_deref().with_context(|| {
981                    format!(
982                        "account {} has auth = oauth but no token_command",
983                        self.name
984                    )
985                })?;
986                first_line_of(command, "token command", &self.name)
987            }
988        }
989    }
990}
991
992impl Config {
993    pub fn account(&self, name: &str) -> Option<&Account> {
994        self.accounts.iter().find(|a| a.name == name)
995    }
996
997    /// The identity for a draft, layered like mutt hooks: `[identity]`,
998    /// then the account's, then every matching `[[identities]]` rule in
999    /// order (a later rule overrides an earlier one; unset fields keep
1000    /// the value below). `rcpts` are the draft's bare recipient
1001    /// addresses, empty when they are not known yet, which makes
1002    /// recipient rules not match.
1003    /// Every known mailing-list pattern (`lists` plus `subscribed`),
1004    /// compiled for matching against addresses.
1005    pub fn list_matchers(&self) -> Vec<crate::pattern::Matcher> {
1006        self.mail
1007            .lists
1008            .iter()
1009            .chain(&self.mail.subscribed)
1010            .map(|spec| crate::pattern::Matcher::new(spec))
1011            .collect()
1012    }
1013
1014    /// The `subscribed` half on its own, for the Mail-Followup-To rule.
1015    pub fn subscribed_matchers(&self) -> Vec<crate::pattern::Matcher> {
1016        self.mail
1017            .subscribed
1018            .iter()
1019            .map(|spec| crate::pattern::Matcher::new(spec))
1020            .collect()
1021    }
1022
1023    /// mutt's `alternates`, compiled for matching against a bare
1024    /// address.
1025    pub fn alternate_matchers(&self) -> Vec<crate::pattern::Matcher> {
1026        self.mail
1027            .alternates
1028            .iter()
1029            .map(|spec| crate::pattern::Matcher::new(spec))
1030            .collect()
1031    }
1032
1033    pub fn identity_for(
1034        &self,
1035        folder: &str,
1036        rcpts: &[String],
1037        account: Option<&Account>,
1038    ) -> Identity {
1039        let mut id = self.identity.clone();
1040        let mut overlay = |name: &Option<String>, email: &Option<String>| {
1041            if name.is_some() {
1042                id.name = name.clone();
1043            }
1044            if email.is_some() {
1045                id.email = email.clone();
1046            }
1047        };
1048        if let Some(acct) = account.and_then(|a| a.identity.as_ref()) {
1049            overlay(&acct.name, &acct.email);
1050        }
1051        for rule in &self.identities {
1052            let folder_ok = rule.folder.as_deref().is_none_or(|g| glob_match(g, folder));
1053            let recipient_ok = rule
1054                .recipient
1055                .as_deref()
1056                .is_none_or(|g| rcpts.iter().any(|r| glob_match(g, r)));
1057            if folder_ok && recipient_ok {
1058                overlay(&rule.name, &rule.email);
1059            }
1060        }
1061        id
1062    }
1063}
1064
1065/// Glob match: `*` spans anything, everything else is literal;
1066/// case-insensitive, anchored at both ends.
1067pub fn glob_match(pattern: &str, text: &str) -> bool {
1068    let p: Vec<char> = pattern.to_lowercase().chars().collect();
1069    let t: Vec<char> = text.to_lowercase().chars().collect();
1070    let (mut pi, mut ti) = (0usize, 0usize);
1071    let mut star: Option<(usize, usize)> = None;
1072    while ti < t.len() {
1073        if pi < p.len() && p[pi] == '*' {
1074            star = Some((pi, ti));
1075            pi += 1;
1076        } else if pi < p.len() && p[pi] == t[ti] {
1077            pi += 1;
1078            ti += 1;
1079        } else if let Some((sp, st)) = star {
1080            // Backtrack: let the last * swallow one more character.
1081            pi = sp + 1;
1082            ti = st + 1;
1083            star = Some((sp, st + 1));
1084        } else {
1085            return false;
1086        }
1087    }
1088    while pi < p.len() && p[pi] == '*' {
1089        pi += 1;
1090    }
1091    pi == p.len()
1092}
1093
1094/// mutt's `+x` / `=x`: a mailbox named under $folder. `=` or `+`
1095/// alone is $folder itself; anything else, and any name at all when
1096/// no folder is configured, comes back untouched. This runs on every
1097/// mailbox rmut is handed, typed or configured, before anything
1098/// tries to read it as a path or an imap: spec.
1099pub fn expand_folder(spec: &str, folder: Option<&str>) -> String {
1100    let Some(rest) = spec.strip_prefix(['=', '+']) else {
1101        return spec.to_string();
1102    };
1103    let Some(folder) = folder
1104        .map(|f| f.trim_end_matches('/'))
1105        .filter(|f| !f.is_empty())
1106    else {
1107        return spec.to_string();
1108    };
1109    match rest.is_empty() {
1110        true => folder.to_string(),
1111        false => format!("{folder}/{rest}"),
1112    }
1113}
1114
1115impl Config {
1116    /// Expand `=x` / `+x` in every mailbox the config names, so the
1117    /// rest of the program only ever sees real paths and imap: specs.
1118    /// Idempotent: an expanded name no longer starts with = or +.
1119    pub fn expand_folders(&mut self) {
1120        let folder = self.mail.folder.clone();
1121        let folder = folder.as_deref();
1122        let one = |slot: &mut Option<String>| {
1123            if let Some(v) = slot {
1124                *v = expand_folder(v, folder);
1125            }
1126        };
1127        one(&mut self.mail.sent);
1128        one(&mut self.mail.postponed);
1129        one(&mut self.mail.trash);
1130        one(&mut self.mail.save);
1131        for m in &mut self.mail.mailboxes {
1132            *m = expand_folder(m, folder);
1133        }
1134        for hook in &mut self.fcc_hooks {
1135            hook.mailbox = expand_folder(&hook.mailbox, folder);
1136        }
1137    }
1138}
1139
1140pub fn path() -> Option<PathBuf> {
1141    if let Ok(p) = std::env::var("RMUT_CONFIG") {
1142        return Some(PathBuf::from(p));
1143    }
1144    std::env::var("HOME")
1145        .ok()
1146        .map(|h| PathBuf::from(h).join(".config/rmut/config.toml"))
1147}
1148
1149/// Load the config; a missing file is fine (defaults), a broken file
1150/// returns defaults plus a warning to show the user.
1151pub fn load_default() -> (Config, Option<String>) {
1152    let Some(p) = path() else {
1153        return (Config::default(), None);
1154    };
1155    let Ok(text) = std::fs::read_to_string(&p) else {
1156        return (Config::default(), None);
1157    };
1158    match toml::from_str::<Config>(&text) {
1159        Ok(cfg) => {
1160            let warning = secret_exposed(&cfg, &p);
1161            (cfg, warning)
1162        }
1163        Err(err) => {
1164            let first = err
1165                .to_string()
1166                .lines()
1167                .next()
1168                .unwrap_or("parse error")
1169                .to_string();
1170            (
1171                Config::default(),
1172                Some(format!("config ignored ({}): {first}", p.display())),
1173            )
1174        }
1175    }
1176}
1177
1178/// A plaintext `password` in a config anyone can read is the one
1179/// mistake worth interrupting for: the file holds the keys to the
1180/// mail. Says so once at startup, and only when the bits are
1181/// actually open, so a 600 config stays quiet.
1182fn secret_exposed(cfg: &Config, path: &std::path::Path) -> Option<String> {
1183    use std::os::unix::fs::PermissionsExt;
1184    let holds_password = cfg
1185        .accounts
1186        .iter()
1187        .any(|a| a.password.as_ref().is_some_and(|p| !p.is_empty()));
1188    if !holds_password {
1189        return None;
1190    }
1191    let mode = std::fs::metadata(path).ok()?.permissions().mode();
1192    if mode & 0o077 == 0 {
1193        return None;
1194    }
1195    // The imperative first: the message line clips at the window
1196    // edge, and the path is usually the long part.
1197    Some(format!(
1198        "chmod 600 {} (it holds a password and others can read it)",
1199        path.display()
1200    ))
1201}
1202
1203impl Identity {
1204    /// "Name <email>" / "email" for the From header, if configured.
1205    pub fn from_line(&self) -> Option<String> {
1206        match (&self.name, &self.email) {
1207            (Some(n), Some(e)) => Some(format!("{n} <{e}>")),
1208            (None, Some(e)) => Some(e.clone()),
1209            _ => None,
1210        }
1211    }
1212}
1213
1214#[cfg(test)]
1215mod tests {
1216    use super::*;
1217
1218    #[test]
1219    fn a_readable_config_holding_a_password_warns() {
1220        use std::os::unix::fs::PermissionsExt;
1221        let tmp = tempfile::tempdir().unwrap();
1222        let path = tmp.path().join("config.toml");
1223        std::fs::write(&path, "").unwrap();
1224        let with_password: Config = toml::from_str(
1225            r#"
1226            [[accounts]]
1227            name = "work"
1228            user = "jane"
1229            password = "hunter2"
1230            "#,
1231        )
1232        .unwrap();
1233        let with_command: Config = toml::from_str(
1234            r#"
1235            [[accounts]]
1236            name = "work"
1237            user = "jane"
1238            password_command = "gpg -q -d ~/.config/rmut/imap.gpg"
1239            "#,
1240        )
1241        .unwrap();
1242
1243        let mode =
1244            |m: u32| std::fs::set_permissions(&path, std::fs::Permissions::from_mode(m)).unwrap();
1245        mode(0o644);
1246        let warning = secret_exposed(&with_password, &path).expect("a warning");
1247        assert!(warning.starts_with("chmod 600 "), "{warning}");
1248        // Shut when the bits are shut, and when there is no secret to
1249        // expose in the first place.
1250        mode(0o600);
1251        assert!(secret_exposed(&with_password, &path).is_none());
1252        mode(0o644);
1253        assert!(secret_exposed(&with_command, &path).is_none());
1254        assert!(secret_exposed(&Config::default(), &path).is_none());
1255    }
1256
1257    #[test]
1258    fn folder_shorthand_expands_everywhere_a_mailbox_is_named() {
1259        assert_eq!(expand_folder("=archive", Some("~/Mail")), "~/Mail/archive");
1260        assert_eq!(expand_folder("+archive", Some("~/Mail/")), "~/Mail/archive");
1261        // = or + alone is $folder itself.
1262        assert_eq!(expand_folder("=", Some("~/Mail")), "~/Mail");
1263        // An IMAP account works as $folder, so =x is one of its folders.
1264        assert_eq!(
1265            expand_folder("=Archive", Some("imap:work")),
1266            "imap:work/Archive"
1267        );
1268        // Nothing to expand, or nowhere to expand to: untouched.
1269        assert_eq!(expand_folder("~/other", Some("~/Mail")), "~/other");
1270        assert_eq!(expand_folder("=archive", None), "=archive");
1271        assert_eq!(expand_folder("=archive", Some("")), "=archive");
1272
1273        let mut cfg: Config = toml::from_str(
1274            r#"
1275            [mail]
1276            folder = "~/Mail"
1277            mailboxes = ["=inbox", "~/elsewhere"]
1278            sent = "+sent"
1279            trash = "=Trash"
1280            [[fcc_hooks]]
1281            pattern = "~A"
1282            mailbox = "=work"
1283            "#,
1284        )
1285        .unwrap();
1286        cfg.expand_folders();
1287        assert_eq!(cfg.mail.mailboxes, ["~/Mail/inbox", "~/elsewhere"]);
1288        assert_eq!(cfg.mail.sent.as_deref(), Some("~/Mail/sent"));
1289        assert_eq!(cfg.mail.trash.as_deref(), Some("~/Mail/Trash"));
1290        assert_eq!(cfg.fcc_hooks[0].mailbox, "~/Mail/work");
1291        // Idempotent: an expanded name no longer starts with = or +.
1292        cfg.expand_folders();
1293        assert_eq!(cfg.mail.trash.as_deref(), Some("~/Mail/Trash"));
1294    }
1295
1296    #[test]
1297    fn parses_partial_config() {
1298        let cfg: Config = toml::from_str(
1299            r#"
1300            [identity]
1301            name = "Jane"
1302            email = "jane@x"
1303            [mail]
1304            mailboxes = ["~/Maildir"]
1305            sendmail = "/bin/true"
1306            [keys.index]
1307            sync = "w"
1308            "#,
1309        )
1310        .unwrap();
1311        assert_eq!(cfg.identity.from_line().as_deref(), Some("Jane <jane@x>"));
1312        assert_eq!(cfg.mail.mailboxes, vec!["~/Maildir"]);
1313        assert_eq!(cfg.mail.sendmail.as_deref(), Some("/bin/true"));
1314        assert_eq!(cfg.keys.index.get("sync").map(String::as_str), Some("w"));
1315        assert!(cfg.ui.theme.is_none());
1316    }
1317
1318    #[test]
1319    fn empty_and_unknown_keys_are_fine() {
1320        let cfg: Config = toml::from_str("").unwrap();
1321        assert!(cfg.identity.from_line().is_none());
1322        let cfg: Config = toml::from_str("[future]\nx = 1\n").unwrap();
1323        assert!(cfg.mail.mailboxes.is_empty());
1324        assert!(cfg.accounts.is_empty());
1325    }
1326
1327    #[test]
1328    fn parses_accounts_with_defaults() {
1329        let cfg: Config = toml::from_str(
1330            r#"
1331            [[accounts]]
1332            name = "work"
1333            user = "jane@example.com"
1334            password_command = "pass show mail/work"
1335            imap_host = "imap.example.com"
1336            smtp_host = "smtp.example.com"
1337
1338            [[accounts]]
1339            name = "test"
1340            user = "u"
1341            password_command = "true"
1342            imap_host = "localhost"
1343            imap_port = 10143
1344            imap_tls = false
1345            smtp_port = 465
1346            sent_folder = "INBOX/Sent"
1347            "#,
1348        )
1349        .unwrap();
1350        let work = cfg.account("work").unwrap();
1351        assert_eq!(work.imap_port, 993);
1352        assert_eq!(work.smtp_port, 587);
1353        assert!(work.imap_tls && work.smtp_tls);
1354        assert_eq!(work.sent_folder, "Sent");
1355        let test = cfg.account("test").unwrap();
1356        assert_eq!(test.imap_port, 10143);
1357        assert!(!test.imap_tls);
1358        assert!(test.smtp_host.is_none());
1359        assert_eq!(test.sent_folder, "INBOX/Sent");
1360        assert!(cfg.account("nope").is_none());
1361    }
1362
1363    #[test]
1364    fn pgp_section_defaults_and_overrides() {
1365        let cfg: Config = toml::from_str("").unwrap();
1366        assert_eq!(cfg.pgp.command, "gpg");
1367        assert!(cfg.pgp.sign_key.is_none());
1368        assert!(!cfg.pgp.sign_by_default && !cfg.pgp.encrypt_by_default);
1369        let cfg: Config = toml::from_str(
1370            "[pgp]\ncommand = \"gpg2\"\nsign_key = \"jane@x\"\nsign_by_default = true\n",
1371        )
1372        .unwrap();
1373        assert_eq!(cfg.pgp.command, "gpg2");
1374        assert_eq!(cfg.pgp.sign_key.as_deref(), Some("jane@x"));
1375        assert!(cfg.pgp.sign_by_default && !cfg.pgp.encrypt_by_default);
1376    }
1377
1378    #[test]
1379    fn account_missing_required_field_fails_parse() {
1380        assert!(toml::from_str::<Config>("[[accounts]]\nname = \"x\"\n").is_err());
1381    }
1382
1383    fn test_account() -> Account {
1384        Account {
1385            name: "t".into(),
1386            user: "u".into(),
1387            password_command: None,
1388            password: None,
1389            imap_host: None,
1390            imap_port: 993,
1391            imap_tls: true,
1392            smtp_host: None,
1393            smtp_port: 587,
1394            smtp_tls: true,
1395            auth: None,
1396            token_command: None,
1397            sent_folder: "Sent".into(),
1398            identity: None,
1399        }
1400    }
1401
1402    #[test]
1403    fn glob_match_star_and_case() {
1404        assert!(glob_match("*", "anything"));
1405        assert!(glob_match("*work*", "/home/jane/Maildir/work-stuff"));
1406        assert!(glob_match("*@work.example.com", "Jane@Work.Example.Com"));
1407        assert!(glob_match("imap:work/*", "imap:work/INBOX"));
1408        assert!(!glob_match("*@work.example.com", "jane@example.com"));
1409        assert!(!glob_match("work", "workplace")); // anchored
1410        assert!(glob_match("a*b*c", "aXbYc"));
1411        assert!(!glob_match("a*b*c", "aXcYb"));
1412    }
1413
1414    #[test]
1415    fn identity_layers_like_hooks() {
1416        let cfg: Config = toml::from_str(
1417            r#"
1418            [identity]
1419            name = "Jane"
1420            email = "jane@example.com"
1421            reverse_name = true
1422
1423            [[identities]]
1424            folder = "*work*"
1425            email = "jane@work.example.com"
1426
1427            [[identities]]
1428            recipient = "*@club.example.com"
1429            name = "Jenny"
1430
1431            [[accounts]]
1432            name = "acct"
1433            user = "u"
1434            imap_host = "h"
1435            identity = { name = "Jane Acct", email = "acct@example.com" }
1436            "#,
1437        )
1438        .unwrap();
1439        assert!(cfg.identity.reverse_name);
1440        // No match: the global identity as-is.
1441        let id = cfg.identity_for("~/Maildir", &[], None);
1442        assert_eq!(id.from_line().as_deref(), Some("Jane <jane@example.com>"));
1443        // Folder rule overrides the email, keeps the name.
1444        let id = cfg.identity_for("~/Maildir/work", &[], None);
1445        assert_eq!(
1446            id.from_line().as_deref(),
1447            Some("Jane <jane@work.example.com>")
1448        );
1449        // Recipient rule overlays the name; needs a matching recipient.
1450        let rcpts = vec!["bob@club.example.com".to_string()];
1451        let id = cfg.identity_for("~/Maildir", &rcpts, None);
1452        assert_eq!(id.from_line().as_deref(), Some("Jenny <jane@example.com>"));
1453        let id = cfg.identity_for("~/Maildir", &[], None);
1454        assert_eq!(id.name.as_deref(), Some("Jane"));
1455        // The account identity sits between global and the rules.
1456        let account = cfg.account("acct").unwrap();
1457        let id = cfg.identity_for("imap:acct/INBOX", &[], Some(account));
1458        assert_eq!(
1459            id.from_line().as_deref(),
1460            Some("Jane Acct <acct@example.com>")
1461        );
1462        let id = cfg.identity_for("imap:acct/work", &[], Some(account));
1463        assert_eq!(
1464            id.from_line().as_deref(),
1465            Some("Jane Acct <jane@work.example.com>")
1466        );
1467    }
1468
1469    #[test]
1470    fn password_command_takes_first_line() {
1471        let account = |cmd: &str| Account {
1472            password_command: Some(cmd.into()),
1473            ..test_account()
1474        };
1475        assert_eq!(
1476            account("printf 'secret\\nrest\\n'").password().unwrap(),
1477            "secret"
1478        );
1479        assert!(account("false").password().is_err());
1480        assert!(account("true").password().is_err()); // empty output
1481    }
1482
1483    #[test]
1484    fn auth_kinds_and_token_command() {
1485        let acct = test_account();
1486        assert_eq!(acct.auth_kind().unwrap(), AuthKind::Password);
1487        let oauth = Account {
1488            auth: Some("oauthbearer".into()),
1489            token_command: Some("printf 'tok123\\nrest\\n'".into()),
1490            ..test_account()
1491        };
1492        assert_eq!(oauth.auth_kind().unwrap(), AuthKind::OAuthBearer);
1493        assert_eq!(oauth.secret().unwrap(), "tok123");
1494        let no_command = Account {
1495            auth: Some("xoauth2".into()),
1496            ..test_account()
1497        };
1498        assert!(
1499            no_command
1500                .secret()
1501                .unwrap_err()
1502                .to_string()
1503                .contains("no token_command")
1504        );
1505        let bad = Account {
1506            auth: Some("kerberos".into()),
1507            ..test_account()
1508        };
1509        assert!(bad.auth_kind().is_err());
1510        // "password" is an explicit spelling of the default.
1511        let explicit = Account {
1512            auth: Some("password".into()),
1513            password: Some("pw".into()),
1514            ..test_account()
1515        };
1516        assert_eq!(explicit.secret().unwrap(), "pw");
1517    }
1518
1519    #[test]
1520    fn oauth_initial_responses() {
1521        assert_eq!(
1522            AuthKind::XOAuth2.initial_response("jane", "tok", "imap.example.com", 993),
1523            "user=jane\x01auth=Bearer tok\x01\x01"
1524        );
1525        assert_eq!(
1526            AuthKind::OAuthBearer.initial_response("jane", "tok", "imap.example.com", 993),
1527            "n,a=jane,\x01host=imap.example.com\x01port=993\x01auth=Bearer tok\x01\x01"
1528        );
1529    }
1530
1531    #[test]
1532    fn stored_password_and_precedence() {
1533        let stored = Account {
1534            password: Some("hunter2".into()),
1535            ..test_account()
1536        };
1537        assert_eq!(stored.password().unwrap(), "hunter2");
1538        // A configured command wins over the stored password.
1539        let both = Account {
1540            password_command: Some("echo from-command".into()),
1541            password: Some("hunter2".into()),
1542            ..test_account()
1543        };
1544        assert_eq!(both.password().unwrap(), "from-command");
1545        let neither = test_account();
1546        assert!(neither.password().is_err());
1547        let cfg: Config = toml::from_str(
1548            "[[accounts]]\nname = \"x\"\nuser = \"u\"\npassword = \"pw\"\nimap_host = \"h\"\n",
1549        )
1550        .unwrap();
1551        assert_eq!(cfg.account("x").unwrap().password().unwrap(), "pw");
1552    }
1553}