Updated imap (markdown)

[etc/awesome.git] / imap.md

diff --git a/imap.md b/imap.md
index af29cb378565147ab4f13d606dc8fcf9f20b0661..b0d5375b01d8ff1a8aae42893f516d292017a668 100644 (file)
--- a/imap.md
+++ b/imap.md
@@ -1,10 +1,10 @@
 [<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
 
-Shows mail status in a textbox over IMAP protocol.
+Shows mail count in a textbox fetching over IMAP.
 
        myimapcheck = lain.widgets.imap(args)
 
-New mails are notified through a notification like this:
+New mails are notified like this:
 
        +--------------------------------------------+
        | +---+                                      |
@@ -31,24 +31,34 @@ Variable | Meaning | Type | Default
 
 Let's focus better on `is_plain`.
 
-You can just set your password like this:
+The reason why it's false by default is to discourage the habit of storing passwords in plain files.
 
-    args.is_plain = false
-    args.password = "mypassword"
+You can set your password in plain like this:
+
+    myimapcheck = lain.widgets.imap({
+        is_plain = true,
+        password = "myplainpassword",
+        [...]
+    })
 
 and you'll have the same security provided by `~/.netrc`.
 
 **Or** you can use a keyring, like [python keyring](https://pypi.python.org/pypi/keyring):
 
-    args.password = "keyring get password"
+    myimapcheck = lain.widgets.imap({
+        is_plain = true,
+        password = "myplainpassword",
+        server   = "mail.autistici.org",
+        mail     = "dada@anche.no",
+    })
 
 When `is_plain == false`, it *executes* `password` before using it, so you can also use whatever password fetching solution you want.
 
-`settings` can use the value `mailcount`, an integer greater or equal to zero, and can modify `notification_preset` table, which will be the preset for the naughty notifications. Check [here](http://awesome.naquadah.org/doc/api/modules/naughty.html#notify) for the list of variables it can contain. 
+`settings` can use the value `mailcount`, an integer greater or equal to zero, and can modify `mail_notification_preset` table, which will be the preset for the naughty notifications. Check [here](http://awesome.naquadah.org/doc/api/modules/naughty.html#notify) for the list of variables it can contain. 
 
 Default definition:
 
-    notification _preset = {
+    mail_notification _preset = {
        icon = lain/icons/mail.png,
        position = "top_left"
     }