From ad6b6281b309f7814bf530d2052a02460bc28a94 Mon Sep 17 00:00:00 2001 From: kaylee Date: Fri, 2 Feb 2024 17:35:29 +0000 Subject: [PATCH] added example config --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4939a9b..6af50f1 100644 --- a/README.md +++ b/README.md @@ -13,10 +13,21 @@ alerts u when u have unread messages by adding 📬 to your bash prompt ### check mode -- `--mailbox-symbol [string]`: specify your own character instead of 📬 +- `--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`: whether to load server settings from .muttrc 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 \ No newline at end of file