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.

README.md 11 KiB

6 years ago
5 years ago
2 years ago
5 years ago
5 years ago
6 years ago
3 years ago
5 years ago
5 years ago
3 years ago
3 years ago
3 years ago
3 years ago
5 years ago
5 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
5 years ago
5 years ago
5 years ago
5 years ago
3 years ago
3 years ago
2 years ago
3 years ago
3 years ago
5 years ago
3 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225
  1. # mutt-wizard
  2. https://muttwizard.com/
  3. Get this great stuff without effort:
  4. - A full-featured and autoconfigured email client on the terminal with neomutt
  5. - Mail stored offline enabling the ability to:
  6. * view and write emails while you're away from
  7. the internet
  8. * make backups
  9. - Provides a `mailsync` script that can be scheduled to run as often as you
  10. like, which downloads/syncs mail and optionally notifies you when new mail has arrived.
  11. Specifically, this wizard:
  12. - Determines your email server's IMAP and SMTP servers and ports
  13. - Creates dotfiles for `neomutt`, `isync`, and `msmtp` appropriate for your
  14. email address
  15. - Encrypts and locally stores your password for easy remote access, accessible
  16. only by your GPG key
  17. - Handles as many as nine separate email accounts automatically
  18. - Auto-creates bindings to switch between accounts or between mailboxes
  19. - Provides sensible defaults and an attractive appearance for the neomutt email
  20. client
  21. - If mutt-wizard doesn't know your server's IMAP/SMTP info by default, it will
  22. prompt you for them and will put them in all the right places.
  23. ## Install
  24. #### Dependencies
  25. - `neomutt` - the email client. (If you are using Gentoo GNU/Linux, you will need the `sasl` use flag to be enabled)
  26. - `curl` - tests connections (required at install).
  27. - `isync` - downloads and syncs the mail (required if storing IMAP mail locally).
  28. - `msmtp` - sends the email.
  29. - `pass` - safely encrypts passwords (required at install).
  30. - `ca-certificates` - required for SSL. Probably installed already.
  31. - `gettext` - writes config files. Probably installed already.
  32. **Note**: There's a chance of errors if you use a slow-release distro like
  33. Ubuntu, Debian, or Mint. If you get errors in `neomutt`, install the most
  34. recent version manually or manually remove the offending lines in the config in
  35. `/usr/share/mutt-wizard/mutt-wizard.muttrc`.
  36. ```bash
  37. git clone https://github.com/LukeSmithxyz/mutt-wizard
  38. cd mutt-wizard
  39. sudo make install
  40. ```
  41. A user of Arch-based distros can also install the current mutt-wizard release from the AUR as
  42. [mutt-wizard](https://aur.archlinux.org/packages/mutt-wizard/), or the Github master branch, [mutt-wizard-git](https://aur.archlinux.org/packages/mutt-wizard-git/).
  43. ### Optional Dependencies
  44. - `cyrus-sasl-xoauth2-git` - Support for OAUTH2.
  45. - `pam-gnupg` - Automatically logs you into your GPG key on login so you will
  46. never need to input your password once logged on to your system. Check the
  47. repo and directions out [here](https://github.com/cruegge/pam-gnupg).
  48. - `lynx` - view HTML email in neomutt.
  49. - `notmuch` - index and search mail. Install it and run `notmuch setup`, tell
  50. it that your mail is in `~/.local/share/mail/` (although `mw` will do this
  51. automatically if you haven't set notmuch up before). You can run it in mutt
  52. with <kbd>ctrl-f</kbd>. Run `notmuch new` to process new mail.
  53. - `abook` - a terminal-based address book. Pressing tab while typing an address
  54. to send mail to will suggest contacts that are in your abook.
  55. - `urlview` - outputs urls in mail to browser.
  56. - `cronie` - (or any other major cronjob manager) to set up automatic mail
  57. syncing.
  58. - `mpop` - If you want to use POP protocol instead of IMAP.
  59. ## Usage
  60. The mutt-wizard runs via the command `mw`. Once setup is complete, you'll use
  61. `neomutt` to access your mail.
  62. - `mw -a you@email.com` -- add a new email account
  63. - `mw -l` -- list existing accounts
  64. - `mw -d` -- choose an account to delete
  65. - `mw -D your@email.com` -- delete account settings without confirmation
  66. - `mw -t 30` -- toggle automatic mailsync to every 30 minutes
  67. - `mw -T` -- toggle mailsync without specifying minutes (default is 10)
  68. - `mw -r` -- reorder account shortcut numbers
  69. - `pass edit mw-your@email.com` -- revise an account's password
  70. - `mailsync` -- sync all configured email accounts. Also gives notifications of new mail and indexes new mail with notmuch silently.
  71. - `mailsync your@email.com` -- sync a particular (or several) email account(s).
  72. ### Options usable when adding an account
  73. #### Providing arguments
  74. - `-u` -- Give an account username if different from the email address.
  75. - `-n` -- A real name to be used by the account. Put in quotations if multiple
  76. words.
  77. - `-i` -- IMAP server address
  78. - `-I` -- IMAP server port (otherwise assumed to be 993)
  79. - `-s` -- SMTP server address
  80. - `-S` -- SMTP server port (otherwise assumed to be 465)
  81. - `-m` -- Maximum number of emails to be kept offline. No maximum is default
  82. functionality.
  83. - `-x` -- Account password. You will be prompted for it otherwise.
  84. #### General Settings
  85. - `-f` -- Assume mailbox names and force account configuration without
  86. connecting online at all.
  87. - `-o` -- Configure mutt for an account, but do not keep mail offline.
  88. - `-p` -- Use POP protocol instead of IMAP (requires `mpop` installed).
  89. - `mailsync` gives visual messages of new mail by default. Or, set
  90. `MAILSYNC_MUTE=1` as an environmental variable if you prefer not having them.
  91. ## Neomutt user interface
  92. To give you an example of the interface, here's an idea:
  93. - <kbd>m</kbd> - send mail (uses your default `$EDITOR` to write)
  94. - <kbd>j</kbd>/<kbd>k</kbd> and <kbd>d</kbd>/<kbd>u</kbd> - vim-like bindings to go down and up (or <kbd>d</kbd>/<kbd>u</kbd> to go
  95. down/up a page).
  96. - <kbd>l</kbd> - open mail, or attachment page or attachment
  97. - <kbd>h</kbd> - the opposite of <kbd>l</kbd>
  98. - <kbd>r</kbd>/<kbd>R</kbd> - reply/reply all to highlighted mail
  99. - <kbd>s</kbd> - save selected mail or selected attachment
  100. - <kbd>gs</kbd>,<kbd>gi</kbd>,<kbd>ga</kbd>,<kbd>gd</kbd>,<kbd>gS</kbd> - Press <kbd>g</kbd> followed by another letter to change
  101. mailbox: <kbd>s</kbd>ent, <kbd>i</kbd>nbox, <kbd>a</kbd>rchive, <kbd>d</kbd>rafts, <kbd>S</kbd>pam, etc.
  102. - <kbd>M</kbd> and <kbd>C</kbd> - For <kbd>M</kbd>ove and <kbd>C</kbd>opy: follow them with one of the mailbox
  103. letters above, i.e. <kbd>MS</kbd> means "move to Spam".
  104. - <kbd>i#</kbd> - Press <kbd>i</kbd> followed by a number 1-9 to go to a different account. If you
  105. add 9 accounts via mutt-wizard, they will each be assigned a number.
  106. - <kbd>a</kbd> to add address/person to abook and <kbd>Tab</kbd> while typing address to complete
  107. one from abook.
  108. - <kbd>?</kbd> - see all keyboard shortcuts
  109. - <kbd>ctrl-j</kbd>/<kbd>ctrl-k</kbd> - move up and down in sidebar, <kbd>ctrl-o</kbd> opens mailbox.
  110. - <kbd>ctrl-b</kbd> - open a menu to select a URL you want to open in your browser.
  111. - <kbd>p</kbd> - encrypt/sign your message (in compose view, before sending the email).
  112. ## Additional functionality
  113. - `pam-gnupg` - Automatically logs you into your GPG key on login, so you will
  114. never need to input your password once logged on to your system. Check the
  115. repo and directions out [here](https://github.com/cruegge/pam-gnupg).
  116. - `lynx` - View HTML email in neomutt.
  117. - `notmuch` - Index and search mail. Install it and run `notmuch setup`, tell it
  118. that your mail is in `~/.local/share/mail/` (although `mw` will do this
  119. automatically if you haven't set notmuch up before). You can run it in mutt
  120. with <kbd>ctrl-f</kbd>. Run `notmuch new` to process new mail.
  121. - `abook` - A terminal-based address book. Pressing tab while typing an address
  122. to send mail to will suggest contacts that are in your abook.
  123. - `urlview` - Outputs URLs in an email to your browser.
  124. ## New stuff and improvements since the original release
  125. - `mw` is now scriptable with command-line options and can run successfully
  126. without any interaction, making it possible to deploy in a script.
  127. - `isync`/`mbsync` has replaced `offlineimap` as the backend. Offlineimap was
  128. error-prone, bloated, used obsolete Python 2 modules, and required separate
  129. steps to install the system.
  130. - `mw` is now an installed program instead of just a script needed to be kept in
  131. your mutt folder.
  132. - `dialog` is no longer used and the interface is simply text commands.
  133. - More autogenerated shortcuts that allow quickly moving and copying mail
  134. between boxes.
  135. - More elegant attachment handling. Image/video/pdf attachments without relying
  136. on the neomutt instance.
  137. - abook integration by default.
  138. - The messy template files and other directories have been moved or removed,
  139. leaving a clean config folder.
  140. - msmtp configs moved to `~/.config/` and mail default location moved to
  141. `~/.local/share/mail/`, reducing mess in `~`.
  142. - `pass` is used as a password manager instead of separately saving passwords.
  143. - Script is POSIX sh compliant.
  144. - Error handling for the many people who don't read or follow directions. Fewer
  145. errors generally.
  146. - Addition of a manual `man mw`
  147. - Now handles POP protocol via `mpop` for those who prefer it (add an account
  148. with the `-p` option). POP configs are still generated automatically.
  149. ## Help the Project!
  150. - Try mutt-wizard out on weird machines and weird email addresses and report any
  151. errors.
  152. - Open a PR to add new server information into `domains.csv` so their users can
  153. more easily use mutt-wizard.
  154. - If nothing else, donate:
  155. - XMR: `8AzeWXhJvYJ1VeENHcNXCR1dLMgDALreZ1BdooZVjRKndv6myr3t1ue6C4ML2an5fWSpcP1sTDA9nKUMevkukDXG6chRjNv`
  156. - BTC: `bc1qacqfp36ffv9mafechmvk8f6r8qy4tual6rcm9p`
  157. ## Details for Tinkerers
  158. - The critical `mutt`/`neomutt` files are in `~/.config/mutt/`.
  159. - Put whatever global settings you want in `muttrc`. mutt-wizard will add some
  160. lines to this file, which you shouldn't remove unless you know what you're
  161. doing, but you can move them up/down over your config lines if you need to. If
  162. you get binding conflict errors in mutt, you might need to do this.
  163. - Each of the accounts that mutt-wizard generates will have custom settings set
  164. in a separate file in `accounts/`. You can edit these freely if you want to
  165. tinker with settings specific to an account.
  166. - In `/usr/share/mutt-wizard` are several global config files, including
  167. `mutt-wizard`'s default settings. You can override this in your `muttrc` if
  168. you wish.
  169. ## Watch out for these things
  170. - Gmail accounts need to create an
  171. [App Password](https://support.google.com/accounts/answer/185833?hl=en) to
  172. use with "less secure" applications. This password is single-use (i.e.
  173. for setup) and will be stored and encrypted locally. Enabling third-party
  174. applications requires turning off two-factor authentication and this will
  175. circumvent that. You might also need to manually "Enable IMAP" in the
  176. settings.
  177. - If you have a university email or enterprise-hosted email for work, there
  178. might be other hurdles or two-factor authentication you have to jump through.
  179. Some, for example, will want you to create a separate IMAP password, etc.
  180. - `isync` is not fully UTF-8 compatible, so non-Latin characters may be garbled
  181. (although sync should succeed). `mw` will also not auto-create mailbox
  182. shortcuts since it is looking for English mailbox names. I strongly recommend
  183. you to set your email language to English on your mail server to avoid these
  184. problems.
  185. ## License
  186. mutt-wizard is free/libre software. This program is released under the GPLv3
  187. license, which you can find in the file [LICENSE](LICENSE).