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

projects / etc / awesome.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Updated net (markdown)
[etc/awesome.git] / imap.md
diff --git a/imap.md b/imap.md
index 97cd437fa3a2984563420863b03e9c798da7d4d1..ba92d0fd06bf164882729337ff9fe155509dfa86 100644 (file)
--- a/imap.md
+++ b/imap.md
@@ -1,54 +1,33 @@
 [<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
 
 [<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
 
-Shows mail status in a textbox over IMAP protocol.
+Shows mail count in a textbox fetching over IMAP.
 
 
-Dependencies:
-
-- python3
-
-New mails are notified through a notification like this:
-
-       +---------------------------------------------------+
-       | +---+                                             |
-       | |\ /| 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 [...]              |
-       |                                                   |
-       +---------------------------------------------------+
+       myimapcheck = lain.widgets.imap(args)
 
 
-Text will be cut if the mail is too long.
+New mails are notified like this:
 
 
-       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:
 
-Variable | Type
---- | --- 
-`server` | string
-`mail` | string
-`password` | string
+Variable | Meaning | Type
+--- | --- | ---
+`server` | Mail server | string
+`mail` | User mail | string
+`password` | User password | string
 
 while the optional are:
 
 Variable | Meaning | Type | Default
 --- | --- | --- | ---
 `port` | IMAP port | int | 993
 
 while the optional are:
 
 Variable | Meaning | Type | Default
 --- | --- | --- | ---
 `port` | IMAP port | int | 993
-`refresh_timeout` | Refresh timeout seconds | int | 60
-`header` | Text to show before value | string | " Mail "
-`header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF"
-`color` | Mail value color | string | `beautiful.fg_focus` or "#FFFFFF"
-`footer` | Text to append after value | string | " "
-`mail_encoding` | Mail character encoding | string | autodetected
-`maxlen` | Maximum chars to display in notification | int | 200
-`app` | Mail program to spawn on click | string | "mutt"
-`shadow` | Hide widget when there are no mails | boolean | false
+`timeout` | Refresh timeout seconds | int | 60
 `is_plain` | Define whether `password` is a plain password (true) or a function that retrieves it (false) | boolean | false
 `is_plain` | Define whether `password` is a plain password (true) or a function that retrieves it (false) | boolean | false
-
-**Note**: `footer` can be markup text.
+`settings` | User settings | function
 
 Let's focus better on `is_plain`.
 
 
 Let's focus better on `is_plain`.
 
@@ -65,6 +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.
 
-You can also define your custom icon for the naughty notification. Just set `lain_mail_notify` into `theme.lua`:
+`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. 
+
+Default definition:
+
+    mail_notification _preset = {
+       icon = lain/icons/mail.png,
+       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 
 
 
-    theme.lain_mail_notify = "/path/to/my/icon"
\ No newline at end of file
+A textbox.
\ No newline at end of file
awesome window-manager configuration

Legalese

All content available in this repository is copyright © martin f. krafft, unless otherwise noted.

All files and their content are released under the terms of the Artistic Licence 2.0, unless otherwise noted.

The operator of this repository shall not be held liable for offending content in pages linking to or linked from these page, nor does he endorse their content unless stated otherwise.