vpopmail 1.0.1 → 1.0.2

data/README

@@ -35,6 +35,63 @@ rmail subdirectory manually.
 
 To reach the author of ruby-vpopmail, send mail to gildas@breizh.org.
 
+= Examples
+
+== emailcheck
+
+Just run ruby emailcheck email@address.com
+and it will tell you if that email address is valid or not.
+
+See ruby emailcheck --help for help.
+
+== Incorporating emailcheck in maildrop's mailfilter
+
+That's what I did in my own. Since I am not an expert at maildrop yet, I suspect there is a way to make this look nicer.
+
+VCHKMAIL="/usr/bin/ruby /home/vpopmail/bin/emailcheck.rb"
+
+......
+
+# Check if the sender exists
+if ( $ISSPAM == 0)
+{
+    ADDRESS=""
+    if ( /^Reply-To:\s+.*/ )
+    {
+        foreach (getaddr $MATCH) =~ /.+/
+        {
+            ADDRESS="$ADDRESS $MATCH"
+        }
+    }
+    else
+    if ( /^Return-Path:\s+.*/ )
+    {
+        foreach (getaddr $MATCH) =~ /.+/
+        {
+            ADDRESS="$ADDRESS $MATCH"
+        }
+    }
+    else
+    if ( /^From:\s+.*/ )
+    {
+        foreach (getaddr $MATCH) =~ /.+/
+        {
+            ADDRESS="$ADDRESS $MATCH"
+        }
+    }
+
+    if (length($ADDRESS) > 0)
+    {
+        log "   Checking if Sender <$ADDRESS> is valid"
+        `$VCHKMAIL --silent --log -- $ADDRESS`
+        if ( $RETURNCODE == 1 )
+        {
+            log "   Sender <$ADDRESS> does not exist"
+            ISSPAM=1
+        }
+    }
+}
+
 = License
 
 Copyright (c) 2006 Gildas Cherruel

data/examples/emailcheck.rb

@@ -13,11 +13,14 @@ $APPNAME = File::basename(__FILE__, '.rb')
 $log     = nil
 $VERBOSE = true
 $OPTS    = GetoptLong.new(
-		["--domain",  "-d", GetoptLong::REQUIRED_ARGUMENT],
-		["--help",    "-h", GetoptLong::NO_ARGUMENT],
-		["--log",           GetoptLong::OPTIONAL_ARGUMENT],
-		["--silent",  "-s", GetoptLong::NO_ARGUMENT],
-		["--verbose", "-v", GetoptLong::NO_ARGUMENT])
+		["--blacklist",       GetoptLong::REQUIRED_ARGUMENT],
+		["--domain",    "-d", GetoptLong::REQUIRED_ARGUMENT],
+		["--whitelist",       GetoptLong::REQUIRED_ARGUMENT],
+
+		["--help",      "-h", GetoptLong::NO_ARGUMENT],
+		["--log",             GetoptLong::OPTIONAL_ARGUMENT],
+		["--silent",    "-s", GetoptLong::NO_ARGUMENT],
+		["--verbose",   "-v", GetoptLong::NO_ARGUMENT])
 
 #------------------------------------------------------------------------------------------
 # function: Verbose {{{
@@ -65,18 +68,46 @@ def find_postmaster(p_domainname = nil)
 	return "postmaster@#{p_domainname}"
 end # }}}
 
+#------------------------------------------------------------------------------------------
+# function: getlist {{{
+def getlist(p_arg)
+	$log.info "Load list from #{p_arg}" if !$log.nil?
+	if p_arg =~ /^@(.*)/ then
+		$log.debug "list is a filename: #{$1}" if !$log.nil?
+		list = []
+		begin
+			IO.foreach($1) { |line|
+				next if line =~ /^\s*#/
+				next if line =~ /^\s*$/
+				list << line.strip
+				$log.debug "Added to the list: #{line}" if !$log.nil?
+			}
+		rescue Errno::ENOENT
+			Verbose "File: #{$1} does not exist"
+		end
+		return list
+	else
+		return p_arg.split(',')
+	end
+end # }}}
+
 #------------------------------------------------------------------------------------------
 # main {{{
 domainname = nil
 logfile    = nil
