X-Git-Url: http://git.claws-mail.org/?p=claws.git;a=blobdiff_plain;f=manual%2Fplugins.xml;h=a1a224738c439297ca4d30482281cb8b1ddeb4e5;hp=eb18ca79e7531442c564431da92af3d420d39c6c;hb=b4f457686fcc8a0427d5d8abf193aff82221f35a;hpb=d2710c9124d2b7976dcbe692a56665d9e2f85947
diff --git a/manual/plugins.xml b/manual/plugins.xml
index eb18ca79e..a1a224738 100644
--- a/manual/plugins.xml
+++ b/manual/plugins.xml
@@ -5,77 +5,299 @@
Provided plugins
- Sylpheed-Claws' capabilities are extended by plugins. It comes with the following plugins included, all of which are built automatically if the required libraries are present.
+ 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.
- Plugins are installed in $PREFIX/lib/sylpheed-claws/plugins/ and have a suffix of .so
To load a plugin go to Configuration/Plugins
and click the Load Plugin
button. Select the plugin that you want and click OK.
+ Plugins are installed in $PREFIX/lib/sylpheed-claws/plugins/ and have a suffix of
+ .so
. To load a plugin go to
+ Configuration/Plugins
and click the
+ Load Plugin
button. Select the plugin that you want and
+ click Open
button.
- 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.
+ 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.
- Clam Antivirus
- 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 Configuration/Preferences/Plugins/Clam AntiVirus
. Clam AntiVirus is available from http://clamav.sourceforge.net/.
-
- Dillo HTML Viewer
- 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 /Configuration/Preferences/Plugins/Dillo Browser
. Dillo is available from http://www.dillo.org/.
-
- MathML Viewer
- Enables the viewing of attachments that have the Content-Type 'text/mathml' using the GtkMathView widget which is available from http://helm.cs.unibo.it/mml-widget/.
-
- PGP/Core, PGP/Inline and PGP/MIME
- Handles PGP signed and/or encrypted mails. You can decrypt mails, verify signatures or sign and encrypt your own mails. Uses GnuPG/GPGME, ftp://ftp.gnupg.org/gcrypt/gpgme/.
-
- SpamAssassin
- Enables the scanning of 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. Preferences can be found in Configuration/Preferences/Plugins/SpamAssassin
. SpamAssassin is available from http://spamassassin.org/.
-
- Trayicon
- 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.
-
+
+ Bogofilter
+
+
+ The Bogofilter plugin comes with two major features:
+
+ 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.
+
+ 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
+ Configuration/Preferences/Customize toolbars
). Messages
+ marked as spam are optionally saved to a designated folder.
+
+ Plugin preferences can be found in
+ Configuration/Preferences/Plugins/Bogofilter
.
+
+ Bogofilter's advantage over Spamassassin is its speed.
+
+ Bogofilter is available from http://bogofilter.sourceforge.net/.
+
+
+
+
+ Clam Antivirus
+
+
+ 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
+ Configuration/Preferences/Plugins/Clam AntiVirus
.
+ Clam AntiVirus is available from http://clamav.sourceforge.net/.
+
+
+
+
+ Dillo HTML Viewer
+
+
+ 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
+ /Configuration/Preferences/Plugins/Dillo Browser
.
+ Dillo is available from http://www.dillo.org/.
+
+
+
+
+ PGP/Core, PGP/Inline and PGP/MIME
+
+
+ Handles PGP signed and/or encrypted mails. You can decrypt mails,
+ verify signatures or sign and encrypt your own mails. Uses GnuPG/GPGME,
+ ftp://ftp.gnupg.org/gcrypt/gpgme/.
+
+
+
+
+ SpamAssassin
+
+
+ The SpamAssassin plugin comes with two major features:
+
+ 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.
+
+ 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.
+
+ Plugin preferences can be found in
+ Configuration/Preferences/Plugins/SpamAssassin
.
+
+ 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.
+
+ SpamAssassin is available from http://spamassassin.apache.org/. Version 3.1.x or higher is
+ required to use the learning feature in TCP mode.
+
+
+
+
+ Trayicon
+
+
+ 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.
+
+
+
More plugins
- 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 http://claws.sylpheed.org/plugins.php:
+ 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 http://www.sylpheed-claws.net/plugins.php:
- Acpi Notifier
- Enables new mail notification via the LEDs found on some laptops like Acer, Asus and IBM laptops.
-
- AttRemover
- This plugin lets you remove attachments from emails.
-
- CacheSaver
- Saves the caches every 60 seconds (or user-defined period). It helps avoiding the loss of metadata if your computer (or Sylpheed-Claws!) crashes.
-
- etpan! Privacy
- Handles signature verification and decryption of encrypted messages in S/MIME, OpenPGP, and ascii-armored PGP formats.
-
- Fetchinfo
- Inserts headers containing some download information, like UIDL, Sylpheeds account name, POP server, user ID and retrieval time.
-
- Maildir
- Provides direct support for Maildir++ mailboxes. With this plugin you can share your Maildir++ mailbox with other mailers or IMAP servers.
-
- mailMBOX
- Handles mailboxes in mbox format.
-
- Perl
- 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.
-
- SynCE
- Assists in keeping the addressbook of a Windows CE device (Pocket PC/ iPAQ, Smartphone etc) in sync with Claws' addressbook, with respect to email addresses.
-
- vCalendar
- Enables vCalendar message handling like that produced by Evolution or Outlook, and Webcal subscriptions.
-
- RSSyl
- Allows you to read your favorite newsfeeds in Claws. RSS 1.0, 2.0 and Atom feeds are currently supported.
-
+
+ Acpi Notifier
+
+
+ Enables new mail notification via the LEDs found on some laptops like
+ Acer, Asus, Fujitsu and IBM laptops.
+
+
+
+
+ AttRemover
+
+
+ This plugin lets you remove attachments from emails.
+
+
+
+
+ CacheSaver
+
+
+ Saves the caches every 60 seconds (or user-defined period). It helps
+ avoiding the loss of metadata if your computer (or
+ Sylpheed-Claws!) crashes.
+
+
+
+
+ etpan! Privacy
+
+
+ Handles signature verification and decryption of encrypted messages in
+ S/MIME, OpenPGP and ascii-armored PGP formats. Doesn't handle
+ passphrases.
+
+
+
+
+ Fetchinfo
+
+
+ Inserts headers containing some download information, like UIDL,
+ Sylpheed-Claws' account name, POP server, user ID and retrieval time.
+
+
+
+
+ GtkHtml Viewer
+
+
+ Like Dillo, enables the viewing of HTML messages, but in a nicer way
+ (antialiased fonts).
+
+
+
+
+ Maildir
+
+
+ Provides direct support for Maildir++ mailboxes. With this plugin you
+ can share your Maildir++ mailbox with other mailers or IMAP servers.
+
+
+
+
+ mailMBOX
+
+
+ Handles mailboxes in MBox format.
+
+
+
+
+ Perl
+
+
+ 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.
+
+
+
+
+ S/MIME
+
+
+ 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, ftp://ftp.gnupg.org/gcrypt/gpgme/.
+
+
+
+
+ SynCE
+
+
+ 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.
+
+
+
+
+ vCalendar
+
+
+ Enables vCalendar message handling like that produced by Evolution or
+ Outlook, and Webcal subscriptions.
+
+
+
+
+ RSSyl
+
+
+ Allows you to read your favorite newsfeeds in Claws. RSS 1.0, 2.0 and
+ Atom feeds are currently supported.
+
+
+
- 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 the IRC channel, #sylpheed on IRCnet.
+ 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.
+
+
+
+ Network access from the plugins
+
+ 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,
+ http_proxy. For example,
+http_proxy=http://user:passwd@myproxy.example.com:8080
+ will tell libCurl to connect to port 8080 of the machine
+ myproxy.example.com, with the user user
and password
+ passwd
to connect to the Internet.
+
+ You can either set this variable before starting Sylpheed-Claws, by
+ using for example
+ http_proxy=http://user:passwd@myproxy.example.com:8080
+ sylpheed-claws, or set it in your
+ ~/.bashrc file (or your shell equivalent), by
+ adding the following lineOther shells may have
+ diferent syntaxes, check your shell's manual page.:
+export http_proxy=http://user:passwd@myproxy.example.com:8080
+ (you'll have to reconnect to have it taken into account).
-
+