mailman 0.5.2 → 0.5.3

data/README.md

@@ -3,14 +3,16 @@
 Mailman is an incoming mail processing microframework (with POP3 and Maildir
 support), that works with Rails "out of the box".
 
-    require 'mailman'
-    Mailman::Application.run do
-      to 'ticket-%id%@example.org' do

-        Ticket.find(params[:id]).add_reply(message)org' do

-      end
-    end
+```ruby
+require 'mailman'
+Mailman::Application.run do

+  to 'ticket-%id%@example.org' do

+    Ticket.find(params[:id]).add_reply(message)
+  end
+end
+```
 
-See the [User Guide](http://rubydoc.info/github/titanous/mailman/master/file/USER_GUIDE.md) for more information.
+See the [User Guide](https://github.com/titanous/mailman/blob/master/USER_GUIDE.md) for more information.
 
 There is also a great [Getting Started Guide](http://dansowter.com/mailman-guide/) written by Dan Sowter.
 
@@ -21,7 +23,7 @@ There is also a great [Getting Started Guide](http://dansowter.com/mailman-guide
 
 ## Compatibility
 
-Tested on all Ruby versions with Travis CI.
+Tested on Ruby 1.8.7, 1.9.2, 1.9.3, REE, JRuby 1.7, and Rubinius.
 
 ### Dependencies
 
@@ -41,13 +43,17 @@ and my mentor was [Steven Soroka](http://github.com/ssoroka).
 - [Nicolas Aguttes](http://github.com/tranquiliste)
 - [Nathan Broadbent](https://github.com/ndbroadbent)
 - [Tim Carey-Smith](http://github.com/halorgium)
+- [Dan Cheail](https://github.com/DanCheail)
 - [Francis Chong](https://github.com/siuying)
 - [Kevin Glowacz](https://github.com/kjg)
 - [Cyril Mougel](http://github.com/shingara)
+- [Brian Palmer](https://github.com/codekitchen)
 - [Phillip Ridlen](https://github.com/philtr)
 - [Daniel Schierbeck](http://github.com/dasch)
 - [Steven Soroka](http://github.com/ssoroka)
+- [Benjamin Waldher](https://github.com/lgbr)
 - [Ian White](http://github.com/ianwhite)
+- [Andreas Wolff](https://github.com/rubyphunk)
 
 
 ## Copyright

data/USER_GUIDE.md

@@ -5,16 +5,18 @@ Mailman is a microframework for processing incoming email.
 Here is an example Mailman app that takes incoming messages to a support
 email account, and adds them to a database.
 
-    # mailman_app.rb
-    require 'mailman'
+```ruby
+# mailman_app.rb
+require 'mailman'
 
-    Mailman.config.maildir = '~/Maildir'
+Mailman.config.maildir = '~/Maildir'
 
-    Mailman::Application.run do
-      to 'support@example.org' do
-        Ticket.new_from_message(message)
-      end
-    end
+Mailman::Application.run do
+  to 'support@example.org' do
+    Ticket.new_from_message(message)
+  end
+end
+```
 
 The Mailman app could then be started by running `ruby mailman_app.rb`.
 
@@ -63,9 +65,11 @@ the params helper (`params[:captures]`) as an Array, and as block arguments.
 
 Routes are defined within a Mailman application block:
 
-    Mailman::Application.run do
-      # routes here
-    end
+```ruby
+Mailman::Application.run do
+  # routes here
+end
+```
 
 Messages are passed through routes in the order they are defined in the
 application from top to bottom. The first matching route's block will be
@@ -76,42 +80,54 @@ called.
 Conditions can be chained so that the route will only be executed if all
 conditions pass:
 
-    to('support@example.org').subject(/urgent/) do
-      # process urgent message here
-    end
+```ruby
+to('support@example.org').subject(/urgent/) do
+  # process urgent message here
+end
+```
 
 #### Special routes
 
 The `default` route is a catch-all that is run if no other routes match:
 
-    default do
-      # process non-matching messages
-    end
+```ruby
+default do
+  # process non-matching messages
+end
+```
 
 #### Block Arguments
 
 All captures from matchers are available as block arguments:
 
-    from('%user%@example.org').subject(/Ticket (\d+)/) do |username, ticket_id|
-      puts "Got message from #{username} about Ticket #{ticket_id}"
-    end
+```ruby
+from('%user%@example.org').subject(/Ticket (\d+)/) do |username, ticket_id|
+  puts "Got message from #{username} about Ticket #{ticket_id}"
+end
+```
 
 #### Class Routing
 
 Messages can also be routed to methods. For instance, to route to an
 Object with a `receive` instance method defined, this will work:
 
-    from '%user%@example.org', Sample
+```ruby
+from '%user%@example.org', Sample
+```
 
 Messages can also be routed to arbitrary instance methods:
 
-    from '%user%@example.org', 'ExampleClass#new_message'
+```ruby
+from '%user%@example.org', 'ExampleClass#new_message'
+```
 
 The method should accept two arguments, the message object, and the params:
 
-    def receive(message, params)
-      # process message here
-    end
+```ruby
+def receive(message, params)
+  # process message here
+end
+```
 
 #### Route Helpers
 
@@ -119,12 +135,14 @@ There are two helpers available inside of route blocks:
 
 The `params` hash holds all captures from matchers:
 
-    from('%user%@example.org').subject(/RE: (.*)/) do
-      params[:user] #=> 'chunkybacon'
-      # it is an indifferent hash, so you can use strings and symbols
-      # interchangeably as keys
-      params['captures'][0] #=> 'A very important message about pigs'
-    end
+```ruby
+from('%user%@example.org').subject(/RE: (.*)/) do
+  params[:user] #=> 'chunkybacon'
+  # it is an indifferent hash, so you can use strings and symbols
+  # interchangeably as keys
+  params['captures'][0] #=> 'A very important message about pigs'
+end
+```
 
 The `message` helper is a `Mail::Message` object that contains the entire
 message. See the [mail](http://github.com/mikel/mail/) docs for information on
@@ -201,13 +219,15 @@ set, Mailman will use POP3 polling as the receiver.
 
 **Example**:
 
-    Mailman.config.pop3 = {
-      :username => 'chunkybacon@gmail.com',
-      :password => 'foobar',
-      :server   => 'pop.gmail.com',
-      :port     => 995, # defaults to 110
-      :ssl      => true # defaults to false
-    }
+```ruby
+Mailman.config.pop3 = {
+  :username => 'chunkybacon@gmail.com',
+  :password => 'foobar',
+  :server   => 'pop.gmail.com',
+  :port     => 995, # defaults to 110
+  :ssl      => true # defaults to false
+}
+```
 
 
 ### Polling

data/lib/mailman/application.rb

@@ -68,20 +68,23 @@ module Mailman
       # Maildir
       elsif Mailman.config.maildir
         require 'maildir'
-        require 'listen'
 
         Mailman.logger.info "Maildir receiver enabled (#{Mailman.config.maildir})."
         @maildir = Maildir.new(Mailman.config.maildir)
+
         process_maildir
 
-        Mailman.logger.debug "Monitoring the Maildir for new messages..."
+        if Mailman.config.watch_maildir
+          require 'listen'
+          Mailman.logger.debug "Monitoring the Maildir for new messages..."
 
-        callback = Proc.new do |modified, added, removed|
-          process_maildir
-        end
+          callback = Proc.new do |modified, added, removed|
+            process_maildir
+          end
 
-        @listener = Listen.to(File.join(Mailman.config.maildir, 'new')).change(&callback)
-        @listener.start
+          @listener = Listen.to(File.join(Mailman.config.maildir, 'new')).change(&callback)
+          @listener.start
+        end
       end
     end
 

data/lib/mailman/configuration.rb

@@ -14,6 +14,10 @@ module Mailman
     # @return [String] the path to the maildir
     attr_accessor :maildir
 
+    # @return [boolean] whether or not to watch for new messages in the maildir.
+    #   Settings this to false disables listening for file changes if using the Maildir receiver.
+    attr_accessor :watch_maildir
+
     # @return [String] the path to the rails root. Setting this to false to stop
     #   the rails environment from loading
     attr_accessor :rails_root
@@ -35,6 +39,10 @@ module Mailman
       @poll_interval ||= 60
     end
 
+    def watch_maildir
+      @watch_maildir.nil? ? true : @watch_maildir
+    end
+
     def rails_root
       @rails_root.nil? ? '.' : @rails_root
     end

data/lib/mailman/receiver/imap.rb

@@ -13,22 +13,28 @@ module Mailman
       #   messages to
       # @option options [String] :server the server to connect to
       # @option options [Integer] :port the port to connect to
+      # @option options [Boolean] :ssl whether or not to use ssl
       # @option options [String] :username the username to authenticate with
       # @option options [String] :password the password to authenticate with
+      # @option options [String] :folder the mail folder to search
       def initialize(options)
         @processor = options[:processor]
+        @server    = options[:server]
         @username  = options[:username]
         @password  = options[:password]
         @filter    = options[:filter] || ['NEW']
         @port      = options[:port] || 143
-
-        @connection = Net::IMAP.new(options[:server], @port)
+        @ssl       = options[:ssl] || false
+        @folder    = options[:folder] || "INBOX"
       end
 
       # Connects to the IMAP server.
       def connect
-        @connection.login(@username, @password)
-        @connection.examine("INBOX")
+        if @connection.nil? or @connection.disconnected?
+          @connection = Net::IMAP.new(@server, @port, @ssl)
+          @connection.login(@username, @password)
+        end
+        @connection.select(@folder)
       end
 
       # Disconnects from the IMAP server.

data/lib/mailman/version.rb

@@ -1,3 +1,3 @@
 module Mailman
-  VERSION = '0.5.2'
+  VERSION = '0.5.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mailman
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-13 00:00:00.000000000 Z
+date: 2012-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
-  requirement: &70211186601640 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: 2.0.3
   type: :runtime
   prerelease: false
-  version_requirements: *70211186601640
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.3
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70211186600220 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: 2.3.4
   type: :runtime
   prerelease: false
-  version_requirements: *70211186600220
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.4
 - !ruby/object:Gem::Dependency
   name: listen
-  requirement: &70211186599220 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: 0.4.1
   type: :runtime
   prerelease: false
-  version_requirements: *70211186599220
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.1
 - !ruby/object:Gem::Dependency
   name: maildir
-  requirement: &70211186598540 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +69,15 @@ dependencies:
         version: 0.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *70211186598540
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70211186597440 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +85,15 @@ dependencies:
         version: 0.4.1
   type: :runtime
   prerelease: false
-  version_requirements: *70211186597440
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.1
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70211186596820 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,7 +101,12 @@ dependencies:
         version: '2.10'
   type: :development
   prerelease: false
-  version_requirements: *70211186596820
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.10'
 description: Mailman makes it easy to process incoming emails with a simple routing
   DSL
 email:
@@ -124,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: mailman
-rubygems_version: 1.8.11
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A incoming email processing microframework