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