Code

Merge branch 'collectd-3.11' into collectd-4.0
[collectd.git] / src / collectd-email.pod
1 =head1 NAME
3 collectd-email - Documentation of collectd's C<email plugin>
5 =head1 SYNOPSIS
7   # See collectd.conf(5)
8   LoadPlugin email
9   # ...
10   <Plugin email>
11     SocketGroup "collectd"
12     SocketPerms "0770"
13     MaxConns 5
14   </Plugin>
16 =head1 DESCRIPTION
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.
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.
26 =head1 OPERATION
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:
32 =over 4
34 =item
36 E-Mail type (e.g. "ham", "spam", "virus", ...) and size (bytes):
38   e:<type>:<size>
40 If C<size> is less than or equal to zero, C<size> is ignored.
42 =item
44 Spam score:
46   s:<value>
48 =item
50 Successful spam checks (e.g. "BAYES_99", "SUBJECT_DRUG_GAP_C", ...):
52   c:<type1>[,<type2>,...]
54 Each line is limited to 256 characters (including the newline character). 
55 Longer lines will be ignored.
57 =back
59 =head1 SEE ALSO
61 L<collectd(1)>,
62 L<collectd.conf(5)>
64 =head1 AUTHOR
66 The C<email plugin> has been written by Sebastian Harl E<lt>shE<nbsp>atE<nbsp>tokkee.orgE<gt>.
68 The SpamAssassin-plugin has been written by Alexander Wirt E<lt>formorerE<nbsp>atE<nbsp>formorer.deE<gt>.
70 This manpage has been written by Florian Forster E<lt>octoE<nbsp>atE<nbsp>verplant.orgE<gt>.
72 =cut