maildiode 0.0.4 → 0.0.5

data/README

@@ -5,7 +5,7 @@ Released under the GNU GPL v3
 
 *** NOTE *** 
 This code is NOT ready for production use.
-You will probably lose email if you use it on a real server!!
+You mightlose email if you use it on a real server!!
 ************
 
 PROJECT GOALS:
@@ -71,15 +71,15 @@ INSTALLATION AND CONFIGURATION
 
   
 TODO
-- Rename plugins to avoid namespace conflicts
+- Allow integrating milters and/or other external filters
+- Blacklist: Should allow filtering on from, subject, etc
 - Add debounce filter to reject bounces for mail we didn't send
-- Implement greylist exemptions (see below)
-- Periodically clear out old greylist entries
+- Greylist: Implement greylisting IP exemptions
+- Greylist: Periodically clear out old database entries
 - Properly handle multiple recipients where some work and some fail
    (Reply OK but send bounces to the failures)
 - Add a return path header?
 - Create SPF filter?
-- Allow integrating milters and/or other external filters
 
 
 SEE ALSO

data/bin/maildiode

@@ -81,16 +81,16 @@ module MailDiode
 	    MailDiode::log_info("Initializing plugin: [#{plugin_name}]")
 		case plugin_name
 			when 'blacklist'
-				require 'plugins/blacklist'
+				require 'maildiode-plugins/blacklist'
 				return BlacklistFilter.new(settings)
 			when 'delay'
-				require 'plugins/delay'
+				require 'maildiode-plugins/delay'
 				return DelayFilter.new(settings)
 			when 'alias'
-				require 'plugins/alias'
+				require 'maildiode-plugins/alias'
 				return AliasFilter.new(settings)
 			when 'greylist'
-				require 'plugins/greylist'
+				require 'maildiode-plugins/greylist'
 				return GreylistFilter.new(settings)
 			else
 				raise "Unrecognized plugin: #{plugin_name}"				

data/doc/index.html

@@ -7,6 +7,10 @@
 <h2>What is it?</h2>
 MailDiode is an SMTP daemon that accepts incoming email and delivers
 it to maildirs.
+<h2>Where can I get it?</h2>
+<p>A gem is available: <code>gem install maildiode</code>,
+or you can download it from
+<a href='http://rubyforge.org/projects/maildiode/'>RubyForge</a>.</p>
 <h2>Why another SMTP server?</h2>
 <p>Because all the others I have found are either too hard to configure, 
 or are written in insecure languages (C). 
@@ -30,11 +34,10 @@ but realizes that allowing each daemon to handle one specific task
 is simpler and (hopefully) more secure than having one service try 
 to handle both.
 <h2>What is the status of MailDiode?</h2>
-As of 2008-12-02 it is (still) in alpha test. 
-That is, I am starting to use it for some of my own production email.
-Mostly it works pretty well.
-It cannot yet be run as a daemon.
-After that feature works, I'll probably publish a gem.
+As of 2008-12-08 it is in late alpha/early beta test. 
+That is, I am using it for some of my own production email,
+and amd interested in feedback from other people.
+There are no known bugs, but I'm sure there are some in there.
 <h2>When you say "simple", what do you mean?</h2>
 MailDiode supports virtual domains, aliasing, and greylisting.
 Here is a sample config file demonstrating all those features:
@@ -45,14 +48,17 @@ server hostname localhost
 server ip 0.0.0.0
 server port 10025
 server maxconnections 20
+#server user maildiode
 
-maildir kevin     /home/kevins/TestMail/main/
-maildir catchall  /home/kevins/TestMail/other/
+maildir bob@example.com /home/bob/mail
+maildir kevin           /home/kevins/TestMail/main/
+maildir catchall        /home/kevins/TestMail/other/
 
 plugin alias
 alias kevin     ^kevin@qualitycode.com$
