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.

mw.1 7.9 KiB

5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231
  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. <command>
  7. .SH DESCRIPTION
  8. .B mw
  9. takes a user email account and sets up a terminal-based email interface for it with
  10. .B neomutt.
  11. This can include offline email with
  12. .B isync/mbsync
  13. and configs for
  14. .B msmtp
  15. for sending mail, and also passwords automatically encrypted and stored with
  16. .B pass.
  17. .SH COMMANDS
  18. .TP
  19. .B add
  20. configure an email account
  21. .TP
  22. .B ls
  23. list all email accounts configured by mutt-wizard
  24. .TP
  25. .B delete
  26. delete the configuration files for an already configured email account
  27. .TP
  28. .B purge
  29. totally purge all local mutt-wizard accounts
  30. .TP
  31. .B cron
  32. toggle a cronjob that will automatically sync mail with
  33. .B mailsync
  34. as often as you wish
  35. .SH DETAILS
  36. .TP
  37. .B Mail location
  38. If the user chooses to keep offline email with
  39. .B isync,
  40. it will be kept in
  41. .I ~/.local/share/mail/.
  42. .B notmuch
  43. can be used to index and search this mail by giving this directory when first running
  44. .B notmuch setup.
  45. 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.
  46. .TP
  47. .B muttrc files
  48. mutt-wizard will create a muttrc file for each created account holding account-specific details. These will appear in
  49. .I ~/.config/mutt/accounts/
  50. 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
  51. .I ~/.config/mutt/muttrc
  52. file.
  53. .TP
  54. .B Mail deletion
  55. Neither
  56. .B delete
  57. or
  58. .B purge
  59. will delete 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.
  60. .TP
  61. .B Default settings
  62. 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
  63. .I /usr/local/share/mutt-wizard/mutt-wizard.muttrc
  64. and the default mailcap file can be found in
  65. .I
  66. /usr/local/share/mutt-wizard/mailcap.
  67. Any of these settings can be overwritten in
  68. .I ~/.config/mutt/muttrc,
  69. but be mindful that your overriding binds should appear after the
  70. .I
  71. mutt-wizard.muttrc
  72. file is sourced.
  73. .TP
  74. .B Detecting server settings
  75. mutt-wizard has a repository of email services and their server information kept in
  76. .I /usr/local/share/mutt-wizard/domains.csv
  77. which is used to automatically configure email settings.
  78. 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.
  79. If you would like to help develop mutt-wizard for others, you are invited to add this service information to
  80. .I domains.csv
  81. on mutt-wizard's Github <https://github.com/lukesmithxyz/mutt-wizard> or Gitlab <https://gitlab.com/lukesmithxyz/mutt-wizard> pages.
  82. .TP
  83. .B Gmail accounts
  84. 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>.
  85. .B Protonmail accounts
  86. 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.
  87. .B Enterprise and university accounts
  88. 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.
  89. .TP
  90. .B Password decryption
  91. mutt-wizard uses
  92. .I pass
  93. and therefore
  94. .I gpg
  95. 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.
  96. Because of this I strongly recommend the program
  97. .I pam-gnupg
  98. <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.
  99. If you don't want to use this program, you can also increase the cache time of an inputted GPG password with the
  100. .I default-cache-ttl
  101. and
  102. .I max-cache-ttl
  103. variables in your
  104. .I
  105. gpg-agent.conf.
  106. .SH MUTT-WIZARD'S NEOMUTT CONFIGURATION
  107. 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.
  108. .TP
  109. .B Color
  110. 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.
  111. .TP
  112. .B Movement with h/j/k/l
  113. Use vim keys to move down
  114. .I j
  115. or up
  116. .I k
  117. in mail, while
  118. .I l
  119. opens mail, then the attachment view, then an attachment, while
  120. .I h
  121. is the reverse.
  122. While mail is open, go to next or previous mail with
  123. .I J
  124. and
  125. .I K.
  126. In the mail index,
  127. .I d
  128. and
  129. .I u
  130. go down and up by a half page and
  131. .I gg
  132. and
  133. .I G
  134. go to the very top and very bottom.
  135. .TP
  136. .B Search mail
  137. If you have
  138. .B notmuch
  139. configured with your proper mail directory (see above), you may run
  140. .I ctrl-f
  141. to search for mail containing any given sequence.
  142. Even without notmuch,
  143. .I L
  144. limits mail, showing only those with the given sequence in the subject while
  145. .I A
  146. shows all mail (same as limiting to "all").
  147. .TP
  148. .B Deleting mail
  149. .I D
  150. deletes mail, while
  151. .I U
  152. undeletes it (type in mail number to get to deleted mail). Note that
  153. .I S
  154. saves your mailbox, finalizing deletion. If you have a
  155. .I Trash
  156. box, deleted mail is moved there. If you want it to skip that and simply be deleted, comment out or remove the
  157. .I set trash
  158. line in that account's muttrc.
  159. .TP
  160. .B Send mail
  161. .I m
  162. creates a new mail message;
  163. .I r
  164. replies to the selected message;
  165. .I R
  166. replies all to the selected message and
  167. .I f
  168. fowards the selected message.
  169. .TP
  170. .B Compose mail screen
  171. Once you write mail and save the buffer you will be brought to the compose screen. Press
  172. .I a
  173. to add attachments, use
  174. .I s/t/c/b/d
  175. to change the subject/to/CC/BCC/description. Press
  176. .I S
  177. to change the signature/encryption. Press
  178. .I y
  179. to send the mail.
  180. .TP
  181. .B Saving and autocompleting email addresses with abook
  182. Install the optional dependency abook and you will be able to save the sender's email address with
  183. .I a.
  184. Once this is done, when you are typing in any email/contact prompt, you may press
  185. .I Tab
  186. to find contacts matching your input. Although abook is often used with mutt, it is also a useful program in its own right.
  187. .TP
  188. .B Switching and moving mail between mailboxes
  189. The
  190. .I g
  191. 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
  192. .I g,
  193. you can also press
  194. .I C
  195. to copy mail or
  196. .I M
  197. to move mail to the same boxes.
  198. .TP
  199. .B Switching between accounts
  200. mutt-wizard can configure as many as nine accounts each numbered by the lowest available number when configured. Press
  201. .I i
  202. followed by an account's number to change to that account: i2, i5, etc.
  203. .I ctrl-b
  204. to open a menu to select a url you want to open in you browser.
  205. .TP
  206. .B Sidebar
  207. mutt-wizard enables the sidebar by default which displays your account's boxes with mail tallies.
  208. .I B
  209. will toggle the sidebar. Move up and down in it with
  210. .I ctrl-k/j.
  211. Open a box with
  212. .I ctrl-o.
  213. .TP
  214. .B More information
  215. Remember that you can press
  216. .I ?
  217. at any time in neomutt to get a list of all key-bindings and functions. This list can also vary for different context menus.
  218. .SH AUTHORS
  219. Written by Luke Smith <luke@lukesmith.xyz> originally in 2018.
  220. .SH LICENSE
  221. GPLv3
  222. .SH SEE ALSO
  223. .BR neomutt (1),
  224. .BR neomuttrc (1)
  225. .BR mbsync (1),
  226. .BR msmtp (1),
  227. .BR notmuch (1),
  228. .BR abook (1)