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.

5 jaren geleden
5 jaren geleden
4 jaren geleden
5 jaren geleden
5 jaren geleden
5 jaren geleden
5 jaren geleden
4 jaren geleden
5 jaren geleden
4 jaren geleden
5 jaren geleden
4 jaren geleden
5 jaren geleden
4 jaren geleden
5 jaren geleden
4 jaren geleden
4 jaren geleden
5 jaren geleden
5 jaren geleden
5 jaren geleden
5 jaren geleden
5 jaren geleden
5 jaren geleden
4 jaren geleden
5 jaren geleden
5 jaren geleden
5 jaren geleden
5 jaren geleden
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270
  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. .TP
  62. .B -x
  63. Account password. You will be prompted for the password interactively if this option is not given.
  64. .SH OTHER OPTIONS
  65. .TP
  66. .B -f
  67. 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.
  68. .TP
  69. .B -o
  70. Create settings for an account to be used online only without mail syncing abilities. Without
  71. .B -f
  72. connection will still be attempted in setup to discover mailboxes.
  73. .TP
  74. .B -p
  75. Add a Protonmail account. Protonmail Bridge must be installed and set up.
  76. .SH DETAILS
  77. .TP
  78. .B Mail location
  79. If the user chooses to keep offline email with
  80. .B isync,
  81. it will be kept in
  82. .I ~/.local/share/mail/.
  83. .B notmuch
  84. can be used to index and search this mail by giving this directory when first running
  85. .B notmuch setup.
  86. 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.
  87. .TP
  88. .B muttrc files
  89. mutt-wizard will create a muttrc file for each created account holding account-specific details. These will appear in
  90. .I ~/.config/mutt/accounts/
  91. 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
  92. .I ~/.config/mutt/muttrc
  93. file.
  94. .TP
  95. .B Mail deletion
  96. mutt-wizard's delete action will delete configuration files and
  97. .I not
  98. 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.
  99. .TP
  100. .B Default settings
  101. 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
  102. .I /usr/local/share/mutt-wizard/mutt-wizard.muttrc
  103. and the default mailcap file can be found in
  104. .I
  105. /usr/local/share/mutt-wizard/mailcap.
  106. Any of these settings can be overwritten in
  107. .I ~/.config/mutt/muttrc,
  108. but be mindful that your overriding binds should appear after the
  109. .I
  110. mutt-wizard.muttrc
  111. file is sourced.
  112. .TP
  113. .B Detecting server settings
  114. mutt-wizard has a repository of email services and their server information kept in
  115. .I /usr/local/share/mutt-wizard/domains.csv
  116. which is used to automatically configure email settings.
  117. 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.
  118. If you would like to help develop mutt-wizard for others, you are invited to add this service information to
  119. .I domains.csv
  120. on mutt-wizard's Github <https://github.com/lukesmithxyz/mutt-wizard> or Gitlab <https://gitlab.com/lukesmithxyz/mutt-wizard> pages.
  121. .TP
  122. .B Gmail accounts
  123. 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>.
  124. .B Protonmail accounts
  125. 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.
  126. .B Enterprise and university accounts
  127. 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.
  128. .TP
  129. .B Password decryption
  130. mutt-wizard uses
  131. .I pass
  132. and therefore
  133. .I gpg
  134. 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.
  135. Because of this I strongly recommend the program
  136. .I pam-gnupg
  137. <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.
  138. If you don't want to use this program, you can also increase the cache time of an inputted GPG password with the
  139. .I default-cache-ttl
  140. and
  141. .I max-cache-ttl
  142. variables in your
  143. .I
  144. gpg-agent.conf.
  145. .SH MUTT-WIZARD'S NEOMUTT CONFIGURATION
  146. 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.
  147. .TP
  148. .B Color
  149. 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.
  150. .TP
  151. .B Movement with h/j/k/l
  152. Use vim keys to move down
  153. .I j
  154. or up
  155. .I k
  156. in mail, while
  157. .I l
  158. opens mail, then the attachment view, then an attachment, while
  159. .I h
  160. is the reverse.
  161. While mail is open, go to next or previous mail with
  162. .I J
  163. and
  164. .I K.
  165. In the mail index,
  166. .I d
  167. and
  168. .I u
  169. go down and up by a half page and
  170. .I gg
  171. and
  172. .I G
  173. go to the very top and very bottom.
  174. .TP
  175. .B Search mail
  176. If you have
  177. .B notmuch
  178. configured with your proper mail directory (see above), you may run
  179. .I ctrl-f
  180. to search for mail containing any given sequence.
  181. Even without notmuch,
  182. .I L
  183. limits mail, showing only those with the given sequence in the subject while
  184. .I A
  185. shows all mail (same as limiting to "all").
  186. .TP
  187. .B Deleting mail
  188. .I D
  189. deletes mail, while
  190. .I U
  191. undeletes it (type in mail number to get to deleted mail). Note that
  192. .I S
  193. saves your mailbox, finalizing deletion. If you have a
  194. .I Trash
  195. box, deleted mail is moved there. If you want it to skip that and simply be deleted, comment out or remove the
  196. .I set trash
  197. line in that account's muttrc.
  198. .TP
  199. .B Send mail
  200. .I m
  201. creates a new mail message;
  202. .I r
  203. replies to the selected message;
  204. .I R
  205. replies all to the selected message and
  206. .I f
  207. fowards the selected message.
  208. .TP
  209. .B Compose mail screen
  210. Once you write mail and save the buffer you will be brought to the compose screen. Press
  211. .I a
  212. to add attachments, use
  213. .I s/t/c/b/d
  214. to change the subject/to/CC/BCC/description. Press
  215. .I S
  216. to change the signature/encryption. Press
  217. .I y
  218. to send the mail.
  219. .TP
  220. .B Saving and autocompleting email addresses with abook
  221. Install the optional dependency abook and you will be able to save the sender's email address with
  222. .I a.
  223. Once this is done, when you are typing in any email/contact prompt, you may press
  224. .I Tab
  225. to find contacts matching your input. Although abook is often used with mutt, it is also a useful program in its own right.
  226. .TP
  227. .B Switching and moving mail between mailboxes
  228. The
  229. .I g
  230. 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
  231. .I g,
  232. you can also press
  233. .I C
  234. to copy mail or
  235. .I M
  236. to move mail to the same boxes.
  237. .TP
  238. .B Switching between accounts
  239. mutt-wizard can configure as many as nine accounts each numbered by the lowest available number when configured. Press
  240. .I i
  241. followed by an account's number to change to that account: i2, i5, etc.
  242. .I ctrl-b
  243. to open a menu to select a url you want to open in you browser.
  244. .TP
  245. .B Sidebar
  246. mutt-wizard enables the sidebar by default which displays your account's boxes with mail tallies.
  247. .I B
  248. will toggle the sidebar. Move up and down in it with
  249. .I ctrl-k/j.
  250. Open a box with
  251. .I ctrl-o.
  252. .TP
  253. .B More information
  254. Remember that you can press
  255. .I ?
  256. at any time in neomutt to get a list of all key-bindings and functions. This list can also vary for different context menus.
  257. .SH AUTHORS
  258. Written by Luke Smith <luke@lukesmith.xyz> originally in 2018.
  259. .SH LICENSE
  260. GPLv3
  261. .SH SEE ALSO
  262. .BR neomutt (1),
  263. .BR neomuttrc (1)
  264. .BR mbsync (1),
  265. .BR msmtp (1),
  266. .BR notmuch (1),
  267. .BR abook (1)