]> git.madduck.net Git - etc/awesome.git/blobdiff - 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 mpd (markdown)
[etc/awesome.git] / imap.md
diff --git a/imap.md b/imap.md
index 6590ee703758f09116060f7a7c0b3bbf5af96122..ba92d0fd06bf164882729337ff9fe155509dfa86 100644 (file)
--- a/imap.md
+++ b/imap.md
@@ -1,28 +1,16 @@
 [<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
 
 [<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
 
-**Please be warned**: this is a temporary solution, since it works fine in normal situations but causes little freezes if connection is sobbing. I am working on something much more solid.
+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:
+       myimapcheck = lain.widgets.imap(args)
 
 
-       +---------------------------------------------------+
-       | +---+                                             |
-       | |\ /| donald@disney.org has 3 new messages        |
-       | +---+                                             |
-       |       Latest From: Mickey Mouse <boss@disney.org> |
-    |       Subject: Re: pay raise                      |
-    |                                                   |
-    |       Not after what you did yesterday.           |
-    |       Daisy told me everything [...]              |
-       |                                                   |
-       +---------------------------------------------------+
+New mails are notified like this:
 
 
-Text will be cut if the mail is too long.
-
-       myimapcheck = lain.widgets.imap(args)
+       +--------------------------------------------+
+       | +---+                                      |
+       | |\ /| donald@disney.org has 3 new messages |
+       | +---+                                      |
+       +--------------------------------------------+
 
 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.
+
 ### output 
 
 A textbox.
\ No newline at end of file
 ### output 
 
 A textbox.
\ No newline at end of file