mailman 0.4.0 → 0.5.0

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2010 Jonathan Rudenberg
+Copyright (c) 2010-2012 Jonathan Rudenberg
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,4 +1,4 @@
-# Mailman
+# Mailman [![Build Status](https://secure.travis-ci.org/titanous/mailman.png)](https://secure.travis-ci.org/titanous/mailman)
 
 Mailman is an incoming mail processing microframework (with POP3 and Maildir
 support), that works with Rails "out of the box".
@@ -12,10 +12,25 @@ support), that works with Rails "out of the box".
 
 See the [User Guide](http://rubydoc.info/github/titanous/mailman/master/file/USER_GUIDE.md) for more information.
 
+There is also a great [Getting Started Guide](http://dansowter.com/mailman-guide/) written by Dan Sowter.
+
+
 ## Installation
 
     gem install mailman
 
+## Compatibility
+
+Tested on all Ruby versions with Travis CI.
+
+### Dependencies
+
+ * mail >= 2.0.3
+ * activesupport >= 2.3.4
+ * listen >= 0.4.1
+ * maildir >= 0.5.0
+ * i18n >= 0.4.1
+
 ## Thanks
 
 This project was sponsored by the [Ruby Summer of Code](http://rubysoc.org),
@@ -23,11 +38,17 @@ and my mentor was [Steven Soroka](http://github.com/ssoroka).
 
 ### Contributors
 
-- [Tim Carey-Smith](http://github.com/halorgium)
 - [Nicolas Aguttes](http://github.com/tranquiliste)
+- [Nathan Broadbent](https://github.com/ndbroadbent)
+- [Tim Carey-Smith](http://github.com/halorgium)
+- [Francis Chong](https://github.com/siuying)
+- [Cyril Mougel](http://github.com/shingara)
+- [Phillip Ridlen](https://github.com/philtr)
 - [Daniel Schierbeck](http://github.com/dasch)
+- [Steven Soroka](http://github.com/ssoroka)
 - [Ian White](http://github.com/ianwhite)
 
+
 ## Copyright
 
-Copyright (c) 2010 Jonathan Rudenberg. See LICENSE for details.
+Copyright (c) 2010-2012 Jonathan Rudenberg. See LICENSE for details.

data/USER_GUIDE.md

@@ -99,9 +99,9 @@ All captures from matchers are available as block arguments:
 #### Class Routing
 
 Messages can also be routed to methods. For instance, to route to an
-ActionMailer mailer with a `receive` method defined, this will work:
+Object with a `receive` instance method defined, this will work:
 
-    from '%user%@example.org', SampleMailer
+    from '%user%@example.org', Sample
 
 Messages can also be routed to arbitrary instance methods:
 
@@ -242,3 +242,10 @@ loading will be disabled.
 interfere with running Mailman with cron or as a daemon.
 
 **Default**: `false`
+
+### Graceful death
+
+`Mailman.config.graceful_death`, if set, will catch SIGINTs 
+(Control-C) and allow the mail receiver to finish its current
+iteration before exiting. Note that this currently only works
+with POP3 receivers.

data/lib/mailman.rb

@@ -5,9 +5,6 @@ require 'active_support'
 require 'active_support/core_ext/string/inflections'
 require 'active_support/core_ext/hash/indifferent_access'
 
-require 'maildir'
-require 'fssm'
-
 require 'mailman/version'
 
 module Mailman

data/lib/mailman/application.rb

@@ -15,6 +15,8 @@ module Mailman
     attr_reader :processor
 
     # Creates a new router, and sets up any routes passed in the block.
+    # @param [Hash] options the application options
+    # @option options [true,false] :graceful_death catch interrupt signal and don't die until end of poll
     # @param [Proc] block a block with routes
     def initialize(&block)
       @router = Mailman::Router.new
@@ -22,6 +24,10 @@ module Mailman
       instance_eval(&block)
     end
 
+    def polling?
+      Mailman.config.poll_interval > 0 && !@polling_interrupt
+    end
+
     # Sets the block to run if no routes match a message.
     def default(&block)
       @router.default_block = block
@@ -32,52 +38,79 @@ module Mailman
       Mailman.logger.info "Mailman v#{Mailman::VERSION} started"
 
       rails_env = File.join(Mailman.config.rails_root, 'config', 'environment.rb')
-      if Mailman.config.rails_root && File.exist?(rails_env)
+      if Mailman.config.rails_root && File.exist?(rails_env) && !(defined?(Rails) && Rails.env)
         Mailman.logger.info "Rails root found in #{Mailman.config.rails_root}, requiring environment..."
         require rails_env
       end
 
-      if !Mailman.config.ignore_stdin && $stdin.fcntl(Fcntl::F_GETFL, 0) == 0 # we have stdin
+      if Mailman.config.graceful_death
+        # When user presses CTRL-C, finish processing current message before exiting
+        Signal.trap("INT") { @polling_interrupt = true }
+      end
+
+      # STDIN
+      if !Mailman.config.ignore_stdin && $stdin.fcntl(Fcntl::F_GETFL, 0) == 0
         Mailman.logger.debug "Processing message from STDIN."
         @processor.process($stdin.read)
+
+      # IMAP
+      elsif Mailman.config.imap
+        options = {:processor => @processor}.merge(Mailman.config.imap)
+        Mailman.logger.info "IMAP receiver enabled (#{options[:username]}@#{options[:server]})."
+        polling_loop Receiver::IMAP.new(options)
+
+      # POP3
       elsif Mailman.config.pop3
         options = {:processor => @processor}.merge(Mailman.config.pop3)
         Mailman.logger.info "POP3 receiver enabled (#{options[:username]}@#{options[:server]})."
-        if Mailman.config.poll_interval > 0 # we should poll
-          polling = true
-          Mailman.logger.info "Polling enabled. Checking every #{Mailman.config.poll_interval} seconds."
-        else 
-          polling = false
-          Mailman.logger.info 'Polling disabled. Checking for messages once.'
-        end
-
-        connection = Receiver::POP3.new(options)
-        loop do
-          Mailman.logger.debug "Checking POP3 server for messages..."
-          connection.connect
-          connection.get_messages
-          connection.disconnect
-          break if !polling
-          sleep Mailman.config.poll_interval
-        end
+        polling_loop Receiver::POP3.new(options)
 
+      # Maildir
       elsif Mailman.config.maildir
+        require 'maildir'
+        require 'listen'
+
         Mailman.logger.info "Maildir receiver enabled (#{Mailman.config.maildir})."
-        maildir = Maildir.new(Mailman.config.maildir)
+        @maildir = Maildir.new(Mailman.config.maildir)
 
-        # Process messages queued in the new directory
-        Mailman.logger.debug "Processing new message queue..."
-        maildir.list(:new).each do |message|
-          @processor.process_maildir_message(message)
+        Mailman.logger.debug "Monitoring the Maildir for new messages..."
+        Listen.to File.join(Mailman.config.maildir, 'new') do |modified, added, removed|
+          process_maildir
         end
+      end
+    end
 
-        Mailman.logger.debug "Monitoring the Maildir for new messages..."
-        FSSM.monitor File.join(Mailman.config.maildir, 'new') do |monitor|
-          monitor.create { |directory, filename| # a new message was delivered to new
-            message = Maildir::Message.new(maildir, "new/#{filename}")
-            @processor.process_maildir_message(message)
-          }
+    # List all message in Maildir new directory and process it
+    def process_maildir
+      # Process messages queued in the new directory
+      Mailman.logger.debug "Processing new message queue..."
+      @maildir.list(:new).each do |message|
+        @processor.process_maildir_message(message)
+      end
+    end
+
+    private
+
+    # Run the polling loop for the email inbox connection
+    def polling_loop(connection)
+      if polling?
+        polling_msg = "Polling enabled. Checking every #{Mailman.config.poll_interval} seconds."
+      else
+        polling_msg = "Polling disabled. Checking for messages once."
+      end
+      Mailman.logger.info(polling_msg)
+
+      loop do
+        begin
+          connection.connect
+          connection.get_messages
+          connection.disconnect
+        rescue SystemCallError => e
+          Mailman.logger.error e.message
         end
+
+        break unless polling?
+        sleep Mailman.config.poll_interval
       end
     end
 

data/lib/mailman/configuration.rb

@@ -5,7 +5,7 @@ module Mailman
     attr_accessor :logger
 
     # @return [Hash] the configuration hash for POP3
-    attr_accessor :pop3
+    attr_accessor :pop3, :imap
 
     # @return [Fixnum] the poll interval for POP3 or IMAP. Setting this to 0
     #   disables polling
@@ -18,10 +18,15 @@ module Mailman
     #   rails environment loading
     attr_accessor :rails_root
 
-    # @return [boolean] whether or not to ignore stdin.  Setting this to true 
+    # @return [boolean] whether or not to ignore stdin.  Setting this to true
     #   stops Mailman from entering stdin processing mode.
     attr_accessor :ignore_stdin
-    
+
+    # @return [boolean] catch SIGINT and allow current iteration to finish
+    # rather than dropping dead immediately. Currently only works with POP3
+    # connections.
+    attr_accessor :graceful_death
+
     def logger
       @logger ||= Logger.new(STDOUT)
     end

data/lib/mailman/message_processor.rb

@@ -13,16 +13,17 @@ module Mailman
     # router.
     # @param [String] message the message to process
     def process(message)
-      message = Mail.new(message)
-      Mailman.logger.info "Got new message from '#{message.from.first}' with subject '#{message.subject}'."
-      @router.route(message)
+      mail = Mail.new(message)
+      from = mail.from.nil? ? "unknown" : mail.from.first
+      Mailman.logger.info "Got new message from '#{from}' with subject '#{mail.subject}'."
+      @router.route(mail)
     end
 
     # Processes a +Maildir::Message+ instance.
     def process_maildir_message(message)
+      process(message.data)
       message.process # move message to cur
       message.seen!
-      process(message.data)
     end
 
   end

data/lib/mailman/receiver.rb

@@ -2,6 +2,7 @@ module Mailman
   module Receiver
 
     autoload :POP3, 'mailman/receiver/pop3'
+    autoload :IMAP, 'mailman/receiver/imap'
 
   end
-end
+end

data/lib/mailman/receiver/imap.rb

@@ -0,0 +1,54 @@
+require 'net/imap'
+
+module Mailman
+  module Receiver
+    # Receives messages using IMAP, and passes them to a {MessageProcessor}.
+    class IMAP
+
+      # @return [Net::IMAP] the IMAP connection
+      attr_reader :connection
+
+      # @param [Hash] options the receiver options
+      # @option options [MessageProcessor] :processor the processor to pass new
+      #   messages to
+      # @option options [String] :server the server to connect to
+      # @option options [Integer] :port the port to connect to
+      # @option options [String] :username the username to authenticate with
+      # @option options [String] :password the password to authenticate with
+      def initialize(options)
+        @processor = options[:processor]
+        @username  = options[:username]
+        @password  = options[:password]
+        @filter    = options[:filter] || ['NEW']
+        @port      = options[:port] || 143
+
+        @connection = Net::IMAP.new(options[:server], @port)
+      end
+
+      # Connects to the IMAP server.
+      def connect
+        @connection.login(@username, @password)
+        @connection.examine("INBOX")
+      end
+
+      # Disconnects from the IMAP server.
+      def disconnect
+        @connection.logout
+        @connection.disconnected? ? true : @connection.disconnect rescue nil
+      end
+
+      # Iterates through new messages, passing them to the processor, and
+      # deleting them.
+      def get_messages
+        @connection.search(@filter).each do  |message|
+          body = @connection.fetch(message,"RFC822")[0].attr["RFC822"]
+          @processor.process(body)
+          @connection.store(message,"+FLAGS",[Net::IMAP::DELETED])
+        end
+        # Clears messages that have the Deleted flag set
+        @connection.expunge
+      end
+
+    end
+  end
+end

data/lib/mailman/route/conditions.rb

@@ -37,7 +37,15 @@ module Mailman
     # Matches against the Body of a message.
     class BodyCondition < Condition
       def match(message)
-        @matcher.match(message.body.decoded)
+        if message.multipart?
+          message.parts.each do |part|
+            if result = @matcher.match(part.decoded)
+              return result
+            end
+          end
+        else
+          @matcher.match(message.body.decoded)
+        end
       end
     end
 

data/lib/mailman/version.rb

@@ -1,3 +1,3 @@
 module Mailman
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,123 +1,94 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: mailman
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 4
-  - 0
-  version: 0.4.0
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Jonathan Rudenberg
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-10-03 00:00:00 -04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: mail
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70284016144160 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 0
-        - 3
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.0.3
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: activesupport
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70284016144160
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70284016143180 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 3
-        - 4
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.3.4
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: fssm
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70284016143180
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: &70284016140380 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 1
-        - 4
-        version: 0.1.4
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.1
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: maildir
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *70284016140380
+- !ruby/object:Gem::Dependency
+  name: maildir
+  requirement: &70284017139220 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 5
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.5.0
   type: :runtime
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: i18n
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *70284017139220
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &70284017138760 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 4
-        - 1
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.4.1
   type: :runtime
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *70284017138760
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70284017138300 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
   type: :development
-  version_requirements: *id006
-description: Mailman makes it easy to process incoming emails with a simple routing DSL
-email: 
+  prerelease: false
+  version_requirements: *70284017138300
+description: Mailman makes it easy to process incoming emails with a simple routing
+  DSL
+email:
 - jonathan@titanous.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/mailman/application.rb
 - lib/mailman/configuration.rb
 - lib/mailman/message_processor.rb
+- lib/mailman/receiver/imap.rb
 - lib/mailman/receiver/pop3.rb
 - lib/mailman/receiver.rb
 - lib/mailman/route/condition.rb
@@ -133,37 +104,28 @@ files:
 - LICENSE
 - README.md
 - USER_GUIDE.md
-has_rdoc: true
 homepage: http://mailmanrb.com
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: mailman
-rubygems_version: 1.3.7
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: A incoming email processing microframework
 test_files: []
-