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.
25 <term>Bogofilter</term>
28 The Bogofilter plugin comes with two major features:
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
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.
42 Plugin preferences can be found in
43 <quote>Configuration/Preferences/Plugins/Bogofilter</quote>.
45 Bogofilter's advantage over Spamassassin is its speed.
47 Bogofilter is available from <ulink
48 url="http://bogofilter.sourceforge.net/"
49 >http://bogofilter.sourceforge.net/</ulink>.
54 <term>Dillo HTML Viewer</term>
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>.
67 <term>PGP/Core, PGP/Inline and PGP/MIME</term>
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>.
78 <term>SpamAssassin</term>
81 The SpamAssassin plugin comes with two major features:
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.
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.
95 Plugin preferences can be found in
96 <quote>Configuration/Preferences/Plugins/SpamAssassin</quote>.
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
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.
110 <term>Trayicon</term>
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
122 <section id="plugins_external">
123 <title>More plugins</title>
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>:
132 <term>Acpi Notifier</term>
135 Enables new mail notification via the LEDs found on some laptops like
136 Acer, Asus, Fujitsu and IBM laptops.
141 <term>AttachWarner</term>
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.
151 <term>AttRemover</term>
154 Allows you to remove attachments from emails.
159 <term>CacheSaver</term>
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
170 <term>Fetchinfo</term>
173 Inserts headers containing some download information, like UIDL,
174 Claws Mail' account name, POP server, user ID and retrieval time.
179 <term>GtkHtml2 Viewer</term>
182 Like Dillo, enables the viewing of HTML messages, but in a nicer way
188 <term>mailMBOX</term>
191 Handles mailboxes in MBox format.
199 Writes a msg header summary to a log file, (Default:
200 <filename>~/Mail/NewLog</filename>), on arrival of new mail
201 <emphasis>after</emphasis> sorting.
206 <term>Notification</term>
209 Provides various ways to notify the user of new and unread email.
214 <term>PDF Viewer</term>
217 Provides direct rendering of PDF and PostScript attachments
218 in the Claws Mail message view. It also allows browsing, zooming and
219 displaying detailed information about such attachments.
227 Intended to extend the filtering possibilities of Claws Mail. It
228 provides a Perl interface to Claws Mail' filtering mechanism,
229 allowing the use of full Perl power in email filters.
237 Allows you to read your favorite newsfeeds in Claws. RSS 1.0, 2.0 and
238 Atom feeds are currently supported.
246 Handles S/MIME signed and/or encrypted mails. You can decrypt mails,
247 verify signatures or sign and encrypt your own mails. Uses GnuPG/GPGME
248 and GpgSM, <ulink url="ftp://ftp.gnupg.org/gcrypt/gpgme/"
249 >ftp://ftp.gnupg.org/gcrypt/gpgme/</ulink>.
254 <term>SpamReport</term>
257 This plugin reports spam to various places.
258 Currently only <ulink url="http://spam-signal.fr"
259 >spam-signal.fr</ulink> and <ulink url="http://spamcop.net"
260 >spamcop.net</ulink> are supported.
268 Assists in keeping the address book of a Windows CE device (Pocket
269 PC, iPAQ, Smartphone, etc.) in sync with Claws Mail' address book,
270 with respect to email addresses.
275 <term>vCalendar</term>
278 Enables vCalendar message handling like that produced by Evolution or
279 Outlook, and Webcal subscriptions.
285 If you're a developer, writing a plugin to extend Claws Mail'
286 capabilities is probably the best and easiest solution. We will
287 provide hosting to your code, and will be glad to answer your questions
288 in the mailing-list or on the IRC channels,
289 <literal>#claws</literal> on Freenode or IRCnet.
292 <section id="plugins_network">
293 <title>Network access from the plugins</title>
295 Some of the external plugins, for example RSSyl, vCalendar or GtkHtml
296 Viewer, need Internet access for their operations (retrieving feeds in
297 the case of RSSyl or vCalendar, and fetching images in the case of
298 GtkHtml Viewer). These plugins use the Curl library. Hence, if your
299 Internet access is restricted by a proxy, you will need to tell libCurl
300 to use this proxy. This is done by setting an environment variable,
301 <literal>http_proxy</literal>. For example,
302 <literal>http_proxy=http://user:passwd@myproxy.example.com:8080</literal>
303 will tell libCurl to connect to port 8080 of the machine
304 myproxy.example.com, with the user <quote>user</quote> and password
305 <quote>passwd</quote> to connect to the Internet.
307 You can either set this variable before starting Claws Mail, by
309 <command>http_proxy=http://user:passwd@myproxy.example.com:8080
310 claws-mail</command>, or set it in your
311 <filename>~/.bashrc</filename> file (or your shell equivalent), by
312 adding the following line<footnote><para>Other shells may have
313 diferent syntaxes, check your shell's manual page.</para></footnote>:
314 <command>export http_proxy=http://user:passwd@myproxy.example.com:8080</command>
315 (you'll have to reconnect to have it taken into account).