added example config
This commit is contained in:
		
							parent
							
								
									80fdd31ef3
								
							
						
					
					
						commit
						ad6b6281b3
					
				
							
								
								
									
										15
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										15
									
								
								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 | ||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user