mailman 0.7.2 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e0d6250baa93fa46879402ceb182c3a708646fd
-  data.tar.gz: f7b302706b41090084e7bc4fb615428210fab46a
+  metadata.gz: 95cd28c23630aa811c3a0f9299730e745bc29a8a
+  data.tar.gz: 52e2f0d09f4452e08a16d5a51b9f7d85b45ba93b
 SHA512:
-  metadata.gz: 36ff95f7fbef72bb59af16b5dad474e170afa93b1a8f459dfce4cb48135a01715dcaa3ab20a973068c19805a23ed08a2847252645c07ca3115e087f509160838
-  data.tar.gz: a2bd2c82bb9833ff2202ff6e238cd4432d0162a0f54f93ccfa10782bd365368f58e37362b60ad15a64f6abeac8cbf601200c437c211dac6de07b0d12c33c56e4
+  metadata.gz: dc09cb996cc8418a81a15d02c9585807256d62c8d0ade276930005689bbab99e570d42c0fa45fb19b50e2b4c03b2bea8fe202c9347262f207456ff06495e56de
+  data.tar.gz: 35aa8a40870ffa6439cda844fc47a9269a5650411ea4ce0223d867f5c027f66818a2447782bed53e512860c85bd84735a1f5cdeeb8f637732960d83b0aaea09e

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 0.7.3 (March 17, 2015)
+Features
+   starttls for imap
+   allow passing options to openssl for pop3/imap
+
+Security fixes
+   Enable certificate validation for pop3
+
+Bugfixes
+   added retry logic to handle connection errors gracefully
+
 ## 0.7.2 (June 9, 2014)
 
 Bugfixes
@@ -26,7 +37,7 @@ Features
 
 Features
 
