1 <?xml version="1.0" encoding="utf-8"?>
2 <section id="ch_plugins">
3 <title>Extending Claws Mail</title>
5 <section id="plugins_default">
6 <title>Provided plugins</title>
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.
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.
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.
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
30 <term>Bogofilter</term>
33 The Bogofilter plugin comes with two major features:
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
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.
47 Plugin preferences can be found in
48 <quote>Configuration/Preferences/Plugins/Bogofilter</quote>.
50 Bogofilter's advantage over Spamassassin is its speed.
52 Bogofilter is available from <ulink
53 url="http://bogofilter.sourceforge.net/"
54 >http://bogofilter.sourceforge.net/</ulink>.
59 <term>Dillo HTML Viewer</term>
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>.
72 <term>PGP/Core, PGP/Inline and PGP/MIME</term>
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>.
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>.
94 <term>SpamAssassin</term>
97 The SpamAssassin plugin comes with two major features:
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.
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.
111 Plugin preferences can be found in
112 <quote>Configuration/Preferences/Plugins/SpamAssassin</quote>.
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
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.
126 <term>Trayicon</term>
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
138 <section id="plugins_external">
139 <title>More plugins</title>
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>:
148 <term>Acpi Notifier</term>
151 Enables new mail notification via the LEDs found on some laptops like
152 Acer, Asus, Fujitsu and IBM laptops.
153 More information: <ulink url="http://www.claws-mail.org/plugin.php?plugin=acpinotifier">
154 www.claws-mail.org/plugin.php?plugin=acpinotifier</ulink>
159 <term>AttachWarner</term>
162 Reminds you about possibly forgotten attachments. Checks for common
163 expressions found when attaching a file and warns you if no attachment
164 was added to the mail you're sending.
165 More information: <ulink url="http://www.claws-mail.org/plugin.php?plugin=attachwarner">
166 www.claws-mail.org/plugin.php?plugin=attachwarner</ulink>
171 <term>AttRemover</term>
174 Allows you to remove attachments from emails.
179 <term>BSFilter</term>
182 BSFilter is a plugin that is very similar to the Bogofilter plugin but uses
183 the bsfilter (<ulink url="http://bsfilter.org/index-e.html">bsfilter.org/index-e.html</ulink>)
184 bayesian spam filter as a backend.
186 Like Bogofilter, you have to train it with spam and ham
187 messages in order for bsfilter to start recognising spam.
189 Plugin preferences can be found in
190 <quote>Configuration/Preferences/Plugins/BSFilter</quote>.
195 <term>CacheSaver</term>
198 Saves the caches every 60 seconds (or user-defined period). It helps
199 avoiding the loss of metadata if your computer (<emphasis>or
200 Claws Mail!</emphasis>) crashes. (NOTE: using this plugin can slow
209 Enables the display of HTML messages using the GTK+ port of the
215 <term>Fetchinfo</term>
218 Inserts headers containing some download information, like UIDL,
219 Claws Mail' account name, POP server, user ID and retrieval time.
224 <term>GtkHtml2 Viewer</term>
227 Like Dillo, enables the viewing of HTML messages, but in a nicer way
229 More information: <ulink url="http://www.claws-mail.org/plugin.php?plugin=gtkhtml2">
230 www.claws-mail.org/plugin.php?plugin=gtkhtml2</ulink>
235 <term>Mail Archiver</term>
238 Enables folders and subfolders to be archived in several different
244 <term>mailMBOX</term>
247 Handles mailboxes in MBox format.
255 Writes a msg header summary to a log file, (Default:
256 <filename>~/Mail/NewLog</filename>), on arrival of new mail
257 <emphasis>after</emphasis> sorting.
262 <term>Notification</term>
265 Provides various ways to notify the user of new and unread email.
266 More information: <ulink url="http://www.claws-mail.org/plugin.php?plugin=notification">
267 www.claws-mail.org/plugin.php?plugin=notification</ulink>
275 Intended to extend the filtering possibilities of Claws Mail. It
276 provides a Perl interface to Claws Mail' filtering mechanism,
277 allowing the use of full Perl power in email filters.
285 This plugin provides Python integration features.
286 More information: <ulink url="http://www.claws-mail.org/plugin.php?plugin=python">
287 www.claws-mail.org/plugin.php?plugin=python</ulink>
295 Allows you to read your favorite newsfeeds in Claws. RSS 1.0, 2.0 and
296 Atom feeds are currently supported.
297 More information: <ulink url="http://www.claws-mail.org/plugin.php?plugin=rssyl">
298 www.claws-mail.org/plugin.php?plugin=rssyl</ulink>
303 <term>SpamReport</term>
306 This plugin reports spam to various places.
307 Currently the sites <ulink url="http://spam-signal.fr"
308 >spam-signal.fr</ulink> and <ulink url="http://spamcop.net"
309 >spamcop.net</ulink> are supported, and the <ulink
310 url="http://lists.debian.org">Debian lists (lists.debian.org)</ulink>
311 spam nomination system.
319 Assists in keeping the address book of a Windows CE device (Pocket
320 PC, iPAQ, Smartphone, etc.) in sync with Claws Mail' address book,
321 with respect to email addresses.
326 <term>TNEF parse</term>
329 This plugin enables reading <literal>application/ms-tnef attachments</literal>.
330 More information: <ulink url="http://www.claws-mail.org/plugin.php?plugin=tnef_parser">
331 www.claws-mail.org/plugin.php?plugin=tnef_parser</ulink>
336 <term>vCalendar</term>
339 Enables vCalendar message handling like that produced by Evolution or
340 Outlook, and Webcal subscriptions.
341 More information: <ulink url="http://www.claws-mail.org/plugin.php?plugin=vcalendar">
342 www.claws-mail.org/plugin.php?plugin=vcalendar</ulink>
348 If you're a developer, writing a plugin to extend Claws Mail'
349 capabilities is probably the best and easiest solution. We will
350 provide hosting to your code, and will be glad to answer your questions
351 in the mailing-list or on the IRC channels,
352 <literal>#claws</literal> on Freenode or IRCnet.
355 <section id="plugins_network">
356 <title>Network access from the plugins</title>
358 Some of the external plugins, for example RSSyl, vCalendar or GtkHtml
359 Viewer, need Internet access for their operations (retrieving feeds in
360 the case of RSSyl or vCalendar, and fetching images in the case of
361 GtkHtml Viewer). These plugins use the Curl library. Hence, if your
362 Internet access is restricted by a proxy, you will need to tell libCurl
363 to use this proxy. This is done by setting an environment variable,
364 <literal>http_proxy</literal>. For example,
365 <literal>http_proxy=http://user:passwd@myproxy.example.com:8080</literal>
366 will tell libCurl to connect to port 8080 of the machine
367 myproxy.example.com, with the user <quote>user</quote> and password
368 <quote>passwd</quote> to connect to the Internet.
370 You can either set this variable before starting Claws Mail, by
372 <command>http_proxy=http://user:passwd@myproxy.example.com:8080
373 claws-mail</command>, or set it in your
374 <filename>~/.bashrc</filename> file (or your shell equivalent), by
375 adding the following line<footnote><para>Other shells may have
376 diferent syntaxes, check your shell's manual page.</para></footnote>:
377 <command>export http_proxy=http://user:passwd@myproxy.example.com:8080</command>
378 (you'll have to reconnect to have it taken into account).