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>.
83 <term>SpamAssassin</term>
86 The SpamAssassin plugin comes with two major features:
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.
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.
100 Plugin preferences can be found in
101 <quote>Configuration/Preferences/Plugins/SpamAssassin</quote>.
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
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.
115 <term>Trayicon</term>
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
127 <section id="plugins_external">
128 <title>More plugins</title>
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>:
137 <term>Acpi Notifier</term>
140 Enables new mail notification via the LEDs found on some laptops like
141 Acer, Asus, Fujitsu and IBM laptops.
146 <term>AttachWarner</term>
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.
156 <term>AttRemover</term>
159 Allows you to remove attachments from emails.
164 <term>BSFilter</term>
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.
171 Like Bogofilter, you have to train it with spam and ham
172 messages in order for bsfilter to start recognising spam.
174 Plugin preferences can be found in
175 <quote>Configuration/Preferences/Plugins/BSFilter</quote>.
180 <term>CacheSaver</term>
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
194 Enables the display of HTML messages using the GTK+ port of the
200 <term>Fetchinfo</term>
203 Inserts headers containing some download information, like UIDL,
204 Claws Mail' account name, POP server, user ID and retrieval time.
209 <term>GtkHtml2 Viewer</term>
212 Like Dillo, enables the viewing of HTML messages, but in a nicer way
218 <term>Mail Archiver</term>
221 Enables folders and subfolders to be archived in several different
227 <term>mailMBOX</term>
230 Handles mailboxes in MBox format.
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.
245 <term>Notification</term>
248 Provides various ways to notify the user of new and unread email.
253 <term>PDF Viewer</term>
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.
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.
276 Allows you to read your favorite newsfeeds in Claws. RSS 1.0, 2.0 and
277 Atom feeds are currently supported.
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>.
293 <term>SpamReport</term>
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.
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.
316 <term>vCalendar</term>
319 Enables vCalendar message handling like that produced by Evolution or
320 Outlook, and Webcal subscriptions.
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.
333 <section id="plugins_network">
334 <title>Network access from the plugins</title>
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.
348 You can either set this variable before starting Claws Mail, by
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).