-  - IMAP: Mark messages as seen instead of deleting them (see [5b6aef0](https://github.com/titanous/mailman/commit/5b6aef0163f0f28c790abf3083cbda7cbc9cc13f) for details on how revert to the previous behaviour)
+  - IMAP: Mark messages as seen instead of deleting them (see [5b6aef0](https://github.com/mailman/mailman/commit/5b6aef0163f0f28c790abf3083cbda7cbc9cc13f) for details on how revert to the previous behaviour)
 
 Bugfixes
 

data/README.md

@@ -1,4 +1,4 @@
-# Mailman [![Build Status](https://secure.travis-ci.org/titanous/mailman.png)](https://secure.travis-ci.org/titanous/mailman)
+# Mailman [![Build Status](https://secure.travis-ci.org/mailman/mailman.png)](https://secure.travis-ci.org/mailman/mailman)
 
 Mailman is an incoming mail processing microframework (with POP3 and Maildir
 support), that works with Rails "out of the box".
@@ -12,7 +12,7 @@ Mailman::Application.run do
 end
 ```
 
-See the [User Guide](https://github.com/titanous/mailman/blob/master/USER_GUIDE.md) for more information.
+See the [User Guide](https://github.com/mailman/mailman/blob/master/USER_GUIDE.md) for more information.
 
 **If you'd like to maintain this gem, email jonathan@titanous.com.**
 
@@ -22,7 +22,14 @@ See the [User Guide](https://github.com/titanous/mailman/blob/master/USER_GUIDE.
 
 ## Compatibility
 
-Tested on Ruby 2.0, 1.9.3, JRuby, and Rubinius.
+Tested on Ruby 2.1, 2.0, 1.9.3, JRuby, and Rubinius.
+
+### Ruby < 2.0.0
+
+In order to use this gem with ruby versions older then 2.0.0, you have to
+restrict the maildir gem to the latest supported version in your `Gemfile`:
+
+    gem 'maildir', '< 2.1.0'
 
 ## Thanks
 

data/USER_GUIDE.md

@@ -185,24 +185,31 @@ after processing*. If you want to keep a copy of messages, it is recommended
 that you use a mail retriever with the Maildir receiver. You could also use
 Gmail and set it to keep messages after they have been retrieved with POP3.
 
+You can pass a Hash to `ssl` with
+[SSL context options](http://www.ruby-doc.org/stdlib/libdoc/openssl/rdoc/OpenSSL/SSL/SSLContext.html).
+For example, when you have a self-signed certificate: `ssl: { ca_file: '/etc/pki/my_ca.pem' }`.
+
 
 ### IMAP
 
-The IMAP receiver is enabled when the `Mailman.config.imap` hash is set. 
+The IMAP receiver is enabled when the `Mailman.config.imap` hash is set.
 Polling can be set with `Mailman.config.poll_interval`. This will read all unread messages in the INBOX by default.
 Here are example settings for gmail.
 
 ```ruby
 Mailman.config.imap = {
-  server: 'imap.gmail.com', 
-  port: 993,  # usually 995, 993 for gmail
+  server: 'imap.gmail.com',
+  port: 993, # you usually don't need to set this, but it's there if you need to
   ssl: true,
+  # Use starttls instead of ssl (do not specify both)
+  #starttls: true,
   username: 'foo@somedomain.com',
   password: 'totallyunsecuredpassword'
 }
 
 ```
 * When using gmail, remember to [enable IMAP](https://support.google.com/mail/troubleshooter/1668960)
+* You can pass a Hash to `ssl`, just like with POP3.
 
 ### Maildir
 
@@ -243,7 +250,7 @@ Mailman.config.pop3 = {
   :username => 'chunkybacon@gmail.com',
   :password => 'foobar',
   :server   => 'pop.gmail.com',
-  :port     => 995, # defaults to 110
+  :port     => 995, # you can usually omit this, but it's there
   :ssl      => true # defaults to false
 }
 ```

data/lib/mailman/application.rb

@@ -133,14 +133,23 @@ module Mailman
       end
       Mailman.logger.info(polling_msg)
 
+      tries ||= 5
       loop do
         begin
           connection.connect
           connection.get_messages
-        rescue SystemCallError => e
+        rescue SystemCallError, EOFError => e
           Mailman.logger.error e.message
+          unless (tries -= 1).zero?
+            Mailman.logger.error "Retrying..."
+            begin
+              connection.disconnect
+            rescue # don't crash in the crash handler
+            end
+            retry
+          end
         ensure
-          connection.disconnect
+          connection.started? && connection.disconnect
         end
 
         break unless polling?

data/lib/mailman/receiver/imap.rb

@@ -13,7 +13,11 @@ 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 [Boolean,Hash] :ssl if options is true, then an attempt will
+      #   be made to use SSL (now TLS) to connect to the server. A Hash can be used
+      #   to enable ssl and supply SSL context options.
+      # @option options [Boolean] :starttls use STARTTLS command to start
+      #   TLS session.
       # @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
@@ -28,22 +32,34 @@ module Mailman
         @password   = options[:password]
         @filter     = options[:filter] || 'UNSEEN'
         @done_flags = options[:done_flags] || [Net::IMAP::SEEN]
-        @port       = options[:port] || 143
         @ssl        = options[:ssl] || false
+        @starttls   = options[:starttls] || false
+        @port       = options[:port] || (@ssl ? 993 : 143)
         @folder     = options[:folder] || "INBOX"
+
+        if @starttls && @ssl
+          raise StandardError.new("either specify ssl or starttls, not both")
+        end
       end
 
       # Connects to the IMAP server.
       def connect
+        tries ||= 5
         if @connection.nil? or @connection.disconnected?
           @connection = Net::IMAP.new(@server, port: @port, ssl: @ssl)
+          if @starttls
+            @connection.starttls
+          end
           @connection.login(@username, @password)
         end
         @connection.select(@folder)
+      rescue Net::IMAP::ByeResponseError, Net::IMAP::NoResponseError => e
+        retry unless (tries -= 1).zero?
       end
 
       # Disconnects from the IMAP server.
       def disconnect
+        return false if @connection.nil?
         @connection.logout
         @connection.disconnected? ? true : @connection.disconnect rescue nil
       end
@@ -53,13 +69,21 @@ module Mailman
       def get_messages
         @connection.search(@filter).each do |message|
           body = @connection.fetch(message, "RFC822")[0].attr["RFC822"]
-          @processor.process(body)
+          begin
+            @processor.process(body)
+          rescue StandardError => error
+            Mailman.logger.error "Error encountered processing message: #{message.inspect}\n #{error.class.to_s}: #{error.message}\n #{error.backtrace.join("\n")}"
+            next
+          end
           @connection.store(message, "+FLAGS", @done_flags)
         end
         # Clears messages that have the Deleted flag set
         @connection.expunge
       end
 
+      def started?
+        not (!@connection.nil? && @connection.disconnected?)
+      end
     end
   end
 end

data/lib/mailman/receiver/pop3.rb

@@ -12,16 +12,21 @@ module Mailman
       # @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 [Integer] :port the port to connect to (default 110, or 995 for ssl)
       # @option options [String] :username the username to authenticate with
       # @option options [String] :password the password to authenticate with
-      # @option options [true,false] :ssl enable SSL
+      # @option options [true,false,Hash] :ssl enable SSL
       def initialize(options)
         @processor = options[:processor]
         @username = options[:username]
         @password = options[:password]
-        @connection = Net::POP3.new(options[:server], options[:port])
-        @connection.enable_ssl(OpenSSL::SSL::VERIFY_NONE) if options[:ssl]
+        port = options[:port] || (options[:ssl] ? 995 : 110)
+        @connection = Net::POP3.new(options[:server], port)
+        if options[:ssl].is_a? Hash
+          @connection.enable_ssl(options[:ssl])
+        elsif options[:ssl]
+          @connection.enable_ssl
+        end
         @connection.open_timeout = options[:open_timeout] if options[:open_timeout]
         @connection.read_timeout = options[:read_timeout] if options[:read_timeout]
       end
@@ -40,11 +45,19 @@ module Mailman
       # deleting them.
       def get_messages
         @connection.each_mail do |message|
-          @processor.process(message.pop)
+          begin
+            @processor.process(message.pop)
+          rescue StandardError => error
+            Mailman.logger.error "Error encountered processing message: #{message.inspect}\n #{error.class.to_s}: #{error.message}\n #{error.backtrace.join("\n")}"
+            next
+          end
         end
         @connection.delete_all
       end
 
+      def started?
+        @connection.started?
+      end
     end
   end
 end

data/lib/mailman/version.rb

@@ -1,3 +1,3 @@
 module Mailman
-  VERSION = '0.7.2'
+  VERSION = '0.7.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailman
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.7.3
 platform: ruby
 authors:
 - Jonathan Rudenberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-10 00:00:00.000000000 Z
+date: 2015-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: '3.0'
 description: Mailman makes it easy to process incoming emails with a simple routing
   DSL
 email:
@@ -126,7 +126,7 @@ files:
 - lib/mailman/route/string_matcher.rb
 - lib/mailman/router.rb
 - lib/mailman/version.rb
-homepage: https://github.com/titanous/mailman
+homepage: https://github.com/mailman/mailman
 licenses: []
 metadata: {}
 post_install_message: