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

Updated maildir (markdown)

This commit is contained in:
Luke Bonham 2013-09-10 14:31:01 -07:00
parent ff0865c837
commit 0e9db489f5
1 changed files with 8 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
maildir.md
View File

@ -24,19 +24,16 @@ If there's new mails, the textbox will say something like "mail: bugs(3), system
mymaildir = lain.widgets.maildir("/path/to/my/maildir")
The function takes a table as optional argument, which can contain:
### input table
Variable | Meaning | Type | Default
--- | --- | --- | ---
`timeout` | Refresh timeout seconds | int | 60
`mailpath` | Path to your maildir | string | "~/Mail"
`ignore_boxes` | A list of boxes to ignore | table | empty table
`refresh_timeout` | Refresh timeout seconds | int | 60
`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"
`footer` | Text to append after value | string | " "
`app` | Mail program to spawn on click | string | "mutt"| boolean | false
`shadow` | Hide widget when there are no mails | boolean | false
`settings` | User settings | function | empty function
**Note**: `footer` can be markup text.
`settings` can use the string `newmail`, which format will be something like defined above, or "no mail".
### output
A textbox.