1COLLECTD-EMAIL(5)                  collectd                  COLLECTD-EMAIL(5)
2
3
4

NAME

6       collectd-email - Documentation of collectd's "email plugin"
7

SYNOPSIS

9         # See collectd.conf(5)
10         LoadPlugin email
11         # ...
12         <Plugin email>
13           SocketGroup "collectd"
14           SocketPerms "0770"
15           MaxConns 5
16         </Plugin>
17

DESCRIPTION

19       The "email plugin" opens an UNIX-socket over which one can submit email
20       statistics, such as the number of "ham", "spam", "virus", etc. mails
21       received/handled, spam scores and matched spam checks.
22
23       This plugin is intended to be used with the
24       Mail::SpamAssassin::Plugin::Collectd SpamAssassin-plugin which is
25       included in contrib/, but is of course not limited to that use.
26

OPERATION

28       This plugin collects data indirectly by providing a UNIX-socket that
29       external programs can connect to. A simple line based protocol is used
30       to communicate with the plugin:
31
32       ·   E-Mail type (e.g. "ham", "spam", "virus", ...) and size (bytes):
33
34             e:<type>:<size>
35
36           If "size" is less than or equal to zero, "size" is ignored.
37
38       ·   Spam score:
39
40             s:<value>
41
42       ·   Successful spam checks (e.g. "BAYES_99", "SUBJECT_DRUG_GAP_C",
43           ...):
44
45             c:<type1>[,<type2>,...]
46
47           Each line is limited to 256 characters (including the newline
48           character).  Longer lines will be ignored.
49

SEE ALSO

51       collectd(1), collectd.conf(5)
52

AUTHOR

54       The "email plugin" has been written by Sebastian Harl
55       <sh at tokkee.org>.
56
57       The SpamAssassin-plugin has been written by Alexander Wirt
58       <formorer at formorer.de>.
59
60       This manpage has been written by Florian Forster
61       <octo at verplant.org>.
62
63
64
654.9.5                             2011-03-26                 COLLECTD-EMAIL(5)