Maildrop Syntax Tutorial - Revision history

Cheeks: /* Important Syntax Note */

2024-05-29T21:46:49Z

Important Syntax Note

← Older revision		Revision as of 15:46, 29 May 2024
Line 24:		Line 24:
	$THISISSPAM = 1		$THISISSPAM = 1
	}		}
			</pre>

	=Variables=		=Variables=

Cheeks: /* Getting Started */

2024-05-29T21:46:34Z

Getting Started

← Older revision		Revision as of 15:46, 29 May 2024
Line 9:		Line 9:

	# SWCP:MAILFILTER:NNNNN Version n.n.n		# SWCP:MAILFILTER:NNNNN Version n.n.n

			===Important Syntax Note===
			For the most part the .mailfilter syntax is pretty standard-looking code with arbitrary white space between elements. The one big exception to this is the opening brace on an "if" statement. It MUST be on a line by itself, not at the end of the line with the "if" on it. For example:

			<pre>
			BAD (will produce mail delivery errors):
			if (/strange ach offer/:b) {
			$THISISSPAM = 1
			}

			GOOD:
			if (/strange ach offer/:b)
			{
			$THISISSPAM = 1
			}

	=Variables=		=Variables=

Cheeks: /* Filter Then Forward */

2014-03-08T22:48:29Z

Filter Then Forward

← Older revision		Revision as of 16:48, 8 March 2014
Line 161:		Line 161:
	}		}

			=Modify The Message=
			You can use the "xfilter" command to modify the message "in place" before delivery. For example, if you wanted to tag the subject line of any message from your friend Bubbba, you could use this:
			<pre>
			# Flag messages from Bubba in the subject
			if (/^From:.*bubba@bubbaville.com/)
			{
			xfilter "sed -e 's/^Subject: /Subject: [FROM BUBBA] /'"
			}
			</pre>

	=Testing your new filter rules=		=Testing your new filter rules=

Cheeks: /* A Better Version */

2014-03-08T22:46:32Z

A Better Version

← Older revision		Revision as of 16:46, 8 March 2014
Line 99:		Line 99:
	}		}

	==A ~~Better~~ Version==		==A More Complicated Version==
	This version matches the words opt-in, opt in, opt-out, opt out in the body but constrains the message size to less than 500 lines and less than 15 kilobytes.		This version matches the words opt-in, opt in, opt-out, opt out in the body but constrains the message size to less than 500 lines and less than 15 kilobytes.

Cheeks: /* Getting Started */

2013-04-15T23:44:50Z

Getting Started

← Older revision		Revision as of 17:44, 15 April 2013
Line 6:		Line 6:

	==Getting Started==		==Getting Started==
	If you wish to manually edit your .mailfilter, first log into https://~~kumo~~.swcp.com/~~spam~~ and set the option "Filtering" to No. Wait 15 minutes. You should have a new file called .mailfilter.swcp. From this point you can hand edit the file then rename it to .mailfilter. To keep SWCP or the web interface from mistakenly overwriting your .mailfilter file, be sure to remove the very top line:		If you wish to manually edit your .mailfilter, first log into https://members.swcp.com/mailfilter and set the option "Filtering" to No. Wait 5 minutes or so. You should have a new file called .mailfilter.swcp. From this point you can hand edit the file then rename it to .mailfilter. To keep SWCP or the web interface from mistakenly overwriting your .mailfilter file, be sure to remove the very top line, which will look something like this:

	# SWCP:MAILFILTER:~~neal~~		# SWCP:MAILFILTER:NNNNN Version n.n.n

	=Variables=		=Variables=

Cheeks: /* An Introduction to Maildrop filtering syntax */

2009-01-26T17:36:45Z

An Introduction to Maildrop filtering syntax

