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