awesomewm-mirrors
/
lain
mirror of https://github.com/lcpz/lain.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Updated imap (markdown)

This commit is contained in:
Luke Bonham 2013-09-10 14:17:21 -07:00 committed by copycat-killer
parent 3028d8f44e
commit d9ed217c2c
1 changed files with 24 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
imap.md
View File

@ -2,10 +2,6 @@
Shows mail status in a textbox over IMAP protocol. Shows mail status in a textbox over IMAP protocol.
Dependencies:
- python3
New mails are notified through a notification like this: New mails are notified through a notification like this:
+---------------------------------------------------+ +---------------------------------------------------+
@ -26,29 +22,22 @@ Text will be cut if the mail is too long.
The function takes a table as argument. Required table parameters are: The function takes a table as argument. Required table parameters are:
Variable | Type Variable | Meaning | Type
--- | --- --- | --- | ---
`server` | string `server` | Mail server | string
`mail` | string `mail` | User mail | string
`password` | string `password` | User password | string
while the optional are: while the optional are:
Variable | Meaning | Type | Default Variable | Meaning | Type | Default
--- | --- | --- | --- --- | --- | --- | ---
`port` | IMAP port | int | 993 `port` | IMAP port | int | 993
`refresh_timeout` | Refresh timeout seconds | int | 60 `timeout` | Refresh timeout seconds | int | 60
`header` | Text to show before value | string | " Mail " `encoding` | Mail character encoding | string | autodetected
`header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF"
`color` | Mail value color | string | `beautiful.fg_focus` or "#FFFFFF"
`footer` | Text to append after value | string | " "
`mail_encoding` | Mail character encoding | string | autodetected
`maxlen` | Maximum chars to display in notification | int | 200 `maxlen` | Maximum chars to display in notification | int | 200
`app` | Mail program to spawn on click | string | "mutt"
`shadow` | Hide widget when there are no mails | boolean | false
`is_plain` | Define whether `password` is a plain password (true) or a function that retrieves it (false) | boolean | false `is_plain` | Define whether `password` is a plain password (true) or a function that retrieves it (false) | boolean | false
`settings` | User settings | function
**Note**: `footer` can be markup text.
Let's focus better on `is_plain`. Let's focus better on `is_plain`.
@ -65,6 +54,20 @@ and you'll have the same security provided by `~/.netrc`.
When `is_plain == false`, it *executes* `password` before using it, so you can also use whatever password fetching solution you want. 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`: `settings` can use the string `mailcount`, whose possible values are:
theme.lain_mail_notify = "/path/to/my/icon" - "0"
- "invalid credentials"
- string number
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. Default definition:
notification _preset = {
icon = lain/icons/mail.png,
timeout = 8,
position = "top_left"
}
### output
A textbox.