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.

964 lines
20 KiB

3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 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 cache_type Ar String
  160. .Pq Em optional
  161. Choose which cache 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. .El
  226. .Ss JMAP only
  227. JMAP specific options
  228. .Bl -tag -width 36n
  229. .It Ic server_hostname Ar String
  230. example:
  231. .Qq mail.example.tld
  232. .It Ic server_username Ar String
  233. Server username
  234. .It Ic server_password Ar String
  235. Server password
  236. .It Ic server_port Ar number
  237. .Pq Em optional
  238. The port to connect to
  239. .\" default value
  240. .Pq Em 443
  241. .It Ic danger_accept_invalid_certs Ar boolean
  242. .Pq Em optional
  243. Do not validate TLS certificates.
  244. .\" default value
  245. .Pq Em false
  246. .El
  247. .Ss mbox only
  248. mbox specific options
  249. .Bl -tag -width 36n
  250. .It Ic prefer_mbox_type Ar String
  251. .Pq Em optional
  252. Prefer specific mbox format reader for each message.
  253. Default is mboxcl2 format.
  254. 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.
  255. Valid values
  256. .Bl -bullet -compact
  257. .It
  258. .Ar auto
  259. .It
  260. .Ar mboxo
  261. .It
  262. .Ar mboxrd
  263. .It
  264. .Ar mboxcl
  265. .It
  266. .Ar mboxcl2
  267. .El
  268. .\" default value
  269. .Pq Em auto
  270. .El
  271. To set multiple mailboxes, you have to explicitly state the mailboxes you want in the
  272. .Ic mailboxes
  273. field and set the
  274. .Ar path
  275. property to each of them.
  276. Example:
  277. .Bd -literal
  278. [accounts.mbox]
  279. format = "mbox"
  280. mailboxes."Python mailing list" = { path = "~/.mail/python.mbox", subscribe = true, autoload = true }
  281. .Ed
  282. .Ss MAILBOXES
  283. .Bl -tag -width 36n
  284. .It Ic alias Ar String
  285. .Pq Em optional
  286. Show a different name for this mailbox in the UI
  287. .It Ic autoload Ar boolean
  288. .Pq Em optional
  289. Load this mailbox on startup
  290. .\" default value
  291. .Pq Em true
  292. .It Ic subscribe Ar boolean
  293. .Pq Em optional
  294. Watch this mailbox for updates
  295. .\" default value
  296. .Pq Em true
  297. .It Ic ignore Ar boolean
  298. .Pq Em optional
  299. Silently insert updates for this mailbox, if any
  300. .\" default value
  301. .Pq Em false
  302. .It Ic usage Ar boolean
  303. .Pq Em optional
  304. special usage of this mailbox.
  305. Valid values are:
  306. .Bl -bullet -compact
  307. .It
  308. .Ar Normal
  309. .Pq Em default
  310. .It
  311. .Ar Inbox
  312. .It
  313. .Ar Archive
  314. .It
  315. .Ar Drafts
  316. .It
  317. .Ar Flagged
  318. .It
  319. .Ar Junk
  320. .It
  321. .Ar Sent
  322. .It
  323. .Ar Trash
  324. .El
  325. otherwise usage is inferred from the mailbox title.
  326. If for example your Sent folder is not named "Sent", you must explicitly set it.
  327. .It Ic conf_override Ar boolean
  328. .Pq Em optional
  329. Override global settings for this mailbox.
  330. Available sections to override are
  331. .Em pager, notifications, shortcuts, composing
  332. and the account options
  333. .Em identity
  334. and
  335. .Em index_style Ns
  336. \&.
  337. Example:
  338. .Bd -literal
  339. [accounts."imap.domain.tld".mailboxes."INBOX"]
  340. index_style = "plain"
  341. [accounts."imap.domain.tld".mailboxes."INBOX".pager]
  342. filter = ""
  343. .Ed
  344. .El
  345. .Sh COMPOSING
  346. Composing specific options
  347. .Bl -tag -width 36n
  348. .It Ic send_mail Ar String|SmtpServerConf
  349. Command to pipe new mail to (exit code must be 0 for success) or settings for an SMTP server connection.
  350. See section
  351. .Sx SMTP Connections
  352. for its fields.
  353. .It Ic editor_command Ar String
  354. Command to launch editor.
  355. Can have arguments.
  356. Draft filename is given as the last argument.
  357. If it's missing, the environment variable $EDITOR is looked up.
  358. .It Ic embed Ar boolean
  359. .Pq Em optional
  360. Embed editor within meli.
  361. Editor must be xterm compliant.
  362. .\" default value
  363. .Pq Em false
  364. .It Ic format_flowed Ar boolean
  365. .Pq Em optional
  366. Set format=flowed [RFC3676] in text/plain attachments.
  367. .\" default value
  368. .Pq Em true
  369. .It Ic default_header_values Ar hash table String[String]
  370. Default header values used when creating a new draft.
  371. .El
  372. .Sh SHORTCUTS
  373. Shortcuts can take the following values:
  374. .Bl -bullet -compact
  375. .It
  376. .Em Backspace
  377. .It
  378. .Em Left
  379. .It
  380. .Em Right
  381. .It
  382. .Em Up
  383. .It
  384. .Em Down
  385. .It
  386. .Em Home
  387. .It
  388. .Em End
  389. .It
  390. .Em PageUp
  391. .It
  392. .Em PageDown
  393. .It
  394. .Em Delete
  395. .It
  396. .Em Insert
  397. .It
  398. .Em Enter
  399. .It
  400. .Em Tab
  401. .It
  402. .Em Esc
  403. .It
  404. .Em F1..F12
  405. .It
  406. .Em M-char
  407. .It
  408. .Em C-char
  409. .It
  410. .Em char
  411. .El
  412. .Em char
  413. is a single character string.
  414. .sp
  415. The headings before each list indicate the map key of the shortcut list.
  416. For example for the first list titled
  417. .Em general
  418. the configuration is typed as follows:
  419. .Bd -literal
  420. [shortcuts.general]
  421. next_tab = 'T'
  422. .Ed
  423. .sp
  424. and for
  425. .Em compact-listing Ns
  426. :
  427. .Bd -literal
  428. [shortcuts.compact-listing]
  429. open_thread = "Enter"
  430. exit_thread = 'i'
  431. .Ed
  432. .sp
  433. .Pp
  434. .Em general
  435. .Bl -tag -width 36n
  436. .It Ic next_tab
  437. Go to next tab.
  438. .\" default value
  439. .Pq Em T
  440. .It Ic go_to_tab
  441. Go to the
  442. .Em n Ns
  443. th tab
  444. .Pq Em cannot be redefined
  445. .El
  446. .sp
  447. .Em listing
  448. .Bl -tag -width 36n
  449. .It Ic prev_page
  450. Go to previous page.
  451. .\" default value
  452. .Pq Em PageUp
  453. .It Ic next_page
  454. Go to next page.
  455. .\" default value
  456. .Pq Em PageDown
  457. .It Ic prev_mailbox
  458. Go to previous mailbox.
  459. .\" default value
  460. .Pq Em K
  461. .It Ic next_mailbox
  462. Go to next mailbox.
  463. .\" default value
  464. .Pq Em J
  465. .It Ic prev_account
  466. Go to previous account.
  467. .\" default value
  468. .Pq Em l
  469. .It Ic next_account
  470. Go to next account.
  471. .\" default value
  472. .Pq Em h
  473. .It Ic new_mail
  474. Start new mail draft in new tab
  475. .\" default value
  476. .Pq Em m
  477. .It Ic set_seen
  478. Set thread as seen.
  479. .\" default value
  480. .Pq Em n
  481. .It Ic refresh
  482. Manually request a mailbox refresh.
  483. .\" default value
  484. .Pq Em F5
  485. .It Ic search
  486. Search within list of e-mails.
  487. .\" default value
  488. .Pq Em /
  489. .It Ic toggle_menu_visibility
  490. Toggle visibility of side menu in mail list.
  491. .\" default value
  492. .Pq Em `
  493. .El
  494. .sp
  495. .Em compact-listing
  496. .Bl -tag -width 36n
  497. .It Ic exit_thread
  498. Exit thread view
  499. .\" default value
  500. .Pq Em i
  501. .It Ic open_thread
  502. Open thread.
  503. .\" default value
  504. .Pq Em Enter
  505. .It Ic select_entry
  506. Select thread entry.
  507. .\" default value
  508. .Pq Em v
  509. .El
  510. .sp
  511. .Em pager
  512. .Bl -tag -width 36n
  513. .It Ic scroll_up
  514. Scroll up pager.
  515. .\" default value
  516. .Pq Em k
  517. .It Ic scroll_down
  518. Scroll down pager.
  519. .\" default value
  520. .Pq Em j
  521. .It Ic page_up
  522. Go to previous pager page
  523. .\" default value
  524. .Pq Em PageUp
  525. .It Ic page_down
  526. Go to next pager pag
  527. .\" default value
  528. .Pq Em PageDown
  529. .El
  530. .sp
  531. .Em contact-list
  532. .Bl -tag -width 36n
  533. .It Ic create_contact
  534. Create new contact.
  535. .\" default value
  536. .Pq Em c
  537. .It Ic edit_contact
  538. Edit contact under cursor
  539. .\" default value
  540. .Pq Em e
  541. .It Ic mail_contact
  542. Mail contact under cursor
  543. .\" default value
  544. .Pq Em m
  545. .It Ic toggle_menu_visibility
  546. Toggle visibility of side menu in mail list.
  547. .\" default value
  548. .Pq Em `
  549. .El
  550. .sp
  551. .sp
  552. .Em composing
  553. .Bl -tag -width 36n
  554. .It Ic send_mail
  555. Deliver draft to mailer
  556. .\" default value
  557. .Pq Em s
  558. .It Ic edit_mail
  559. Edit mail.
  560. .\" default value
  561. .Pq Em e
  562. .El
  563. .sp
  564. .Em envelope-view
  565. .Pp
  566. 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.
  567. .Bl -tag -width 36n
  568. .It Ic add_addresses_to_contacts Ns
  569. Select addresses from envelope to add to contacts.
  570. .\" default value
  571. .Pq Em c
  572. .It Ic view_raw_source
  573. View raw envelope source in a pager.
  574. .\" default value
  575. .Pq Em M-r
  576. .It Ic reply
  577. Reply to envelope.
  578. .\" default value
  579. .Pq Em R
  580. .It Ic edit
  581. Open envelope in composer.
  582. .\" default value
  583. .Pq Em e
  584. .It Ic return_to_normal_view
  585. Return to envelope if viewing raw source or attachment.
  586. .\" default value
  587. .Pq Em r
  588. .It Ic open_attachment
  589. Opens selected attachment with
  590. .Cm xdg-open
  591. .\" default value
  592. .Pq Em a
  593. .It Ic open_mailcap
  594. Opens selected attachment according to its mailcap entry.
  595. See
  596. .Xr meli 1 FILES
  597. for the mailcap file locations.
  598. .\" default value
  599. .Pq Em m
  600. .It Ic go_to_url
  601. Go to url of given index
  602. .\" default value
  603. .Pq Em g
  604. .It Ic toggle_url_mode
  605. Toggles url open mode.
  606. When active, it prepends an index next to each url that you can select by typing the index and open by issuing
  607. .Ic go_to_url
  608. .\" default value
  609. .Pq Em u
  610. .It Ic toggle_expand_headers
  611. Expand extra headers (References and others)
  612. .\" default value
  613. .Pq Em h
  614. .El
  615. .sp
  616. .Em thread-view
  617. .Bl -tag -width 36n
  618. .It Ic reverse_thread_order
  619. Reverse thread order.
  620. .\" default value
  621. .Pq Em r
  622. .It Ic toggle_mailview
  623. Toggle mail view visibility.
  624. .\" default value
  625. .Pq Em p
  626. .It Ic toggle_threadview
  627. Toggle thread view visibility.
  628. .\" default value
  629. .Pq Em t
  630. .It Ic collapse_subtree
  631. Collapse thread branches.
  632. .\" default value
  633. .Pq Em h
  634. .It Ic prev_page
  635. Go to previous page.
  636. .\" default value
  637. .Pq Em PageUp
  638. .It Ic next_page
  639. Go to next page.
  640. .\" default value
  641. .Pq Em PageDown
  642. .El
  643. .sp
  644. .Sh NOTIFICATIONS
  645. .Bl -tag -width 36n
  646. .It Ic enable Ar boolean
  647. Enable freedesktop-spec notifications.
  648. .\" default value
  649. .Pq Em true
  650. .It Ic script Ar String
  651. .Pq Em optional
  652. Script to pass notifications to, with title as 1st arg and body as 2nd
  653. .\" default value
  654. .Pq Em none Ns
  655. \&.
  656. .It Ic xbiff_file_path Ar String
  657. .Pq Em optional
  658. File that gets its size updated when new mail arrives.
  659. .Pq Em none
  660. .\" default value
  661. .It Ic play_sound Ar boolean
  662. .Pq Em optional
  663. Play theme sound in notifications if possible.
  664. .Pq Em false
  665. .\" default value
  666. .It Ic sound_file Ar String
  667. .Pq Em optional
  668. Play sound file in notifications if possible.
  669. .\" default value
  670. .Pq Em none
  671. .El
  672. .Sh PAGER
  673. .Bl -tag -width 36n
  674. .It Ic headers_sticky Ar boolean
  675. .Pq Em optional
  676. Always show headers when scrolling.
  677. .\" default value
  678. .Pq Em true
  679. .It Ic html_filter Ar String
  680. .Pq Em optional
  681. Pipe html attachments through this filter before display
  682. .\" default value
  683. .Pq Em none
  684. .It Ic filter Ar String
  685. .Pq Em optional
  686. A command to pipe mail output through for viewing in pager.
  687. .\" default value
  688. .Pq Em none
  689. .It Ic format_flowed Ar bool
  690. .Pq Em optional
  691. Respect format=flowed
  692. .\" default value
  693. .Pq Em true
  694. .It Ic split_long_lines Ar bool
  695. .Pq Em optional
  696. Split long lines that would overflow on the x axis.
  697. .\" default value
  698. .Pq Em true
  699. .It Ic minimum_width Ar num
  700. .Pq Em optional
  701. Minimum text width in columns.
  702. .\" default value
  703. .Pq Em 80
  704. .It Ic auto_choose_multipart_alternative Ar boolean
  705. .Pq Em optional
  706. Choose `text/html` alternative if `text/plain` is empty in `multipart/alternative` attachments.
  707. .\" default value
  708. .Pq Em true
  709. .El
  710. .Sh LISTING
  711. .Bl -tag -width 36n
  712. .It Ic datetime_fmt Ar String
  713. .Pq Em optional
  714. Datetime formatting passed verbatim to strftime(3).
  715. .\" default value
  716. .Pq Em \&%Y-\&%m-\&%d \&%T
  717. .It Ic recent_dates Ar Boolean
  718. .Pq Em optional
  719. Show recent dates as `X {minutes,hours,days} ago`, up to 7 days.
  720. .\" default value
  721. .Pq Em true
  722. .It Ic filter Ar Query
  723. .Pq Em optional
  724. Show only envelopes matching this query.
  725. .Po
  726. For query syntax see
  727. .Xr meli 1 QUERY ABNF SYNTAX
  728. .Pc
  729. .\" default value
  730. .Pq Em None
  731. .Pp
  732. Example:
  733. .Bd -literal
  734. filter = "not flags:seen" # show only unseen messages
  735. .Ed
  736. .El
  737. .Sh TAGS
  738. .Bl -tag -width 36n
  739. .It Ic colours Ar hash table String[Color]
  740. .Pq Em optional
  741. Set UI colors for tags
  742. .It Ic ignore_tags Ar Array String
  743. .Pq Em optional
  744. Hide tags (not the tagged messages themselves)
  745. .El
  746. .sp
  747. Example:
  748. .sp
  749. .Bd -literal
  750. [tags]
  751. # valid inputs: #HHHHHH, #ABC -> #AABBCC, XTERM_NAME, 0-255 byte
  752. colors = { signed="#Ff6600", replied="DeepSkyBlue4", draft="#f00", replied="8" }
  753. [accounts.dummy]
  754. \&...
  755. [accounts.dummy.mailboxes]
  756. # per mailbox override:
  757. "INBOX" = { tags.ignore_tags=["inbox", ] }
  758. .Ed
  759. .Sh PGP
  760. .Bl -tag -width 36n
  761. .It Ic auto_verify_signatures Ar boolean
  762. Auto verify signed e-mail according to RFC3156
  763. .\" default value
  764. .Pq Em true
  765. .It Ic auto_sign Ar boolean
  766. .Pq Em optional
  767. Always sign sent messages
  768. .\" default value
  769. .Pq Em false
  770. .It Ic key Ar String
  771. .Pq Em optional
  772. Key to be used when signing/encrypting (not functional yet)
  773. .\" default value
  774. .Pq Em none
  775. .It Ic gpg_binary Ar String
  776. .Pq Em optional
  777. The gpg binary name or file location to use
  778. .\" default value
  779. .Pq Em "gpg2"
  780. .El
  781. .Sh TERMINAL
  782. .Bl -tag -width 36n
  783. .It Ic theme Ar String
  784. .Pq Em optional
  785. Theme name to use.
  786. .\" default value
  787. .Pq Em dark
  788. .It Ic ascii_drawing Ar boolean
  789. .Pq Em optional
  790. If true, box drawing will be done with ascii characters.
  791. .\" default value
  792. .Pq Em false
  793. .It Ic use_color Ar boolean
  794. .Pq Em optional
  795. If false, no ANSI colors are used.
  796. .\" default value
  797. .Pq Em true
  798. .It Ic window_title Ar String
  799. .Pq Em optional
  800. Set window title in xterm compatible terminals An empty string means no window title is set.
  801. .\" default value
  802. .Pq Em "meli"
  803. .It Ic themes Ar hash table String[String[Attribute]]
  804. Define UI themes.
  805. See
  806. .Xr meli-themes 5
  807. for details.
  808. .Bd -literal
  809. [terminal]
  810. theme = "themeB"
  811. [terminal.themes.themeA]
  812. "mail.view.body" = {fg = "HotPink3", bg = "LightSalmon1"}
  813. \&...
  814. [terminal.themes.themeB]
  815. "mail.view.body" = {fg = "CadetBlue", bg = "White"}
  816. \&...
  817. [terminal.themes.themeC]
  818. \&...
  819. .Ed
  820. .El
  821. .Sh LOG
  822. .Bl -tag -width 36n
  823. .It Ic log_file Ar String
  824. .Pq Em optional
  825. path of the log file
  826. .\" default value
  827. .Pq Pa $XDG_DATA_HOME/meli/meli.log
  828. .It Ic maximum_level Ar String
  829. .Pq Em optional
  830. maximum level of messages to log.
  831. All levels less or equal to the
  832. .Ic maximum_level
  833. will be appended to the log file.
  834. Available levels are, in partial order:
  835. .Bl -bullet -compact
  836. .It
  837. .Em OFF
  838. .It
  839. .Em FATAL
  840. .It
  841. .Em ERROR
  842. .It
  843. .Em WARN
  844. .It
  845. .Em INFO
  846. .It
  847. .Em DEBUG
  848. .It
  849. .Em TRACE
  850. .El
  851. This means that to turn logging off, set
  852. .Ic maximum_level
  853. to
  854. .Em OFF Ns
  855. \&.
  856. .\" default value
  857. .Pq Em INFO
  858. .El
  859. .Sh SMTP Connections
  860. .Bl -tag -width 36n
  861. .It Ic hostname Ar String
  862. server hostname
  863. .It Ic port Ar Integer
  864. server port
  865. .It Ic envelope_from Ar String
  866. .Pq Em optional
  867. address to set as sender in SMTP transactions
  868. .\" default value
  869. .Pq Em none
  870. .It Ic auth Ar SmtpAuth
  871. SMTP server authentication.
  872. See
  873. .Sx SmtpAuth
  874. subsection.
  875. .It Ic security Ar SmtpSecurity
  876. .Pq Em optional
  877. gpg binary name or file location to use
  878. .\" default value
  879. .Po see
  880. .Sx SmtpSecurity
  881. subsection
  882. .Pc
  883. .It Ic extensions Ar SmtpExtensions
  884. .Pq Em optional
  885. set support for SMTP extensions if they are advertised by the server
  886. .\" default value
  887. .Po see
  888. .Sx SmtpExtensions
  889. subsection
  890. .Pc
  891. .El
  892. .Ss SmtpAuth
  893. .Bl -tag -width 36n
  894. .It Ic type Ar "none" | "auto"
  895. .El
  896. .Pp
  897. For type "auto":
  898. .Bl -tag -width 36n
  899. .It Ic username Ar String
  900. .It Ic password Ar String|SmtpPassword
  901. .It Ic require_auth Ar bool
  902. .Pq Em optional
  903. require authentication in every case
  904. .\" default value
  905. .Pq Em true
  906. .El
  907. .Ss SmtpPassword
  908. .Bl -tag -width 36n
  909. .It Ic type Ar "raw" | "command_evaluation"
  910. .It Ic value Ar String
  911. Either a raw password string, or command to execute.
  912. .El
  913. .Ss SmtpSecurity
  914. Default security type is
  915. .Em auto Ns
  916. \&.
  917. .Bl -tag -width 36n
  918. .It Ic type Ar "none" | "auto" | "starttls" | "tls"
  919. .It Ic danger_accept_invalid_certs Ar bool
  920. Accept invalid SSL/TLS certificates
  921. .\" default value
  922. .Pq Em false
  923. .El
  924. .Ss SmtpExtensions
  925. .Bl -tag -width 36n
  926. .It Ic pipelining Ar bool
  927. rfc2920
  928. .\" default value
  929. .Pq Em true
  930. .It Ic chunking Ar bool
  931. rfc3030
  932. .\" default value
  933. .Pq Em true
  934. .It Ic prdr Ar bool
  935. draft-hall-prdr-00
  936. .\" default value
  937. .Pq Em true
  938. .It Ic dsn_notify Ar String
  939. RFC3461
  940. .\" default value
  941. .Pq Em FAILURE
  942. .El
  943. .Sh SEE ALSO
  944. .Xr meli 1 ,
  945. .Xr meli-themes 5
  946. .Sh CONFORMING TO
  947. TOML Standard v.0.5.0 https://toml.io/en/v0.5.0
  948. .Sh AUTHORS
  949. Copyright 2017-2019
  950. .An Manos Pitsidianakis Aq epilys@nessuent.xyz
  951. Released under the GPL, version 3 or greater.
  952. This software carries no warranty of any kind.
  953. (See COPYING for full copyright and warranty notices.)
  954. .Pp
  955. .Aq https://meli.delivery