maildir.md

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