← Older revision		Revision as of 11:36, 26 January 2009
Line 3:		Line 3:
	SWCP uses Maildrop to handle its anti-spam filtering. However, Maildrop also allows for a lot of other types of filtering, most of which require manually editing .mailfilter files (and reading your email on the server via TWIG, pine, mutt, etc.). This tutorial covers the basics of manually editing a .mailfilter for an assortment of uses.		SWCP uses Maildrop to handle its anti-spam filtering. However, Maildrop also allows for a lot of other types of filtering, most of which require manually editing .mailfilter files (and reading your email on the server via TWIG, pine, mutt, etc.). This tutorial covers the basics of manually editing a .mailfilter for an assortment of uses.

	Additionally, SWCP provides a web interface for our end users to create a user's .mailfilter file, and most of our users use the web interface to do so. '''Manual editing is incompatible with web interface editing'''.		Additionally, SWCP provides a web interface for our end users to create a user's .mailfilter file, and most of our users use the web interface to do so. '''Manual editing is incompatible with web interface editing'''. There's a "magic cookie" at the top of the .mailfilter file generated by the web interface. You need to remove that string to keep the web interface from overwriting your changes. Also note that after you remove the magic cookie, changes to the web interface settings will NOT be propagated to your .mailfilter file.

	==Getting Started==		==Getting Started==
	If you wish to manually edit your .mailfilter, first log into https://kumo.swcp.com/spam and set the option "Filtering" to No. Wait 15 minutes. You should have a new file called .mailfilter.swcp. From this point you can hand edit the file then rename it to .mailfilter. To keep SWCP or the web interface from mistakenly overwriting your .mailfilter file, be sure to remove the very top line:		If you wish to manually edit your .mailfilter, first log into https://kumo.swcp.com/spam and set the option "Filtering" to No. Wait 15 minutes. You should have a new file called .mailfilter.swcp. From this point you can hand edit the file then rename it to .mailfilter. To keep SWCP or the web interface from mistakenly overwriting your .mailfilter file, be sure to remove the very top line:

	# SWCP:MAILFILTER:neal		# SWCP:MAILFILTER:neal

	=Variables=		=Variables=

Cheeks: /* A real example */

2009-01-26T17:34:06Z

A real example

← Older revision		Revision as of 11:34, 26 January 2009
Line 175:		Line 175:

	=A real example=		=A real example=
			<pre>
	MAILDIR="/users/$LOGNAME/mail"		MAILDIR="/users/$LOGNAME/mail"
	DEFAULT="/var/mail/$LOGNAME"		DEFAULT="/var/mail/$LOGNAME"
	SPAMCAN="/users/$LOGNAME/mail/SPAM"		SPAMCAN="/users/$LOGNAME/mail/SPAM"
	logfile "/users/$LOGNAME/maildrop_log"		logfile "/users/$LOGNAME/maildrop_log"
	#		#
	if(/^Subject: !.$/)		if(/^Subject: !.$/)
	{		{
	if($MATCH2 =~ /Dialup Session Report/)		if($MATCH2 =~ /Dialup Session Report/)
	{		{
Line 198:		Line 198:
	to "$MAILDIR/domreg"		to "$MAILDIR/domreg"
	}		}
	}		}
	# end of Subject exceptions		# end of Subject exceptions
	#		#
	# begin To/Cc exceptions		# begin To/Cc exceptions
	foreach /^(To\|Cc): !.$/		foreach /^(To\|Cc): !.$/
	{		{
	if($MATCH =~ /ilikespam@/)		if($MATCH =~ /ilikespam@/)
	{		{
Line 219:		Line 219:
	to "$MAILDIR/puppy"		to "$MAILDIR/puppy"
	}		}
	}		}
	# end of To and Cc exceptions		# end of To and Cc exceptions
	#		#
	# beginning of From exceptions		# beginning of From exceptions
	if(/^From:!.$/)		if(/^From:!.$/)
	{		{

	if($MATCH2 =~ /joejoe@uswest.com/)		if($MATCH2 =~ /joejoe@uswest.com/)
	{		{
Line 246:		Line 245:
	to "$DEFAULT"		to "$DEFAULT"
	}		}
	}		}
	# asdf end of From: exceptions		# asdf end of From: exceptions
	#		#
	log "Ptrn: final match"		log "Ptrn: final match"
	to "$SPAMCAN"		to "$SPAMCAN"
			</pre>

	----		----

	''~~The bulk of this document was written by~~ [mailto:~~jamesh~~@swcp.com ~~James Hamilton~~].		''If you have questions, please email the [mailto:help@swcp.com SWCP Helpdesk].

Cheeks: /* Shameless plug */

2009-01-26T17:32:25Z

Shameless plug

← Older revision		Revision as of 11:32, 26 January 2009
Line 172:		Line 172:
	'''You'll probably want to log into a host other than your mailserver.''' If your system has a systemwide maildroprc you'll see all the debug from that too. That's probably not what you want :-)		'''You'll probably want to log into a host other than your mailserver.''' If your system has a systemwide maildroprc you'll see all the debug from that too. That's probably not what you want :-)

	~~==Shameless plug==~~

	~~http://www.dillivision.com/felix - use my cat to help you manage your email.~~

	=A real example=		=A real example=

Cheeks: /* Looping with Foreach */

2009-01-26T17:31:49Z

Looping with Foreach

← Older revision		Revision as of 11:31, 26 January 2009
Line 130:		Line 130:
	=Looping with Foreach=		=Looping with Foreach=
	If you wish to match to & cc in the same statement you must use a foreach		If you wish to match to & cc in the same statement you must use a foreach
			<pre>
	foreach /^(To\|Cc): !.$/		foreach /^(To\|Cc): !.$/
	{		{
	if ( $MATCH =~ /@netris.com/)		if ( $MATCH =~ /@netris.com/)
	{		{
Line 142:		Line 142:
	to "$SPAMCAN"		to "$SPAMCAN"
	}		}
	}		}
			</pre>

	=Dropping a message entirely=		=Dropping a message entirely=

Cheeks: /* Using Matching */

2009-01-26T17:31:33Z

Using Matching

← Older revision		Revision as of 11:31, 26 January 2009
Line 113:		Line 113:

	'''Note''': It should be noted that maildrop has (what I consider to be) a documented bug. Different types of matches cause different MATCH variables to be used. In particular if statements using this match syntax dump their variable contents into MATCH2, foreach matches dump their match contents into a variable called MATCH, see below.		'''Note''': It should be noted that maildrop has (what I consider to be) a documented bug. Different types of matches cause different MATCH variables to be used. In particular if statements using this match syntax dump their variable contents into MATCH2, foreach matches dump their match contents into a variable called MATCH, see below.
			<pre>
	if (/^Subject: !.$/)		if (/^Subject: !.$/)
	{		{

	if ($MATCH2 =~ /Updates from the hospital about (mom\|dad\|brother)/ )		if ($MATCH2 =~ /Updates from the hospital about (mom\|dad\|brother)/ )
	{		{
Line 126:		Line 125:
	to "$SPAMCAN"		to "$SPAMCAN"
	}		}
			}
	}		</pre>

	=Looping with Foreach=		=Looping with Foreach=