.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "COLLECTD-EMAIL 5"
.TH COLLECTD-EMAIL 5 2024-04-19 5.12.0.git collectd
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
collectd\-email \- Documentation of collectd's "email plugin"
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 8
\&  # See collectd.conf(5)
\&  LoadPlugin email
\&  # ...
\&  <Plugin email>
\&    SocketGroup "collectd"
\&    SocketPerms "0770"
\&    MaxConns 5
\&  </Plugin>
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The \f(CW\*(C`email plugin\*(C'\fR opens an UNIX-socket over which one can submit email
statistics, such as the number of "ham", "spam", "virus", etc. mails
received/handled, spam scores and matched spam checks.
.PP
This plugin is intended to be used with the
Mail::SpamAssassin::Plugin::Collectd SpamAssassin-plugin which is included
in \fIcontrib/\fR, but is of course not limited to that use.
.SH OPERATION
.IX Header "OPERATION"
This plugin collects data indirectly by providing a UNIX-socket that external
programs can connect to. A simple line based protocol is used to communicate
with the plugin:
.IP \(bu 4
E\-Mail type (e.g. "ham", "spam", "virus", ...) and size (bytes):
.Sp
.Vb 1
\&  e:<type>:<size>
.Ve
.Sp
If \f(CW\*(C`size\*(C'\fR is less than or equal to zero, \f(CW\*(C`size\*(C'\fR is ignored.
.IP \(bu 4
Spam score:
.Sp
.Vb 1
\&  s:<value>
.Ve
.IP \(bu 4
Successful spam checks (e.g. "BAYES_99", "SUBJECT_DRUG_GAP_C", ...):
.Sp
.Vb 1
\&  c:<type1>[,<type2>,...]
.Ve
.Sp
Each line is limited to 256 characters (including the newline character). 
Longer lines will be ignored.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBcollectd\fR\|(1),
\&\fBcollectd.conf\fR\|(5)
.SH AUTHOR
.IX Header "AUTHOR"
The \f(CW\*(C`email plugin\*(C'\fR has been written by Sebastian Harl <sh\ at\ tokkee.org>.
.PP
The SpamAssassin-plugin has been written by Alexander Wirt <formorer\ at\ formorer.de>.
.PP
This manpage has been written by Florian Forster <octo\ at\ collectd.org>.