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