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