Braulio Henrique Marques Souto a9345ca14c | hace 2 años | |
---|---|---|
bin | hace 2 años | |
lib | hace 2 años | |
share | hace 2 años | |
.gitignore | hace 5 años | |
FUNDING.yml | hace 3 años | |
LICENSE | hace 6 años | |
Makefile | hace 2 años | |
README.md | hace 2 años | |
mailsync.1 | hace 2 años | |
mutt-wizard.1 | hace 2 años |
Get this great stuff without effort:
mailsync
script that can be scheduled to run as often as you
like, which downloads/syncs mail and notifies you when new mail has arrived.Specifically, this wizard:
neomutt
, isync
, and msmtp
appropriate for your
email addressneomutt
- the email client (If you are using Gentoo GNU/Linux, you will need the sasl
use flag to be enabled).curl
- tests connections (required at install).isync
- downloads and syncs the mail (required if storing IMAP mail locally).msmtp
- sends the email.pass
- safely encrypts passwords (required at install).xdg-utils
- desktop integration utilities.Note: 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
.
git clone https://github.com/brauliohms/mutt-wizard
cd mutt-wizard
sudo make install
A user of Arch-based distros can also install the current mutt-wizard release from the AUR as mutt-wizard, or the Github master branch, mutt-wizard-git.
pam-gnupg
- 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.lynx
or w3m
or links2
- view HTML email in neomutt.notmuch
- index and search mail. Install it and run notmuch setup
, tell
it that your mail is in ~/.local/share/mail/
(although mutt-wizard
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.abook
- a terminal-based address book. Pressing tab while typing an address
to send mail to will suggest contacts that are in your abook.urlview
- outputs urls in mail to browser.crontab
- (or any other major cronjob manager) to set up automatic mail
syncing.mpop
- If you want to use POP protocol instead of IMAP.aspell
- GNU Aspell spell-checker.dunst
- dmenu style notification.feh
- Image viewer.mpv
- Media file viewer (audio and videos).zathura
- Pdf viewer.font-awesome
- Iconic font and CSS toolkit.The mutt-wizard runs via the command mutt-wizard
. Once setup is complete, you’ll use
neomutt
to access your mail.
mutt-wizard -a you@email.com
-- add a new email accountmutt-wizard -l
-- list existing accountsmutt-wizard -y your@email.com
-- sync an email accountmutt-wizard -Y
-- sync all configured email accountsmutt-wizard -d
-- choose an account to deletemutt-wizard -D your@email.com
-- delete account settings without confirmationmutt-wizard -t 30
-- toggle automatic mailsync to every 30 minutesmutt-wizard -T
-- toggle mailsync without specifying minutes (default is 10)mutt-wizard -r
-- reorder account shortcut numberspass edit mutt-wizard-your@email.com
-- revise an account’s password-u
-- Give an account username if different from the email address.-n
-- A real name to be used by the account. Put in quotations if multiple
words.-i
-- IMAP server address-I
-- IMAP server port (otherwise assumed to be 993)-s
-- SMTP server address-S
-- SMTP server port (otherwise assumed to be 465)-m
-- Maximum number of emails to be kept offline. No maximum is default
functionality.-x
-- Account password. You will be prompted for it otherwise.-f
-- Assume mailbox names and force account configuration without
connecting online at all.-o
-- Configure mutt for an account, but do not keep mail offline.-p
-- Use POP protocol instead of IMAP (requires mpop
installed).To give you an example of the interface, here’s an idea:
$EDITOR
to write)pam-gnupg
- 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.lynx
or w3m
or links2
- view HTML email in neomutt.notmuch
- Index and search mail. Install it and run notmuch setup
, tell it
that your mail is in ~/.local/share/mail/
(although mutt-wizard
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.abook
- A terminal-based address book. Pressing tab while typing an address
to send mail to will suggest contacts that are in your abook.urlview
- Outputs URLs in an email to your browser.mutt-wizard
is now an installed program instead of just a script needed to be kept in
your mutt folder. Is now scriptable with command-line options and can run successfully
without any interaction, making it possible to deploy in a script.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.dialog
is no longer used and the interface is simply text commands.~/.config/
and mail default location moved to
~/.local/share/mail/
, reducing mess in ~
.pass
is used as a password manager instead of separately saving passwords.man mutt-wizard
mpop
for those who prefer it (add an account
with the -p
option). POP configs are still generated automatically.domains.csv
so their users can
more easily use mutt-wizard.8AzeWXhJvYJ1VeENHcNXCR1dLMgDALreZ1BdooZVjRKndv6myr3t1ue6C4ML2an5fWSpcP1sTDA9nKUMevkukDXG6chRjNv
bc1qacqfp36ffv9mafechmvk8f6r8qy4tual6rcm9p
mutt
/neomutt
files are in ~/.config/mutt/
.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 config lines if you need to. If
you get binding conflict errors in mutt, you might need to do this.accounts/
. You can edit these freely if you want to
tinker with settings specific to an account./usr/share/mutt-wizard
are several global config files, including
mutt-wizard
's default settings. You can override this in your muttrc
if
you wish.isync
is not fully UTF-8 compatible, so non-Latin characters may be garbled
(although sync should succeed). mutt-wizard
will also not auto-create 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.mutt-wizard is free/libre software. This program is released under the GPLv3 license, which you can find in the file LICENSE.