.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" 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::PhishTag 3"
.TH Mail::SpamAssassin::Plugin::PhishTag 3 2024-09-01 "perl v5.40.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
PhishTag \- SpamAssassin plugin for redirecting links in incoming emails.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& loadplugin     Mail::SpamAssassin::Plugin::PhishTag
\&
\& trigger_ratio    0.1
\& trigger_target   RULE_NAME  http://www.antiphishing.org/consumer_recs.html
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
PhishTag enables administrators to rewrite links in emails that trigger certain
tests, preferably anti-phishing blocklist tests. The plugin will inhibit the
blocking of a portion of the emails that trigger the test by SpamAssassin, and
let them pass to the users' inbox after the rewrite. It is useful in providing
training to email users about company policies and general email usage.
.SH OPTIONS
.IX Header "OPTIONS"
The following options can be set by modifying the configuration file.
.IP \(bu 4
trigger_ratio percentage_value
.Sp
Sets the probability in percentage that a positive test will trigger the 
email rewrite, e.g. 0.1 will rewrite on the average 1 in 1000 emails that 
match the trigger.
.IP \(bu 4
trigger_target RULE_NAME http_url
.Sp
The name of the test which would trigger the email rewrite; all the URLs 
will be replaced by http_url.
.SH DOWNLOAD
.IX Header "DOWNLOAD"
The source of this plugin is available at: 
http://umut.topkara.org/PhishTag/PhishTag.pm
a sample configuration file is also available:
http://umut.topkara.org/PhishTag/PhishTag.cf
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Check the list of tests performed by SpamAssassin to modify the
configuration file to match your needs from 
https://spamassassin.apache.org/tests.html
.SH AUTHOR
.IX Header "AUTHOR"
Umut Topkara, 2008, <umut@topkara.org>
http://umut.topkara.org
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This plugin is free software; you can redistribute it and/or modify
it under the same terms as SpamAssassin itself, either version 3.2.4 
or, at your option, any later version of SpamAssassin you may have 
available.