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