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>Clam Antivirus</term>
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
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>.
69 <term>Dillo HTML Viewer</term>
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>.
82 <term>PGP/Core, PGP/Inline and PGP/MIME</term>
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>.
93 <term>SpamAssassin</term>
96 The SpamAssassin plugin comes with two major features:
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.
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.
110 Plugin preferences can be found in
111 <quote>Configuration/Preferences/Plugins/SpamAssassin</quote>.
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
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.
125 <term>Trayicon</term>
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
137 <section id="plugins_external">
138 <title>More plugins</title>
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>:
147 <term>Acpi Notifier</term>
150 Enables new mail notification via the LEDs found on some laptops like
151 Acer, Asus, Fujitsu and IBM laptops.
156 <term>AttachWarner</term>
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.
166 <term>AttRemover</term>
169 Allows you to remove attachments from emails.
174 <term>CacheSaver</term>
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
185 <term>Fetchinfo</term>
188 Inserts headers containing some download information, like UIDL,
189 Claws Mail' account name, POP server, user ID and retrieval time.
194 <term>GtkHtml2 Viewer</term>
197 Like Dillo, enables the viewing of HTML messages, but in a nicer way
203 <term>mailMBOX</term>
206 Handles mailboxes in MBox format.
214 Writes a msg header summary to a log file, (Default: ~/Mail/NewLog),
215 on arrival of new mail *after* sorting.
220 <term>Notification</term>
223 Provides various ways to notify the user of new and unread email.
228 <term>PDF Viewer</term>
231 Provides direct rendering of PDF and PostScript attachments
232 in the Claws Mail message view. It also allows browsing, zooming and
233 displaying detailed information about such attachments.
241 Intended to extend the filtering possibilities of Claws Mail. It
242 provides a Perl interface to Claws Mail' filtering mechanism,
243 allowing the use of full Perl power in email filters.
251 Allows you to read your favorite newsfeeds in Claws. RSS 1.0, 2.0 and
252 Atom feeds are currently supported.
260 Handles S/MIME signed and/or encrypted mails. You can decrypt mails,
261 verify signatures or sign and encrypt your own mails. Uses GnuPG/GPGME
262 and GpgSM, <ulink url="ftp://ftp.gnupg.org/gcrypt/gpgme/"
263 >ftp://ftp.gnupg.org/gcrypt/gpgme/</ulink>.
268 <term>SpamReport</term>
271 This plugin reports spam to various places.
272 Currently only spam-signal.fr is supported.
280 Assists in keeping the address book of a Windows CE device (Pocket
281 PC, iPAQ, Smartphone, etc.) in sync with Claws Mail' address book,
282 with respect to email addresses.
287 <term>vCalendar</term>
290 Enables vCalendar message handling like that produced by Evolution or
291 Outlook, and Webcal subscriptions.
297 If you're a developer, writing a plugin to extend Claws Mail'
298 capabilities is probably the best and easiest solution. We will
299 provide hosting to your code, and will be glad to answer your questions
300 in the mailing-list or on the IRC channels,
301 <literal>#claws-mail</literal> on Freenode or IRCnet.
304 <section id="plugins_network">
305 <title>Network access from the plugins</title>
307 Some of the external plugins, for example RSSyl, vCalendar or GtkHtml
308 Viewer, need Internet access for their operations (retrieving feeds in
309 the case of RSSyl or vCalendar, and fetching images in the case of
310 GtkHtml Viewer). These plugins use the Curl library. Hence, if your
311 Internet access is restricted by a proxy, you will need to tell libCurl
312 to use this proxy. This is done by setting an environment variable,
313 <literal>http_proxy</literal>. For example,
314 <literal>http_proxy=http://user:passwd@myproxy.example.com:8080</literal>
315 will tell libCurl to connect to port 8080 of the machine
316 myproxy.example.com, with the user <quote>user</quote> and password
317 <quote>passwd</quote> to connect to the Internet.
319 You can either set this variable before starting Claws Mail, by
321 <command>http_proxy=http://user:passwd@myproxy.example.com:8080
322 claws-mail</command>, or set it in your
323 <filename>~/.bashrc</filename> file (or your shell equivalent), by
324 adding the following line<footnote><para>Other shells may have
325 diferent syntaxes, check your shell's manual page.</para></footnote>:
326 <command>export http_proxy=http://user:passwd@myproxy.example.com:8080</command>
327 (you'll have to reconnect to have it taken into account).