.\" -*- 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 "Mail::SpamAssassin::RegistryBoundaries 3pm"
.TH Mail::SpamAssassin::RegistryBoundaries 3pm 2024-04-02 "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
Mail::SpamAssassin::RegistryBoundaries \- domain delegation rules
.SH METHODS
.IX Header "METHODS"
.ie n .IP "($hostname, $domain) = split_domain ($fqdn, $is_ascii)" 4
.el .IP "($hostname, \f(CW$domain\fR) = split_domain ($fqdn, \f(CW$is_ascii\fR)" 4
.IX Item "($hostname, $domain) = split_domain ($fqdn, $is_ascii)"
Cut a fully-qualified hostname into the hostname part and the domain
part, splitting at the DNS registry boundary.
.Sp
Examples:
.Sp
.Vb 2
\&    "www.foo.com" => ( "www", "foo.com" )
\&    "www.foo.co.uk" => ( "www", "foo.co.uk" )
.Ve
.Sp
If \f(CW$is_ascii\fR given and true, skip \fBidn_to_ascii()\fR conversion
.ie n .IP "$domain = trim_domain($fqdn, $is_ascii)" 4
.el .IP "\f(CW$domain\fR = trim_domain($fqdn, \f(CW$is_ascii\fR)" 4
.IX Item "$domain = trim_domain($fqdn, $is_ascii)"
Cut a fully-qualified hostname into the hostname part and the domain
part, returning just the domain.
.Sp
Examples:
.Sp
.Vb 2
\&    "www.foo.com" => "foo.com"
\&    "www.foo.co.uk" => "foo.co.uk"
.Ve
.Sp
If \f(CW$is_ascii\fR given and true, skip \fBidn_to_ascii()\fR conversion
.ie n .IP "$ok = is_domain_valid($dom, $is_ascii)" 4
.el .IP "\f(CW$ok\fR = is_domain_valid($dom, \f(CW$is_ascii\fR)" 4
.IX Item "$ok = is_domain_valid($dom, $is_ascii)"
Return \f(CW1\fR if the domain/hostname uses valid known TLD, \f(CW\*(C`undef\*(C'\fR otherwise.
.Sp
If \f(CW$is_ascii\fR given and true, skip \fBidn_to_ascii()\fR conversion.
.Sp
Note that this only checks the TLD validity and nothing else.  To verify
that the complete fqdn is in a valid legal format, \fBUtil::is_fqdn_valid()\fR can
additionally be used.