<?xml version="1.0" encoding="utf-8"?>
<section id="ch_plugins">
-<title>Extending Sylpheed-Claws</title>
+<title>Extending Claws Mail</title>
<section id="plugins_default">
<title>Provided plugins</title>
<para>
- Sylpheed-Claws' capabilities are extended by plugins. It comes with
+ Claws Mail' 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.
</para><para>
Plugins are installed in <filename class="directory"
- >$PREFIX/lib/sylpheed-claws/plugins/</filename> and have a suffix of
+ >$PREFIX/lib/claws-mail/plugins/</filename> 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
If you don't find the plugin you're looking for, it is possible that
your Operating System distribution provides it in a separate package.
In this case, search for the plugin in your package manager.
+ </para><para>
+ Some plugins provide the same functionality as others, (for example, the
+ three HTML message viewers). In this case you will have to choose which
+ one to load, as Claws Mail will refuse to load more than one of
+ the same type.
</para>
<variablelist>
<varlistentry>
You can train Bogofilter 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
- <quote>Configuration/Preferences/Customize toolbars</quote>). Messages
+ <quote>Configuration/Preferences/Toolbars</quote>). Messages
marked as spam are optionally saved to a designated folder.
</para><para>
Plugin preferences can be found in
</para>
</listitem>
</varlistentry>
- <varlistentry>
- <term>Clam Antivirus</term>
- <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>
- </varlistentry>
<varlistentry>
<term>Dillo HTML Viewer</term>
<listitem>
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
- <quote>Configuration/Preferences/Customize toolbars</quote>). Messages
+ <quote>Configuration/Preferences/Toolbars</quote>). Messages
marked as spam are optionally saved to a designated folder.
</para><para>
Plugin preferences can be found in
<para>
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>:
+ available at <ulink url="http://www.claws-mail.org/plugins.php"
+ >http://www.claws-mail.org/plugins.php</ulink>:
</para>
<variablelist>
<varlistentry>
</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>AttachWarner</term>
+ <listitem>
+ <para>
+ Reminds you about possibly forgotten attachments. Checks for common
+ expressions found when attaching a file and warns you if no attachment
+ was added to the mail you're sending.
+ </para>
+ </listitem>
+ </varlistentry>
<varlistentry>
<term>AttRemover</term>
<listitem>
<para>
- This plugin lets you remove attachments from emails.
+ Allows you to remove attachments from emails.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>BSFilter</term>
+ <listitem>
+ <para>
+ BSFilter is a plugin that is very similar to the Bogofilter plugin but uses
+ the <ulink url="http://bsfilter.org/index-e.html">bsfilter</ulink>
+ bayesian spam filter as a backend.
+ </para><para>
+ Like Bogofilter, you have to train it with spam and ham
+ messages in order for bsfilter to start recognising spam.
+ </para><para>
+ Plugin preferences can be found in
+ <quote>Configuration/Preferences/Plugins/BSFilter</quote>.
</para>
</listitem>
</varlistentry>
<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.
+ Claws Mail!</emphasis>) crashes. (NOTE: using this plugin can slow
+ down Claws Mail.)
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>etpan! Privacy</term>
+ <term>Fancy</term>
<listitem>
<para>
- Handles signature verification and decryption of encrypted messages in
- S/MIME, OpenPGP and ascii-armored PGP formats. Doesn't handle
- passphrases.
+ Enables the display of HTML messages using the GTK+ port of the
+ WebKit library.
</para>
</listitem>
</varlistentry>
<listitem>
<para>
Inserts headers containing some download information, like UIDL,
- Sylpheed-Claws' account name, POP server, user ID and retrieval time.
+ Claws Mail' account name, POP server, user ID and retrieval time.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>GtkHtml Viewer</term>
+ <term>GtkHtml2 Viewer</term>
<listitem>
<para>
Like Dillo, enables the viewing of HTML messages, but in a nicer way
</listitem>
</varlistentry>
<varlistentry>
- <term>Maildir</term>
+ <term>Mail Archiver</term>
<listitem>
<para>
- Provides direct support for Maildir++ mailboxes. With this plugin you
- can share your Maildir++ mailbox with other mailers or IMAP servers.
+ Enables folders and subfolders to be archived in several different
+ formats.
</para>
</listitem>
</varlistentry>
</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>NewMail</term>
+ <listitem>
+ <para>
+ Writes a msg header summary to a log file, (Default:
+ <filename>~/Mail/NewLog</filename>), on arrival of new mail
+ <emphasis>after</emphasis> sorting.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Notification</term>
+ <listitem>
+ <para>
+ Provides various ways to notify the user of new and unread email.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>PDF Viewer</term>
+ <listitem>
+ <para>
+ Provides direct rendering of PDF and PostScript attachments
+ in the Claws Mail message view. It also allows browsing, zooming and
+ displaying detailed information about such attachments.
+ </para>
+ </listitem>
+ </varlistentry>
<varlistentry>
<term>Perl</term>
<listitem>
<para>
- Intended to extend the filtering possibilities of Sylpheed-Claws. It
- provides a Perl interface to Sylpheed-Claws' filtering mechanism,
+ Intended to extend the filtering possibilities of Claws Mail. It
+ provides a Perl interface to Claws Mail' filtering mechanism,
allowing the use of full Perl power in email filters.
</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>RSSyl</term>
+ <listitem>
+ <para>
+ Allows you to read your favorite newsfeeds in Claws. RSS 1.0, 2.0 and
+ Atom feeds are currently supported.
+ </para>
+ </listitem>
+ </varlistentry>
<varlistentry>
<term>S/MIME</term>
<listitem>
</listitem>
</varlistentry>
<varlistentry>
- <term>SynCE</term>
+ <term>SpamReport</term>
<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.
+ This plugin reports spam to various places.
+ Currently the sites <ulink url="http://spam-signal.fr"
+ >spam-signal.fr</ulink> and <ulink url="http://spamcop.net"
+ >spamcop.net</ulink> are supported, and the <ulink
+ url="http://lists.debian.org">Debian lists</ulink>
+ spam nomination system.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>vCalendar</term>
+ <term>SynCE</term>
<listitem>
<para>
- Enables vCalendar message handling like that produced by Evolution or
- Outlook, and Webcal subscriptions.
+ Assists in keeping the address book of a Windows CE device (Pocket
+ PC, iPAQ, Smartphone, etc.) in sync with Claws Mail' address book,
+ with respect to email addresses.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>RSSyl</term>
+ <term>vCalendar</term>
<listitem>
<para>
- Allows you to read your favorite newsfeeds in Claws. RSS 1.0, 2.0 and
- Atom feeds are currently supported.
+ Enables vCalendar message handling like that produced by Evolution or
+ Outlook, and Webcal subscriptions.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
- If you're a developer, writing a plugin to extend Sylpheed-Claws'
+ If you're a developer, writing a plugin to extend Claws Mail'
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,
- <literal>#sylpheed-claws</literal> on Freenode or IRCnet.
+ <literal>#claws</literal> on Freenode or IRCnet.
</para>
</section>
<section id="plugins_network">
myproxy.example.com, with the user <quote>user</quote> and password
<quote>passwd</quote> to connect to the Internet.
</para><para>
- You can either set this variable before starting Sylpheed-Claws, by
+ You can either set this variable before starting Claws Mail, by
using for example
<command>http_proxy=http://user:passwd@myproxy.example.com:8080
- sylpheed-claws</command>, or set it in your
+ claws-mail</command>, or set it in your
<filename>~/.bashrc</filename> file (or your shell equivalent), by
adding the following line<footnote><para>Other shells may have
diferent syntaxes, check your shell's manual page.</para></footnote>:
projects / claws.git / blobdiff