You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1079 lines
23 KiB

2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
  1. .\" meli - meli.conf.5
  2. .\"
  3. .\" Copyright 2017-2019 Manos Pitsidianakis
  4. .\"
  5. .\" This file is part of meli.
  6. .\"
  7. .\" meli is free software: you can redistribute it and/or modify
  8. .\" it under the terms of the GNU General Public License as published by
  9. .\" the Free Software Foundation, either version 3 of the License, or
  10. .\" (at your option) any later version.
  11. .\"
  12. .\" meli is distributed in the hope that it will be useful,
  13. .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15. .\" GNU General Public License for more details.
  16. .\"
  17. .\" You should have received a copy of the GNU General Public License
  18. .\" along with meli. If not, see <http://www.gnu.org/licenses/>.
  19. .\"
  20. .Dd September 16, 2019
  21. .Dt MELI.CONF 5
  22. .Os
  23. .Sh NAME
  24. .Nm meli.conf
  25. .Nd configuration file for the Meli Mail User Agent
  26. .Sh SYNOPSIS
  27. .Pa $XDG_CONFIG_HOME/meli/config.toml
  28. .Sh DESCRIPTION
  29. Configuration for meli is written in TOML which has a few things to consider (quoting the spec):
  30. .Pp
  31. .Bl -bullet -compact
  32. .It
  33. TOML is case sensitive.
  34. .It
  35. A TOML file must be a valid UTF-8 encoded Unicode document.
  36. .It
  37. Whitespace means tab (0x09) or space (0x20).
  38. .It
  39. Newline means LF (0x0A) or CRLF (0x0D 0x0A).
  40. .El
  41. .Pp
  42. Refer to TOML documentation for valid TOML syntax.
  43. .sp
  44. Though not part of TOML syntax,
  45. .Nm
  46. can have nested configuration files by using the following
  47. .Xr m4 1
  48. include macro:
  49. .Dl include(\&"/path/to/file\&")
  50. .Sh SECTIONS
  51. The top level sections of the config are:
  52. .Bl -bullet -compact
  53. .It
  54. accounts
  55. .It
  56. shortcuts
  57. .It
  58. notifications
  59. .It
  60. pager
  61. .It
  62. listing
  63. .It
  64. composing
  65. .It
  66. pgp
  67. .It
  68. terminal
  69. .It
  70. log
  71. .El
  72. .Sh EXAMPLES
  73. example configuration
  74. .sp
  75. .Bd -literal
  76. # Setting up a Maildir account
  77. [accounts.account-name]
  78. root_mailbox = "/path/to/root/folder"
  79. format = "Maildir"
  80. index_style = "Compact"
  81. identity="email@address.tld"
  82. subscribed_mailboxes = ["folder", "folder/Sent"] # or [ "*", ] for all mailboxes
  83. display_name = "Name"
  84. # Set mailbox-specific settings
  85. [accounts.account-name.mailboxes]
  86. "INBOX" = { alias="Inbox" } #inline table
  87. "drafts" = { alias="Drafts" } #inline table
  88. [accounts.account-name.mailboxes."foobar-devel"] # or a regular table
  89. ignore = true # don't show notifications for this mailbox
  90. # Setting up an mbox account
  91. [accounts.mbox]
  92. root_mailbox = "/var/mail/username"
  93. format = "mbox"
  94. index_style = "Compact"
  95. identity="username@hostname.local"
  96. composing.send_mail = { hostname = "localhost", port = 25, auth = { type = "none" }, security = { type = "none" } }
  97. [pager]
  98. filter = "COLUMNS=72 /usr/local/bin/pygmentize -l email"
  99. html_filter = "w3m -I utf-8 -T text/html"
  100. [notifications]
  101. script = "notify-send"
  102. [composing]
  103. # required for sending e-mail
  104. send_mail = 'msmtp --read-recipients --read-envelope-from'
  105. #send_mail = { hostname = "smtp.mail.tld", port = 587, auth = { type = "auto", username = "user", password = { type = "command_eval", value = "gpg2 --no-tty -q -d ~/.passwords/user.gpg" } }, security = { type = "STARTTLS" } }
  106. editor_command = 'vim +/^$'
  107. [shortcuts]
  108. [shortcuts.composing]
  109. edit_mail = 'e'
  110. [shortcuts.listing]
  111. new_mail = 'm'
  112. set_seen = 'n'
  113. [terminal]
  114. theme = "light"
  115. .Ed
  116. .Pp
  117. Available options are listed below.
  118. Default values are shown in parentheses.
  119. .Sh ACCOUNTS
  120. .Bl -tag -width 36n
  121. .It Ic root_mailbox Ar String
  122. The backend-specific path of the root_mailbox, usually INBOX.
  123. .It Ic format Ar String Op maildir mbox imap notmuch jmap
  124. The format of the mail backend.
  125. .It Ic subscribed_mailboxes Ar [String,]
  126. An array of mailbox paths to display in the UI.
  127. Paths are relative to the root mailbox (eg "INBOX/Sent", not "Sent").
  128. The glob wildcard
  129. .Em \&*
  130. can be used to match every mailbox name and path.
  131. .It Ic identity Ar String
  132. Your e-mail address that is inserted in the From: headers of outgoing mail.
  133. .It Ic index_style Ar String
  134. Sets the way mailboxes are displayed.
  135. .El
  136. .TS
  137. allbox tab(:);
  138. lb l.
  139. conversations:shows one entry per thread
  140. compact:shows one row per thread
  141. threaded:shows threads as a tree structure
  142. plain:shows one row per mail, regardless of threading
  143. .TE
  144. .Bl -tag -width 36n
  145. .It Ic display_name Ar String
  146. .Pq Em optional
  147. A name which can be combined with your address: "Name <email@address.tld>".
  148. .It Ic read_only Ar boolean
  149. Attempt to not make any changes to this account.
  150. .Pq Em false
  151. .It Ic manual_refresh Ar boolean
  152. .Pq Em optional
  153. If true, do not monitor account for changes (you can use shortcut listing.refresh)
  154. .Pq Em false
  155. .It Ic refresh_command Ar String
  156. .Pq Em optional
  157. command to execute when manually refreshing (shortcut listing.refresh)
  158. .Pq Em None
  159. .It Ic search_backend Ar String
  160. .Pq Em optional
  161. Choose which search backend to use.
  162. Available options are 'none' and 'sqlite3'
  163. .Pq Em "sqlite3"
  164. .It Ic vcard_folder Ar String
  165. .Pq Em optional
  166. Folder that contains .vcf files.
  167. They are parsed and imported read-only.
  168. .It Ic mailboxes Ar mailbox
  169. .Pq Em optional
  170. Configuration for each mailbox.
  171. Its format is described below in
  172. .Sx mailboxes Ns
  173. \&.
  174. .El
  175. .Ss notmuch only
  176. .Ic root_mailbox
  177. points to the directory which contains the
  178. .Pa .notmuch/
  179. subdirectory.
  180. notmuch mailboxes are virtual, since they are defined by user-given notmuch queries.
  181. You must explicitly state the mailboxes you want in the
  182. .Ic mailboxes
  183. field and set the
  184. .Ar query
  185. property to each of them.
  186. Example:
  187. .Bd -literal
  188. [accounts.notmuch]
  189. format = "notmuch"
  190. \&...
  191. [accounts.notmuch.mailboxes]
  192. "INBOX" = { query="tag:inbox", subscribe = true }
  193. "Drafts" = { query="tag:draft", subscribe = true }
  194. "Sent" = { query="from:username@server.tld from:username2@server.tld", subscribe = true }
  195. .Ed
  196. .Ss IMAP only
  197. IMAP specific options are:
  198. .Bl -tag -width 36n
  199. .It Ic server_hostname Ar String
  200. example:
  201. .Qq mail.example.tld
  202. .It Ic server_username Ar String
  203. Server username
  204. .It Ic server_password Ar String
  205. Server password
  206. .It Ic server_password_command Ar String
  207. .Pq Em optional
  208. Use instead of
  209. .Ic server_password
  210. .It Ic server_port Ar number
  211. .Pq Em optional
  212. The port to connect to
  213. .\" default value
  214. .Pq Em 143
  215. .It Ic use_starttls Ar boolean
  216. .Pq Em optional
  217. If port is 993 and use_starttls is unspecified, it becomes false by default.
  218. .\" default value
  219. .Pq Em true
  220. .It Ic danger_accept_invalid_certs Ar boolean
  221. .Pq Em optional
  222. Do not validate TLS certificates.
  223. .\" default value
  224. .Pq Em false
  225. .It Ic use_idle Ar boolean
  226. .Pq Em optional
  227. Use IDLE extension.
  228. .\" default value
  229. .Pq Em true
  230. .It Ic use_deflate Ar boolean
  231. .Pq Em optional
  232. Use COMPRESS=DEFLATE extension (if built with DEFLATE support).
  233. .\" default value
  234. .Pq Em true
  235. .It Ic timeout Ar integer
  236. .Pq Em optional
  237. Timeout to use for server connections in seconds.
  238. A timeout of 0 seconds means there's no timeout.
  239. .\" default value
  240. .Pq Em 16
  241. .El
  242. .Ss JMAP only
  243. JMAP specific options
  244. .Bl -tag -width 36n
  245. .It Ic server_hostname Ar String
  246. example:
  247. .Qq mail.example.tld
  248. .It Ic server_username Ar String
  249. Server username
  250. .It Ic server_password Ar String
  251. Server password
  252. .It Ic server_port Ar number
  253. .Pq Em optional
  254. The port to connect to
  255. .\" default value
  256. .Pq Em 443
  257. .It Ic danger_accept_invalid_certs Ar boolean
  258. .Pq Em optional
  259. Do not validate TLS certificates.
  260. .\" default value
  261. .Pq Em false
  262. .El
  263. .Ss mbox only
  264. mbox specific options
  265. .Bl -tag -width 36n
  266. .It Ic prefer_mbox_type Ar String
  267. .Pq Em optional
  268. Prefer specific mbox format reader for each message.
  269. Default is mboxcl2 format.
  270. If the preferred format fails, the message is retried with mboxrd and then if it fails again there's a recover attempt, which discards the invalid message.
  271. Valid values
  272. .Bl -bullet -compact
  273. .It
  274. .Ar auto
  275. .It
  276. .Ar mboxo
  277. .It
  278. .Ar mboxrd
  279. .It
  280. .Ar mboxcl
  281. .It
  282. .Ar mboxcl2
  283. .El
  284. .\" default value
  285. .Pq Em auto
  286. .El
  287. To set multiple mailboxes, you have to explicitly state the mailboxes you want in the
  288. .Ic mailboxes
  289. field and set the
  290. .Ar path
  291. property to each of them.
  292. Example:
  293. .Bd -literal
  294. [accounts.mbox]
  295. format = "mbox"
  296. mailboxes."Python mailing list" = { path = "~/.mail/python.mbox", subscribe = true, autoload = true }
  297. .Ed
  298. .Ss MAILBOXES
  299. .Bl -tag -width 36n
  300. .It Ic alias Ar String
  301. .Pq Em optional
  302. Show a different name for this mailbox in the UI
  303. .It Ic autoload Ar boolean
  304. .Pq Em optional
  305. Load this mailbox on startup
  306. .\" default value
  307. .Pq Em true
  308. .It Ic subscribe Ar boolean
  309. .Pq Em optional
  310. Watch this mailbox for updates
  311. .\" default value
  312. .Pq Em true
  313. .It Ic ignore Ar boolean
  314. .Pq Em optional
  315. Silently insert updates for this mailbox, if any
  316. .\" default value
  317. .Pq Em false
  318. .It Ic usage Ar boolean
  319. .Pq Em optional
  320. special usage of this mailbox.
  321. Valid values are:
  322. .Bl -bullet -compact
  323. .It
  324. .Ar Normal
  325. .Pq Em default
  326. .It
  327. .Ar Inbox
  328. .It
  329. .Ar Archive
  330. .It
  331. .Ar Drafts
  332. .It
  333. .Ar Flagged
  334. .It
  335. .Ar Junk
  336. .It
  337. .Ar Sent
  338. .It
  339. .Ar Trash
  340. .El
  341. otherwise usage is inferred from the mailbox title.
  342. If for example your Sent folder is not named "Sent", you must explicitly set it.
  343. .It Ic conf_override Ar boolean
  344. .Pq Em optional
  345. Override global settings for this mailbox.
  346. Available sections to override are
  347. .Em pager, notifications, shortcuts, composing
  348. and the account options
  349. .Em identity
  350. and
  351. .Em index_style Ns
  352. \&.
  353. Example:
  354. .Bd -literal
  355. [accounts."imap.domain.tld".mailboxes."INBOX"]
  356. index_style = "plain"
  357. [accounts."imap.domain.tld".mailboxes."INBOX".pager]
  358. filter = ""
  359. .Ed
  360. .El
  361. .Sh COMPOSING
  362. Composing specific options
  363. .Bl -tag -width 36n
  364. .It Ic send_mail Ar String|SmtpServerConf
  365. Command to pipe new mail to (exit code must be 0 for success) or settings for an SMTP server connection.
  366. See section
  367. .Sx SMTP Connections
  368. for its fields.
  369. .It Ic editor_command Ar String
  370. Command to launch editor.
  371. Can have arguments.
  372. Draft filename is given as the last argument.
  373. If it's missing, the environment variable $EDITOR is looked up.
  374. .It Ic embed Ar boolean
  375. .Pq Em optional
  376. Embed editor within meli.
  377. Editor must be xterm compliant.
  378. .\" default value
  379. .Pq Em false
  380. .It Ic format_flowed Ar boolean
  381. .Pq Em optional
  382. Set format=flowed [RFC3676] in text/plain attachments.
  383. .\" default value
  384. .Pq Em true
  385. .It Ic insert_user_agent Ar boolean
  386. .Pq Em optional
  387. Add meli User-Agent header in new drafts
  388. .\" default value
  389. .Pq Em true
  390. .It Ic default_header_values Ar hash table String[String]
  391. Default header values used when creating a new draft.
  392. .El
  393. .Sh SHORTCUTS
  394. Shortcuts can take the following values:
  395. .Bl -bullet -compact
  396. .It
  397. .Em Backspace
  398. .It
  399. .Em Left
  400. .It
  401. .Em Right
  402. .It
  403. .Em Up
  404. .It
  405. .Em Down
  406. .It
  407. .Em Home
  408. .It
  409. .Em End
  410. .It
  411. .Em PageUp
  412. .It
  413. .Em PageDown
  414. .It
  415. .Em Delete
  416. .It
  417. .Em Insert
  418. .It
  419. .Em Enter
  420. .It
  421. .Em Tab
  422. .It
  423. .Em Esc
  424. .It
  425. .Em F1..F12
  426. .It
  427. .Em M-char
  428. .It
  429. .Em C-char
  430. .It
  431. .Em char
  432. .El
  433. .Em char
  434. is a single character string.
  435. .sp
  436. The headings before each list indicate the map key of the shortcut list.
  437. For example for the first list titled
  438. .Em general
  439. the configuration is typed as follows:
  440. .Bd -literal
  441. [shortcuts.general]
  442. next_tab = 'T'
  443. .Ed
  444. .sp
  445. and for
  446. .Em compact-listing Ns
  447. :
  448. .Bd -literal
  449. [shortcuts.compact-listing]
  450. open_thread = "Enter"
  451. exit_thread = 'i'
  452. .Ed
  453. .sp
  454. .Pp
  455. .Em general
  456. .Bl -tag -width 36n
  457. .It Ic toggle_help
  458. Toggle help and shortcuts view.
  459. .\" default value
  460. .Pq Em \&?
  461. .It Ic enter_command_mode
  462. Enter
  463. .Em COMMAND
  464. mode.
  465. .\" default value
  466. .Pq Ql Em \
  467. .It Ic next_tab
  468. Go to next tab.
  469. .\" default value
  470. .Pq Em T
  471. .It Ic go_to_tab
  472. Go to the
  473. .Em n Ns
  474. th tab
  475. .Pq Em cannot be redefined
  476. .El
  477. .sp
  478. .Em listing
  479. .Bl -tag -width 36n
  480. .It Ic prev_page
  481. Go to previous page.
  482. .\" default value
  483. .Pq Em PageUp
  484. .It Ic next_page
  485. Go to next page.
  486. .\" default value
  487. .Pq Em PageDown
  488. .It Ic prev_mailbox
  489. Go to previous mailbox.
  490. .\" default value
  491. .Pq Em K
  492. .It Ic next_mailbox
  493. Go to next mailbox.
  494. .\" default value
  495. .Pq Em J
  496. .It Ic prev_account
  497. Go to previous account.
  498. .\" default value
  499. .Pq Em l
  500. .It Ic next_account
  501. Go to next account.
  502. .\" default value
  503. .Pq Em h
  504. .It Ic new_mail
  505. Start new mail draft in new tab
  506. .\" default value
  507. .Pq Em m
  508. .It Ic set_seen
  509. Set thread as seen.
  510. .\" default value
  511. .Pq Em n
  512. .It Ic refresh
  513. Manually request a mailbox refresh.
  514. .\" default value
  515. .Pq Em F5
  516. .It Ic search
  517. Search within list of e-mails.
  518. .\" default value
  519. .Pq Em /
  520. .It Ic toggle_menu_visibility
  521. Toggle visibility of side menu in mail list.
  522. .\" default value
  523. .Pq Em `
  524. .El
  525. .sp
  526. .Em compact-listing
  527. .Bl -tag -width 36n
  528. .It Ic exit_thread
  529. Exit thread view
  530. .\" default value
  531. .Pq Em i
  532. .It Ic open_thread
  533. Open thread.
  534. .\" default value
  535. .Pq Em Enter
  536. .It Ic select_entry
  537. Select thread entry.
  538. .\" default value
  539. .Pq Em v
  540. .El
  541. .sp
  542. .Em pager
  543. .Bl -tag -width 36n
  544. .It Ic scroll_up
  545. Scroll up pager.
  546. .\" default value
  547. .Pq Em k
  548. .It Ic scroll_down
  549. Scroll down pager.
  550. .\" default value
  551. .Pq Em j
  552. .It Ic page_up
  553. Go to previous pager page
  554. .\" default value
  555. .Pq Em PageUp
  556. .It Ic page_down
  557. Go to next pager pag
  558. .\" default value
  559. .Pq Em PageDown
  560. .El
  561. .sp
  562. .Em contact-list
  563. .Bl -tag -width 36n
  564. .It Ic create_contact
  565. Create new contact.
  566. .\" default value
  567. .Pq Em c
  568. .It Ic edit_contact
  569. Edit contact under cursor
  570. .\" default value
  571. .Pq Em e
  572. .It Ic mail_contact
  573. Mail contact under cursor
  574. .\" default value
  575. .Pq Em m
  576. .It Ic toggle_menu_visibility
  577. Toggle visibility of side menu in mail list.
  578. .\" default value
  579. .Pq Em `
  580. .El
  581. .sp
  582. .sp
  583. .Em composing
  584. .Bl -tag -width 36n
  585. .It Ic send_mail
  586. Deliver draft to mailer
  587. .\" default value
  588. .Pq Em s
  589. .It Ic edit_mail
  590. Edit mail.
  591. .\" default value
  592. .Pq Em e
  593. .El
  594. .sp
  595. .Em envelope-view
  596. .Pp
  597. 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.
  598. .Bl -tag -width 36n
  599. .It Ic add_addresses_to_contacts Ns
  600. Select addresses from envelope to add to contacts.
  601. .\" default value
  602. .Pq Em c
  603. .It Ic view_raw_source
  604. View raw envelope source in a pager.
  605. .\" default value
  606. .Pq Em M-r
  607. .It Ic reply
  608. Reply to envelope.
  609. .\" default value
  610. .Pq Em R
  611. .It Ic edit
  612. Open envelope in composer.
  613. .\" default value
  614. .Pq Em e
  615. .It Ic return_to_normal_view
  616. Return to envelope if viewing raw source or attachment.
  617. .\" default value
  618. .Pq Em r
  619. .It Ic open_attachment
  620. Opens selected attachment with
  621. .Cm xdg-open
  622. .\" default value
  623. .Pq Em a
  624. .It Ic open_mailcap
  625. Opens selected attachment according to its mailcap entry.
  626. See
  627. .Xr meli 1 FILES
  628. for the mailcap file locations.
  629. .\" default value
  630. .Pq Em m
  631. .It Ic go_to_url
  632. Go to url of given index
  633. .\" default value
  634. .Pq Em g
  635. .It Ic toggle_url_mode
  636. Toggles url open mode.
  637. When active, it prepends an index next to each url that you can select by typing the index and open by issuing
  638. .Ic go_to_url
  639. .\" default value
  640. .Pq Em u
  641. .It Ic toggle_expand_headers
  642. Expand extra headers (References and others)
  643. .\" default value
  644. .Pq Em h
  645. .El
  646. .sp
  647. .Em thread-view
  648. .Bl -tag -width 36n
  649. .It Ic reverse_thread_order
  650. Reverse thread order.
  651. .\" default value
  652. .Pq Em r
  653. .It Ic toggle_mailview
  654. Toggle mail view visibility.
  655. .\" default value
  656. .Pq Em p
  657. .It Ic toggle_threadview
  658. Toggle thread view visibility.
  659. .\" default value
  660. .Pq Em t
  661. .It Ic collapse_subtree
  662. Collapse thread branches.
  663. .\" default value
  664. .Pq Em h
  665. .It Ic prev_page
  666. Go to previous page.
  667. .\" default value
  668. .Pq Em PageUp
  669. .It Ic next_page
  670. Go to next page.
  671. .\" default value
  672. .Pq Em PageDown
  673. .El
  674. .sp
  675. .Sh NOTIFICATIONS
  676. .Bl -tag -width 36n
  677. .It Ic enable Ar boolean
  678. Enable notifications.
  679. .\" default value
  680. .Pq Em true
  681. .It Ic script Ar String
  682. .Pq Em optional
  683. Script to pass notifications to, with title as 1st arg and body as 2nd
  684. .\" default value
  685. .Pq Em none Ns
  686. \&.
  687. .It Ic xbiff_file_path Ar String
  688. .Pq Em optional
  689. File that gets its size updated when new mail arrives.
  690. .Pq Em none
  691. .\" default value
  692. .It Ic play_sound Ar boolean
  693. .Pq Em optional
  694. Play theme sound in notifications if possible.
  695. .Pq Em false
  696. .\" default value
  697. .It Ic sound_file Ar String
  698. .Pq Em optional
  699. Play sound file in notifications if possible.
  700. .\" default value
  701. .Pq Em none
  702. .El
  703. .Sh PAGER
  704. .Bl -tag -width 36n
  705. .It Ic headers_sticky Ar boolean
  706. .Pq Em optional
  707. Always show headers when scrolling.
  708. .\" default value
  709. .Pq Em true
  710. .It Ic html_filter Ar String
  711. .Pq Em optional
  712. Pipe html attachments through this filter before display
  713. .\" default value
  714. .Pq Em none
  715. .It Ic filter Ar String
  716. .Pq Em optional
  717. A command to pipe mail output through for viewing in pager.
  718. .\" default value
  719. .Pq Em none
  720. .It Ic format_flowed Ar bool
  721. .Pq Em optional
  722. Respect format=flowed
  723. .\" default value
  724. .Pq Em true
  725. .It Ic split_long_lines Ar bool
  726. .Pq Em optional
  727. Split long lines that would overflow on the x axis.
  728. .\" default value
  729. .Pq Em true
  730. .It Ic minimum_width Ar num
  731. .Pq Em optional
  732. Minimum text width in columns.
  733. .\" default value
  734. .Pq Em 80
  735. .It Ic auto_choose_multipart_alternative Ar boolean
  736. .Pq Em optional
  737. Choose `text/html` alternative if `text/plain` is empty in `multipart/alternative` attachments.
  738. .\" default value
  739. .Pq Em true
  740. .El
  741. .Sh LISTING
  742. .Bl -tag -width 36n
  743. .It Ic datetime_fmt Ar String
  744. .Pq Em optional
  745. Datetime formatting passed verbatim to strftime(3).
  746. .\" default value
  747. .Pq Em \&%Y-\&%m-\&%d \&%T
  748. .It Ic recent_dates Ar Boolean
  749. .Pq Em optional
  750. Show recent dates as `X {minutes,hours,days} ago`, up to 7 days.
  751. .\" default value
  752. .Pq Em true
  753. .It Ic filter Ar Query
  754. .Pq Em optional
  755. Show only envelopes matching this query.
  756. .Po
  757. For query syntax see
  758. .Xr meli 1 QUERY ABNF SYNTAX
  759. .Pc
  760. .\" default value
  761. .Pq Em None
  762. .Pp
  763. Example:
  764. .Bd -literal
  765. filter = "not flags:seen" # show only unseen messages
  766. .Ed
  767. .It Ic index_style Ar String
  768. Sets the way mailboxes are displayed.
  769. .It Ic sidebar_mailbox_tree_has_sibling Ar String
  770. .Pq Em optional
  771. Sets the string to print in the mailbox tree for a level where its root has a sibling.
  772. See example below for a clear explanation and examples.
  773. .It Ic sidebar_mailbox_tree_no_sibling Ar String
  774. .Pq Em optional
  775. Sets the string to print in the mailbox tree for a level where its root has no sibling.
  776. .It Ic sidebar_mailbox_tree_has_sibling_leaf Ar String
  777. .Pq Em optional
  778. Sets the string to print in the mailbox tree for a leaf level where its root has a sibling.
  779. .It Ic sidebar_mailbox_tree_no_sibling_leaf Ar String
  780. .Pq Em optional
  781. Sets the string to print in the mailbox tree for a leaf level where its root has no sibling.
  782. .El
  783. .Ss Examples of sidebar mailbox tree customization
  784. The default values
  785. .Bd
  786. has_sibling = " "
  787. no_sibling = " ";
  788. has_sibling_leaf = " "
  789. no_sibling_leaf = " "
  790. .Ed
  791. render a mailbox tree like the following:
  792. .Bd -literal
  793. 0 Inbox 3
  794. 1 Archive
  795. 2 Drafts
  796. 3 Lists
  797. 4 example-list-a
  798. 5 example-list-b
  799. 6 Sent
  800. 7 Spam
  801. 8 Trash
  802. .Ed
  803. Other possible trees:
  804. .Bd -literal
  805. has_sibling = " ┃"
  806. no_sibling = " "
  807. has_sibling_leaf = " ┣━"
  808. no_sibling_leaf = " ┗━"
  809. .Ed
  810. .Bd -literal
  811. 0 Inbox 3
  812. 1 ┣━Archive
  813. 2 ┣━Drafts
  814. 3 ┣━Lists
  815. 4 ┃ ┣━example-list-a
  816. 5 ┃ ┗━example-list-b
  817. 6 ┣━Sent
  818. 7 ┣━Spam
  819. 8 ┗━Trash
  820. .Ed
  821. A completely ASCII one:
  822. .Bd -literal
  823. has_sibling = " |"
  824. no_sibling = " "
  825. has_sibling_leaf = " |\\_"
  826. no_sibling_leaf = " \\_"
  827. .Ed
  828. .Bd -literal
  829. 0 Inbox 3
  830. 1 |\\_Archive
  831. 2 |\\_Drafts
  832. 3 |\\_Lists
  833. 4 | |\\_example-list-a
  834. 5 | \\_example-list-b
  835. 6 |\\_Sent
  836. 7 |\\_Spam
  837. 8 \\_Trash
  838. .Ed
  839. .Sh TAGS
  840. .Bl -tag -width 36n
  841. .It Ic colours Ar hash table String[Color]
  842. .Pq Em optional
  843. Set UI colors for tags
  844. .It Ic ignore_tags Ar Array String
  845. .Pq Em optional
  846. Hide tags (not the tagged messages themselves)
  847. .El
  848. .sp
  849. Example:
  850. .sp
  851. .Bd -literal
  852. [tags]
  853. # valid inputs: #HHHHHH, #ABC -> #AABBCC, XTERM_NAME, 0-255 byte
  854. colors = { signed="#Ff6600", replied="DeepSkyBlue4", draft="#f00", replied="8" }
  855. [accounts.dummy]
  856. \&...
  857. [accounts.dummy.mailboxes]
  858. # per mailbox override:
  859. "INBOX" = { tags.ignore_tags=["inbox", ] }
  860. .Ed
  861. .Sh PGP
  862. .Bl -tag -width 36n
  863. .It Ic auto_verify_signatures Ar boolean
  864. Auto verify signed e-mail according to RFC3156
  865. .\" default value
  866. .Pq Em true
  867. .It Ic auto_sign Ar boolean
  868. .Pq Em optional
  869. Always sign sent messages
  870. .\" default value
  871. .Pq Em false
  872. .It Ic key Ar String
  873. .Pq Em optional
  874. Key to be used when signing/encrypting (not functional yet)
  875. .\" default value
  876. .Pq Em none
  877. .El
  878. .Sh TERMINAL
  879. .Bl -tag -width 36n
  880. .It Ic theme Ar String
  881. .Pq Em optional
  882. Theme name to use.
  883. .\" default value
  884. .Pq Em dark
  885. .It Ic ascii_drawing Ar boolean
  886. .Pq Em optional
  887. If true, box drawing will be done with ascii characters.
  888. .\" default value
  889. .Pq Em false
  890. .It Ic use_color Ar boolean
  891. .Pq Em optional
  892. If false, no ANSI colors are used.
  893. .\" default value
  894. .Pq Em true
  895. .It Ic window_title Ar String
  896. .Pq Em optional
  897. Set window title in xterm compatible terminals An empty string means no window title is set.
  898. .\" default value
  899. .Pq Em "meli"
  900. .It Ic file_picker_command Ar String
  901. .Pq Em optional
  902. Set command that prints file paths in stderr, separated by NULL bytes.
  903. Used with
  904. .Ic add-attachment-file-picker
  905. when composing new mail.
  906. .\" default value
  907. .Pq Em None
  908. .It Ic themes Ar hash table String[String[Attribute]]
  909. Define UI themes.
  910. See
  911. .Xr meli-themes 5
  912. for details.
  913. .Bd -literal
  914. [terminal]
  915. theme = "themeB"
  916. [terminal.themes.themeA]
  917. "mail.view.body" = {fg = "HotPink3", bg = "LightSalmon1"}
  918. \&...
  919. [terminal.themes.themeB]
  920. "mail.view.body" = {fg = "CadetBlue", bg = "White"}
  921. \&...
  922. [terminal.themes.themeC]
  923. \&...
  924. .Ed
  925. .El
  926. .Sh LOG
  927. .Bl -tag -width 36n
  928. .It Ic log_file Ar String
  929. .Pq Em optional
  930. path of the log file
  931. .\" default value
  932. .Pq Pa $XDG_DATA_HOME/meli/meli.log
  933. .It Ic maximum_level Ar String
  934. .Pq Em optional
  935. maximum level of messages to log.
  936. All levels less or equal to the
  937. .Ic maximum_level
  938. will be appended to the log file.
  939. Available levels are, in partial order:
  940. .Bl -bullet -compact
  941. .It
  942. .Em OFF
  943. .It
  944. .Em FATAL
  945. .It
  946. .Em ERROR
  947. .It
  948. .Em WARN
  949. .It
  950. .Em INFO
  951. .It
  952. .Em DEBUG
  953. .It
  954. .Em TRACE
  955. .El
  956. This means that to turn logging off, set
  957. .Ic maximum_level
  958. to
  959. .Em OFF Ns
  960. \&.
  961. .\" default value
  962. .Pq Em INFO
  963. .El
  964. .Sh SMTP Connections
  965. .Bl -tag -width 36n
  966. .It Ic hostname Ar String
  967. server hostname
  968. .It Ic port Ar Integer
  969. server port
  970. .It Ic envelope_from Ar String
  971. .Pq Em optional
  972. address to set as sender in SMTP transactions
  973. .\" default value
  974. .Pq Em none
  975. .It Ic auth Ar SmtpAuth
  976. SMTP server authentication.
  977. See
  978. .Sx SmtpAuth
  979. subsection.
  980. .It Ic security Ar SmtpSecurity
  981. .Pq Em optional
  982. gpg binary name or file location to use
  983. .\" default value
  984. .Po see
  985. .Sx SmtpSecurity
  986. subsection
  987. .Pc
  988. .It Ic extensions Ar SmtpExtensions
  989. .Pq Em optional
  990. set support for SMTP extensions if they are advertised by the server
  991. .\" default value
  992. .Po see
  993. .Sx SmtpExtensions
  994. subsection
  995. .Pc
  996. .El
  997. .Ss SmtpAuth
  998. .Bl -tag -width 36n
  999. .It Ic type Ar "none" | "auto"
  1000. .El
  1001. .Pp
  1002. For type "auto":
  1003. .Bl -tag -width 36n
  1004. .It Ic username Ar String
  1005. .It Ic password Ar String|SmtpPassword
  1006. .It Ic require_auth Ar bool
  1007. .Pq Em optional
  1008. require authentication in every case
  1009. .\" default value
  1010. .Pq Em true
  1011. .El
  1012. .Ss SmtpPassword
  1013. .Bl -tag -width 36n
  1014. .It Ic type Ar "raw" | "command_evaluation"
  1015. .It Ic value Ar String
  1016. Either a raw password string, or command to execute.
  1017. .El
  1018. .Ss SmtpSecurity
  1019. Default security type is
  1020. .Em auto Ns
  1021. \&.
  1022. .Bl -tag -width 36n
  1023. .It Ic type Ar "none" | "auto" | "starttls" | "tls"
  1024. .It Ic danger_accept_invalid_certs Ar bool
  1025. Accept invalid SSL/TLS certificates
  1026. .\" default value
  1027. .Pq Em false
  1028. .El
  1029. .Ss SmtpExtensions
  1030. .Bl -tag -width 36n
  1031. .It Ic pipelining Ar bool
  1032. rfc2920
  1033. .\" default value
  1034. .Pq Em true
  1035. .It Ic chunking Ar bool
  1036. rfc3030
  1037. .\" default value
  1038. .Pq Em true
  1039. .It Ic prdr Ar bool
  1040. draft-hall-prdr-00
  1041. .\" default value
  1042. .Pq Em true
  1043. .It Ic dsn_notify Ar String
  1044. RFC3461
  1045. .\" default value
  1046. .Pq Em FAILURE
  1047. .El
  1048. .Sh SEE ALSO
  1049. .Xr meli 1 ,
  1050. .Xr meli-themes 5
  1051. .Sh CONFORMING TO
  1052. TOML Standard v.0.5.0 https://toml.io/en/v0.5.0
  1053. .Sh AUTHORS
  1054. Copyright 2017-2019
  1055. .An Manos Pitsidianakis Aq epilys@nessuent.xyz
  1056. Released under the GPL, version 3 or greater.
  1057. This software carries no warranty of any kind.
  1058. (See COPYING for full copyright and warranty notices.)
  1059. .Pp
  1060. .Aq https://meli.delivery