.\" Automatically generated by Pod::Man 4.14 (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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 "Mail::Milter::ContextWrapper 3pm"
.TH Mail::Milter::ContextWrapper 3pm "2023-01-22" "perl v5.36.0" "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"
Mail::Milter::ContextWrapper \- Perl extension for wrappering the milter context
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Mail::Milter::ContextWrapper;
\&
\&    my $oldctx = ($ctx from callback);
\&
\&    # in the connect_callback
\&    $oldctx\->setpriv(new Mail::Milter::ContextWrapper($ctx,
\&        { methodname => \e&methodimpl[, ...] }));
\&
\&    # in all callbacks
\&    my $newctx = $ctx\->getpriv();
\&
\&    # in the close_callback
\&    $oldctx\->setpriv(undef);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Mail::Milter::ContextWrapper wraps the milter context with replacement
methods defined by the caller.  This can be used to intercept context
object actions and manipulate them from within a Mail::Milter::Wrapper.
.PP
Because the wrappering must occur on every callback, this implementation
suggests embedding the wrapper inside the private data of the milter
itself.  This works with existing milters by providing separate \*(L"setpriv\*(R"
and \*(L"getpriv\*(R" methods within the wrapper that do not propagate up to the
embedded context object.
.SH "METHODS"
.IX Header "METHODS"
.IP "new(\s-1CTX,\s0 { \s-1NAME\s0 => \e&SUB[, ...] })" 4
.IX Item "new(CTX, { NAME => &SUB[, ...] })"
Creates a Mail::Milter::ContextWrapper object.  This should be called from
the \*(L"connect\*(R" callback and passed back to \f(CW\*(C`setpriv()\*(C'\fR.
.Sp
NAMEs are names of methods to override within the wrapper.  These methods
will be called with the wrapper as first argument (like a normal object
method).
.IP "\fBgetpriv()\fR" 4
.IX Item "getpriv()"
Returns a private data item set by \f(CW\*(C`setpriv()\*(C'\fR.  See Sendmail::Milter
for more information.  This implementation stores the datum in the
wrapper, thus allowing the parent context to store a reference to the
wrapper itself.
.Sp
This method cannot be overridden by the user.
.IP "\fBget_ctx()\fR" 4
.IX Item "get_ctx()"
Returns the parent context object stored within this wrapper.  Typically
used by method overrides to defer back to the real method.
.Sp
This method cannot be overridden by the user.
.IP "get_key(\s-1NAME\s0)" 4
.IX Item "get_key(NAME)"
Get a keyed data item separate from the \f(CW\*(C`getpriv\*(C'\fR private data.  This
provides out-of-band data storage that need not clobber the single \*(L"priv\*(R"
data item used by most milters.
.IP "\fBgetpriv()\fR" 4
.IX Item "getpriv()"
Sets a private data item to be returned by \f(CW\*(C`getpriv()\*(C'\fR.  See
Sendmail::Milter for more information.  This implementation stores the
datum in the wrapper, thus allowing the parent context to store a
reference to the wrapper itself.
.Sp
This method cannot be overridden by the user.
.IP "set_key(\s-1NAME, VALUE\s0)" 4
.IX Item "set_key(NAME, VALUE)"
.PD 0
.IP "set_key(\s-1NAME\s0 => \s-1VALUE\s0)" 4
.IX Item "set_key(NAME => VALUE)"
.PD
Set a keyed data item separate from the \f(CW\*(C`getpriv\*(C'\fR private data.  This
provides out-of-band data storage that need not clobber the single \*(L"priv\*(R"
data item used by most milters.
.SH "AUTHOR"
.IX Header "AUTHOR"
Todd Vierling, <tv@duh.org> <tv@pobox.com>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Mail::Milter, Sendmail::Milter