<title>Extending Claws Mail</title>
<section id="plugins_default">
- <title>Provided plugins</title>
+ <title>Plugins</title>
<para>
- 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.
+ Claws Mail's capabilities are extended by plugins, which are
+ listed below.
</para><para>
Plugins are installed in <filename class="directory"
>$PREFIX/lib/claws-mail/plugins/</filename> and have a suffix of
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
+ 3 anti-Spam plugins). 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>
+ <para>
+ There is a list of all plugins available at <ulink
+ url="http://www.claws-mail.org/plugins.php"
+ >http://www.claws-mail.org/plugins.php</ulink>.
</para>
<variablelist>
<varlistentry>
- <term>Bogofilter</term>
+ <term>ACPI Notifier</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>.
+ Enables new mail notification via the LEDs found on some laptops like
+ Acer, Asus, Fujitsu and IBM laptops.
+ More information: <ulink
+ url="http://www.claws-mail.org/plugin.php?plugin=acpinotifier"
+ >www.claws-mail.org/plugin.php?plugin=acpinotifier</ulink>
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>Dillo HTML Viewer</term>
+ <term>AddressKeeper</term>
<listitem>
<para>
- Enables the viewing of HTML messages using the Dillo web browser,
- version 0.7.0 or newer. It uses Dillo's <literal>--local</literal>
- 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>.
+ Saves all unknown recipient addresses (<quote>To</quote>,
+ <quote>Cc</quote> and/or <quote>Bcc</quote>) to a designated
+ addressbook folder.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>PGP/Core, PGP/Inline and PGP/MIME</term>
+ <term>AttachWarner</term>
<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>.
+ 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.
+ More information: <ulink
+ url="http://www.claws-mail.org/plugin.php?plugin=attachwarner"
+ >www.claws-mail.org/plugin.php?plugin=attachwarner</ulink>
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>SpamAssassin</term>
+ <term>AttRemover</term>
<listitem>
<para>
- The SpamAssassin plugin comes with two major features:
+ Allows you to remove attachments from emails.
+ </para>
+ </listitem>
+ </varlistentry>
+ <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 SpamAssassin. It can optionally delete mail identified
+ account using Bogofilter. 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.
+ off.
</para><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
+ 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
+ <quote>Configuration/Preferences/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/SpamAssassin</quote>.
+ <quote>Configuration/Preferences/Plugins/Bogofilter</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.
+ Bogofilter's advantage over Spamassassin is its speed.
</para><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.
+ Bogofilter is available from <ulink
+ url="http://bogofilter.sourceforge.net/"
+ >http://bogofilter.sourceforge.net/</ulink>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>BSFilter</term>
+ <listitem>
+ <para>
+ BSFilter is a plugin that is very similar to the Bogofilter plugin
+ but uses the bsfilter (<ulink url="http://bsfilter.org/index-e.html"
+ >bsfilter.org/index-e.html</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>
<varlistentry>
- <term>Trayicon</term>
+ <term>Clamd</term>
<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.
+ Allows scanning all messages received from IMAP, POP or local accounts
+ using the clam daemon part of the Clam AV (AntiVirus) software.
</para>
</listitem>
</varlistentry>
- </variablelist>
- </section>
-
- <section id="plugins_external">
- <title>More plugins</title>
- <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.claws-mail.org/plugins.php"
- >http://www.claws-mail.org/plugins.php</ulink>:
- </para>
- <variablelist>
<varlistentry>
- <term>Acpi Notifier</term>
+ <term>Fancy</term>
<listitem>
<para>
- Enables new mail notification via the LEDs found on some laptops like
- Acer, Asus, Fujitsu and IBM laptops.
+ Enables the display of HTML messages using the GTK+ port of the
+ WebKit library.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>AttachWarner</term>
+ <term>Fetchinfo</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>
+ Inserts headers containing some download information, like UIDL,
+ Claws Mail' account name, POP server, user ID and retrieval time.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>AttRemover</term>
+ <term>GData</term>
<listitem>
- <para>
- Allows you to remove attachments from emails.
+ <para>
+ Provides an interface to Google services using the gdata library.
+ Currently, the only implemented functionality is to include Google
+ Contacts in the Tab-address completion.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>CacheSaver</term>
+ <term>GeoLocation</term>
<listitem>
<para>
- Saves the caches every 60 seconds (or user-defined period). It helps
- avoiding the loss of metadata if your computer (<emphasis>or
- Claws Mail!</emphasis>) crashes. (NOTE: using this plugin can slow
- down Claws Mail.)
+ Provides geolocation functionality based on the addresses contained
+ in the messages.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>Fetchinfo</term>
+ <term>Libravatar</term>
<listitem>
<para>
- Inserts headers containing some download information, like UIDL,
- Claws Mail' account name, POP server, user ID and retrieval time.
+ Enables displaying avatar images associated to user profiles in
+ libravatar.org or user's avatar enabled domains.
+ More information: <ulink
+ url="http://www.claws-mail.org/plugin.php?plugin=libravatar"
+ >www.claws-mail.org/plugin.php?plugin=libravatar</ulink>
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>GtkHtml2 Viewer</term>
+ <term>Mail Archiver</term>
<listitem>
<para>
- Like Dillo, enables the viewing of HTML messages, but in a nicer way
- (antialiased fonts).
+ Enables folders and subfolders to be archived in several different
+ formats.
</para>
</listitem>
</varlistentry>
<listitem>
<para>
Provides various ways to notify the user of new and unread email.
+ More information: <ulink
+ url="http://www.claws-mail.org/plugin.php?plugin=notification"
+ >www.claws-mail.org/plugin.php?plugin=notification</ulink>
</para>
</listitem>
</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.
+ Allows rendering of PDF and PostScript attachments using the Poppler
+ library and GhostScript external program.
+ More information: <ulink
+ url="http://www.claws-mail.org/plugin.php?plugin=pdf_viewer"
+ >www.claws-mail.org/plugin.php?plugin=pdf_viewer</ulink>
</para>
</listitem>
</varlistentry>
</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>PGP/Core, PGP/Inline and PGP/MIME</term>
+ <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>.
+ More information: <ulink
+ url="http://www.claws-mail.org/plugin.php?plugin=gpg"
+ >www.claws-mail.org/plugin.php?plugin=gpg</ulink>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Python</term>
+ <listitem>
+ <para>
+ This plugin provides Python integration features.
+ More information: <ulink
+ url="http://www.claws-mail.org/plugin.php?plugin=python"
+ >www.claws-mail.org/plugin.php?plugin=python</ulink>
+ </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.
+ More information: <ulink
+ url="http://www.claws-mail.org/plugin.php?plugin=rssyl"
+ >www.claws-mail.org/plugin.php?plugin=rssyl</ulink>
</para>
</listitem>
</varlistentry>
<term>S/MIME</term>
<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
+ 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>
</varlistentry>
+ <varlistentry>
+ <term>SpamAssassin</term>
+ <listitem>
+ <para>
+ The SpamAssassin plugin comes with two major features:
+ </para><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><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
+ <quote>Configuration/Preferences/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/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
+ required to use the learning feature in TCP mode.
+ </para>
+ </listitem>
+ </varlistentry>
<varlistentry>
<term>SpamReport</term>
<listitem>
<para>
This plugin reports spam to various places.
- Currently
only <ulink url="http://spam-signal.fr"
+ Currently
the sites <ulink url="http://spam-signal.fr"
>spam-signal.fr</ulink> and <ulink url="http://spamcop.net"
- >spamcop.net</ulink> are supported.
+ >spamcop.net</ulink> are supported, and the <ulink
+ url="http://lists.debian.org">Debian lists (lists.debian.org)</ulink>
+ spam nomination system.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>SynCE</term>
+ <term>TNEF parse</term>
<listitem>
<para>
- 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.
+ This plugin enables reading <literal>application/ms-tnef attachments</literal>.
+ More information: <ulink
+ url="http://www.claws-mail.org/plugin.php?plugin=tnef_parser"
+ >www.claws-mail.org/plugin.php?plugin=tnef_parser</ulink>
</para>
</listitem>
</varlistentry>
<para>
Enables vCalendar message handling like that produced by Evolution or
Outlook, and Webcal subscriptions.
+ More information: <ulink
+ url="http://www.claws-mail.org/plugin.php?plugin=vcalendar"
+ >www.claws-mail.org/plugin.php?plugin=vcalendar</ulink>
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
- If you're a developer, writing a plugin to extend Claws Mail'
+ If you're a developer, writing a plugin to extend Claws Mail's
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>#claws</literal> on Freenode or IRCnet.
</para>
</section>
+
<section id="plugins_network">
<title>Network access from the plugins</title>
<para>
(you'll have to reconnect to have it taken into account).
</para>
</section>
+
</section>
projects / claws.git / blobdiff