.\" -*- 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 "Sendmail::Milter 3pm"
.TH Sendmail::Milter 3pm 2024-03-17 "perl v5.38.2" "User Contributed Perl Documentation"
.\" 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
Sendmail::Milter \- compatibility interface for Sendmail::PMilter
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    use Sendmail::Milter;
\&
\&    Sendmail::Milter::auto_setconn(NAME);
\&    Sendmail::Milter::register(NAME, { CALLBACKS }, FLAGS);
\&    Sendmail::Milter::main();
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This is a compatibility interface which emulates the "standard"
Sendmail::Milter API.
.SH FUNCTIONS
.IX Header "FUNCTIONS"
The following functions are available in this module.  Unlike
\&\f(CW\*(C`Sendmail::PMilter\*(C'\fR, this interface involves a single, global instance of
milter data, so these functions are called without an object reference.
.PP
For each function, see the description of its object-based counterpart in
Sendmail::PMilter.
.IP "Sendmail::Milter::auto_getconn(NAME[, CONFIG])" 4
.IX Item "Sendmail::Milter::auto_getconn(NAME[, CONFIG])"
.PD 0
.IP "Sendmail::Milter::auto_setconn(NAME[, CONFIG])" 4
.IX Item "Sendmail::Milter::auto_setconn(NAME[, CONFIG])"
.IP "Sendmail::Milter::main([MAXCHILDREN[, MAXREQ]])" 4
.IX Item "Sendmail::Milter::main([MAXCHILDREN[, MAXREQ]])"
.IP "Sendmail::Milter::register(NAME, CALLBACKS[, FLAGS])" 4
.IX Item "Sendmail::Milter::register(NAME, CALLBACKS[, FLAGS])"
.IP Sendmail::Milter::setconn(DESC) 4
.IX Item "Sendmail::Milter::setconn(DESC)"
.PD
.PP
One extension function is provided by this implementation.
.IP \fBSendmail::Milter::get_milter()\fR 4
.IX Item "Sendmail::Milter::get_milter()"
Returns the \f(CW\*(C`Sendmail::PMilter\*(C'\fR instance underlying this emulation layer.
This allows mostly-unmodified milter scripts to set PMilter extensions
(such as dispatcher and sendmail.cf values).  It is recommended, however,
that new code use the object instance methods described in
Sendmail::PMilter.
.SH EXPORTS
.IX Header "EXPORTS"
In order to preserve compatibility with the standard \f(CW\*(C`Sendmail::Milter\*(C'\fR
interface, all SMFI* constants described in Sendmail::PMilter are
exported into the caller's namespace by default.
.PP
(Note that \f(CW\*(C`Sendmail::PMilter\*(C'\fR itself does not export these symbols
by default.)