manual/plugins.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <section id="ch_plugins">
   3 <title>Extending Claws Mail</title>
   4
   5   <section id="plugins_default">
   6     <title>Plugins</title>
   7     <para>
   8         Claws Mail's capabilities are extended by plugins, which are
   9         listed below.
  10     </para><para>
  11         Plugins are installed in <filename class="directory"
  12         >$PREFIX/lib/claws-mail/plugins/</filename> and have a suffix of
  13         <quote>.so</quote>. To load a plugin go to
  14         <quote>Configuration/Plugins</quote> and click the
  15         <quote>Load Plugin</quote> button. Select the plugin that you want and
  16         click <quote>Open</quote> button.
  17     </para><para>
  18         If you don't find the plugin you're looking for, it is possible that
  19         your Operating System distribution provides it in a separate package.
  20         In this case, search for the plugin in your package manager.
  21     </para><para>
  22         Some plugins provide the same functionality as others, (for example, the
  23         3 anti-Spam plugins). In this case you will have to choose which
  24         one to load, as Claws Mail will refuse to load more than one of
  25         the same type.
  26     </para>
  27     <para>
  28         There is a list of all plugins available at <ulink
  29         url="http://www.claws-mail.org/plugins.php"
  30         >http://www.claws-mail.org/plugins.php</ulink>.
  31     </para>
  32     <variablelist>
  33       <varlistentry>
  34         <term>ACPI Notifier</term>
  35         <listitem>
  36           <para>
  37         Enables new mail notification via the LEDs found on some laptops like
  38         Acer, Asus, Fujitsu and IBM laptops.
  39         More information: <ulink
  40         url="http://www.claws-mail.org/plugin.php?plugin=acpinotifier"
  41         >www.claws-mail.org/plugin.php?plugin=acpinotifier</ulink>
  42           </para>
  43         </listitem>
  44       </varlistentry>
  45       <varlistentry>
  46         <term>AddressKeeper</term>
  47         <listitem>
  48           <para>
  49         Saves all unknown recipient addresses (<quote>To</quote>,
  50         <quote>Cc</quote> and/or <quote>Bcc</quote>) to a designated
  51         addressbook folder.
  52           </para>
  53         </listitem>
  54       </varlistentry>
  55       <varlistentry>
  56         <term>AttachWarner</term>
  57         <listitem>
  58           <para>
  59         Reminds you about possibly forgotten attachments. Checks for common
  60         expressions found when attaching a file and warns you if no attachment
  61         was added to the mail you're sending.
  62         More information: <ulink
  63         url="http://www.claws-mail.org/plugin.php?plugin=attachwarner"
  64         >www.claws-mail.org/plugin.php?plugin=attachwarner</ulink>
  65           </para>
  66         </listitem>
  67       </varlistentry>
  68       <varlistentry>
  69         <term>AttRemover</term>
  70         <listitem>
  71           <para>
  72         Allows you to remove attachments from emails.
  73           </para>
  74         </listitem>
  75       </varlistentry>
  76       <varlistentry>
  77         <term>Bogofilter</term>
  78         <listitem>
  79           <para>
  80         The Bogofilter plugin comes with two major features:
  81           </para><para>
  82         The ability to scan incoming mail received from a POP, IMAP or LOCAL
  83         account using Bogofilter. It can optionally delete mail identified
  84         as spam or save it to a designated folder. Mail scanning can be turned
  85         off.
  86           </para><para>
  87         The ability for users to teach Bogofilter to recognise spam or ham.
  88         You can train Bogofilter by marking messages as spam or ham from the
  89         Message List contextual menu, or using the relevant toolbar button in
  90         the main window or the message window (see
  91         <quote>Configuration/Preferences/Toolbars</quote>). Messages
  92         marked as spam are optionally saved to a designated folder.
  93           </para><para>
  94         Plugin preferences can be found in
  95         <quote>Configuration/Preferences/Plugins/Bogofilter</quote>.
  96           </para><para>
  97         Bogofilter's advantage over Spamassassin is its speed.
  98           </para><para>
  99         Bogofilter is available from <ulink
 100         url="http://bogofilter.sourceforge.net/"
 101         >http://bogofilter.sourceforge.net/</ulink>.
 102           </para>
 103         </listitem>
 104       </varlistentry>
 105       <varlistentry>
 106         <term>BSFilter</term>
 107         <listitem>
 108           <para>
 109         BSFilter is a plugin that is very similar to the Bogofilter plugin
 110         but uses the bsfilter (<ulink url="http://bsfilter.org/index-e.html"
 111         >bsfilter.org/index-e.html</ulink>) bayesian spam filter as a backend.
 112           </para><para>
 113         Like Bogofilter, you have to train it with spam and ham
 114         messages in order for bsfilter to start recognising spam.
 115           </para><para>
 116         Plugin preferences can be found in
 117         <quote>Configuration/Preferences/Plugins/BSFilter</quote>.
 118           </para>
 119         </listitem>
 120       </varlistentry>
 121       <varlistentry>
 122         <term>Clamd</term>
 123         <listitem>
 124           <para>
 125         Allows scanning all messages received from IMAP, POP or local accounts
 126         using the clam daemon part of the ClamAV (AntiVirus) software (<ulink
 127         url="http://www.clamav.net/">http://www.clamav.net/</ulink>).
 128           </para>
 129         </listitem>
 130       </varlistentry>
 131       <varlistentry>
 132         <term>Fancy</term>
 133         <listitem>
 134           <para>
 135         Enables the display of HTML messages using the GTK+ port of the
 136         WebKit library.
 137           </para>
 138         </listitem>
 139       </varlistentry>
 140       <varlistentry>
 141         <term>Fetchinfo</term>
 142         <listitem>
 143           <para>
 144         Inserts headers containing some download information, like UIDL,
 145         Claws Mail' account name, POP server, user ID and retrieval time.
 146           </para>
 147         </listitem>
 148       </varlistentry>
 149       <varlistentry>
 150         <term>GData</term>
 151         <listitem>
 152           <para>
 153         Provides an interface to Google services using the gdata library.
 154         Currently, the only implemented functionality is to include Google
 155         Contacts in the Tab-address completion.
 156           </para>
 157         </listitem>
 158       </varlistentry>
 159       <varlistentry>
 160         <term>GeoLocation</term>
 161         <listitem>
 162           <para>
 163         Provides geolocation functionality based on the addresses contained
 164         in the messages.
 165           </para>
 166         </listitem>
 167       </varlistentry>
 168       <varlistentry>
 169         <term>Libravatar</term>
 170         <listitem>
 171           <para>
 172         Enables displaying avatar images associated to user profiles in
 173         libravatar.org or user's avatar enabled domains.
 174         More information: <ulink
 175         url="http://www.claws-mail.org/plugin.php?plugin=libravatar"
 176         >www.claws-mail.org/plugin.php?plugin=libravatar</ulink>
 177           </para>
 178         </listitem>
 179       </varlistentry>
 180       <varlistentry>
 181         <term>Mail Archiver</term>
 182         <listitem>
 183           <para>
 184         Enables folders and subfolders to be archived in several different
 185         formats.
 186           </para>
 187         </listitem>
 188       </varlistentry>
 189       <varlistentry>
 190         <term>mailMBOX</term>
 191         <listitem>
 192           <para>
 193         Handles mailboxes in MBox format.
 194           </para>
 195         </listitem>
 196       </varlistentry>
 197       <varlistentry>
 198         <term>NewMail</term>
 199         <listitem>
 200           <para>
 201         Writes a msg header summary to a log file, (Default:
 202         <filename>~/Mail/NewLog</filename>), on arrival of new mail
 203         <emphasis>after</emphasis> sorting.
 204           </para>
 205         </listitem>
 206       </varlistentry>
 207       <varlistentry>
 208         <term>Notification</term>
 209         <listitem>
 210           <para>
 211         Provides various ways to notify the user of new and unread email.
 212         More information: <ulink
 213         url="http://www.claws-mail.org/plugin.php?plugin=notification"
 214         >www.claws-mail.org/plugin.php?plugin=notification</ulink>
 215           </para>
 216         </listitem>
 217       </varlistentry>
 218       <varlistentry>
 219         <term>PDF Viewer</term>
 220         <listitem>
 221           <para>
 222         Allows rendering of PDF and PostScript attachments using the Poppler
 223         library and GhostScript external program.
 224         More information: <ulink
 225         url="http://www.claws-mail.org/plugin.php?plugin=pdf_viewer"
 226         >www.claws-mail.org/plugin.php?plugin=pdf_viewer</ulink>
 227           </para>
 228         </listitem>
 229       </varlistentry>
 230       <varlistentry>
 231         <term>Perl</term>
 232         <listitem>
 233           <para>
 234         Intended to extend the filtering possibilities of Claws Mail. It
 235         provides a Perl interface to Claws Mail' filtering mechanism,
 236         allowing the use of full Perl power in email filters.
 237           </para>
 238         </listitem>
 239       </varlistentry>
 240       <varlistentry>
 241         <term>PGP/Core, PGP/Inline and PGP/MIME</term>
 242         <listitem>
 243           <para>
 244         Handles PGP signed and/or encrypted mails. You can decrypt mails,
 245         verify signatures or sign and encrypt your own mails. Uses GnuPG/GPGME,
 246         <ulink url="ftp://ftp.gnupg.org/gcrypt/gpgme/"
 247         >ftp://ftp.gnupg.org/gcrypt/gpgme/</ulink>.
 248         More information: <ulink
 249         url="http://www.claws-mail.org/plugin.php?plugin=gpg"
 250         >www.claws-mail.org/plugin.php?plugin=gpg</ulink>
 251           </para>
 252         </listitem>
 253       </varlistentry>
 254       <varlistentry>
 255         <term>Python</term>
 256         <listitem>
 257           <para>
 258         This plugin provides Python integration features.
 259         More information: <ulink
 260         url="http://www.claws-mail.org/plugin.php?plugin=python"
 261         >www.claws-mail.org/plugin.php?plugin=python</ulink>
 262           </para>
 263         </listitem>
 264       </varlistentry>
 265       <varlistentry>
 266         <term>RSSyl</term>
 267         <listitem>
 268           <para>
 269         Allows you to read your favorite newsfeeds in Claws. RSS 1.0, 2.0 and
 270         Atom feeds are currently supported.
 271         More information: <ulink
 272         url="http://www.claws-mail.org/plugin.php?plugin=rssyl"
 273         >www.claws-mail.org/plugin.php?plugin=rssyl</ulink>
 274           </para>
 275         </listitem>
 276       </varlistentry>
 277       <varlistentry>
 278         <term>S/MIME</term>
 279         <listitem>
 280           <para>
 281         Handles S/MIME signed and/or encrypted mails. You can decrypt mails,
 282         verify signatures or sign and encrypt your own mails. Uses GnuPG/GPGME
 283         and GpgSM, <ulink url="ftp://ftp.gnupg.org/gcrypt/gpgme/"
 284         >ftp://ftp.gnupg.org/gcrypt/gpgme/</ulink>.
 285           </para>
 286         </listitem>
 287       </varlistentry>
 288       <varlistentry>
 289         <term>SpamAssassin</term>
 290         <listitem>
 291           <para>
 292         The SpamAssassin plugin comes with two major features:
 293           </para><para>
 294         The ability to scan incoming mail received from a POP, IMAP or LOCAL
 295         account using SpamAssassin. It can optionally delete mail identified
 296         as spam or save it to a designated folder. Mail scanning can be turned
 297         off, which is useful if your email is scanned on your server.
 298           </para><para>
 299         The ability for users to teach SpamAssassin to recognise spam or ham.
 300         You can train SpamAssassin by marking messages as spam or ham from the
 301         Message List contextual menu, or using the relevant toolbar button in
 302         the main window or the message window (see
 303         <quote>Configuration/Preferences/Toolbars</quote>). Messages
 304         marked as spam are optionally saved to a designated folder.
 305           </para><para>
 306         Plugin preferences can be found in
 307         <quote>Configuration/Preferences/Plugins/SpamAssassin</quote>.
 308           </para><para>
 309         SpamAssassin's advantage over Bogofilter is that it's not only a
 310         bayesian filter, but it also performs various local and network tests
 311         to determine spaminess.
 312           </para><para>
 313         SpamAssassin is available from <ulink
 314         url="http://spamassassin.apache.org/"
 315         >http://spamassassin.apache.org/</ulink>. Version 3.1.x or higher is
 316         required to use the learning feature in TCP mode.
 317           </para>
 318         </listitem>
 319       </varlistentry>
 320       <varlistentry>
 321         <term>SpamReport</term>
 322         <listitem>
 323           <para>
 324         This plugin reports spam to various places.
 325         Currently the sites <ulink url="http://spam-signal.fr"
 326         >spam-signal.fr</ulink> and <ulink url="http://spamcop.net"
 327         >spamcop.net</ulink> are supported, and the <ulink
 328         url="http://lists.debian.org">Debian lists (lists.debian.org)</ulink>
 329         spam nomination system.
 330           </para>
 331         </listitem>
 332       </varlistentry>
 333       <varlistentry>
 334         <term>TNEF parse</term>
 335         <listitem>
 336           <para>
 337         This plugin enables reading <literal>application/ms-tnef attachments</literal>.
 338         More information: <ulink
 339         url="http://www.claws-mail.org/plugin.php?plugin=tnef_parser"
 340         >www.claws-mail.org/plugin.php?plugin=tnef_parser</ulink>
 341           </para>
 342         </listitem>
 343       </varlistentry>
 344       <varlistentry>
 345         <term>vCalendar</term>
 346         <listitem>
 347           <para>
 348         Enables vCalendar message handling like that produced by Evolution or
 349         Outlook, and Webcal subscriptions.
 350         More information: <ulink
 351         url="http://www.claws-mail.org/plugin.php?plugin=vcalendar"
 352         >www.claws-mail.org/plugin.php?plugin=vcalendar</ulink>
 353           </para>
 354         </listitem>
 355       </varlistentry>
 356     </variablelist>
 357     <para>
 358         If you're a developer, writing a plugin to extend Claws Mail's
 359         capabilities is probably the best and easiest solution. We will
 360         provide hosting to your code, and will be glad to answer your questions
 361         in the mailing-list or on the IRC channels,
 362         <literal>#claws</literal> on Freenode or IRCnet.
 363     </para>
 364   </section>
 365
 366   <section id="plugins_network">
 367     <title>Network access from the plugins</title>
 368     <para>
 369         Some of the external plugins, for example RSSyl, vCalendar, Libravatar
 370         or Fancy, need Internet access for their operations (retrieving feeds in
 371         the case of RSSyl or vCalendar, and fetching images in the case of
 372         Libravatar or Fancy). These plugins use the Curl library. Hence, if your
 373         Internet access is restricted by a proxy, you will need to tell libCurl
 374         to use this proxy. This is done by setting an environment variable,
 375         <literal>http_proxy</literal>. For example, <literal
 376         >http_proxy=http://user:passwd@myproxy.example.com:8080</literal>
 377         will tell libCurl to connect to port 8080 of the machine
 378         myproxy.example.com, with the user <quote>user</quote> and password
 379         <quote>passwd</quote> to connect to the Internet.
 380     </para><para>
 381         You can either set this variable before starting Claws Mail, by
 382         using for example
 383         <command>http_proxy=http://user:passwd@myproxy.example.com:8080
 384         claws-mail</command>, or set it in your
 385         <filename>~/.bashrc</filename> file (or your shell equivalent), by
 386         adding the following line<footnote><para>Other shells may have
 387         diferent syntaxes, check your shell's manual page.</para></footnote>:
 388         <command
 389         >export http_proxy=http://user:passwd@myproxy.example.com:8080</command>
 390         (you'll have to reconnect to have it taken into account).
 391     </para>
 392   </section>
 393
 394 </section>
 395