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.
 
 
 
 

268 rivejä
9.0 KiB

  1. .TH MW 1 mutt-wizard
  2. .SH NAME
  3. mw \- mutt-wizard \- autoconfigure email accounts for neomutt and isync
  4. .SH SYNOPSIS
  5. .B mw
  6. [
  7. .I OPTIONS
  8. ]
  9. .SH DESCRIPTION
  10. .B mw
  11. takes a user email account and sets up a terminal-based email interface for it with
  12. .B neomutt.
  13. This can include offline email with
  14. .B isync/mbsync
  15. and configs for
  16. .B msmtp
  17. for sending mail, and also passwords automatically encrypted and stored with
  18. .B pass.
  19. .SH COMMANDS
  20. .TP
  21. .B -a your@email.com
  22. add an email address
  23. .TP
  24. .B -l
  25. list all email accounts configured by mutt-wizard
  26. .TP
  27. .B -d
  28. pick an already configured account and remove its configuration
  29. .TP
  30. .B -D your@email.com
  31. remove a configured account without confirmation
  32. .TP
  33. .B -y your@email.com
  34. download and upload mail for an email account
  35. .TP
  36. .B -Y
  37. sync all email accounts
  38. .SH OPTIONS FOR ADDING ACCOUNTS
  39. These can be specified on the command line, otherwise, you will be prompted for what is necessary. mutt-wizard knows the IMAP/SMTP server information for most email providers, so specifying them is usually redundant.
  40. .TP
  41. .B -u billy
  42. Account logon/username if required and different from email address.
  43. .TP
  44. .B -n Billy
  45. Real name which will appear in emails. Should be put in quotes if multiple words.
  46. .TP
  47. .B -m number
  48. Set a maximum number of messages to be stored offline.
  49. .TP
  50. .B -i
  51. IMAP server address
  52. .TP
  53. .B -I
  54. IMAP server port (assumed to be 993 if not specified)
  55. .TP
  56. .B -s
  57. SMTP server address
  58. .TP
  59. .B -S
  60. SMTP server port (assumed to be 587 if not specified)
  61. .SH OTHER OPTIONS
  62. .TP
  63. .B -f
  64. Force account creation and guess mailboxes without attempting to connect to server. Otherwise if connection cannot be made, the configured account settings will not be persistent.
  65. .TP
  66. .B -o
  67. Create settings for an account to be used online only without mail syncing abilities. Without
  68. .B -f
  69. connection will still be attempted in setup to discover mailboxes.
  70. .TP
  71. .B -p
  72. Add a Protonmail account. Protonmail Bridge must be installed and set up.
  73. .SH DETAILS
  74. .TP
  75. .B Mail location
  76. If the user chooses to keep offline email with
  77. .B isync,
  78. it will be kept in
  79. .I ~/.local/share/mail/.
  80. .B notmuch
  81. can be used to index and search this mail by giving this directory when first running
  82. .B notmuch setup.
  83. If you have not set up notmuch before, mutt-wizard will automatically set it up in the background the first time you add an account.
  84. .TP
  85. .B muttrc files
  86. mutt-wizard will create a muttrc file for each created account holding account-specific details. These will appear in
  87. .I ~/.config/mutt/accounts/
  88. and can be edited by the user if needbe. Note that the mutt-wizard will also source these files and create the bindings to switch between them, and these will appear in your default
  89. .I ~/.config/mutt/muttrc
  90. file.
  91. .TP
  92. .B Mail deletion
  93. mutt-wizard's delete action will delete configuration files and
  94. .I not
  95. downloaded mail for safety (and time)'s sake. If you want to delete downloaded mail, do so manually by removing it from the directory above.
  96. .TP
  97. .B Default settings
  98. The mutt-wizard has many default settings that focus on making it aesthetically pleasing and supplying more vim-like bindings. These can be found in
  99. .I /usr/local/share/mutt-wizard/mutt-wizard.muttrc
  100. and the default mailcap file can be found in
  101. .I
  102. /usr/local/share/mutt-wizard/mailcap.
  103. Any of these settings can be overwritten in
  104. .I ~/.config/mutt/muttrc,
  105. but be mindful that your overriding binds should appear after the
  106. .I
  107. mutt-wizard.muttrc
  108. file is sourced.
  109. .TP
  110. .B Detecting server settings
  111. mutt-wizard has a repository of email services and their server information kept in
  112. .I /usr/local/share/mutt-wizard/domains.csv
  113. which is used to automatically configure email settings.
  114. If your email provider is not found there, it will prompt you to input your email service's IMAP and SMTP server information which can usually be found by searching online.
  115. If you would like to help develop mutt-wizard for others, you are invited to add this service information to
  116. .I domains.csv
  117. on mutt-wizard's Github <https://github.com/lukesmithxyz/mutt-wizard> or Gitlab <https://gitlab.com/lukesmithxyz/mutt-wizard> pages.
  118. .TP
  119. .B Gmail accounts
  120. Google will require you to allow "less-secure" (third party) applications or use two-factor authentication in order to access their IMAP servers to download your mail. If you use Gmail, be sure to handle this before running mutt-wizard <https://support.google.com/accounts/answer/6010255>.
  121. .B Protonmail accounts
  122. Protonmail users must use the Protonmail Bridge <https://protonmail.com/bridge/> to access their IMAP and SMTP servers. This too should be configured before running mutt-wizard.
  123. .B Enterprise and university accounts
  124. Many universities and businesses might host their domain's email via Google or another service. This often requires a special IMAP/SMTP-specific password that you must generate and use. Again, mutt-wizard can handle these systems, but only once they've been set up.
  125. .TP
  126. .B Password decryption
  127. mutt-wizard uses
  128. .I pass
  129. and therefore
  130. .I gpg
  131. to decrypt your passwords. Provided your GPG key has a password, this might mean that you will be prompted for your GPG password the first time you sync or send mail in a session. Once your password is cached, it might also expire later as well.
  132. Because of this I strongly recommend the program
  133. .I pam-gnupg
  134. <https://github.com/cruegge/pam-gnupg> which automatically unlocks your GPG password on login and keeps it active, thus giving you, with mutt-wizard, secure access to all your email accounts on your system without ever having to input a password.
  135. If you don't want to use this program, you can also increase the cache time of an inputted GPG password with the
  136. .I default-cache-ttl
  137. and
  138. .I max-cache-ttl
  139. variables in your
  140. .I
  141. gpg-agent.conf.
  142. .SH MUTT-WIZARD'S NEOMUTT CONFIGURATION
  143. Here is a list of not only mutt-wizard's particular defaults, but what you need to get the most out of email accounts configured with mutt-wizard.
  144. .TP
  145. .B Color
  146. The mutt-wizard's default settings add color to messages in the index and color mail details to make them easier to see. New mail, in addition to being marked by the typical N, will also be bold.
  147. .TP
  148. .B Movement with h/j/k/l
  149. Use vim keys to move down
  150. .I j
  151. or up
  152. .I k
  153. in mail, while
  154. .I l
  155. opens mail, then the attachment view, then an attachment, while
  156. .I h
  157. is the reverse.
  158. While mail is open, go to next or previous mail with
  159. .I J
  160. and
  161. .I K.
  162. In the mail index,
  163. .I d
  164. and
  165. .I u
  166. go down and up by a half page and
  167. .I gg
  168. and
  169. .I G
  170. go to the very top and very bottom.
  171. .TP
  172. .B Search mail
  173. If you have
  174. .B notmuch
  175. configured with your proper mail directory (see above), you may run
  176. .I ctrl-f
  177. to search for mail containing any given sequence.
  178. Even without notmuch,
  179. .I L
  180. limits mail, showing only those with the given sequence in the subject while
  181. .I A
  182. shows all mail (same as limiting to "all").
  183. .TP
  184. .B Deleting mail
  185. .I D
  186. deletes mail, while
  187. .I U
  188. undeletes it (type in mail number to get to deleted mail). Note that
  189. .I S
  190. saves your mailbox, finalizing deletion. If you have a
  191. .I Trash
  192. box, deleted mail is moved there. If you want it to skip that and simply be deleted, comment out or remove the
  193. .I set trash
  194. line in that account's muttrc.
  195. .TP
  196. .B Send mail
  197. .I m
  198. creates a new mail message;
  199. .I r
  200. replies to the selected message;
  201. .I R
  202. replies all to the selected message and
  203. .I f
  204. fowards the selected message.
  205. .TP
  206. .B Compose mail screen
  207. Once you write mail and save the buffer you will be brought to the compose screen. Press
  208. .I a
  209. to add attachments, use
  210. .I s/t/c/b/d
  211. to change the subject/to/CC/BCC/description. Press
  212. .I S
  213. to change the signature/encryption. Press
  214. .I y
  215. to send the mail.
  216. .TP
  217. .B Saving and autocompleting email addresses with abook
  218. Install the optional dependency abook and you will be able to save the sender's email address with
  219. .I a.
  220. Once this is done, when you are typing in any email/contact prompt, you may press
  221. .I Tab
  222. to find contacts matching your input. Although abook is often used with mutt, it is also a useful program in its own right.
  223. .TP
  224. .B Switching and moving mail between mailboxes
  225. The
  226. .I g
  227. key can be paired with several other keys to automatically move to another mailbox: gi: Inbox; gs: Sent; gd: Drafts; ga: Archive; gS: Spam; gj: Junk; gt: Trash. These bindings will only be present for accounts that have the boxes in question. Instead of
  228. .I g,
  229. you can also press
  230. .I C
  231. to copy mail or
  232. .I M
  233. to move mail to the same boxes.
  234. .TP
  235. .B Switching between accounts
  236. mutt-wizard can configure as many as nine accounts each numbered by the lowest available number when configured. Press
  237. .I i
  238. followed by an account's number to change to that account: i2, i5, etc.
  239. .I ctrl-b
  240. to open a menu to select a url you want to open in you browser.
  241. .TP
  242. .B Sidebar
  243. mutt-wizard enables the sidebar by default which displays your account's boxes with mail tallies.
  244. .I B
  245. will toggle the sidebar. Move up and down in it with
  246. .I ctrl-k/j.
  247. Open a box with
  248. .I ctrl-o.
  249. .TP
  250. .B More information
  251. Remember that you can press
  252. .I ?
  253. at any time in neomutt to get a list of all key-bindings and functions. This list can also vary for different context menus.
  254. .SH AUTHORS
  255. Written by Luke Smith <luke@lukesmith.xyz> originally in 2018.
  256. .SH LICENSE
  257. GPLv3
  258. .SH SEE ALSO
  259. .BR neomutt (1),
  260. .BR neomuttrc (1)
  261. .BR mbsync (1),
  262. .BR msmtp (1),
  263. .BR notmuch (1),
  264. .BR abook (1)