2006-08-12 [paul] 2.4.0cvs42
[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>
26                         <para>The SpamAssassin plugin comes with two major features:</para>
27                         <para>The ability to scan 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. Mail scanning can be turned off, which is useful if your email is scanned on your server.</para>
28                         <para>The ability for users to teach SpamAssassin to recognise spam or ham. You can train SpamAssassin by marking messages as spam or ham from the Message List contextual menu, or using the relevant toolbar button in the main window or the message window (see "Configuration/Preferences/Customize toolbars"). Messages marked as spam are optionally saved to a designated folder.</para>
29                         <para>Plugin preferences can be found in "Configuration/Preferences/Plugins/SpamAssassin".</para>
30                         <para>SpamAssassin is available from <ulink url="http://spamassassin.apache.org/">http://spamassassin.apache.org/</ulink>. Version 3.1.x or higher is required to use the learning feature in TCP mode.</para>
31                 </listitem>
32     </varlistentry>
33     <varlistentry><term>Trayicon</term>
34             <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>
35     </varlistentry>
36     </variablelist>
37   </section>
39   <section id="plugins_external">
40     <title>More plugins</title>
41     <para>
42             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://www.sylpheed-claws.net/plugins.php">http://www.sylpheed-claws.net/plugins.php</ulink>:
43     </para>
44     <variablelist>
45     <varlistentry><term>Acpi Notifier</term>
46             <listitem><para>Enables new mail notification via the LEDs found on some laptops like Acer, Asus, Fujitsu and IBM laptops.</para></listitem>
47     </varlistentry>
48     <varlistentry><term>AttRemover</term>
49             <listitem><para> This plugin lets you remove attachments from emails.</para></listitem>
50     </varlistentry>
51     <varlistentry><term>CacheSaver</term>
52             <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>
53     </varlistentry>
54     <varlistentry><term>etpan! Privacy</term>
55             <listitem><para>Handles signature verification and decryption of encrypted messages in S/MIME, OpenPGP and ascii-armored PGP formats. Doesn't handle passphrases.</para></listitem>
56     </varlistentry>
57     <varlistentry><term>Fetchinfo</term>
58             <listitem><para>Inserts headers containing some download information, like UIDL, Sylpheed-Claws' account name, POP server, user ID and retrieval time.</para></listitem>
59     </varlistentry>
60     <varlistentry><term>GtkHtml Viewer</term>
61             <listitem><para>Like Dillo, enables the viewing of html messages, but in a nicer way (antialiased fonts).</para></listitem>
62     </varlistentry>
63     <varlistentry><term>Maildir</term>
64             <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>
65     </varlistentry>
66     <varlistentry><term>mailMBOX</term>
67             <listitem><para>Handles mailboxes in mbox format. </para></listitem>
68     </varlistentry>
69     <varlistentry><term>Perl</term>
70             <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>
71     </varlistentry>
72     <varlistentry><term>S/MIME</term>
73             <listitem><para>Handles S/MIME signed and/or encrypted mails. You can decrypt mails, verify signatures or sign and encrypt your own mails. Uses GnuPG/GPGME and GpgSM, <ulink url="ftp://ftp.gnupg.org/gcrypt/gpgme/">ftp://ftp.gnupg.org/gcrypt/gpgme/</ulink>.</para></listitem>
74     </varlistentry>
75     <varlistentry><term>SynCE</term>
76             <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>
77     </varlistentry>
78     <varlistentry><term>vCalendar</term>
79             <listitem><para>Enables vCalendar message handling like that produced by Evolution or Outlook, and Webcal subscriptions.</para></listitem>
80     </varlistentry>
81     <varlistentry><term>RSSyl</term>
82             <listitem><para>Allows you to read your favorite newsfeeds in Claws. RSS 1.0, 2.0 and Atom feeds are currently supported.</para></listitem>
83     </varlistentry>
84     </variablelist>
85     <para>
86         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 on the IRC channels, #sylpheed-claws on Freenode or IRCnet.
87     </para>
88   </section>
89   <section id="plugins_network">
90     <title>Network access from the plugins</title>
91     <para>
92         Some of the external plugins, for example RSSyl, vCalendar or GtkHtml Viewer, need Internet access for their operations (retrieving feeds in the case of RSSyl or vCalendar, and fetching images in the case of GtkHtml Viewer). These plugins use the Curl library. Hence, if your Internet access is restricted by a proxy, you will need to tell libCurl to use this proxy. This is done by setting an environment variable, <emphasis>http_proxy</emphasis>. For example, <emphasis>http_proxy=http://user:passwd@myproxy.example.com:8080</emphasis> will tell libCurl to connect to port 8080 of the machine myproxy.example.com, with the user <quote>user</quote> and password <quote>passwd</quote> to connect to the Internet. 
93     </para>
94     <para>
95         You can either set this variable before starting Sylpheed-Claws, by using for example <emphasis>http_proxy=http://user:passwd@myproxy.example.com:8080 sylpheed-claws</emphasis>, or set it in your ~/.bashrc file, by adding the following line: <emphasis>export http_proxy=http://user:passwd@myproxy.example.com:8080</emphasis> (you'll have to reconnect to have it taken into account).
96     </para>
97   </section>
98 </section>