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 8.2 KiB

6 years ago
5 years ago
5 years ago
6 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
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
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123
  1. # mutt-wizard
  2. Get this great stuff without effort:
  3. - A full-featured and autoconfigured email client on the terminal with neomutt
  4. - Mail stored offline so you can view and write email while away from internet and keep backups
  5. Specifically, this wizard:
  6. - Determines your email server's IMAP and SMTP servers and ports
  7. - Creates dotfiles for `neomutt`, `isync`, and `msmtp` appropriate for your email address
  8. - Encrypts and stores locally your password for easy remote access, accessible only by your GPG key
  9. - Handles as many as nine separate email accounts automatically
  10. - Auto-creates bindings to switch between accounts or between mailboxes
  11. - Can automatically set mail updates as often as you want to sync your mail and update you when new mail arrives
  12. - Provides sensible defaults and an attractive appearance for the neomutt email client
  13. - If mutt-wizard doesn't know your server's IMAP/SMTP info by default, it will prompt you for them and will put them in all the right places.
  14. ## Install and Use
  15. ```
  16. git clone https://github.com/LukeSmithxyz/mutt-wizard
  17. cd mutt-wizard
  18. sudo make install
  19. ```
  20. User of Arch-based distros can also install mutt-wizard from the AUR as [mutt-wizard-git](https://aur.archlinux.org/packages/mutt-wizard-git/).
  21. *NOTE:* If you have used an older version of mutt-wizard, especially when it used to use `offlineimap`, you need to remove your old configs. Back anything up that's important and run:
  22. ```
  23. rm -rf ~/.config/mutt ~/.msmtprc ~/.config/msmtp ~/.offlineimap ~/.offlineimaprc ~/.config/offlineimap ~/.mbsyncrc
  24. ```
  25. The mutt-wizard is run with the command `mw`. It also installs the `mailsync` command. Once everything is setup, you'll use `neomutt` to access your mail.
  26. - `mw add` -- add a new email account
  27. - `mw ls` -- list existing accounts
  28. - `mw pass` -- revise an account's password
  29. - `mw delete` -- deleted an added account
  30. - `mw purge` -- delete all accounts and settings
  31. - `mw cron` -- toggle/configure a cronjob to sync mail
  32. ## Dependencies
  33. - `neomutt` - the email client.
  34. - `isync` - downloads and syncs the mail. (required at install)
  35. - `msmtp` - sends the email.
  36. - `pass` - safely encrypts passwords (required at install)
  37. There's a chance of errors if you use a slow-release distro like Ubuntu, Debian or Mint. If you get errors in `neomutt`, install the most recent version manually or manually remove the offending lines in the config in `/usr/share/mutt-wizard/mutt-wizard.muttrc`.
  38. ### Optional
  39. - `w3m` - view HTML email and images in neomutt.
  40. - `notmuch` - index and search mail. Install it and run `notmuch setup`, tell it that your mail is in `~/.local/share/mail/` (although `mw` will do this automatically if you haven't set notmuch up before). You can run it in mutt with `ctrl-f`. Run `notmuch new` to process new mail, although the included `mailsync` script does this for you.
  41. - `libnotify`/`libnotify-bin` - allows notifications when syncthing mail with `mailsync`
  42. - `abook` - a terminal-based address book. Pressing tab while typing an address to send mail to will suggest contacts that are in your abook.
  43. - A cron manager - if you want to enable the auto-sync feature.
  44. - `pam-gnupg` - this is a more general program that I use. It automatically logs you into your GPG key on login so you will never need to input your password once logged on to your system. Check the repo and directions out [here](https://github.com/cruegge/pam-gnupg).
  45. - `urlview` - outputs urls in mail to browser.
  46. ## Neomutt user interface
  47. To give you an example of the interface, here's an idea:
  48. - `m` - send mail (uses your default `$EDITOR` to write)
  49. - `j`/`k` and `d`/`u` - vim-like bindings to go down and up (or `d`/`u` to go down/up a page).
  50. - `l` - open mail, or attachment page or attachment
  51. - `h` - the opposite of `l`
  52. - `r`/`R` - reply/reply all to highlighted mail
  53. - `s` - save selected mail or selected attachment
  54. - `gs`,`gi`,`ga`,`gd`,`gS` - Press `g` followed by another letter to change mailbox: `s`ent, `i`nbox, `a`rchive, `d`rafts, `S`pam, etc.
  55. - `M` and `C` - For `M`ove and `C`opy: follow them with one of the mailbox letters above, i.e. `MS` means "move to Spam".
  56. - `i#` - Press `i` followed by a number 1-9 to go to a different account. If you add 9 accounts via mutt-wizard, they will each be assigned a number.
  57. - `a` to add address/person to abook and `Tab` while typing address to complete one from book.
  58. - `?` - see all keyboard shortcuts
  59. - `ctrl-j`/`ctrl-k` - move up and down in sidebar, `ctrl-o` opens mailbox.
  60. - `ctrl-b` - open a menu to select a url you want to open in you browser.
  61. ## New stuff and improvements since the original release
  62. - `isync`/`mbsync` has replaced `offlineimap` as the backend. Offlineimap was error-prone, bloated, used obsolete Python 2 modules and required separate steps to install the system.
  63. - `mw` is now an installed program instead of just a script needed to be kept in your mutt folder.
  64. - `dialog` is no longer used (le bloat) and the interface is simply text commands.
  65. - More autogenerated shortcuts that allow quickly moving and copying mail between boxes.
  66. - More elegant attachment handling. Image/video/pdf attachments without relying on the neomutt instance.
  67. - abook integration by default.
  68. - The messy template files and other directories have been moved or removed, leaving a clean config folder.
  69. - msmtp configs moved to `~/.config/` and mail default location moved to `~/.local/share/mail/`, reducing mess in `~`.
  70. - `pass` is used as a password manager instead of separately saving passwords.
  71. - Script is POSIX sh compliant.
  72. - Error handling for the many people who don't read or follow directions. Less errors generally.
  73. - Addition of a manual `man mw`
  74. ## Help the Project!
  75. - Try mutt-wizard out on weird machines and weird email addresses and report any errors.
  76. - Open a PR to add new server information into `domains.csv` so their users can more easily use mutt-wizard.
  77. - If nothing else, [Donate!](https://paypal.me/LukeMSmith)
  78. See Luke's website [here](https://lukesmith.xyz). Email him at [luke@lukesmith.xyz](mailto:luke@lukesmith.xyz).
  79. mutt-wizard is free/libre software, licensed under the GPLv3.
  80. ## Details for Tinkerers
  81. - The critical `mutt`/`neomutt` files are in `~/.config/mutt/`.
  82. - Put whatever global settings you want in `muttrc`. mutt-wizard will add some lines to this file which you shouldn't remove unless you know what you're doing, but you can move them up/down over your personal config lines if you need to. If you get binding conflict errors in mutt, you might need to do this.
  83. - Each of the accounts that mutt-wizard generates will have custom settings set in a separate file in `accounts/`. You can edit these freely if you want to tinker with settings specific to an account.
  84. - In `/usr/share/mutt-wizard` are several global config files, including `mutt-wizard`'s default settings. You can overwride this in your `muttrc` if you wish.
  85. ## Watch out for these things:
  86. - Gmail accounts can now create 'App Password' to use with """less secure""" applications. This password is single use (ie. for setup) and will be stored and encrypted locally. Enabling third-party applications requires turning off two-factor authentication and this will circumvent that. You might also need to manually "Enable IMAP" in the settings.
  87. - Protonmail accounts will require you to set up "Protonmail Bridge" to access PM's IMAP and SMTP servers. Configure that before running mutt-wizard.
  88. - Protonmail bridge is prone to timing out. Watch out for this while adding an account. If the bridge times out, try again.
  89. - If you have a university email, or enterprise-hosted email for work, there might be other hurdles or two-factor authentication you have to jump through. Some, for example, will want you to create a separate IMAP password, etc.
  90. - `isync` is not fully UTF-8 compatible, so non-Latin characters may be garbled (although sync should succeed). `mw` will also not autocreate mailbox shortcuts since it is looking for English mailbox names. I strongly recommend you to set your email language to English on your mail server to avoid these problems.
  91. ## To-do
  92. - Add ~~Mac OS~~/BSD compatibility (the script is confired to work for Mac OS now)
  93. - ~~Out-of-the-box compatibility with Protonmail Bridge~~ (I believe this is done, but more bug-testing is welcome since I don't have PM)
  94. - Option to keep configuration for accounts that failed to connect (maybe)