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-11 16:17:09 -07:00 committed by copycat-killer
parent 1bab36983b
commit eef2b8bd89
1 changed files with 11 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
imap.md
View File

@ -1,28 +1,16 @@
[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) [<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
**Please be warned**: this is a temporary solution, I am working on something much more solid.
---
Shows mail status in a textbox over IMAP protocol. Shows mail status in a textbox over IMAP protocol.
myimapcheck = lain.widgets.imap(args)
New mails are notified through a notification like this: New mails are notified through a notification like this:
+---------------------------------------------------+ +--------------------------------------------+
| +---+ | | +---+ |
| |\ /| donald@disney.org has 3 new messages | | |\ /| donald@disney.org has 3 new messages |
| +---+ | | +---+ |
| Latest From: Mickey Mouse <boss@disney.org> | +--------------------------------------------+
| Subject: Re: pay raise |
| |
| Not after what you did yesterday. |
| Daisy told me everything [...] |
| |
+---------------------------------------------------+
Text will be cut if the mail is too long.
myimapcheck = lain.widgets.imap(args)
The function takes a table as argument. Required table parameters are: The function takes a table as argument. Required table parameters are:
@ -38,8 +26,6 @@ Variable | Meaning | Type | Default
--- | --- | --- | --- --- | --- | --- | ---
`port` | IMAP port | int | 993 `port` | IMAP port | int | 993
`timeout` | Refresh timeout seconds | int | 60 `timeout` | Refresh timeout seconds | int | 60
`encoding` | Mail character encoding | string | autodetected
`maxlen` | Maximum chars to display in notification | int | 200
`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 `settings` | User settings | function
@ -58,20 +44,17 @@ 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.
`settings` can use the string `mailcount`, whose possible values are: `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.
- "0" Default definition:
- "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 = { notification _preset = {
icon = lain/icons/mail.png, icon = lain/icons/mail.png,
timeout = 8,
position = "top_left" position = "top_left"
} }
Note that `mailcount` is 0 either if there are no new mails or credentials are invalid, so make sure you get the right settings.
### output ### output
A textbox. A textbox.