Merge pull request #318 from facetoe/docs

Add mail backend configuration example for #303.
This commit is contained in:
enkore 2016-02-10 18:39:32 +01:00
commit 13a291ce35

View File

@ -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'