[claws.git] / manual / plugins.xml
1 <?xml version="1.0" encoding="utf-8"?>
2 <section id="ch_plugins">
3 <title>Extending Sylpheed-Claws</title>
5   <section id="plugins_default">
6     <title>Provided plugins</title>
7     <para>
8         Sylpheed-Claws' capabilities are extended by plugins. It comes with the plugins listed below included, all of which are built automatically if the required libraries are present.
9     </para><para>
10         Plugins are installed in $PREFIX/lib/sylpheed-claws/plugins/ and have a suffix of <quote>.so</quote> To load a plugin go to <quote>Configuration/Plugins</quote> and click the <quote>Load Plugin</quote> button. Select the plugin that you want and click OK.
11     </para><para>
12         If you don't find the plugin you're looking for, it is possible that your GNU/Linux distribution provides it in a separate package. In this case, search for the plugin in your package manager.
13     </para>
14     <variablelist>
15             <varlistentry><term>Clam Antivirus</term>
16             <listitem><para>Enables the scanning of message attachments in mail received from a POP, IMAP or LOCAL account using Clam AntiVirus. It can optionally delete the mail or save it to a designated folder. Preferences can be found in <quote>Configuration/Preferences/Plugins/Clam AntiVirus</quote>. Clam AntiVirus is available from <ulink url="http://clamav.sourceforge.net/">http://clamav.sourceforge.net/</ulink>.</para></listitem>
17     </varlistentry>
18     <varlistentry><term>Dillo HTML Viewer</term>
19             <listitem><para>Enables the viewing of html messages using the Dillo web browser, version 0.7.0 or newer. It uses Dillo's --local option by default for safe browsing. Preferences can be found in <quote>/Configuration/Preferences/Plugins/Dillo Browser</quote>. Dillo is available from <ulink url="http://www.dillo.org/">http://www.dillo.org/</ulink>.</para></listitem>
20     </varlistentry>
21     <varlistentry><term>PGP/Core, PGP/Inline and PGP/MIME</term>
22             <listitem><para>Handles PGP signed and/or encrypted mails. You can decrypt mails, verify signatures or sign and encrypt your own mails. Uses GnuPG/GPGME, <ulink url="ftp://ftp.gnupg.org/gcrypt/gpgme/">ftp://ftp.gnupg.org/gcrypt/gpgme/</ulink>.</para></listitem>
23     </varlistentry>
24     <varlistentry><term>SpamAssassin</term>
25             <listitem><para>Enables the scanning of incoming mail received from a POP, IMAP or LOCAL account using SpamAssassin. It can optionally delete mail identified as spam or save it to a designated folder. Preferences can be found in <quote>Configuration/Preferences/Plugins/SpamAssassin</quote>. SpamAssassin is available from <ulink url="http://spamassassin.org/">http://spamassassin.org/</ulink>.</para></listitem>
26     </varlistentry>
27     <varlistentry><term>Trayicon</term>
28             <listitem><para>Places an icon in the system tray that indicates whether you have any new mail. A tooltip also shows the current new, unread and total number of messages.</para></listitem>
29     </varlistentry>
30     </variablelist>
31   </section>
33   <section id="plugins_external">
34     <title>More plugins</title>
35     <para>
36         Other plugins have been written too, which are available as separate downloads. At the time of this writing, there are a number of plugins available at <ulink url="http://claws.sylpheed.org/plugins.php">http://claws.sylpheed.org/plugins.php</ulink>:
37     </para>
38     <variablelist>
39     <varlistentry><term>Acpi Notifier</term>
40             <listitem><para>Enables new mail notification via the LEDs found on some laptops like Acer, Asus and IBM laptops.</para></listitem>
41     </varlistentry>
42     <varlistentry><term>AttRemover</term>
43             <listitem><para> This plugin lets you remove attachments from emails.</para></listitem>
44     </varlistentry>
45     <varlistentry><term>CacheSaver</term>
46             <listitem><para>Saves the caches every 60 seconds (or user-defined period). It helps avoiding the loss of metadata if your computer (<emphasis>or Sylpheed-Claws!</emphasis>) crashes.</para></listitem>
47     </varlistentry>
48     <varlistentry><term>etpan! Privacy</term>
49             <listitem><para>Handles signature verification and decryption of encrypted messages in S/MIME, OpenPGP, and ascii-armored PGP formats.</para></listitem>
50     </varlistentry>
51     <varlistentry><term>Fetchinfo</term>
52             <listitem><para>Inserts headers containing some download information, like UIDL, Sylpheeds account name, POP server, user ID and retrieval time.</para></listitem>
53     </varlistentry>
54     <varlistentry><term>Maildir</term>
55             <listitem><para>Provides direct support for Maildir++ mailboxes. With this plugin you can share your Maildir++ mailbox with other mailers or IMAP servers.</para></listitem>
56     </varlistentry>
57     <varlistentry><term>mailMBOX</term>
58             <listitem><para>Handles mailboxes in mbox format. </para></listitem>
59     </varlistentry>
60     <varlistentry><term>Perl</term>
61             <listitem><para>Intended to extend the filtering possibilities of Sylpheed-Claws. It provides a Perl interface to Sylpheed-Claws' filtering mechanism, allowing the use of full Perl power in email filters.</para></listitem>
62     </varlistentry>
63     <varlistentry><term>SynCE</term>
64             <listitem><para>Assists in keeping the address book of a Windows CE device (Pocket PC/ iPAQ, Smartphone etc) in sync with Sylpheed-Claws' address book, with respect to email addresses.</para></listitem>
65     </varlistentry>
66     <varlistentry><term>vCalendar</term>
67             <listitem><para>Enables vCalendar message handling like that produced by Evolution or Outlook, and Webcal subscriptions.</para></listitem>
68     </varlistentry>
69     <varlistentry><term>RSSyl</term>
70             <listitem><para>Allows you to read your favorite newsfeeds in Claws. RSS 1.0, 2.0 and Atom feeds are currently supported.</para></listitem>
71     </varlistentry>
72     </variablelist>
73     <para>
74         If you're a developer, writing a plugin to extend Sylpheed-Claws' capabilities is probably the best and easiest solution. We will provide hosting to your code, and will be glad to answer your questions in the mailing-list or the IRC channel, #sylpheed on IRCnet.
75     </para>
76   </section>
78 </section>