src/collectd-email.pod

   1 =head1 NAME
   2
   3 collectd-email - Documentation of collectd's C<email plugin>
   4
   5 =head1 SYNOPSIS
   6
   7   # See collectd.conf(5)
   8   LoadPlugin email
   9   # ...
  10   <Plugin email>
  11     SocketGroup "collectd"
  12     SocketPerms "0770"
  13     MaxConns 5
  14   </Plugin>
  15
  16 =head1 DESCRIPTION
  17
  18 The C<email plugin> opens an UNIX-socket over which one can submit email
  19 statistics, such as the number of "ham", "spam", "virus", etc. mails
  20 received/handled, spam scores and matched spam checks.
  21
  22 This plugin is intended to be used with the
  23 L<Mail::SpamAssassin::Plugin::Collectd> SpamAssassin-plugin which is included
  24 in F<contrib/>, but is of course not limited to that use.
  25
  26 =head1 OPERATION
  27
  28 This plugin collects data indirectly by providing a UNIX-socket that external
  29 programs can connect to. A simple line based protocol is used to communicate
  30 with the plugin:
  31
  32 =over 4
  33
  34 =item
  35
  36 E-Mail type (e.g. "ham", "spam", "virus", ...) and size (bytes):
  37
  38   e:<type>:<size>
  39
  40 If C<size> is less than or equal to zero, C<size> is ignored.
  41
  42 =item
  43
  44 Spam score:
  45
  46   s:<value>
  47
  48 =item
  49
  50 Successful spam checks (e.g. "BAYES_99", "SUBJECT_DRUG_GAP_C", ...):
  51
  52   c:<type1>[,<type2>,...]
  53
  54 Each line is limited to 256 characters (including the newline character).
  55 Longer lines will be ignored.
  56
  57 =back
  58
  59 =head1 SEE ALSO
  60
  61 L<collectd(1)>,
  62 L<collectd.conf(5)>
  63
  64 =head1 AUTHOR
  65
  66 The C<email plugin> has been written by Sebastian Harl E<lt>shE<nbsp>atE<nbsp>tokkee.orgE<gt>.
  67
  68 The SpamAssassin-plugin has been written by Alexander Wirt E<lt>formorerE<nbsp>atE<nbsp>formorer.deE<gt>.
  69
  70 This manpage has been written by Florian Forster E<lt>octoE<nbsp>atE<nbsp>verplant.orgE<gt>.
  71
  72 =cut