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