reword plugins section, and add info about auto-configure to starting section
[claws.git] / manual / plugins.xml
1 <?xml version="1.0" encoding="utf-8"?>
2 <section id="ch_plugins">
3 <title>Extending Claws Mail</title>
4
5   <section id="plugins_default">
6     <title>Plugins</title>
7     <para>
8         Claws Mail's capabilities are extended by plugins, which are
9         listed below.
10     </para><para>
11         Plugins are installed in <filename class="directory"
12         >$PREFIX/lib/claws-mail/plugins/</filename> and have a suffix of 
13         <quote>.so</quote>. To load a plugin go to 
14         <quote>Configuration/Plugins</quote> and click the 
15         <quote>Load Plugin</quote> button. Select the plugin that you want and 
16         click <quote>Open</quote> button.
17     </para><para>
18         If you don't find the plugin you're looking for, it is possible that 
19         your Operating System distribution provides it in a separate package. 
20         In this case, search for the plugin in your package manager.
21     </para><para>
22         Some plugins provide the same functionality as others, (for example, the 
23         3 anti-Spam plugins). In this case you will have to choose which 
24         one to load, as Claws Mail will refuse to load more than one of
25         the same type.
26     </para>
27     <para>
28         There is a list of all plugins available at <ulink
29         url="http://www.claws-mail.org/plugins.php"
30         >http://www.claws-mail.org/plugins.php</ulink>.
31     </para>
32     <variablelist>
33       <varlistentry>
34         <term>ACPI Notifier</term>
35         <listitem>
36           <para>
37         Enables new mail notification via the LEDs found on some laptops like
38         Acer, Asus, Fujitsu and IBM laptops.
39         More information: <ulink
40         url="http://www.claws-mail.org/plugin.php?plugin=acpinotifier"
41         >www.claws-mail.org/plugin.php?plugin=acpinotifier</ulink>
42           </para>
43         </listitem>
44       </varlistentry>
45       <varlistentry>
46         <term>AddressKeeper</term>
47         <listitem>
48           <para>
49         Saves all unknown recipient addresses (<quote>To</quote>,
50         <quote>Cc</quote> and/or <quote>Bcc</quote>) to a designated
51         addressbook folder.
52           </para>
53         </listitem>
54       </varlistentry>
55       <varlistentry>
56         <term>AttachWarner</term>
57         <listitem>
58           <para>
59         Reminds you about possibly forgotten attachments. Checks for common
60         expressions found when attaching a file and warns you if no attachment
61         was added to the mail you're sending.
62         More information: <ulink
63         url="http://www.claws-mail.org/plugin.php?plugin=attachwarner"
64         >www.claws-mail.org/plugin.php?plugin=attachwarner</ulink>
65           </para>
66         </listitem>
67       </varlistentry>
68       <varlistentry>
69         <term>AttRemover</term>
70         <listitem>
71           <para>
72         Allows you to remove attachments from emails.
73           </para>
74         </listitem>
75       </varlistentry>
76       <varlistentry>
77         <term>Bogofilter</term>
78         <listitem>
79           <para>
80         The Bogofilter plugin comes with two major features:
81           </para><para>
82         The ability to scan incoming mail received from a POP, IMAP or LOCAL 
83         account using Bogofilter. It can optionally delete mail identified
84         as spam or save it to a designated folder. Mail scanning can be turned 
85         off.
86           </para><para>
87         The ability for users to teach Bogofilter to recognise spam or ham.
88         You can train Bogofilter by marking messages as spam or ham from the
89         Message List contextual menu, or using the relevant toolbar button in 
90         the main window or the message window (see 
91         <quote>Configuration/Preferences/Toolbars</quote>). Messages 
92         marked as spam are optionally saved to a designated folder.
93           </para><para>
94         Plugin preferences can be found in 
95         <quote>Configuration/Preferences/Plugins/Bogofilter</quote>.
96           </para><para>
97         Bogofilter's advantage over Spamassassin is its speed.
98           </para><para>
99         Bogofilter is available from <ulink
100         url="http://bogofilter.sourceforge.net/"
101         >http://bogofilter.sourceforge.net/</ulink>.
102           </para>
103         </listitem>
104       </varlistentry>
105       <varlistentry>
106         <term>BSFilter</term>
107         <listitem>
108           <para> 
109         BSFilter is a plugin that is very similar to the Bogofilter plugin
110         but uses the bsfilter (<ulink url="http://bsfilter.org/index-e.html"
111         >bsfilter.org/index-e.html</ulink>) bayesian spam filter as a backend.
112           </para><para>
113         Like Bogofilter, you have to train it with spam and ham
114         messages in order for bsfilter to start recognising spam.
115           </para><para>
116         Plugin preferences can be found in 
117         <quote>Configuration/Preferences/Plugins/BSFilter</quote>.
118           </para>
119         </listitem>
120       </varlistentry>
121       <varlistentry>
122         <term>Clamd</term>
123         <listitem>
124           <para>
125         Allows scanning all messages received from IMAP, POP or local accounts
126         using the clam daemon part of the Clam AV (AntiVirus) software.
127           </para>
128         </listitem>
129       </varlistentry>
130       <varlistentry>
131         <term>Fancy</term>
132         <listitem>
133           <para>
134         Enables the display of HTML messages using the GTK+ port of the
135         WebKit library.
136           </para>
137         </listitem>
138       </varlistentry>
139       <varlistentry>
140         <term>Fetchinfo</term>
141         <listitem>
142           <para>
143         Inserts headers containing some download information, like UIDL, 
144         Claws Mail' account name, POP server, user ID and retrieval time.
145           </para>
146         </listitem>
147       </varlistentry>
148       <varlistentry>
149         <term>GData</term>
150         <listitem>
151           <para>
152         Provides an interface to Google services using the gdata library.
153         Currently, the only implemented functionality is to include Google
154         Contacts in the Tab-address completion.
155           </para>
156         </listitem>
157       </varlistentry>
158       <varlistentry>
159         <term>GeoLocation</term>
160         <listitem>
161           <para>
162         Provides geolocation functionality based on the addresses contained
163         in the messages.
164           </para>
165         </listitem>
166       </varlistentry>
167       <varlistentry>
168         <term>Libravatar</term>
169         <listitem>
170           <para>
171         Enables displaying avatar images associated to user profiles in
172         libravatar.org or user's avatar enabled domains.
173         More information: <ulink
174         url="http://www.claws-mail.org/plugin.php?plugin=libravatar"
175         >www.claws-mail.org/plugin.php?plugin=libravatar</ulink>
176           </para>
177         </listitem>
178       </varlistentry>
179       <varlistentry>
180         <term>Mail Archiver</term>
181         <listitem>
182           <para>
183         Enables folders and subfolders to be archived in several different
184         formats.
185           </para>
186         </listitem>
187       </varlistentry>
188       <varlistentry>
189         <term>mailMBOX</term>
190         <listitem>
191           <para>
192         Handles mailboxes in MBox format.
193           </para>
194         </listitem>
195       </varlistentry>
196       <varlistentry>
197         <term>NewMail</term>
198         <listitem>
199           <para>
200         Writes a msg header summary to a log file, (Default: 
201         <filename>~/Mail/NewLog</filename>), on arrival of new mail 
202         <emphasis>after</emphasis> sorting. 
203           </para>
204         </listitem>
205       </varlistentry>
206       <varlistentry>
207         <term>Notification</term>
208         <listitem>
209           <para>
210         Provides various ways to notify the user of new and unread email.
211         More information: <ulink
212         url="http://www.claws-mail.org/plugin.php?plugin=notification"
213         >www.claws-mail.org/plugin.php?plugin=notification</ulink>
214           </para>
215         </listitem>
216       </varlistentry>
217       <varlistentry>
218         <term>PDF Viewer</term>
219         <listitem>
220           <para>
221         Allows rendering of PDF and PostScript attachments using the Poppler
222         library and GhostScript external program.
223         More information: <ulink
224         url="http://www.claws-mail.org/plugin.php?plugin=pdf_viewer"
225         >www.claws-mail.org/plugin.php?plugin=pdf_viewer</ulink>
226           </para>
227         </listitem>
228       </varlistentry>
229       <varlistentry>
230         <term>Perl</term>
231         <listitem>
232           <para>
233         Intended to extend the filtering possibilities of Claws Mail. It 
234         provides a Perl interface to Claws Mail' filtering mechanism, 
235         allowing the use of full Perl power in email filters.
236           </para>
237         </listitem>
238       </varlistentry>
239       <varlistentry>
240         <term>PGP/Core, PGP/Inline and PGP/MIME</term>
241         <listitem>
242           <para>
243         Handles PGP signed and/or encrypted mails. You can decrypt mails,
244         verify signatures or sign and encrypt your own mails. Uses GnuPG/GPGME,
245         <ulink url="ftp://ftp.gnupg.org/gcrypt/gpgme/"
246         >ftp://ftp.gnupg.org/gcrypt/gpgme/</ulink>.
247         More information: <ulink
248         url="http://www.claws-mail.org/plugin.php?plugin=gpg"
249         >www.claws-mail.org/plugin.php?plugin=gpg</ulink>
250           </para>
251         </listitem>
252       </varlistentry>
253       <varlistentry>
254         <term>Python</term>
255         <listitem>
256           <para>
257         This plugin provides Python integration features.
258         More information: <ulink
259         url="http://www.claws-mail.org/plugin.php?plugin=python"
260         >www.claws-mail.org/plugin.php?plugin=python</ulink>
261           </para>
262         </listitem>
263       </varlistentry>
264       <varlistentry>
265         <term>RSSyl</term>
266         <listitem>
267           <para>
268         Allows you to read your favorite newsfeeds in Claws. RSS 1.0, 2.0 and 
269         Atom feeds are currently supported.
270         More information: <ulink
271         url="http://www.claws-mail.org/plugin.php?plugin=rssyl"
272         >www.claws-mail.org/plugin.php?plugin=rssyl</ulink>
273           </para>
274         </listitem>
275       </varlistentry>
276       <varlistentry>
277         <term>S/MIME</term>
278         <listitem>
279           <para>
280         Handles S/MIME signed and/or encrypted mails. You can decrypt mails,
281         verify signatures or sign and encrypt your own mails. Uses GnuPG/GPGME
282         and GpgSM, <ulink url="ftp://ftp.gnupg.org/gcrypt/gpgme/"
283         >ftp://ftp.gnupg.org/gcrypt/gpgme/</ulink>.
284           </para>
285         </listitem>
286       </varlistentry>
287       <varlistentry>
288         <term>SpamAssassin</term>
289         <listitem>
290           <para>
291         The SpamAssassin plugin comes with two major features:
292           </para><para>
293         The ability to scan incoming mail received from a POP, IMAP or LOCAL
294         account using SpamAssassin. It can optionally delete mail identified
295         as spam or save it to a designated folder. Mail scanning can be turned
296         off, which is useful if your email is scanned on your server.
297           </para><para>
298         The ability for users to teach SpamAssassin to recognise spam or ham.
299         You can train SpamAssassin by marking messages as spam or ham from the
300         Message List contextual menu, or using the relevant toolbar button in
301         the main window or the message window (see
302         <quote>Configuration/Preferences/Toolbars</quote>). Messages
303         marked as spam are optionally saved to a designated folder.
304           </para><para>
305         Plugin preferences can be found in
306         <quote>Configuration/Preferences/Plugins/SpamAssassin</quote>.
307           </para><para>
308         SpamAssassin's advantage over Bogofilter is that it's not only a
309         bayesian filter, but it also performs various local and network tests
310         to determine spaminess.
311           </para><para>
312         SpamAssassin is available from <ulink
313         url="http://spamassassin.apache.org/"
314         >http://spamassassin.apache.org/</ulink>. Version 3.1.x or higher is
315         required to use the learning feature in TCP mode.
316           </para>
317         </listitem>
318       </varlistentry>
319       <varlistentry>
320         <term>SpamReport</term>
321         <listitem>
322           <para>
323         This plugin reports spam to various places.
324         Currently the sites <ulink url="http://spam-signal.fr"
325         >spam-signal.fr</ulink> and <ulink url="http://spamcop.net"
326         >spamcop.net</ulink> are supported, and the <ulink
327         url="http://lists.debian.org">Debian lists (lists.debian.org)</ulink>
328         spam nomination system.
329           </para>
330         </listitem>
331       </varlistentry>
332       <varlistentry>
333         <term>TNEF parse</term>
334         <listitem>
335           <para>
336         This plugin enables reading <literal>application/ms-tnef attachments</literal>.
337         More information: <ulink
338         url="http://www.claws-mail.org/plugin.php?plugin=tnef_parser"
339         >www.claws-mail.org/plugin.php?plugin=tnef_parser</ulink>
340           </para>
341         </listitem>
342       </varlistentry>
343       <varlistentry>
344         <term>vCalendar</term>
345         <listitem>
346           <para>
347         Enables vCalendar message handling like that produced by Evolution or 
348         Outlook, and Webcal subscriptions.
349         More information: <ulink
350         url="http://www.claws-mail.org/plugin.php?plugin=vcalendar"
351         >www.claws-mail.org/plugin.php?plugin=vcalendar</ulink>
352           </para>
353         </listitem>
354       </varlistentry>
355     </variablelist>
356     <para>
357         If you're a developer, writing a plugin to extend Claws Mail's
358         capabilities is probably the best and easiest solution. We will 
359         provide hosting to your code, and will be glad to answer your questions
360         in the mailing-list or on the IRC channels, 
361         <literal>#claws</literal> on Freenode or IRCnet.
362     </para>
363   </section>
364
365   <section id="plugins_network">
366     <title>Network access from the plugins</title>
367     <para>
368         Some of the external plugins, for example RSSyl, vCalendar or GtkHtml 
369         Viewer, need Internet access for their operations (retrieving feeds in 
370         the case of RSSyl or vCalendar, and fetching images in the case of 
371         GtkHtml Viewer). These plugins use the Curl library. Hence, if your 
372         Internet access is restricted by a proxy, you will need to tell libCurl
373         to use this proxy. This is done by setting an environment variable, 
374         <literal>http_proxy</literal>. For example, 
375 <literal>http_proxy=http://user:passwd@myproxy.example.com:8080</literal> 
376         will tell libCurl to connect to port 8080 of the machine 
377         myproxy.example.com, with the user <quote>user</quote> and password 
378         <quote>passwd</quote> to connect to the Internet. 
379     </para><para>
380         You can either set this variable before starting Claws Mail, by 
381         using for example 
382         <command>http_proxy=http://user:passwd@myproxy.example.com:8080 
383         claws-mail</command>, or set it in your 
384         <filename>~/.bashrc</filename> file (or your shell equivalent), by 
385         adding the following line<footnote><para>Other shells may have 
386         diferent syntaxes, check your shell's manual page.</para></footnote>: 
387 <command>export http_proxy=http://user:passwd@myproxy.example.com:8080</command>
388         (you'll have to reconnect to have it taken into account).
389     </para>
390   </section>
391
392 </section>
393