Add a note about bogo's initial learning
[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 only can filter emails after an initial learning (mark some
100         spams as Spam, and some legitimate emails as Ham).
101           </para><para>
102         Bogofilter is available from <ulink
103         url="http://bogofilter.sourceforge.net/"
104         >http://bogofilter.sourceforge.net/</ulink>.
105           </para>
106         </listitem>
107       </varlistentry>
108       <varlistentry>
109         <term>BSFilter</term>
110         <listitem>
111           <para> 
112         BSFilter is a plugin that is very similar to the Bogofilter plugin
113         but uses the bsfilter (<ulink url="http://bsfilter.org/index-e.html"
114         >bsfilter.org/index-e.html</ulink>) bayesian spam filter as a backend.
115           </para><para>
116         Like Bogofilter, you have to train it with spam and ham
117         messages in order for bsfilter to start recognising spam.
118           </para><para>
119         Plugin preferences can be found in 
120         <quote>Configuration/Preferences/Plugins/BSFilter</quote>.
121           </para>
122         </listitem>
123       </varlistentry>
124       <varlistentry>
125         <term>Clamd</term>
126         <listitem>
127           <para>
128         Allows scanning all messages received from IMAP, POP or local accounts
129         using the clam daemon part of the ClamAV (AntiVirus) software (<ulink
130         url="http://www.clamav.net/">http://www.clamav.net/</ulink>).
131           </para>
132         </listitem>
133       </varlistentry>
134       <varlistentry>
135         <term>Fancy</term>
136         <listitem>
137           <para>
138         Enables the rendering of HTML messages using the GTK+ port of the
139         WebKit library.
140           </para>
141         </listitem>
142       </varlistentry>
143       <varlistentry>
144         <term>Fetchinfo</term>
145         <listitem>
146           <para>
147         Inserts headers containing some download information, like UIDL, 
148         Claws Mail' account name, POP server, user ID and retrieval time.
149           </para>
150         </listitem>
151       </varlistentry>
152       <varlistentry>
153         <term>GData</term>
154         <listitem>
155           <para>
156         Provides an interface to Google services using the gdata library.
157         Currently, the only implemented functionality is to include Google
158         Contacts in the Tab-address completion.
159           </para>
160         </listitem>
161       </varlistentry>
162       <varlistentry>
163         <term>GeoLocation</term>
164         <listitem>
165           <para>
166         Provides geolocation functionality based on the addresses contained
167         in the messages.
168           </para>
169         </listitem>
170       </varlistentry>
171       <varlistentry>
172         <term>Libravatar</term>
173         <listitem>
174           <para>
175         Enables the display of avatar images associated with user profiles at
176         libravatar.org or the user's avatar enabled domains.
177         More information: <ulink
178         url="http://www.claws-mail.org/plugin.php?plugin=libravatar"
179         >www.claws-mail.org/plugin.php?plugin=libravatar</ulink>
180           </para>
181         </listitem>
182       </varlistentry>
183       <varlistentry>
184         <term>Mail Archiver</term>
185         <listitem>
186           <para>
187         Enables folders and subfolders to be archived in several different
188         formats.
189           </para>
190         </listitem>
191       </varlistentry>
192       <varlistentry>
193         <term>mailMBOX</term>
194         <listitem>
195           <para>
196         Handles mailboxes in MBox format.
197           </para>
198         </listitem>
199       </varlistentry>
200       <varlistentry>
201         <term>NewMail</term>
202         <listitem>
203           <para>
204         Writes a message header summary to a log file, (Default:
205         <filename>~/Mail/NewLog</filename>), on arrival of new mail
206         <emphasis>after</emphasis> sorting.
207           </para>
208         </listitem>
209       </varlistentry>
210       <varlistentry>
211         <term>Notification</term>
212         <listitem>
213           <para>
214         Provides various ways to notify the user of new and unread email.
215         More information: <ulink
216         url="http://www.claws-mail.org/plugin.php?plugin=notification"
217         >www.claws-mail.org/plugin.php?plugin=notification</ulink>
218           </para>
219         </listitem>
220       </varlistentry>
221       <varlistentry>
222         <term>PDF Viewer</term>
223         <listitem>
224           <para>
225         Allows rendering of PDF and PostScript attachments using the Poppler
226         library and GhostScript external program.
227         More information: <ulink
228         url="http://www.claws-mail.org/plugin.php?plugin=pdf_viewer"
229         >www.claws-mail.org/plugin.php?plugin=pdf_viewer</ulink>
230           </para>
231         </listitem>
232       </varlistentry>
233       <varlistentry>
234         <term>Perl</term>
235         <listitem>
236           <para>
237         Intended to extend the filtering possibilities of Claws Mail. It 
238         provides a Perl interface to Claws Mail' filtering mechanism, 
239         allowing the use of full Perl power in email filters.
240           </para>
241         </listitem>
242       </varlistentry>
243       <varlistentry>
244         <term>PGP/Core, PGP/Inline and PGP/MIME</term>
245         <listitem>
246           <para>
247         Handles PGP signed and/or encrypted mails. You can decrypt mails,
248         verify signatures or sign and encrypt your own mails. Uses GnuPG/GPGME,
249         <ulink url="ftp://ftp.gnupg.org/gcrypt/gpgme/"
250         >ftp://ftp.gnupg.org/gcrypt/gpgme/</ulink>.
251         More information: <ulink
252         url="http://www.claws-mail.org/plugin.php?plugin=gpg"
253         >www.claws-mail.org/plugin.php?plugin=gpg</ulink>
254           </para>
255         </listitem>
256       </varlistentry>
257       <varlistentry>
258         <term>Python</term>
259         <listitem>
260           <para>
261         This plugin provides Python integration features.
262         More information: <ulink
263         url="http://www.claws-mail.org/plugin.php?plugin=python"
264         >www.claws-mail.org/plugin.php?plugin=python</ulink>
265           </para>
266         </listitem>
267       </varlistentry>
268       <varlistentry>
269         <term>RSSyl</term>
270         <listitem>
271           <para>
272         Allows you to read your favorite newsfeeds in Claws. RSS 1.0, 2.0 and 
273         Atom feeds are currently supported.
274         More information: <ulink
275         url="http://www.claws-mail.org/plugin.php?plugin=rssyl"
276         >www.claws-mail.org/plugin.php?plugin=rssyl</ulink>
277           </para>
278         </listitem>
279       </varlistentry>
280       <varlistentry>
281         <term>S/MIME</term>
282         <listitem>
283           <para>
284         Handles S/MIME signed and/or encrypted mails. You can decrypt mails,
285         verify signatures or sign and encrypt your own mails. Uses GnuPG/GPGME
286         and GpgSM, <ulink url="ftp://ftp.gnupg.org/gcrypt/gpgme/"
287         >ftp://ftp.gnupg.org/gcrypt/gpgme/</ulink>.
288           </para>
289         </listitem>
290       </varlistentry>
291       <varlistentry>
292         <term>SpamAssassin</term>
293         <listitem>
294           <para>
295         The SpamAssassin plugin comes with two major features:
296           </para><para>
297         The ability to scan incoming mail received from a POP, IMAP or LOCAL
298         account using SpamAssassin. It can optionally delete mail identified
299         as spam or save it to a designated folder. Mail scanning can be turned
300         off, which is useful if your email is scanned on your server.
301           </para><para>
302         The ability for users to teach SpamAssassin to recognise spam or ham.
303         You can train SpamAssassin by marking messages as spam or ham from the
304         Message List contextual menu, or using the relevant toolbar button in
305         the main window or the message window (see
306         <quote>Configuration/Preferences/Toolbars</quote>). Messages
307         marked as spam are optionally saved to a designated folder.
308           </para><para>
309         Plugin preferences can be found in
310         <quote>Configuration/Preferences/Plugins/SpamAssassin</quote>.
311           </para><para>
312         SpamAssassin's advantage over Bogofilter is that it's not only a
313         bayesian filter, but it also performs various local and network tests
314         to determine spaminess.
315           </para><para>
316         SpamAssassin is available from <ulink
317         url="http://spamassassin.apache.org/"
318         >http://spamassassin.apache.org/</ulink>. Version 3.1.x or higher is
319         required to use the learning feature in TCP mode.
320           </para>
321         </listitem>
322       </varlistentry>
323       <varlistentry>
324         <term>SpamReport</term>
325         <listitem>
326           <para>
327         This plugin reports spam to various places.
328         Currently the sites <ulink url="http://spam-signal.fr"
329         >spam-signal.fr</ulink> and <ulink url="http://spamcop.net"
330         >spamcop.net</ulink> are supported, and the <ulink
331         url="http://lists.debian.org">Debian lists (lists.debian.org)</ulink>
332         spam nomination system.
333           </para>
334         </listitem>
335       </varlistentry>
336       <varlistentry>
337         <term>TNEF parse</term>
338         <listitem>
339           <para>
340         This plugin enables reading <literal>application/ms-tnef</literal> attachments.
341         More information: <ulink
342         url="http://www.claws-mail.org/plugin.php?plugin=tnef_parser"
343         >www.claws-mail.org/plugin.php?plugin=tnef_parser</ulink>
344           </para>
345         </listitem>
346       </varlistentry>
347       <varlistentry>
348         <term>vCalendar</term>
349         <listitem>
350           <para>
351         Enables vCalendar message handling like that produced by Evolution or 
352         Outlook, and Webcal subscriptions.
353         More information: <ulink
354         url="http://www.claws-mail.org/plugin.php?plugin=vcalendar"
355         >www.claws-mail.org/plugin.php?plugin=vcalendar</ulink>
356           </para>
357         </listitem>
358       </varlistentry>
359     </variablelist>
360     <para>
361         If you're a developer, writing a plugin to extend Claws Mail's
362         capabilities is probably the best and easiest solution. We will 
363         provide hosting to your code, and will be glad to answer your questions
364         in the mailing-list or on the IRC channels, 
365         <literal>#claws</literal> on Freenode or IRCnet.
366     </para>
367   </section>
368
369   <section id="plugins_network">
370     <title>Network access from the plugins</title>
371     <para>
372         Some of the external plugins, for example RSSyl, vCalendar, Libravatar
373         or Fancy, need Internet access for their operations (retrieving feeds in
374         the case of RSSyl or vCalendar, and fetching images in the case of
375         Libravatar or Fancy). These plugins use the Curl library. Hence, if your
376         Internet access is restricted by a proxy, you will need to tell libCurl
377         to use this proxy. This is done by setting an environment variable,
378         <literal>http_proxy</literal>. For example, 
379         <literal>http_proxy=http://user:passwd@myproxy.example.com:8080</literal>
380         will tell libCurl to connect to port 8080 of the machine
381         myproxy.example.com, with the user <quote>user</quote> and password
382         <quote>passwd</quote> to connect to the Internet.
383     </para><para>
384         You can either set this variable before starting Claws Mail by
385         using, for example,
386         <command>http_proxy=http://user:passwd@myproxy.example.com:8080
387         claws-mail</command>, or you can set it in your
388         <filename>~/.bashrc</filename> file (or your shell equivalent), by
389         adding the following line<footnote><para>Other shells may have
390         diferent syntaxes, check your shell's manual page.</para></footnote>:
391         <command
392         >export http_proxy=http://user:passwd@myproxy.example.com:8080</command>
393         (you'll have to reconnect to have it taken into account).
394     </para>
395   </section>
396
397 </section>
398