]> 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:

Destroyed To start (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 Dependencies:
6
7 - python3
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 | Type
30 --- | --- 
31 `server` | string
32 `mail` | string
33 `password` | string
34
35 while the optional are:
36
37 Variable | Meaning | Type | Default
38 --- | --- | --- | ---
39 `port` | IMAP port | int | 993
40 `refresh_timeout` | Refresh timeout seconds | int | 60
41 `header` | Text to show before value | string | " Mail "
42 `header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF"
43 `color` | Mail value color | string | `beautiful.fg_focus` or "#FFFFFF"
44 `footer` | Text to append after value | string | " "
45 `mail_encoding` | Mail character encoding | string | autodetected
46 `maxlen` | Maximum chars to display in notification | int | 200
47 `app` | Mail program to spawn on click | string | "mutt"
48 `shadow` | Hide widget when there are no mails | boolean | false
49 `is_plain` | Define whether `password` is a plain password (true) or a function that retrieves it (false) | boolean | false
50
51 **Note**: `footer` can be markup text.
52
53 Let's focus better on `is_plain`.
54
55 You can just set your password like this:
56
57     args.is_plain = false
58     args.password = "mypassword"
59
60 and you'll have the same security provided by `~/.netrc`.
61
62 **Or** you can use a keyring, like [python keyring](https://pypi.python.org/pypi/keyring):
63
64     args.password = "keyring get password"
65
66 When `is_plain == false`, it *executes* `password` before using it, so you can also use whatever password fetching solution you want.
67
68 You can also define your custom icon for the naughty notification. Just set `lain_mail_notify` into `theme.lua`:
69
70     theme.lain_mail_notify = "/path/to/my/icon"