1
0
Fork 0
uvgotmail/README.md

23 lines
706 B
Markdown

# uvgotmail
alerts u when u have unread messages by adding 📬 to your bash prompt
## USAGE:
- configure your imap server in `~/.uvgotmail/config` file. you can also use an existing `.muttrc` file.
- add `./uvgotmail.py --daemon &` to the end of your `.bashrc` file
- find the line where your PS1 is set and put `$(./uvgotmail.py --check)` at the start
## OPTIONS:
### check mode
- `--mailbox-symbol [string]`: specify your own character instead of 📬
- `--no-count`: by default, if you have multiple messages you will get `(n) 📬` in your PS1. this option turns that off.
### daemon mode
- `--config [path]`: path to config file
- `--mutt`: whether to load server settings from .muttrc file