From: Luke Bonham <copycat-killer@users.noreply.github.com>
Date: Mon, 20 Jan 2014 17:52:35 +0000 (-0800)
Subject: Updated imap (markdown)
X-Git-Url: https://git.madduck.net/etc/awesome.git/commitdiff_plain/dd10cac1306530f46f0e8506156e1ef21b456fae?ds=inline

Updated imap (markdown)
---

diff --git a/imap.md b/imap.md
index ba92d0f..b0d5375 100644
--- a/imap.md
+++ b/imap.md
@@ -31,16 +31,26 @@ 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.