summaryrefslogtreecommitdiffstats
path: root/py3status/modules/imap.py
diff options
context:
space:
mode:
authorUltrabug <ultrabug@gentoo.org>2015-03-31 13:14:25 +0200
committerUltrabug <ultrabug@gentoo.org>2015-03-31 13:14:25 +0200
commitada99c0af5665828abc725923bf2f104c577c852 (patch)
treea4e58a0d9a5bec4612efe98bf068730a45c32ef7 /py3status/modules/imap.py
parentcdfec19502d0415f92d85ffa48e6bec495ccb644 (diff)
move config parameters on every module docstring, overall QA
Diffstat (limited to 'py3status/modules/imap.py')
-rw-r--r--py3status/modules/imap.py15
1 files changed, 14 insertions, 1 deletions
diff --git a/py3status/modules/imap.py b/py3status/modules/imap.py
index 47661f1..07190dd 100644
--- a/py3status/modules/imap.py
+++ b/py3status/modules/imap.py
@@ -2,6 +2,18 @@
"""
Display the unread messages count from your IMAP account.
+Configuration parameters:
+ - cache_timeout : how often to run this check
+ - criterion : status of emails to check for
+ - hide_if_zero : don't show on bar if 0
+ - imap_server : IMAP server to connect to
+ - mailbox : name of the mailbox to check
+ - name : format to display
+ - new_mail_color : what color to output on new mail
+ - password : login password
+ - port : IMAP server port
+ - user : login user
+
@author obb
"""
@@ -10,7 +22,8 @@ from time import time
class Py3status:
-
+ """
+ """
# available configuration parameters
cache_timeout = 60
criterion = 'UNSEEN'