.\" -*- 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::Plugin::RelayCountry 3"
.TH Mail::SpamAssassin::Plugin::RelayCountry 3 2023-07-26 "perl v5.38.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
RelayCountry \- add message metadata indicating the country code of each relay
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  loadplugin     Mail::SpamAssassin::Plugin::RelayCountry
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The RelayCountry plugin attempts to determine the domain country codes
of each relay used in the delivery path of messages and add that information
to the message metadata.
.PP
Following metadata headers and tags are added:
.PP
.Vb 4
\& X\-Relay\-Countries           _RELAYCOUNTRY_
\&   All untrusted relays. Contains all relays starting from the
\&   trusted_networks border. This method has been used by default since
\&   early SA versions.
\&
\& X\-Relay\-Countries\-External  _RELAYCOUNTRYEXT_
\&   All external relays. Contains all relays starting from the
\&   internal_networks border. Could be useful in some cases when
\&   trusted/msa_networks extend beyond the internal border and those
\&   need to be checked too.
\&
\& X\-Relay\-Countries\-All       _RELAYCOUNTRYALL_
\&   All possible relays (internal + external).
\&
\& X\-Relay\-Countries\-Auth      _RELAYCOUNTRYAUTH_
\&   Auth will contain all relays starting from the first relay that used
\&   authentication. For example, this could be used to check for hacked
\&   local users coming in from unexpected countries. If there are no
\&   authenticated relays, this will be empty.
.Ve
.SH REQUIREMENT
.IX Header "REQUIREMENT"
This plugin uses Mail::SpamAssassin::GeoDB and requires a module supported
by it, for example MaxMind::DB::Reader (GeoIP2).