mutt-wizard/README.md

# Luke's mutt Wizard for automatic Neomutt and OfflineIMAP configuration!

![mutt wizard preview](etc/mw.png)

Mutt is one of the most rewarding programs one can use, but can be a pain in
the ass to configure. Since my job is making power-user tools available for the
masses I want to create a tool that automates most of mutt configuration so
that users can simply give their email address and get a /comfy/ setup. At
that, I don't just want a mutt wizard, but an offlineIMAP wizard, so users can
easily access their mail offline as well, and a wizard that makes it easy to
store passwords securely using gpg.

The mutt-wizard is all of this in a simple ncurses menu. It's really just a
little bash script, but one that can save countless people thousands of
combined manhours of frustratingly trying to get all the moving pieces working
together.

## User interface

The system takes an email and autodetect its server settings, generating a
muttrc and offlineimaprc profile automatically. If it can't do so, it simply
prompts you for these (which you can easily look up) and will put them all in
the right places. You get:

+ Automatic configuration of mutt and offlineimap.
+ Automatic encryption and safe storage of passwords which are used by mutt and
  offlineimap when necessary.
+ Multiple account management in mutt: jump from account to account with the
  `i` prefix in mutt: `i1`: first email account, `i5`: fifth, etc.
+ Easy movement to mail folders in mutt: `gi`: go to inbox, `gs` to sent mail,
  `ga` to archive, `gS` to spam, `gd` to drafts, etc.
+ Some default controls and colors. This system is going to be integrated into
  my [public auto-rice script](https://larbs.xyz) so I want it to look pretty
  and be usable out the box.
+ An optional autosync script that will smartly run offlineimap when connected
  to the internet at what interval you want and will notify you with a ding
  when new mail arrives.

### Will it work on my email? (95% yes)

Yes! At this point, the only problems are the unexpected ones. Please try it,
and if you do run into problems, email me at
[luke@lukesmith.xyz](mailto:luke@lukesmith.xyz)! I've tried the system
personally on Gmail, Teknik.io, cock.li and Yandex, while others have tried
other providers.

If you have a ProtonMail account, due to their secure setup, you must have
[ProtonMail Bridge](https://protonmail.com/bridge/) installed and configured.
Compatibility with ProtonMail is still in testing, so be sure to open an issue
if you have problems as I do not have a paid account to test this with.

Note also that Gmail and some providers require you to enable sign-ins from
third-party (or as they call it "less secure") applications to be able to load
mail with mutt and offlineimap. Be sure to enable that!

## Installation and Dependencies

`dialog`, `neomutt`, `offlineimap` and `msmtp` should be installed. You also need to
have a GPG public/private key pair for the wizard to automatically store your
passwords. The whole repo should be cloned to `~/.config/mutt/`. (If you have a
previous mutt folder, you'll want to back it up or delete it first.)

```
git clone https://github.com/LukeSmithxyz/mutt-wizard.git ~/.config/mutt
```

You will want to delete or rename your current `~/.offlineimaprc` and
`~/.msmtprc` as well, as although you can later modify these files produced by
the script, you must have no file there the first time you add your first
account or the wizard will assume some settings are already set which aren't.

Just run `mutt-wizard.sh` and choose to add an account. After you do so, you
may run `offlineimap` to begin the mailsync, and you will be able to run
neomutt and see your mail.  If mutt doesn't immediately work properly run the
`Redetect mailboxes` option, then open mutt. This may be necessary for some
accounts.


### Installation on macOS

You may need to install or symlink additional packages on macOS. Otherwise the generation of configuration files may fail, or worse.

```
ln -s /usr/local/bin/gpg /usr/local/bin/gpg2
brew install coreutils
ln -s /usr/local/bin/gshred /usr/local/bin/shred
```

### Non-essential dependencies for extra features

The automatically deployed configs will look for certain programs for certain
extra abilities. Consider installing the following for the extra functionality.

+ `notmuch` -- for mail searching and indexing set to `ctrl-f`. Be sure to run
  `notmuch setup`. Remember your mail is in `~/.mail/` when you configure
  notmuch.
+ `w3m` and/or `w3mimg` -- for HTML emails and viewing images. Like .pdfs, view in the attachments menu.
+ A cron manager if you want the autosync feature.
+ `iproute2mac` for Mac users who want the autosync feature.
+ `mpv` if you want the autosync feature to notify you with a ding on new mail.

## The autosync

If you activate the autosync at a significantly infrequent interval, by
default, your system might prompt you for your GPG password every time. To
prevent this, you can change the time a GPG unlock lasts by adding a time in
seconds as below into `~/.gnupg/gpg-agent.conf`:

```
default-cache-ttl <number-of-seconds>
max-cache-ttl <number-of-seconds>
```

You can also use [pam-gnupg](https://github.com/cruegge/pam-gnupg) if you want
to just log into your keyring immediately on log in. This is what I do, but
it's less secure if you leave you computer logged on.

## You can help!

If you use mutt with a particular host or domain, put your server information
in `domains.csv`! This will make everyone else who uses your email provider's
life much easier!

Or you can help monetarily via [Patreon](https://patreon.com/lukesmith) or
[Paypal](https://paypal.me/LukeMSmith)!

## Notes

Mail is stored in `~/.mail`. mutt configs and caches for each account are in
`~/.config/mutt/accounts/`. Encypted passwords are in
`~/.config/mutt/credentials`. A "personal" muttrc, with the macros for
switching accounts and the default config is in
`~/.config/mutt/personal.muttrc`.

## Todo

* Expand the list of server information in `domains.csv`, possibly porting the
  Thunderbird autoconfigure settings.