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 ### input table
  28
  29 Variable | Meaning | Type | Default
  30 --- | --- | --- | ---
  31 `timeout` | Refresh timeout seconds | int | 60
  32 `mailpath` | Path to your maildir | string | "~/Mail"
  33 `settings` | User settings | function | empty function
  34
  35 `settings` can use the string `newmail`, which format will be something like defined above, or "no mail".
  36
  37 ### output
  38
  39 A textbox.