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