2006-08-26 [mones] 2.4.0cvs94
[claws.git] / manual / plugins.xml
1 <?xml version="1.0" encoding="utf-8"?>
2 <section id="ch_plugins">
3 <title>Extending Sylpheed-Claws</title>
4
5   <section id="plugins_default">
6     <title>Provided plugins</title>
7     <para>
8         Sylpheed-Claws' 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.
11     </para><para>
12         Plugins are installed in <filename class="directory"
13         >$PREFIX/lib/sylpheed-claws/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.
18     </para><para>
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.
22     </para>
23     <variablelist>
24       <varlistentry>
25         <term>Clam Antivirus</term>
26         <listitem>
27           <para>
28         Enables the scanning of message attachments in mail received from a 
29         POP, IMAP or LOCAL account using Clam AntiVirus. It can optionally 
30         delete the mail or save it to a designated folder. Preferences can be 
31         found in 
32         <quote>Configuration/Preferences/Plugins/Clam AntiVirus</quote>. 
33         Clam AntiVirus is available from <ulink 
34         url="http://clamav.sourceforge.net/"
35         >http://clamav.sourceforge.net/</ulink>.
36           </para>
37         </listitem>
38       </varlistentry>
39       <varlistentry>
40         <term>Dillo HTML Viewer</term>
41         <listitem>
42           <para>
43         Enables the viewing of HTML messages using the Dillo web browser, 
44         version 0.7.0 or newer. It uses Dillo's <literal>--local</literal> 
45         option by default for safe browsing. Preferences can be found in 
46         <quote>/Configuration/Preferences/Plugins/Dillo Browser</quote>. 
47         Dillo is available from <ulink url="http://www.dillo.org/"
48         >http://www.dillo.org/</ulink>.
49           </para>
50         </listitem>
51       </varlistentry>
52       <varlistentry>
53         <term>PGP/Core, PGP/Inline and PGP/MIME</term>
54         <listitem>
55           <para>
56         Handles PGP signed and/or encrypted mails. You can decrypt mails, 
57         verify signatures or sign and encrypt your own mails. Uses GnuPG/GPGME,
58         <ulink url="ftp://ftp.gnupg.org/gcrypt/gpgme/"
59         >ftp://ftp.gnupg.org/gcrypt/gpgme/</ulink>.
60           </para>
61         </listitem>
62       </varlistentry>
63       <varlistentry>
64         <term>SpamAssassin</term>
65         <listitem>
66           <para>
67         The SpamAssassin plugin comes with two major features:
68           </para><para>
69         The ability to scan incoming mail received from a POP, IMAP or LOCAL 
70         account using SpamAssassin. It can optionally delete mail identified 
71         as spam or save it to a designated folder. Mail scanning can be turned 
72         off, which is useful if your email is scanned on your server.
73           </para><para>
74         The ability for users to teach SpamAssassin to recognise spam or ham. 
75         You can train SpamAssassin by marking messages as spam or ham from the 
76         Message List contextual menu, or using the relevant toolbar button in 
77         the main window or the message window (see 
78         <quote>Configuration/Preferences/Customize toolbars</quote>). Messages 
79         marked as spam are optionally saved to a designated folder.
80           </para><para>
81         Plugin preferences can be found in 
82         <quote>Configuration/Preferences/Plugins/SpamAssassin</quote>.
83           </para><para>
84         SpamAssassin is available from <ulink 
85         url="http://spamassassin.apache.org/"
86         >http://spamassassin.apache.org/</ulink>. Version 3.1.x or higher is 
87         required to use the learning feature in TCP mode.
88           </para>
89         </listitem>
90       </varlistentry>
91       <varlistentry>
92         <term>Trayicon</term>
93         <listitem>
94           <para>
95         Places an icon in the system tray that indicates whether you have any 
96         new mail. A tooltip also shows the current new, unread and total number
97         of messages.
98           </para>
99         </listitem>
100       </varlistentry>
101     </variablelist>
102   </section>
103
104   <section id="plugins_external">
105     <title>More plugins</title>
106     <para>
107         Other plugins have been written too, which are available as separate 
108         downloads. At the time of this writing, there are a number of plugins 
109         available at <ulink url="http://www.sylpheed-claws.net/plugins.php"
110         >http://www.sylpheed-claws.net/plugins.php</ulink>:
111     </para>
112     <variablelist>
113       <varlistentry>
114         <term>Acpi Notifier</term>
115         <listitem>
116           <para>
117         Enables new mail notification via the LEDs found on some laptops like 
118         Acer, Asus, Fujitsu and IBM laptops.
119           </para>
120         </listitem>
121       </varlistentry>
122       <varlistentry>
123         <term>AttRemover</term>
124         <listitem>
125           <para> 
126         This plugin lets you remove attachments from emails.
127           </para>
128         </listitem>
129       </varlistentry>
130       <varlistentry>
131         <term>CacheSaver</term>
132         <listitem>
133           <para>
134         Saves the caches every 60 seconds (or user-defined period). It helps 
135         avoiding the loss of metadata if your computer (<emphasis>or 
136         Sylpheed-Claws!</emphasis>) crashes.
137           </para>
138         </listitem>
139       </varlistentry>
140       <varlistentry>
141         <term>etpan! Privacy</term>
142         <listitem>
143           <para>
144         Handles signature verification and decryption of encrypted messages in 
145         S/MIME, OpenPGP and ascii-armored PGP formats. Doesn't handle 
146         passphrases.
147           </para>
148         </listitem>
149       </varlistentry>
150       <varlistentry>
151         <term>Fetchinfo</term>
152         <listitem>
153           <para>
154         Inserts headers containing some download information, like UIDL, 
155         Sylpheed-Claws' account name, POP server, user ID and retrieval time.
156           </para>
157         </listitem>
158       </varlistentry>
159       <varlistentry>
160         <term>GtkHtml Viewer</term>
161         <listitem>
162           <para>
163         Like Dillo, enables the viewing of HTML messages, but in a nicer way 
164         (antialiased fonts).
165           </para>
166         </listitem>
167       </varlistentry>
168       <varlistentry>
169         <term>Maildir</term>
170         <listitem>
171           <para>
172         Provides direct support for Maildir++ mailboxes. With this plugin you 
173         can share your Maildir++ mailbox with other mailers or IMAP servers.
174           </para>
175         </listitem>
176       </varlistentry>
177       <varlistentry>
178         <term>mailMBOX</term>
179         <listitem>
180           <para>
181         Handles mailboxes in MBox format.
182           </para>
183         </listitem>
184       </varlistentry>
185       <varlistentry>
186         <term>Perl</term>
187         <listitem>
188           <para>
189         Intended to extend the filtering possibilities of Sylpheed-Claws. It 
190         provides a Perl interface to Sylpheed-Claws' filtering mechanism, 
191         allowing the use of full Perl power in email filters.
192           </para>
193         </listitem>
194       </varlistentry>
195       <varlistentry>
196         <term>S/MIME</term>
197         <listitem>
198           <para>
199         Handles S/MIME signed and/or encrypted mails. You can decrypt mails, 
200         verify signatures or sign and encrypt your own mails. Uses GnuPG/GPGME 
201         and GpgSM, <ulink url="ftp://ftp.gnupg.org/gcrypt/gpgme/"
202         >ftp://ftp.gnupg.org/gcrypt/gpgme/</ulink>.
203           </para>
204         </listitem>
205       </varlistentry>
206       <varlistentry>
207         <term>SynCE</term>
208         <listitem>
209           <para>
210         Assists in keeping the address book of a Windows CE device (Pocket 
211         PC, iPAQ, Smartphone, etc.) in sync with Sylpheed-Claws' address book, 
212         with respect to email addresses.
213           </para>
214         </listitem>
215       </varlistentry>
216       <varlistentry>
217         <term>vCalendar</term>
218         <listitem>
219           <para>
220         Enables vCalendar message handling like that produced by Evolution or 
221         Outlook, and Webcal subscriptions.
222           </para>
223         </listitem>
224       </varlistentry>
225       <varlistentry>
226         <term>RSSyl</term>
227         <listitem>
228           <para>
229         Allows you to read your favorite newsfeeds in Claws. RSS 1.0, 2.0 and 
230         Atom feeds are currently supported.
231           </para>
232         </listitem>
233       </varlistentry>
234     </variablelist>
235     <para>
236         If you're a developer, writing a plugin to extend Sylpheed-Claws' 
237         capabilities is probably the best and easiest solution. We will 
238         provide hosting to your code, and will be glad to answer your questions
239         in the mailing-list or on the IRC channels, 
240         <literal>#sylpheed-claws</literal> on Freenode or IRCnet.
241     </para>
242   </section>
243   <section id="plugins_network">
244     <title>Network access from the plugins</title>
245     <para>
246         Some of the external plugins, for example RSSyl, vCalendar or GtkHtml 
247         Viewer, need Internet access for their operations (retrieving feeds in 
248         the case of RSSyl or vCalendar, and fetching images in the case of 
249         GtkHtml Viewer). These plugins use the Curl library. Hence, if your 
250         Internet access is restricted by a proxy, you will need to tell libCurl
251         to use this proxy. This is done by setting an environment variable, 
252         <emphasis>http_proxy</emphasis>. For example, 
253 <literal>http_proxy=http://user:passwd@myproxy.example.com:8080</literal> 
254         will tell libCurl to connect to port 8080 of the machine 
255         myproxy.example.com, with the user <quote>user</quote> and password 
256         <quote>passwd</quote> to connect to the Internet. 
257     </para><para>
258         You can either set this variable before starting Sylpheed-Claws, by 
259         using for example 
260         <command>http_proxy=http://user:passwd@myproxy.example.com:8080 
261         sylpheed-claws</command>, or set it in your 
262         <filename>~/.bashrc</filename> file (or your shell equivalent), by 
263         adding the following line<footnote><para>Other shells may have 
264         diferent syntaxes, check your shell's manual page.</para></footnote>: 
265 <command>export http_proxy=http://user:passwd@myproxy.example.com:8080</command>
266         (you'll have to reconnect to have it taken into account).
267     </para>
268   </section>
269 </section>
270