]> git.madduck.net Git - etc/awesome.git/blob - imap.md

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

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