uvgotmail/README.md

903 B

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 symbol 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: 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