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.
 
 
 
 

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