#!/usr/bin/procmail
#
# NAME
#     spamfilterttest - Test the contents of a message which has been
#			processed by spamfilter.
# 
# SYNOPSIS
#     spamfiltertest <message
# 
# DESCRIPTION
#     Spamfiltertest is used to determine why a message was treated by
#     spamfilter the way it was treated. It writes the result of the
#     tests usually done by spamfilter to the stdout.
#
# VERSION
#     2.0 (12 April 2006)
#  
# AUTHOR
#     Frits Wiarda, e-mail fwiarda(at)fwiarda.com
#
# SEE ALSO
#     spamfilter, spamassassin, procmail
#
# NOTES
#     This script has been tested with Red Hat Linux 8.0 with
#     spamassassin updated to revision 3.0.1. Note that for other 
#     systems it can be necessary to modify line 1, containing
#     a reference to procmail. The set variables section below should 
#     be checked as well.
#
#     Debugging can be done by adding LOGFILE=filename and VERBOSE=on 
#     to the command line.
#

######################################################################
#
# Set variables.
#
######################################################################

FORMAIL="/usr/bin/formail"
TEST="/usr/bin/test"
SPAM_HEADER="^X-Spam-Flag: YES"
BYPASS_KEYWORD="NOSPAM"

######################################################################
#
# Perform tests. Store test results in variable RESULT1 to RESULT10.
#
######################################################################

:0 
{ RESULT1="Sender: "`${FORMAIL} -zx "From:" -zx "Reply-To:"` }

RESULT2="No spamassassin spam tag present in header"  
:0
* $ ${SPAM_HEADER}
{ RESULT2="Spamassassin spam tag present in header"  }

RESULT3="No keyword \"${BYPASS_KEYWORD}\" in subject field" 
:0 
* $ ^Subject: ${BYPASS_KEYWORD}
{ RESULT3="Keyword \"${BYPASS_KEYWORD}\" in subject field" }

RESULT4="No header \"X-Spamfilter-Bypass: ${BYPASS_KEYWORD}\" present" 
:0 
* $ ^X-Spamfilter-Bypass: ${BYPASS_KEYWORD}
{ RESULT4="Header \"X-Spamfilter-Bypass: ${BYPASS_KEYWORD}\" present" }

RESULT5="No header \"Auto-Submitted:\" present (or header \"Auto-Submitted: no\" present)" 
:0
* ^Auto-Submitted:
* ! ^Auto-Submitted: no
{ RESULT5="Header \"Auto-Submitted:\" present (not being header \"Auto-Submitted: no\")" }

RESULT6="No header \"Precedence: junk\" present and no header \"Precedence: bulk\" present" 
:0 
* ^Precedence: bulk
{ RESULT6="Header \"Precedence: bulk\" present" }

:0 
* ^Precedence: junk
{ RESULT6="Header \"Precedence: junk\" present" }

######################################################################
#
# Pipe which eats the message and replaces it with the result log.
# The pipe exits prematurely since it does not read form stdin.
# The i flag indicates this must be ignored.
#
######################################################################

:0fi
| (echo "${RESULT1}"; echo "${RESULT2}"; echo "${RESULT3}"; \
    echo "${RESULT4}"; echo "${RESULT5}"; echo "${RESULT6}"; \
    echo "")

######################################################################
#
# Result log is writen to stdout.
#
######################################################################

:0 
|

######################################################################
#
# In case stdout cannot be writen, the result is written to /dev/null.
# This is done to prevent it from being written to a mailbox.
#
######################################################################

:0
/dev/null