From e0a3140f99ae3306c2f26a3c09022f787bb86dce Mon Sep 17 00:00:00 2001 From: facetoe Date: Wed, 10 Feb 2016 22:30:27 +0800 Subject: [PATCH] Add mail backend configuration example for #303. --- docs/i3pystatus.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/i3pystatus.rst b/docs/i3pystatus.rst index 035bdb7..47e669d 100644 --- a/docs/i3pystatus.rst +++ b/docs/i3pystatus.rst @@ -26,6 +26,19 @@ Module reference Mail Backends ------------- +The generic mail module can be configured to use multiple mail backends. Here is an +example configuration for the MaildirMail backend: + +.. code:: python + + status.register("mail", + backends=[maildir.MaildirMail( + directory="/home/name/Mail/inbox") + ], + format="P {unread}", + log_level=20, + hide_if_null=False, ) + .. autogen:: i3pystatus.mail SettingsBase .. nothin'