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.
-**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.
+Shows mail count in a textbox fetching over IMAP.
----
-
-Shows mail status in a textbox over IMAP protocol.
-
-New mails are notified through a notification like this:
The function takes a table as argument. Required table parameters are:
The function takes a table as argument. Required table parameters are:
@@ -38,8+26,6 @@ Variable | Meaning | Type | Default
--- | --- | --- | ---
`port` | IMAP port | int | 993
`timeout` | Refresh timeout seconds | int | 60
--- | --- | --- | ---
`port` | IMAP port | int | 993
`timeout` | Refresh timeout seconds | int | 60
-`encoding` | Mail character encoding | string | autodetected
-`maxlen` | Maximum chars to display in notification | int | 200
`is_plain` | Define whether `password` is a plain password (true) or a function that retrieves it (false) | boolean | false
`settings` | User settings | function
`is_plain` | Define whether `password` is a plain password (true) or a function that retrieves it (false) | boolean | false
`settings` | User settings | function
@@ -58,20+44,17 @@ and you'll have the same security provided by `~/.netrc`.
When `is_plain == false`, it *executes* `password` before using it, so you can also use whatever password fetching solution you want.
When `is_plain == false`, it *executes* `password` before using it, so you can also use whatever password fetching solution you want.
-`settings` can use the string `mailcount`, whose possible values are:
-
-- "0"
-- "invalid credentials"
-- string number
+`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.
-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:
+Default definition:
- notification _preset = {
+ mail_notification _preset = {
icon = lain/icons/mail.png,
icon = lain/icons/mail.png,
- timeout = 8,
position = "top_left"
}
position = "top_left"
}
+Note that `mailcount` is 0 either if there are no new mails or credentials are invalid, so make sure you get the right settings.
projects / etc / awesome.git / blobdiff