-Check new mails over IMAP protocol.
+[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
+
+Shows mail status in a textbox over IMAP protocol.
Dependencies:
-- Python3
+- python3
New mails are notified through a notification like this:
--- | --- | --- | ---
`port` | IMAP port | int | 993
`refresh_timeout` | Refresh timeout seconds | int | 60
-`header` | Text to show before value | string | " Mail "
+`header` | Text to show before value | string | "Mail "
`header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF"
-`color_newmail` | New mail value color | string | `beautiful.fg_focus` or "#FFFFFF"
-`color_nomail` | No mail value color | string | `beautiful.fg_normal` or "#FFFFFF"
+`color` | Mail value color | string | `beautiful.fg_focus` or "#FFFFFF"
`mail_encoding` | Mail character encoding | string | autodetected
`maxlen` | Maximum chars to display in notification | int | 200
`app` | Mail program to spawn on click | string | "mutt"
args.is_plain = false
args.password = "mypassword"
-and you'll have the same security provided by `~/.netrc`
+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):
When `is_plain == false`, it *executes* `password` before using it, so you can also use whatever password fetching solution you want.
-You can also define your custom icon for the naughty notification. Just set `lain_mail_notify` into `theme.lua`.
\ No newline at end of file
+You can also define your custom icon for the naughty notification. Just set `lain_mail_notify` into `theme.lua`:
+
+ theme.lain_mail_notify = "/path/to/my/icon"
\ No newline at end of file