Installation¶
-
Install with a single command from PyPi
- Or install current GitHub master
- Or just download the project and launch
python3 -m envelope
-
If planning to sign/encrypt with GPG, make sure it is installed with
sudo apt install gpg— see also the Configure your GPG tutorial. - If planning to use S/MIME, install the extra:
pip3 install 'envelope[smime]'(pyca cryptography, wheels exist for common platforms; elsewhere you might need a few build prerequisites). Decrypting S/MIME messages (Envelope.load) supports AES-CBC content encryption, not the legacy 3DES. - If planning to send e-mails, prepare SMTP credentials or follow the Configure your SMTP tutorial.
- If your e-mails are to be received outside your local domain, see the DMARC section.
- python-magic is used as a dependency. Due to a well-known name clash with the file-magic package, feel free to run
pip uninstall python-magic && pip install file-magicif you need the latter — envelope is fully compatible with both. Both rely onlibmagicunder the hood, which is probably already installed; if not, install it withsudo apt install libmagic1.
Bash completion¶
- Run:
apt install bash-completion jq - Copy envelope-autocompletion.bash to
/etc/bash_completion.d/ - Restart terminal