]> git.madduck.net Git - etc/awesome.git/blob - maildir.md

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Updated alsabar (markdown)
[etc/awesome.git] / maildir.md
1 [<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
2
3 Shows maildirs status in a textbox.
4
5 Maildirs are structured as follows:
6
7         ~/Mail
8         .
9         |-- arch
10         |   |-- cur
11         |   |-- new
12         |   `-- tmp
13         |-- gmail
14         |   |-- cur
15         |   |-- new
16         |   `-- tmp
17         .
18         .
19         .
20
21 therefore the widget checks whether there are files in the `new` directories.
22 If there's new mails, the textbox will say something like "mail: bugs(3), system(1)", otherwise it says
23 "no mail".
24
25         mymaildir = lain.widgets.maildir("/path/to/my/maildir")
26
27 The function takes a table as optional argument, which can contain:
28
29 Variable | Meaning | Type | Default
30 --- | --- | --- | ---
31 `mailpath` | Path to your maildir | string | "~/Mail"
32 `ignore_boxes` | A list of boxes to ignore | table | empty table
33 `refresh_timeout` | Refresh timeout seconds | int | 60
34 `header` | Text to show before value | string | " Mail "
35 `header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF"
36 `color_newmail` | New mail value color | string | `beautiful.fg_focus` or "#FFFFFF"
37 `color_nomail` | No mail value color | string | `beautiful.fg_normal` or "#FFFFFF"
38 `footer` | Text to append after value | string | " "
39 `app` | Mail program to spawn on click | string | "mutt"| boolean | false
40 `shadow` | Hide widget when there are no mails | boolean | false
41
42 **Note**: `footer` can be markup text.