imap.md

   1 [<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
   2
   3 Shows mail count in a textbox fetching over IMAP.
   4
   5         myimapcheck = lain.widgets.imap(args)
   6
   7 New mails are notified like this:
   8
   9         +--------------------------------------------+
  10         | +---+                                      |
  11         | |\ /| donald@disney.org has 3 new messages |
  12         | +---+                                      |
  13         +--------------------------------------------+
  14
  15 The function takes a table as argument. Required table parameters are:
  16
  17 Variable | Meaning | Type
  18 --- | --- | ---
  19 `server` | Mail server | string
  20 `mail` | User mail | string
  21 `password` | User password | string
  22
  23 while the optional are:
  24
  25 Variable | Meaning | Type | Default
  26 --- | --- | --- | ---
  27 `port` | IMAP port | int | 993
  28 `timeout` | Refresh timeout seconds | int | 60
  29 `is_plain` | Define whether `password` is a plain password (true) or a function that retrieves it (false) | boolean | false
  30 `settings` | User settings | function
  31
  32 Let's focus better on `is_plain`.
  33
  34 The reason why it's false by default is to discourage the habit of storing passwords in plain files.
  35
  36 You can set your password in plain like this:
  37
  38     myimapcheck = lain.widgets.imap({
  39         is_plain = true,
  40         password = "myplainpassword",
  41         [...]
  42     })
  43
  44 and you'll have the same security provided by `~/.netrc`.
  45
  46 **Or** you can use a keyring, like [python keyring](https://pypi.python.org/pypi/keyring):
  47
  48     myimapcheck = lain.widgets.imap({
  49         password = "keyring get mymail",
  50         [...]
  51     })
  52
  53 When `is_plain == false`, it *executes* `password` before using it, so you can also use whatever password fetching solution you want.
  54
  55 `settings` can use the value `mailcount`, an integer greater or equal to zero, and can modify `mail_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.
  56
  57 Default definition:
  58
  59     mail_notification _preset = {
  60        icon = lain/icons/mail.png,
  61        position = "top_left"
  62     }
  63
  64 Note that `mailcount` is 0 either if there are no new mails or credentials are invalid, so make sure you get the right settings.
  65
  66 ### output
  67
  68 A textbox.