imap.md

   1 [<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
   2
   3 **Please be warned**: as for now, this works fine in normal link situations, but is discouraged to use it if your connection is sobbing, since it may cause some short freezes. I am at work to solve this.
   4
   5 Shows mail status in a textbox over IMAP protocol.
   6
   7 New mails are notified through a notification like this:
   8
   9         +---------------------------------------------------+
  10         | +---+                                             |
  11         | |\ /| donald@disney.org has 3 new messages        |
  12         | +---+                                             |
  13         |       Latest From: Mickey Mouse <boss@disney.org> |
  14     |       Subject: Re: pay raise                      |
  15     |                                                   |
  16     |       Not after what you did yesterday.           |
  17     |       Daisy told me everything [...]              |
  18         |                                                   |
  19         +---------------------------------------------------+
  20
  21 Text will be cut if the mail is too long.
  22
  23         myimapcheck = lain.widgets.imap(args)
  24
  25 The function takes a table as argument. Required table parameters are:
  26
  27 Variable | Meaning | Type
  28 --- | --- | ---
  29 `server` | Mail server | string
  30 `mail` | User mail | string
  31 `password` | User password | string
  32
  33 while the optional are:
  34
  35 Variable | Meaning | Type | Default
  36 --- | --- | --- | ---
  37 `port` | IMAP port | int | 993
  38 `timeout` | Refresh timeout seconds | int | 60
  39 `encoding` | Mail character encoding | string | autodetected
  40 `maxlen` | Maximum chars to display in notification | int | 200
  41 `is_plain` | Define whether `password` is a plain password (true) or a function that retrieves it (false) | boolean | false
  42 `settings` | User settings | function
  43
  44 Let's focus better on `is_plain`.
  45
  46 You can just set your password like this:
  47
  48     args.is_plain = false
  49     args.password = "mypassword"
  50
  51 and you'll have the same security provided by `~/.netrc`.
  52
  53 **Or** you can use a keyring, like [python keyring](https://pypi.python.org/pypi/keyring):
  54
  55     args.password = "keyring get password"
  56
  57 When `is_plain == false`, it *executes* `password` before using it, so you can also use whatever password fetching solution you want.
  58
  59 `settings` can use the string `mailcount`, whose possible values are:
  60
  61 - "0"
  62 - "invalid credentials"
  63 - string number
  64
  65 and can modify `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. Default definition:
  66
  67     notification _preset = {
  68        icon = lain/icons/mail.png,
  69        timeout = 8,
  70        position = "top_left"
  71     }
  72
  73 ### output
  74
  75 A textbox.