.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" 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 turned on, 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::Wrapper::DecodeSRS 3pm"
.TH Mail::Milter::Wrapper::DecodeSRS 3pm "2016-06-21" "perl v5.22.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"
Mail::Milter::Wrapper::DecodeSRS \- milter wrapper to decode SRS\-encoded return path
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Mail::Milter::Wrapper::DecodeSRS;
\&
\&    my $milter = ...;
\&    my $wrapper = new Mail::Milter::Wrapper::DecodeSRS($milter);
\&
\&    my $wrapper2 = &DecodeSRS($milter); # convenience
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Mail::Milter::Wrapper::DecodeSRS is a convenience milter wrapper which 
decodes \s-1MAIL FROM:\s0 return paths which have been encoded by the Sender 
Rewrite Scheme, \s-1SRS.  \s0(More information:  http://www.libsrs2.org/)
This wrapper internally understands both the \s-1SRS0\s0 and \s-1SRS1\s0 encoding 
schemes documented by the Mail::SRS author.
.PP
The decoded address is made available to the contained milter via the 
\&\f(CW\*(C`envfrom\*(C'\fR callback, in the same way that a raw address would.
.PP
\&\s-1NOTE: \s0 If the address is not \s-1SRS\s0 encoded, the contained milter is \s-1NOT \s0
called for the duration of the message; instead, \s-1SMFIS_ACCEPT\s0 is returned. 
This is because the milter writer is expected to use this wrapper in a 
chain that also includes the contained milter without wrapping, in order 
to prevent a malicious sender from using \s-1SRS\s0 to bypass access checks.
.PP
For instance, the following is a proper usage of this wrapper in a chain:
.PP
.Vb 1
\&    my $envfrommilter = ...;
\&
\&    my $combinedmilter = new Mail::Milter::Chain(
\&        new Mail::Milter::Wrapper::UnwrapSRS($envfrommilter),
\&        $envfrommilter
\&    );
.Ve
.PP
This behavior can also be used if, e.g., the \s-1MTA\s0 already does one form of 
\&\s-1MAIL FROM:\s0 check, and the contained milter repeats that same database 
check against \s-1SRS\s0 rewritten addresses.  (A good example would be a milter 
emulating Sendmail's access_db map.)
.SH "AUTHOR"
.IX Header "AUTHOR"
Todd Vierling, <tv@duh.org> <tv@pobox.com>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Mail::Milter::Wrapper