+blacklist  = []
+whitelist  = []
 
 $OPTS.each {|opt, arg| # {{{
 	case opt
-		when "--domain"  then domainname = arg
-		when "--help"    then usage()
-		when "--log"     then logfile = arg.empty? ? "/var/log/qmail/#{$APPNAME}.log" : arg
-		when "--silent"  then $VERBOSE = false
-		when "--verbose" then $VERBOSE = true
+		when "--blacklist" then blacklist = getlist(arg)
+		when "--domain"    then domainname = arg
+		when "--whitelist" then whitelist = getlist(arg)
+
+		when "--help"      then usage()
+		when "--log"       then logfile = arg.empty? ? "/var/log/qmail/#{$APPNAME}.log" : arg
+		when "--silent"    then $VERBOSE = false
+		when "--verbose"   then $VERBOSE = true
 	end
 } # }}}
 
@@ -93,7 +124,7 @@ if ARGV.size == 0 then
 	exit 1
 end
 address = ARGV[0]
-valid   = VPOPMail::Message.validAddress?(address, find_postmaster(domainname))
+valid   = VPOPMail::Message.validAddress?(address, find_postmaster(domainname), blacklist, whitelist)
 Verbose "Address #{address} is " + (valid ? "valid" : "invalid")
 exit valid ? 0 : 1
 # }}}

data/examples/mailfilter

@@ -0,0 +1,54 @@
+ISSPAM=0
+
+# Check if the sender exists
+if ( $ISSPAM == 0)
+{
+    log "   Fetching Sender"
+    ADDRESS=""
+    if ( /^Reply-To:\s+.*/ )
+    {
+        foreach (getaddr $MATCH) =~ /.+/
+        {
+            ADDRESS="$ADDRESS $MATCH"
+        }
+        log "   Got Sender <$ADDRESS> from [Reply-To]"
+    }
+    else
+    if ( /^Return-Path:\s+.*/ )
+    {
+        foreach (getaddr $MATCH) =~ /.+/
+        {
+            ADDRESS="$ADDRESS $MATCH"
+        }
+        log "   Got Sender <$ADDRESS> from [Return-Path]"
+    }
+    else
+    if ( /^From:\s+.*/ )
+    {
+        foreach (getaddr $MATCH) =~ /.+/
+        {
+            ADDRESS="$ADDRESS $MATCH"
+        }
+        log "   Got Sender <$ADDRESS> from [From]"
+    }
+
+    if (length($ADDRESS) > 0)
+    {
+        log "   Checking if Sender <$ADDRESS> is valid"
+        `/usr/bin/ruby /home/vpopmail/bin/emailcheck.rb  --whitelist=@/home/vpopmail/etc/whitelist  --blacklist=@/home/vpopmail/etc/blacklist --silent $ADDRESS`
+        log "Return code: $RETURNCODE"
+        if ( $RETURNCODE == 1 )
+        {
+            log "   Sender <$ADDRESS> does not exist"
+            ISSPAM=1
+        }
+        else
+        {
+            log "   Sender <$ADDRESS> does exist"
+        }
+    }
+    else
+    {
+        log "   Weird, could not find any Sender"
+    }
+}

data/lib/vpopmail.rb

@@ -3,7 +3,7 @@
 # Read COPYRIGHT in the root of VPOPMail library for copyright info
 # Creator: gildasc@rubyforg.org
 # Author:  $Author: gildasc $
-# Version: $Id: vpopmail.rb 12 2006-10-09 08:49:52Z gildasc $
+# Version: $Id: vpopmail.rb 13 2006-10-14 21:33:32Z gildasc $
 #++
 
 $:.unshift(File.dirname(__FILE__)) unless
