1Libravatar plugin for Claws Mail
2================================
3
41. What is it for?
52. Network issues
63. Cache details
74. Reporting bugs
8
91. What is it for?
10------------------
11
12This plugin allows showing the profile picture associated to email
13addresses provided by https://www.libravatar.org/. You can read
14more about what is this at http://wiki.libravatar.org/description/.
15
16By default missing profiles in the libravatar site are also searched
17in http://gravatar.com, so it will also show pictures from gravatar
18profiles. This can be turned off by disallowing redirects.
19
20When profile is missing in both sites there's options to use a
21'generated' avatar instead. It's also possible to not generate
22anything. In that case no image will be added and the existing
23Face/X-Face machinery will operate as usual, allowing to show the
24avatar images provided by those headers when no profile picture
25exists in the servers.
26
272. Network issues
28-----------------
29
30This plugin requires a reliable network connection to work. If your
31connection is unreliable or has high latency you're going to experience
32delays when viewing messages for first time (or always if you disable
33cache, which is not recommended, of course).
34
35Another option to alleviate high network latency is to install a local
36libravatar server (see http://wiki.libravatar.org/running_your_own/),
37then change the “base_url” hidden property on your ~/.claws-mail/clawsrc
38file to point your local server URL instead of Libravatar project's URL.
39
40Yet another option is using a caching proxy on your network.
41
42This plugin uses libcurl to download images, so proxy support is
43already implemented. You just need to set the “http_proxy” variable
44in your environment before launching Claws Mail (see ENVIRONMENT
45section in curl(1) manpage for details).
46
473. Cache details
48----------------
49
50This plugin saves retrieved images for later reuse instead of making
51a network request on every message. Cache directory is in
52~/.claws-mail/avatarcache. Does also save the missing ones in a
53special file to avoid filling the cache with empty files.
54
55You can control how much time will be kept there before trying to
56download them again. Missing items are valid for more time, 7 times
57your configured interval cache time. You can disable the image cache,
58but notice that write access to avatarcache is still required.
59Missing cache cannot be disabled.
60
614. Reporting bugs
62-----------------
63
64The TODO file contains more known issues/enhancements, please read it
65before reporting bugs.
66
67--
68Ricardo Mones <ricardo@mones.org>
69
70