2009-09-10 [mones] 3.7.2cvs30
[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>SpamAssassin</term>
84         <listitem>
85           <para>
86         The SpamAssassin plugin comes with two major features:
87           </para><para>
88         The ability to scan incoming mail received from a POP, IMAP or LOCAL 
89         account using SpamAssassin. It can optionally delete mail identified 
90         as spam or save it to a designated folder. Mail scanning can be turned 
91         off, which is useful if your email is scanned on your server.
92           </para><para>
93         The ability for users to teach SpamAssassin to recognise spam or ham. 
94         You can train SpamAssassin by marking messages as spam or ham from the 
95         Message List contextual menu, or using the relevant toolbar button in 
96         the main window or the message window (see 
97         <quote>Configuration/Preferences/Toolbars</quote>). Messages 
98         marked as spam are optionally saved to a designated folder.
99           </para><para>
100         Plugin preferences can be found in 
101         <quote>Configuration/Preferences/Plugins/SpamAssassin</quote>.
102           </para><para>
103         SpamAssassin's advantage over Bogofilter is that it's not only a bayesian
104         filter, but it also performs various local and network tests to
105         determine spaminess.
106           </para><para>
107         SpamAssassin is available from <ulink 
108         url="http://spamassassin.apache.org/"
109         >http://spamassassin.apache.org/</ulink>. Version 3.1.x or higher is 
110         required to use the learning feature in TCP mode.
111           </para>
112         </listitem>
113       </varlistentry>
114       <varlistentry>
115         <term>Trayicon</term>
116         <listitem>
117           <para>
118         Places an icon in the system tray that indicates whether you have any 
119         new mail. A tooltip also shows the current new, unread and total number
120         of messages.
121           </para>
122         </listitem>
123       </varlistentry>
124     </variablelist>
125   </section>
126
127   <section id="plugins_external">
128     <title>More plugins</title>
129     <para>
130         Other plugins have been written too, which are available as separate 
131         downloads. At the time of this writing, there are a number of plugins 
132         available at <ulink url="http://www.claws-mail.org/plugins.php"
133         >http://www.claws-mail.org/plugins.php</ulink>:
134     </para>
135     <variablelist>
136       <varlistentry>
137         <term>Acpi Notifier</term>
138         <listitem>
139           <para>
140         Enables new mail notification via the LEDs found on some laptops like 
141         Acer, Asus, Fujitsu and IBM laptops.
142           </para>
143         </listitem>
144       </varlistentry>
145       <varlistentry>
146         <term>AttachWarner</term>
147         <listitem>
148           <para> 
149         Reminds you about possibly forgotten attachments. Checks for common
150         expressions found when attaching a file and warns you if no attachment
151         was added to the mail you're sending.
152           </para>
153         </listitem>
154       </varlistentry>
155       <varlistentry>
156         <term>AttRemover</term>
157         <listitem>
158           <para> 
159         Allows you to remove attachments from emails.
160           </para>
161         </listitem>
162       </varlistentry>
163       <varlistentry>
164         <term>BSFilter</term>
165         <listitem>
166           <para> 
167         BSFilter is a plugin that is very similar to the Bogofilter plugin but uses
168         the <ulink url="http://bsfilter.org/index-e.html">bsfilter</ulink>
169         bayesian spam filter as a backend. 
170           </para><para>
171         Like Bogofilter, you have to train it with spam and ham
172         messages in order for bsfilter to start recognising spam.
173           </para><para>
174         Plugin preferences can be found in 
175         <quote>Configuration/Preferences/Plugins/BSFilter</quote>.
176           </para>
177         </listitem>
178       </varlistentry>
179       <varlistentry>
180         <term>CacheSaver</term>
181         <listitem>
182           <para>
183         Saves the caches every 60 seconds (or user-defined period). It helps 
184         avoiding the loss of metadata if your computer (<emphasis>or 
185         Claws Mail!</emphasis>) crashes. (NOTE: using this plugin can slow
186         down Claws Mail.)
187           </para>
188         </listitem>
189       </varlistentry>
190       <varlistentry>
191         <term>Fancy</term>
192         <listitem>
193           <para>
194         Enables the display of HTML messages using the GTK+ port of the
195         WebKit library.
196           </para>
197         </listitem>
198       </varlistentry>
199       <varlistentry>
200         <term>Fetchinfo</term>
201         <listitem>
202           <para>
203         Inserts headers containing some download information, like UIDL, 
204         Claws Mail' account name, POP server, user ID and retrieval time.
205           </para>
206         </listitem>
207       </varlistentry>
208       <varlistentry>
209         <term>GtkHtml2 Viewer</term>
210         <listitem>
211           <para>
212         Like Dillo, enables the viewing of HTML messages, but in a nicer way 
213         (antialiased fonts).
214           </para>
215         </listitem>
216       </varlistentry>
217       <varlistentry>
218         <term>Mail Archiver</term>
219         <listitem>
220           <para>
221         Enables folders and subfolders to be archived in several different
222         formats.
223           </para>
224         </listitem>
225       </varlistentry>
226       <varlistentry>
227         <term>mailMBOX</term>
228         <listitem>
229           <para>
230         Handles mailboxes in MBox format.
231           </para>
232         </listitem>
233       </varlistentry>
234       <varlistentry>
235         <term>NewMail</term>
236         <listitem>
237           <para>
238         Writes a msg header summary to a log file, (Default: 
239         <filename>~/Mail/NewLog</filename>), on arrival of new mail 
240         <emphasis>after</emphasis> sorting. 
241           </para>
242         </listitem>
243       </varlistentry>
244       <varlistentry>
245         <term>Notification</term>
246         <listitem>
247           <para>
248         Provides various ways to notify the user of new and unread email.
249           </para>
250         </listitem>
251       </varlistentry>
252       <varlistentry>
253         <term>PDF Viewer</term>
254         <listitem>
255           <para>
256         Provides direct rendering of PDF and PostScript attachments
257         in the Claws Mail message view. It also allows browsing, zooming and 
258         displaying detailed information about such attachments.
259           </para>
260         </listitem>
261       </varlistentry>
262       <varlistentry>
263         <term>Perl</term>
264         <listitem>
265           <para>
266         Intended to extend the filtering possibilities of Claws Mail. It 
267         provides a Perl interface to Claws Mail' filtering mechanism, 
268         allowing the use of full Perl power in email filters.
269           </para>
270         </listitem>
271       </varlistentry>
272       <varlistentry>
273         <term>RSSyl</term>
274         <listitem>
275           <para>
276         Allows you to read your favorite newsfeeds in Claws. RSS 1.0, 2.0 and 
277         Atom feeds are currently supported.
278           </para>
279         </listitem>
280       </varlistentry>
281       <varlistentry>
282         <term>S/MIME</term>
283         <listitem>
284           <para>
285         Handles S/MIME signed and/or encrypted mails. You can decrypt mails, 
286         verify signatures or sign and encrypt your own mails. Uses GnuPG/GPGME 
287         and GpgSM, <ulink url="ftp://ftp.gnupg.org/gcrypt/gpgme/"
288         >ftp://ftp.gnupg.org/gcrypt/gpgme/</ulink>.
289           </para>
290         </listitem>
291       </varlistentry>
292       <varlistentry>
293         <term>SpamReport</term>
294         <listitem>
295           <para>
296         This plugin reports spam to various places.
297         Currently the sites <ulink url="http://spam-signal.fr"
298         >spam-signal.fr</ulink> and <ulink url="http://spamcop.net"
299         >spamcop.net</ulink> are supported, and the <ulink
300         url="http://lists.debian.org">Debian lists</ulink>
301         spam nomination system.
302           </para>
303         </listitem>
304       </varlistentry>
305       <varlistentry>
306         <term>SynCE</term>
307         <listitem>
308           <para>
309         Assists in keeping the address book of a Windows CE device (Pocket 
310         PC, iPAQ, Smartphone, etc.) in sync with Claws Mail' address book, 
311         with respect to email addresses.
312           </para>
313         </listitem>
314       </varlistentry>
315       <varlistentry>
316         <term>vCalendar</term>
317         <listitem>
318           <para>
319         Enables vCalendar message handling like that produced by Evolution or 
320         Outlook, and Webcal subscriptions.
321           </para>
322         </listitem>
323       </varlistentry>
324     </variablelist>
325     <para>
326         If you're a developer, writing a plugin to extend Claws Mail' 
327         capabilities is probably the best and easiest solution. We will 
328         provide hosting to your code, and will be glad to answer your questions
329         in the mailing-list or on the IRC channels, 
330         <literal>#claws</literal> on Freenode or IRCnet.
331     </para>
332   </section>
333   <section id="plugins_network">
334     <title>Network access from the plugins</title>
335     <para>
336         Some of the external plugins, for example RSSyl, vCalendar or GtkHtml 
337         Viewer, need Internet access for their operations (retrieving feeds in 
338         the case of RSSyl or vCalendar, and fetching images in the case of 
339         GtkHtml Viewer). These plugins use the Curl library. Hence, if your 
340         Internet access is restricted by a proxy, you will need to tell libCurl
341         to use this proxy. This is done by setting an environment variable, 
342         <literal>http_proxy</literal>. For example, 
343 <literal>http_proxy=http://user:passwd@myproxy.example.com:8080</literal> 
344         will tell libCurl to connect to port 8080 of the machine 
345         myproxy.example.com, with the user <quote>user</quote> and password 
346         <quote>passwd</quote> to connect to the Internet. 
347     </para><para>
348         You can either set this variable before starting Claws Mail, by 
349         using for example 
350         <command>http_proxy=http://user:passwd@myproxy.example.com:8080 
351         claws-mail</command>, or set it in your 
352         <filename>~/.bashrc</filename> file (or your shell equivalent), by 
353         adding the following line<footnote><para>Other shells may have 
354         diferent syntaxes, check your shell's manual page.</para></footnote>: 
355 <command>export http_proxy=http://user:passwd@myproxy.example.com:8080</command>
356         (you'll have to reconnect to have it taken into account).
357     </para>
358   </section>
359 </section>
360