@@ -27,8 +27,8 @@ module VPOPMail
 	module VERSION #:nodoc:
 		MAJOR   = 1
 		MINOR   = 0
-		TINY    = 1
-		BUILD   = %q$Id: vpopmail.rb 12 2006-10-09 08:49:52Z gildasc $
+		TINY    = 2
+		BUILD   = %q$Id: vpopmail.rb 13 2006-10-14 21:33:32Z gildasc $
 		STRING  = [MAJOR, MINOR, TINY].join('.')
 	end # }}}
 

data/lib/vpopmail/message.rb

@@ -3,7 +3,7 @@
 # Read COPYRIGHT in the root of VPOPMail library for copyright info
 # Creator: gildasc@rubyforg.org
 # Author:  $Author: gildasc $
-# Version: $Id: message.rb 9 2006-10-09 01:12:10Z gildasc $
+# Version: $Id: message.rb 14 2006-10-14 22:17:39Z gildasc $
 #++
 
 require 'rexml/document'
@@ -109,13 +109,35 @@ class Message
 	# MX Servers. Then it will use the SMTP protocol to query the MX servers for the validity
 	# of <tt>p_address</tt>
 	#
+	# <tt>p_blackList</tt> contains the list of email address or domains that should always
+	# be rejected.
+	# <tt>p_whiteList</tt> contains the list of email address or domains that should always
+	# be accepted.
+	#
 	# === Possible Exceptions
 	# * SMTPServerBusy
-	def self.validAddress?(p_address, p_local)
+	def self.validAddress?(p_address, p_local, p_blacklist = [], p_whitelist = [])
 		p_address = RMail::Address.parse(p_address)[0] if !p_address.kind_of? RMail::Address
 		p_local   = RMail::Address.parse(p_local)[0]   if !p_local.kind_of? RMail::Address
 
 		logger.info "Checking Domain: #{p_address.domain}" if !@@logger.nil?
+
+		if p_blacklist.include?(p_address.address)
+			logger.info "Address #{p_address.address} is in the blacklist"
+			return false
+		end
+		if p_blacklist.include?(p_address.domain)
+			logger.info "Domain #{p_address.domain} is in the blacklist"
+			return false
+		end
+		if p_whitelist.include?(p_address.address)
+			logger.info "Address #{p_address.address} is in the whitelist"
+			return true
+		end
+		if p_whitelist.include?(p_address.domain)
+			logger.info "Domain #{p_address.domain} is in the whitelist"
+			return true
+		end
 		begin
 			resolver = Net::DNS::Resolver.new
 			answer   = resolver.query(p_address.domain, Net::DNS::MX)
@@ -163,9 +185,14 @@ class Message
 	# the origin email address when querying the mail server of <tt>p_address</tt>
 	# from the current Message
 	#
+	# <tt>p_blackList</tt> contains the list of email address or domains that should always
+	# be rejected.
+	# <tt>p_whiteList</tt> contains the list of email address or domains that should always
+	# be accepted.
+	#
 	# See Message.validAddress?
-	def validAddress?(p_address)
-		return Message.validAddress?(p_address, @folder.domain.postmaster)
+	def validAddress?(p_address, p_blacklist = [], p_whitelist = [])
+		return Message.validAddress?(p_address, @folder.domain.postmaster, p_blacklist, p_whitelist)
 	end # }}}
 
 	#--------------------------------------------------------------------------------------

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.10
 specification_version: 1
 name: vpopmail
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
-date: 2006-10-09
+  version: 1.0.2
+date: 2006-10-15
 summary: Ruby VPOPMail interface
 require_paths: 
   - lib
@@ -37,6 +37,7 @@ files:
   - lib/vpopmail/message.rb
   - lib/vpopmail/user.rb
   - examples/emailcheck.rb
+  - examples/mailfilter
   - examples/vdelfakemail.rb
   - examples/vlearn.rb
   - Rakefile