<?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
In this case, search for the plugin in your package manager.
</para>
<variablelist>
+ <varlistentry>
+ <term>Bogofilter</term>
+ <listitem>
+ <para>
+ The Bogofilter plugin comes with two major features:
+ </para><para>
+ The ability to scan incoming mail received from a POP, IMAP or LOCAL
+ account using Bogofilter. It can optionally delete mail identified
+ as spam or save it to a designated folder. Mail scanning can be turned
+ off.
+ </para><para>
+ The ability for users to teach Bogofilter to recognise spam or ham.
+ 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
+ marked as spam are optionally saved to a designated folder.
+ </para><para>
+ Plugin preferences can be found in
+ <quote>Configuration/Preferences/Plugins/Bogofilter</quote>.
+ </para><para>
+ Bogofilter's advantage over Spamassassin is its speed.
+ </para><para>
+ Bogofilter is available from <ulink
+ url="http://bogofilter.sourceforge.net/"
+ >http://bogofilter.sourceforge.net/</ulink>.
+ </para>
+ </listitem>
+ </varlistentry>
<varlistentry>
<term>Clam Antivirus</term>
<listitem>
Plugin preferences can be found in
<quote>Configuration/Preferences/Plugins/SpamAssassin</quote>.
</para><para>
+ SpamAssassin's advantage over Bogofilter is that it's not only a bayesian
+ filter, but it also performs various local and network tests to
+ determine spaminess.
+ </para><para>
SpamAssassin is available from <ulink
url="http://spamassassin.apache.org/"
>http://spamassassin.apache.org/</ulink>. Version 3.1.x or higher is
<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>
<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>Fetchinfo</term>
<listitem>
<para>
- Handles signature verification and decryption of encrypted messages in
- S/MIME, OpenPGP and ascii-armored PGP formats. Doesn't handle
- passphrases.
+ Inserts headers containing some download information, like UIDL,
+ Claws Mail' account name, POP server, user ID and retrieval time.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>Fetchinfo</term>
+ <term>GtkHtml2 Viewer</term>
<listitem>
<para>
- Inserts headers containing some download information, like UIDL,
- Sylpheed-Claws' account name, POP server, user ID and retrieval time.
+ Like Dillo, enables the viewing of HTML messages, but in a nicer way
+ (antialiased fonts).
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>GtkHtml Viewer</term>
+ <term>mailMBOX</term>
<listitem>
<para>
- Like Dillo, enables the viewing of HTML messages, but in a nicer way
- (antialiased fonts).
+ Handles mailboxes in MBox format.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>Maildir</term>
+ <term>NewMail</term>
<listitem>
<para>
- Provides direct support for Maildir++ mailboxes. With this plugin you
- can share your Maildir++ mailbox with other mailers or IMAP servers.
+ Writes a msg header summary to a log file, (Default: ~/Mail/NewLog),
+ on arrival of new mail *after* sorting.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>mailMBOX</term>
+ <term>Notification</term>
<listitem>
<para>
- Handles mailboxes in MBox format.
+ 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>
<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 only spam-signal.fr is supported.
</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-mail</literal> on Freenode or IRCnet.
</para>
</section>
<section id="plugins_network">
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,
+ <literal>http_proxy</literal>. For example,
<literal>http_proxy=http://user:passwd@myproxy.example.com:8080</literal>
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.
</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