Muttwizard is a tool that automatically sets up a neomutt-based minimal email system.
Who is mw for?
- Those new to or experimenting with extensible, terminal-based setups.
- Those already familiar with all that, but don't want to be bothered by manually setting up neomutt and its many peripheral programs.
mw does all this for you.
mw follows the Unix philosophy: it calls on already-existing minimal programs to give you a full email system. Knowledge of none of these programs is required by the user to get the system up and working.
- isync downloads the users mail and stores it offline in an instantly-loading archive which is also easy to backup.
- Passwords automatically encrypted with pass and decrypted when needed for login.
- Compatible with POP servers as well, and will automatically set up mpop in those cases.
- Mail automatically indexed with notmuch to enable searching and other things.
- Works with abook so contact information can easily be stored to be used by neomutt or other programs.
- mw can also handle multiple accounts and can easily switch between them.
- mw sets up sensible defaults, including vim bindings and simple color scheming to maximize the usability of neomutt.
Installation
git clone https://github.com/lukesmithxyz/mutt-wizard
cd mutt-wizard
sudo make installDepenencies
- neomutt – email client. Note that mw uses some features that are not included in oldschool mutt, so neomutt is required.
- curl – used to test login credentials and get email information. Not required if run with
-f. - isync – downloads mail. (Not actually required for POP servers though.)
- msmtp – sends mail.
- pass – securely stores user passwords encrypted with their GPG key.
Before using mw, be sure you have a GPG key pair (run gpg --full-gen-key if you do not).
The email used in the GPG key needn't have anything to do with the email accounts added by mw.
It is merely used to store passwords.
Once you have a key pair, run pass init your@gpgpemail.com.
Highly recommended
- lynx – format HTML emails in neomutt.
- notmuch – index all mail making it searchable.
- abook – address book
Other programs to consider
- mpop – for those few POP servers still remaining.
- urlview – allows one to follow urls.
- a cronjob manager – set mw to download mail at a particular interval.
Usage
mw
mw: mutt-wizard, auto-configure email accounts for mutt
including downloadable mail with `isync`.
Main actions:
-a your@email.com Add an email address
-l List email addresses configured
-d Remove an already added address
-D your@email.com Force remove account without confirmation
-y your@email.com Sync mail for account by name
-Y Sync mail for all accounts
-t number Toggle automatic mailsync every minutes
-T Toggle automatic mailsync
-r Reorder and set new default account
Options allowed with -a:
-u Account login name if not full address
-n "Real name" to be on the email account
-i IMAP/POP server address
-I IMAP/POP server port
-s SMTP server address
-S SMTP server port
-x Password for account (recommended to be in double quotes)
-p Add for a POP server instead of IMAP.
-X Delete an account's local email too when deleting.
-o Configure address, but keep mail online.
-f Assume typical English mailboxes without attempting log-on.
NOTE: Once at least one account is added, you can run
`mbsync -a` to begin downloading mail.
To change an account's password, run `pass edit your@email.com`. neomutt
neomutt configured by mw will have vim-like bindings.
o downloads mail.
ctrl-f searches mail indexed by notmuch.
m to write mail, r to reply to a mail, y to send mail that is written.
See man mw for more information.
You may also press ? when within neomutt to get a full list of key bindings.
Support
mw is a real time saver and opens up a new world of efficient email for people. If you've benefited from mw, please donate Bitcoin or Monero:
- BTC:
bc1qacqfp36ffv9mafechmvk8f6r8qy4tual6rcm9p - XMR:
8AzeWXhJvYJ1VeENHcNXCR1dLMgDALreZ1BdooZVjRKndv6myr3t1ue6C4ML2an5fWSpcP1sTDA9nKUMevkukDXG6chRjNv