fdd9e715e052594563f7393f57f49cf7bcd0f784
[claws.git] / src / plugins / libravatar / README
1 Libravatar plugin for Claws Mail
2 --------------------------------
3
4 This plugin allows showing the profile picture associated to email
5 addresses provided by https://www.libravatar.org/. You can read
6 more about what is this at http://wiki.libravatar.org/description/.
7
8 By default missing profiles in the libravatar site are also searched
9 in http://gravatar.com, so it will also show pictures from gravatar
10 profiles. This can be turned off by disallowing redirects.
11
12 When profile is missing in both sites there's options to use a
13 'generated' avatar instead. It's also possible to not generate
14 anything. In that case no image will be added and the existing
15 Face/X-Face machinery will operate as usual, allowing to show the
16 avatar images provided by those headers when no profile picture
17 exists in the servers.
18
19 This plugin uses libcurl to download images, so proxy support is
20 already implemented. You just need to set the “http_proxy” variable
21 in your environment before launching Claws Mail (see ENVIRONMENT
22 section in curl(1) manpage for details).
23
24 This plugin saves retrieved images for later reuse instead of making
25 a network request on every message. Cache directory is in
26 ~/.claws-mail/avatarcache. Does also save the missing ones in a
27 special file to avoid filling the cache with empty files. You can
28 control how much time will be kept there before trying to download
29 them again. Missing items are valid for more time, 7 times your
30 configured interval cache time. You can disable the image cache,
31 but notice that write access to avatarcache is still required.
32 Missing cache cannot be disabled.
33
34 The TODO file contains more known issues/enhancements, read it before
35 reporting bugs.
36
37 -- 
38 Ricardo Mones <ricardo@mones.org>
39