-alias other   	@qualitycode.com$
-alias other     @example.com$
+alias kevin     ^kevins@qualitycode.com$
+alias catchall 	@qualitycode.com$
+alias catchall  @example.com$
 
 plugin blacklist
 blacklist to	\d{6,}.*@qualitycode.com$

data/lib/engine.rb

@@ -197,7 +197,7 @@ module MailDiode
       end
       filterable_data = apply_filters(@envelope.sender, recipient)
       if !@mail_handler.valid_recipient?(filterable_data.recipient)
-        raise_smtp_error(SMTPError::UNKNOWN_RECIPIENT)
+        raise_smtp_error(SMTPError::UNKNOWN_RECIPIENT + filterable_data.recipient)
       end
       @envelope.add_recipient(recipient)
       return RESULT_OK

data/lib/server.rb

@@ -29,12 +29,14 @@ module MailDiode
     def serve(client)
       begin
         MailDiode::log_debug("Accepting client")
-        MailDiode::log_info("Connections: #{connections}")
+        if(connections > 1)
+          MailDiode::log_info("Connections: #{connections}")
+        end
         client.binmode
         engine = @factory.create_engine(@hostname)
         family, port, hostname, ip = client.addr
         greeting = engine.start(ip)
-        MailDiode::log_info("Greeting: #{greeting}")
+        MailDiode::log_debug("Greeting: #{greeting}")
         client << response(greeting)
         while !engine.terminate?
           line = get_line(client, TIMEOUT_SECONDS)

data/lib/util.rb

@@ -95,7 +95,7 @@ module MailDiode
 	end
 
 	def self.log_success(command, args, result)
-		log_info("#{result}: #{command} #{args}")
+		log_debug("#{result}: #{command} #{args}")
 	end
 
 	def self.set_log_level(level)

data/maildiode.conf.sample

@@ -1,28 +1,39 @@
 #debug warn # error warn info debug
 
+# Basic server info
 server hostname localhost
 server ip 0.0.0.0
 server port 10025
 server maxconnections 20
 #server user maildiode
 
+# Define some maildirs: name and location
 maildir bob@example.com /home/bob/mail
-maildir kevin	          /home/kevins/TestMail/main/
-maildir catchall	      /home/kevins/TestMail/other/
+maildir kevin           /home/kevins/TestMail/main/
+maildir catchall        /home/kevins/TestMail/other/
 
+# Aliases have maildir name and matching regexp
+# (Stops as soon as the first match is hit, so put catchall last)
 plugin alias
 alias kevin     ^kevin@qualitycode.com$
 alias kevin     ^kevins@qualitycode.com$
 alias catchall 	@qualitycode.com$
 alias catchall  @example.com$
 
+# Blacklist only supports filtering on "to" for now
+# (handy to limit catchall spam)
+# Each entry is the field to check, and a regexp
+# Any match here causes the email to be rejected
 plugin blacklist
 blacklist to	\d{6,}.*@qualitycode.com$
 
+# Delay responses so impatient spammers will give up
+# Specify delay in seconds
 plugin delay
 delay helo 5
 delay mail 6
 delay rcpt 7
 
+# NOTE: Greylist plugin is not well tested yet!
 plugin greylist
 greylist delayminutes 5

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: maildiode
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Kevin Smith
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-07 00:00:00 -05:00
+date: 2008-12-12 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -43,15 +43,15 @@ extra_rdoc_files:
 - doc/index.html
 files: 
 - bin/maildiode
-- lib/plugins
+- lib/maildiode-plugins
 - lib/engine.rb
 - lib/maildir.rb
 - lib/server.rb
 - lib/util.rb
 - lib/settings.rb
-- lib/plugins/alias.rb
-- lib/plugins/blacklist.rb
-- lib/plugins/delay.rb
+- lib/maildiode-plugins/alias.rb
+- lib/maildiode-plugins/blacklist.rb
+- lib/maildiode-plugins/delay.rb
 - test/test_engine.rb
 - test/test_suite.rb
 - maildiode.conf.sample