mutt-wizard

A wizard that autocreates an offline email setup for (neo)mutt with isync/mbsync
Log | Files | Refs | README | LICENSE

README.md (8118B)


      1 # mutt-wizard
      2 
      3 Get this great stuff without effort:
      4 
      5 - A full-featured and autoconfigured email client on the terminal with neomutt
      6 - Mail stored offline so you can view and write email while away from internet and keep backups
      7 
      8 Specifically, this wizard:
      9 
     10 - Determines your email server's IMAP and SMTP servers and ports
     11 - Creates dotfiles for `neomutt`, `isync`, and `msmtp` appropriate for your email address
     12 - Encrypts and stores locally your password for easy remote access, accessible only by your GPG key
     13 - Handles as many as nine separate email accounts automatically
     14 - Auto-creates bindings to switch between accounts or between mailboxes
     15 - Can automatically set mail updates as often as you want to sync your mail and update you when new mail arrives
     16 - Provides sensible defaults and an attractive appearance for the neomutt email client
     17 - 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.
     18 
     19 ## Install and Use
     20 
     21 ```
     22 git clone https://github.com/LukeSmithxyz/mutt-wizard
     23 cd mutt-wizard
     24 sudo make install
     25 ```
     26 
     27 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/).
     28 
     29 *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:
     30 
     31 ```
     32 rm -rf ~/.config/mutt ~/.msmtprc ~/.config/msmtp ~/.offlineimap ~/.offlineimaprc ~/.config/offlineimap ~/.mbsyncrc
     33 ```
     34 
     35 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.
     36 
     37 - `mw add` -- add a new email account
     38 - `mw ls` -- list existing accounts
     39 - `mw pass` -- revise an account's password
     40 - `mw delete` -- deleted an added account
     41 - `mw purge` -- delete all accounts and settings
     42 - `mw cron` -- toggle/configure a cronjob to sync mail
     43 
     44 ## Dependencies
     45 
     46 - `neomutt` - the email client.
     47 - `isync` - downloads and syncs the mail. (required at install)
     48 - `msmtp` - sends the email.
     49 - `pass` - safely encrypts passwords (required at install)
     50 
     51 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`.
     52 
     53 ### Optional
     54 
     55 - `w3m` - view HTML email and images in neomutt.
     56 - `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.
     57 - `libnotify`/`libnotify-bin` - allows notifications when syncthing mail with `mailsync`
     58 - `abook` - a terminal-based address book. Pressing tab while typing an address to send mail to will suggest contacts that are in your abook.
     59 - A cron manager - if you want to enable the auto-sync feature.
     60 - `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).
     61 - `urlview` - outputs urls in mail to browser.
     62 
     63 ## Neomutt user interface
     64 
     65 To give you an example of the interface, here's an idea:
     66 
     67 - `m` - send mail (uses your default `$EDITOR` to write)
     68 - `j`/`k` and `d`/`u` - vim-like bindings to go down and up (or `d`/`u` to go down/up a page).
     69 - `l` - open mail, or attachment page or attachment
     70 - `h` - the opposite of `l`
     71 - `r`/`R` - reply/reply all to highlighted mail
     72 - `s` - save selected mail or selected attachment
     73 - `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.
     74 - `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".
     75 - `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.
     76 - `a` to add address/person to abook and `Tab` while typing address to complete one from book.
     77 - `?` - see all keyboard shortcuts
     78 - `ctrl-j`/`ctrl-k` - move up and down in sidebar, `ctrl-o` opens mailbox.
     79 - `ctrl-b` - open a menu to select a url you want to open in you browser.
     80 ## New stuff and improvements since the original release
     81 
     82 - `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.
     83 - `mw` is now an installed program instead of just a script needed to be kept in your mutt folder.
     84 - `dialog` is no long used (le bloat) and the interface is simply text commands.
     85 - More autogenerated shortcuts that allow quickly moving and copying mail between boxes.
     86 - More elegant attachment handling. Image/video/pdf attachments without relying on the neomutt instance.
     87 - abook integration by default.
     88 - The messy template files and other directories have been moved or removed, leaving a clean config folder.
     89 - msmtp configs moved to `~/.config/` and mail default location moved to `~/.local/share/mail/`, reducing mess in `~`.
     90 - `pass` is used as a password manager instead of separately saving passwords.
     91 - Script is POSIX sh compliant.
     92 - Error handling for the many people who don't read or follow directions. Less errors generally.
     93 - Addition of a manual `man mw`
     94 
     95 ## Help the Project!
     96 
     97 - Try mutt-wizard out on weird machines and weird email addresses and report any errors.
     98 - Open a PR to add new server information into `domains.csv` so their users can more easily use mutt-wizard.
     99 - If nothing else, [Donate!](https://paypal.me/LukeMSmith)
    100 
    101 See Luke's website [here](https://lukesmith.xyz). Email him at [luke@lukesmith.xyz](mailto:luke@lukesmith.xyz).
    102 
    103 mutt-wizard is free/libre software, licensed under the GPLv3.
    104 
    105 ## Details for Tinkerers
    106 
    107 - The critical `mutt`/`neomutt` files are in `~/.config/mutt/`.
    108 - 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.
    109 - 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.
    110 - 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.
    111 
    112 ## Watch out for these things:
    113 
    114 - For Gmail accounts, remember also to enable third-party ("""less secure""") applications before attempting installation. You might also need to manually "Enable IMAP" in the settings.
    115 - Protonmail accounts will require you to set up "Protonmail Bridge" to access PM's IMAP and SMTP servers. Configure that before running mutt-wizard.
    116 - 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.
    117  - `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.
    118 
    119 ## To-do
    120 
    121 - Add ~~Mac OS~~/BSD compatibility (the script is confired to work for Mac OS now)
    122 - ~~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)
    123 - Option to keep configuration for accounts that failed to connect (maybe)