uvgotmail/README.md

33 lines
899 B
Markdown
Raw Normal View History

2024-02-02 07:53:42 +00:00
# uvgotmail
2024-02-02 08:01:39 +00:00
alerts u when u have unread messages by adding 📬 to your bash prompt
2024-02-02 08:02:12 +00:00
## USAGE:
2024-02-02 08:01:39 +00:00
2024-02-02 16:26:00 +00:00
- configure your imap server in `~/.uvgotmail/config` file. you can also use an existing `.muttrc` file.
2024-02-02 08:01:39 +00:00
- 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
2024-02-02 16:26:00 +00:00
2024-02-02 08:02:12 +00:00
## OPTIONS:
2024-02-02 08:01:39 +00:00
2024-02-02 08:02:12 +00:00
### check mode
2024-02-02 08:01:39 +00:00
2024-02-02 17:35:29 +00:00
- `--mailbox-symbol [string]`: specify your own symbol instead of 📬
2024-02-02 08:01:39 +00:00
- `--no-count`: by default, if you have multiple messages you will get `(n) 📬` in your PS1. this option turns that off.
2024-02-02 08:02:12 +00:00
2024-02-02 09:00:11 +00:00
### daemon mode
2024-02-02 16:26:00 +00:00
- `--config [path]`: path to config file
2024-02-02 17:35:29 +00:00
- `--mutt`: load server settings from .muttrc file
## EXAMPLE CONFIG:
no_count=True
mailbox_symbol=[M]
mutt=False
# this is a comment
ssl=True
server=mail.domain.com
port=993
user=user@domain.com
password=ThisIsMyPassword