.\" 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::Module::ConnectDNSBL 3pm"
.TH Mail::Milter::Module::ConnectDNSBL 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::Module::ConnectDNSBL \- milter to accept/reject connecting hosts matching DNSBLs
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Mail::Milter::Module::ConnectDNSBL;
\&
\&    my $milter = new Mail::Milter::Module::ConnectDNSBL(\*(Aqfoo.spamlist.dom\*(Aq);
\&
\&    my $milter2 = &ConnectDNSBL(\*(Aqfoo.spamlist.dom\*(Aq); # convenience
\&
\&    $milter2\->set_message(\*(AqConnections from %A disallowed\*(Aq);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This milter module rejects any connecting host whose IPv4 address matches
a given \s-1DNS\s0 Blocking List (\s-1DNSBL\s0).  It can also function as a whitelisting
Chain element; see \f(CW\*(C`accept_match()\*(C'\fR.
.PP
The check used by this module is a simple \*(L"A\*(R" record lookup, via the
standard \*(L"gethostbyname\*(R" lookup mechanism.  This method does not require
the use of Net::DNS and is thus typically very fast.
.PP
(Note:  If the connecting host is not using IPv4, this module will simply
be a passthrough using \s-1SMFIS_CONTINUE.\s0)
.SH "METHODS"
.IX Header "METHODS"
.RS 4
new(\s-1DNSBL\s0)
.Sp
new(\s-1DNSBL,\s0 MATCHRECORD[, ...])
.Sp
new(\s-1DNSBL, SUBREF\s0)
.Sp
Creates a ConnectDNSBL object.  \s-1DNSBL\s0 is the root host hierarchy to use
for lookups.  Three methods of matching can be used:
.Sp
If no additional arguments are provided, the match succeeds if there is
any address entry present for the \s-1DNSBL\s0 lookup; the values are not
examined.
.Sp
If one or more \s-1MATCHRECORD\s0 values are supplied, they are string
representations of IPv4 addresses.  If any of these match record values is
the same as any address record returned by the \s-1DNSBL\s0 lookup, the match
succeeds.
.Sp
If a \s-1SUBREF \s0(reference to a subroutine; may be an anonymous inline
\&\f(CW\*(C`sub{}\*(C'\fR) is supplied, it is called for each of the address records
returned by the \s-1DNSBL\s0 lookup.  The subroutine should return 0 or undef to
indicate a failed match, and nonzero to indicate a successful match.  The
subroutine receives a binary-encoded four byte scalar that should be
transformed as needed with \f(CW\*(C`inet_ntoa()\*(C'\fR or \f(CW\*(C`unpack\*(C'\fR.
.Sp
accept_match(\s-1FLAG\s0)
.Sp
If \s-1FLAG\s0 is 0 (the default), a matching \s-1DNSBL\s0 will cause the connection to
be rejected.
.Sp
If \s-1FLAG\s0 is 1, a matching \s-1DNSBL\s0 will cause this module to return \s-1SMFIS_ACCEPT\s0
instead.  This allows a \f(CW\*(C`ConnectDNSBL\*(C'\fR to be used inside a
\&\f(CW\*(C`Mail::Milter::Chain\*(C'\fR container (in \f(CWaccept_break(1)\fR mode), to function
as a whitelist rather than a blacklist.
.Sp
This method returns a reference to the object itself, allowing this method
call to be chained.
.Sp
ignore_tempfail(\s-1FLAG\s0)
.Sp
If \s-1FLAG\s0 is 0 (the default), a \s-1DNSBL\s0 lookup which fails the underlying \s-1DNS\s0
query will cause the milter to return a temporary failure result
(\s-1SMFIS_TEMPFAIL\s0).
.Sp
If \s-1FLAG\s0 is 1, a temporary \s-1DNS\s0 failure will be treated as if the lookup
resulted in an empty record set (\s-1SMFIS_CONTINUE\s0).
.Sp
This method returns a reference to the object itself, allowing this method
call to be chained.
.Sp
set_message(\s-1MESSAGE\s0)
.Sp
Sets the message used when rejecting connections.  This string may contain
the substring \f(CW%A\fR, which will be replaced by the matching IPv4 address,
or \f(CW%L\fR, which will be replaced by the name of the matching \s-1DNSBL.\s0
.Sp
This method returns a reference to the object itself, allowing this method
call to be chained.
.RE
.SH "BUGS"
.IX Header "BUGS"
In Sendmail 8.11 and 8.12, a milter rejection at \*(L"connect\*(R" stage does not
allow the reply message to be set \*(-- it simply becomes \*(L"not accepting
messages\*(R".  However, this module still attempts to set the reply code and
message in the hope that this will be fixed.
.SH "AUTHOR"
.IX Header "AUTHOR"
Todd Vierling, <tv@duh.org> <tv@pobox.com>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Mail::Milter::Object
.SH "POD ERRORS"
.IX Header "POD ERRORS"
Hey! \fBThe above document had some coding errors, which are explained below:\fR
.IP "Around line 79:" 4
.IX Item "Around line 79:"
You can't have =items (as at line 91) unless the first thing after the =over is an =item