| blob | ff856ca49e46462638d29de5733566b7ffcb10e5 |
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>Plugins</title>
7 <para>
8 Claws Mail's capabilities are extended by plugins, which are
9 listed below.
10 </para><para>
11 Plugins are installed in <filename class="directory"
12 >$PREFIX/lib/claws-mail/plugins/</filename> and have a suffix of
13 <quote>.so</quote>. To load a plugin go to
14 <quote>Configuration/Plugins</quote> and click the
15 <quote>Load Plugin</quote> button. Select the plugin that you want and
16 click the <quote>Open</quote> button.
17 </para><para>
18 If you don't find the plugin you're looking for, it is possible that
19 your Operating System distribution provides it in a separate package.
20 In this case, search for the plugin in your package manager.
21 </para><para>
22 Some plugins provide the same functionality as others, (for example, the
23 3 anti-Spam plugins). In this case you will have to choose which
24 one to load, as Claws Mail will refuse to load more than one of
25 the same type.
26 </para>
27 <para>
28 There is a list of all plugins available at <ulink
29 url="https://www.claws-mail.org/plugins.php"
30 >www.claws-mail.org/plugins.php</ulink>.
31 </para>
32 <variablelist>
33 <varlistentry>
34 <term>ACPI Notifier</term>
35 <listitem>
36 <para>
37 Enables new mail notification via the LEDs found on some laptops like
38 Acer, Asus, Fujitsu and IBM laptops.
39 More information: <ulink
40 url="https://www.claws-mail.org/plugin.php?plugin=acpinotifier"
41 >www.claws-mail.org/plugin.php?plugin=acpinotifier</ulink>
42 </para>
43 </listitem>
44 </varlistentry>
45 <varlistentry>
46 <term>AddressKeeper</term>
47 <listitem>
48 <para>
49 Saves all unknown recipient addresses (<quote>To</quote>,
50 <quote>Cc</quote> and/or <quote>Bcc</quote>) to a designated
51 addressbook folder.
52 </para>
53 </listitem>
54 </varlistentry>
55 <varlistentry>
56 <term>AttachWarner</term>
57 <listitem>
58 <para>
59 Reminds you about possibly forgotten attachments. Checks for common
60 expressions found when attaching a file and warns you if no attachment
61 was added to the mail you're sending.
62 More information: <ulink
63 url="https://www.claws-mail.org/plugin.php?plugin=attachwarner"
64 >www.claws-mail.org/plugin.php?plugin=attachwarner</ulink>
65 </para>
66 </listitem>
67 </varlistentry>
68 <varlistentry>
69 <term>AttRemover</term>
70 <listitem>
71 <para>
72 Allows you to remove attachments from emails.
73 </para>
74 </listitem>
75 </varlistentry>
76 <varlistentry>
77 <term>Bogofilter</term>
78 <listitem>
79 <para>
80 The Bogofilter plugin comes with two major features:
81 </para><para>
82 The ability to scan incoming mail received from a POP, IMAP or LOCAL
83 account using Bogofilter. It can optionally delete mail identified
84 as spam or save it to a designated folder. Mail scanning can be turned
85 off.
86 </para><para>
87 The ability for users to teach Bogofilter to recognise spam or ham.
88 You can train Bogofilter by marking messages as spam or ham from the
89 Message List contextual menu, or using the relevant toolbar button in
90 the main window or the message window (see
91 <quote>Configuration/Preferences/Toolbars</quote>). Messages
92 marked as spam are optionally saved to a designated folder.
93 </para><para>
94 Plugin preferences can be found in
95 <quote>Configuration/Preferences/Plugins/Bogofilter</quote>.
96 </para><para>
97 Bogofilter's advantage over Spamassassin is its speed.
98 </para><para>
99 Bogofilter must be trained before it can filter messages. To train
100 it you will need to mark some spam as Spam, and some legitimate
101 emails as Ham.
102 </para><para>
103 Bogofilter is available from <ulink
104 url="http://bogofilter.sourceforge.net/"
105 >bogofilter.sourceforge.net/</ulink>.
106 </para>
107 </listitem>
108 </varlistentry>
109 <varlistentry>
110 <term>BSFilter</term>
111 <listitem>
112 <para>
113 BSFilter is a plugin that is very similar to the Bogofilter plugin
114 but uses the bsfilter (<ulink url="http://bsfilter.org/index-e.html"
115 >bsfilter.org/index-e.html</ulink>) bayesian spam filter as a backend.
116 </para><para>
117 Like Bogofilter, you have to train it with spam and ham
118 messages in order for bsfilter to start recognising spam.
119 </para><para>
120 Plugin preferences can be found in
121 <quote>Configuration/Preferences/Plugins/BSFilter</quote>.
122 </para>
123 </listitem>
124 </varlistentry>
125 <varlistentry>
126 <term>Clamd</term>
127 <listitem>
128 <para>
129 Allows scanning all messages received from IMAP, POP or local accounts
130 using the clam daemon part of the ClamAV (AntiVirus) software (<ulink
131 url="http://www.clamav.net/">www.clamav.net/</ulink>).
132 </para>
133 </listitem>
134 </varlistentry>
135 <varlistentry>
136 <term>Fancy</term>
137 <listitem>
138 <para>
139 Enables the rendering of HTML messages using the GTK port of the
140 WebKit library. By default, no remote content is loaded.
141 </para><para>
142 Plugin preferences can be found in
143 <quote>Configuration/Preferences/Plugins/Fancy</quote>.
144 </para>
145 </listitem>
146 </varlistentry>
147 <varlistentry>
148 <term>Fetchinfo</term>
149 <listitem>
150 <para>
151 Inserts headers containing some download information, like UIDL,
152 Claws Mail' account name, POP server, user ID and retrieval time.
153 </para>
154 </listitem>
155 </varlistentry>
156 <varlistentry>
157 <term>Keyword Warner</term>
158 <listitem>
159 <para>
160 Shows a warning when sending or queueing a message and a reference
161 to one or more keywords is found in the message text.
162 </para>
163 </listitem>
164 </varlistentry>
165 <varlistentry>
166 <term>Libravatar</term>
167 <listitem>
168 <para>
169 Enables the display of avatar images associated with user profiles at
170 libravatar.org or the user's avatar enabled domains.
171 More information: <ulink
172 url="https://www.claws-mail.org/plugin.php?plugin=libravatar"
173 >www.claws-mail.org/plugin.php?plugin=libravatar</ulink>
174 </para>
175 </listitem>
176 </varlistentry>
177 <varlistentry>
178 <term>Mail Archiver</term>
179 <listitem>
180 <para>
181 Enables folders and subfolders to be archived in several different
182 formats.
183 </para>
184 </listitem>
185 </varlistentry>
186 <varlistentry>
187 <term>mailMBOX</term>
188 <listitem>
189 <para>
190 Handles mailboxes in MBox format.
191 </para>
192 </listitem>
193 </varlistentry>
194 <varlistentry>
195 <term>NewMail</term>
196 <listitem>
197 <para>
198 Writes a message header summary to a log file, (Default:
199 <filename>~/Mail/NewLog</filename>), on arrival of new mail
200 <emphasis>after</emphasis> sorting.
201 </para>
202 </listitem>
203 </varlistentry>
204 <varlistentry>
205 <term>Notification</term>
206 <listitem>
207 <para>
208 Provides various ways to notify the user of new and unread email.
209 More information: <ulink
210 url="https://www.claws-mail.org/plugin.php?plugin=notification"
211 >www.claws-mail.org/plugin.php?plugin=notification</ulink>
212 </para>
213 </listitem>
214 </varlistentry>
215 <varlistentry>
216 <term>PDF Viewer</term>
217 <listitem>
218 <para>
219 Allows rendering of PDF and PostScript attachments using the Poppler
220 library and GhostScript external program.
221 More information: <ulink
222 url="https://www.claws-mail.org/plugin.php?plugin=pdf_viewer"
223 >www.claws-mail.org/plugin.php?plugin=pdf_viewer</ulink>
224 </para>
225 </listitem>
226 </varlistentry>
227 <varlistentry>
228 <term>Perl</term>
229 <listitem>
230 <para>
231 Intended to extend the filtering possibilities of Claws Mail. It
232 provides a Perl interface to Claws Mail' filtering mechanism,
233 allowing the use of full Perl power in email filters.
234 </para>
235 </listitem>
236 </varlistentry>
237 <varlistentry>
238 <term>PGP/Core, PGP/Inline and PGP/MIME</term>
239 <listitem>
240 <para>
241 Handles PGP signed and/or encrypted mails. You can decrypt mails,
242 verify signatures or sign and encrypt your own mails. Uses GnuPG/GPGME,
243 <ulink url="https://www.gnupg.org/software/gpgme/"
244 >www.gnupg.org/software/gpgme/</ulink>.
245 More information: <ulink
246 url="https://www.claws-mail.org/plugin.php?plugin=gpg"
247 >www.claws-mail.org/plugin.php?plugin=gpg</ulink>
248 </para>
249 </listitem>
250 </varlistentry>
251 <varlistentry>
252 <term>Python</term>
253 <listitem>
254 <para>
255 This plugin provides Python integration features.
256 More information: <ulink
257 url="http://www.claws-mail.org/plugin.php?plugin=python"
258 >www.claws-mail.org/plugin.php?plugin=python</ulink>
259 </para>
260 </listitem>
261 </varlistentry>
262 <varlistentry>
263 <term>RSSyl</term>
264 <listitem>
265 <para>
266 Allows you to read your favorite newsfeeds in Claws. RSS 1.0, 2.0 and
267 Atom feeds are currently supported.
268 More information: <ulink
269 url="https://www.claws-mail.org/plugin.php?plugin=rssyl"
270 >www.claws-mail.org/plugin.php?plugin=rssyl</ulink>
271 </para>
272 </listitem>
273 </varlistentry>
274 <varlistentry>
275 <term>S/MIME</term>
276 <listitem>
277 <para>
278 Handles S/MIME signed and/or encrypted mails. You can decrypt mails,
279 verify signatures or sign and encrypt your own mails. Uses GnuPG/GPGME
280 and GpgSM, <ulink url="ftp://ftp.gnupg.org/gcrypt/gpgme/"
281 >ftp://ftp.gnupg.org/gcrypt/gpgme/</ulink>.
282 </para>
283 </listitem>
284 </varlistentry>
285 <varlistentry>
286 <term>SpamAssassin</term>
287 <listitem>
288 <para>
289 The SpamAssassin plugin comes with two major features:
290 </para><para>
291 The ability to scan incoming mail received from a POP, IMAP or LOCAL
292 account using SpamAssassin. It can optionally delete mail identified
293 as spam or save it to a designated folder. Mail scanning can be turned
294 off, which is useful if your email is scanned on your server.
295 </para><para>
296 The ability for users to teach SpamAssassin to recognise spam or ham.
297 You can train SpamAssassin by marking messages as spam or ham from the
298 Message List contextual menu, or using the relevant toolbar button in
299 the main window or the message window (see
300 <quote>Configuration/Preferences/Toolbars</quote>). Messages
301 marked as spam are optionally saved to a designated folder.
302 </para><para>
303 Plugin preferences can be found in
304 <quote>Configuration/Preferences/Plugins/SpamAssassin</quote>.
305 </para><para>
306 SpamAssassin's advantage over Bogofilter is that it's not only a
307 bayesian filter, but it also performs various local and network tests
308 to determine spaminess.
309 </para><para>
310 SpamAssassin is available from <ulink
311 url="http://spamassassin.apache.org/"
312 >spamassassin.apache.org/</ulink>. Version 3.1.x or higher is
313 required to use the learning feature in TCP mode.
314 </para>
315 </listitem>
316 </varlistentry>
317 <varlistentry>
318 <term>SpamReport</term>
319 <listitem>
320 <para>
321 This plugin reports spam to various places.
322 Currently the sites <ulink url="http://spam-signal.fr"
323 >spam-signal.fr</ulink> and <ulink url="http://spamcop.net"
324 >spamcop.net</ulink> are supported, and the <ulink
325 url="http://lists.debian.org">Debian lists (lists.debian.org)</ulink>
326 spam nomination system.
327 </para>
328 </listitem>
329 </varlistentry>
330 <varlistentry>
331 <term>TNEF parse</term>
332 <listitem>
333 <para>
334 This plugin enables reading <literal>application/ms-tnef</literal> attachments.
335 More information: <ulink
336 url="https://www.claws-mail.org/plugin.php?plugin=tnef_parser"
337 >www.claws-mail.org/plugin.php?plugin=tnef_parser</ulink>
338 </para>
339 </listitem>
340 </varlistentry>
341 <varlistentry>
342 <term>vCalendar</term>
343 <listitem>
344 <para>
345 Enables vCalendar message handling like that produced by Evolution or
346 Outlook, and Webcal subscriptions.
347 More information: <ulink
348 url="https://www.claws-mail.org/plugin.php?plugin=vcalendar"
349 >www.claws-mail.org/plugin.php?plugin=vcalendar</ulink>
350 </para>
351 </listitem>
352 </varlistentry>
353 </variablelist>
354 <para>
355 If you're a developer, writing a plugin to extend Claws Mail's
356 capabilities is probably the best and easiest solution. We will
357 provide hosting to your code, and will be glad to answer your questions
358 in the mailing-list or on the IRC channel,
359 <literal>#claws</literal> on <ulink url="https://libera.chat">Libera.chat</ulink>.
360 </para>
361 </section>
363 <section id="plugins_network">
364 <title>Network access from the plugins</title>
365 <para>
366 Some of the external plugins, for example RSSyl, vCalendar, Libravatar
367 or Fancy, need Internet access for their operations (retrieving feeds in
368 the case of RSSyl or vCalendar, and fetching images in the case of
369 Libravatar or Fancy). These plugins use the Curl library. Hence, if your
370 Internet access is restricted by a proxy, you will need to tell libCurl
371 to use this proxy. This is done by setting an environment variable,
372 <literal>http_proxy</literal>. For example,
373 <literal>http_proxy=http://user:passwd@myproxy.example.com:8080</literal>
374 will tell libCurl to connect to port 8080 of the machine
375 myproxy.example.com, with the user <quote>user</quote> and password
376 <quote>passwd</quote> to connect to the Internet.
377 </para><para>
378 You can either set this variable before starting Claws Mail by
379 using, for example,
380 <command>http_proxy=http://user:passwd@myproxy.example.com:8080
381 claws-mail</command>, or you can set it in your
382 <filename>~/.bashrc</filename> file (or your shell equivalent), by
383 adding the following line<footnote><para>Other shells may have
384 diferent syntaxes, check your shell's manual page.</para></footnote>:
385 <command
386 >export http_proxy=http://user:passwd@myproxy.example.com:8080</command>
387 (you'll have to reconnect to have it taken into account).
388 </para>
389 </section>
391 <section id="plugin_path_config">
392 <title>Plugin path configuration</title>
393 <para>
394 By default, when loading a plugin, its full path is saved in
395 <filename>~/.claws-mail/clawsrc</filename>.
396 </para><para>
397 As most users have only one copy of Claws Mail installed and always
398 use the same installation method, this is not a problem.
399 </para><para>
400 However, if you have multiple copies of Claws Mail installed
401 and want to share the same configuration among them, this may not
402 work, particularly when using different versions of Claws Mail.
403 </para><para>
404 A second installed copy will try to load the plugins installed by
405 the first and, if the versions differ, the plugins will be rejected.
406 </para><para>
407 In order to avoid this problem you can manually edit the plugins
408 section in the <filename>clawsrc</filename> file, replacing the full
409 path with just the plugin file name of those you want to load
410 relative to the copy of Claws Mail being run.
411 </para><para>
412 In so doing, each copy of Claws Mail will try to load those plugins
413 from its own plugin directory, rather than a fixed location.
414 </para>
415 </section>
417 </section>