jro_apps/redmine Commit - r12863:eaac0eff082e

add support for pop3s (SSL) to redmine:email:receive_pop3 (#16707)...

Toshi MARUYAMA -

r12863:eaac0eff082e

parent child

Context file:

r12863:eaac0eff082e

Collapse all files

lib/redmine/pop3.rb +13 -1

             # Redmine - project management software
             # Copyright (C) 2006-2014  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             require 'net/pop'
             module Redmine
               module POP3
                 class << self
                   def check(pop_options={}, options={})
+                    if pop_options[:ssl]
+                      ssl = true
+                      if pop_options[:ssl] == 'force'
+                        Net::POP3.enable_ssl(OpenSSL::SSL::VERIFY_NONE)
+                      else
+                        Net::POP3.enable_ssl(OpenSSL::SSL::VERIFY_PEER)
+                      end
+                    else
+                      ssl = false
+                    end
                     host = pop_options[:host] || '127.0.0.1'
-                    port = pop_options[:port] || '110'
+                    port = pop_options[:port]
+                    port ||= ssl ? '995' : '110'
                     apop = (pop_options[:apop].to_s == '1')
                     delete_unprocessed = (pop_options[:delete_unprocessed].to_s == '1')
                     pop = Net::POP3.APOP(apop).new(host,port)
                     logger.debug "Connecting to #{host}..." if logger && logger.debug?
                     pop.start(pop_options[:username], pop_options[:password]) do |pop_session|
                       if pop_session.mails.empty?
                         logger.debug "No email to process" if logger && logger.debug?
                       else
                         logger.debug "#{pop_session.mails.size} email(s) to process..." if logger && logger.debug?
                         pop_session.each_mail do |msg|
                           message = msg.pop
                           message_id = (message =~ /^Message-I[dD]: (.*)/ ? $1 : '').strip
                           if MailHandler.safe_receive(message, options)
                             msg.delete
                             logger.debug "--> Message #{message_id} processed and deleted from the server" if logger && logger.debug?
                           else
                             if delete_unprocessed
                               msg.delete
                               logger.debug "--> Message #{message_id} NOT processed and deleted from the server" if logger && logger.debug?
                             else
                               logger.debug "--> Message #{message_id} NOT processed and left on the server" if logger && logger.debug?
                             end
                           end
                         end
                       end
                     end
                   end
                   private
                   def logger
                     ::Rails.logger
                   end
                 end
               end
             end

lib/tasks/email.rake +2 0

             # Redmine - project management software
             # Copyright (C) 2006-2014  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             namespace :redmine do
               namespace :email do
                 desc <<-END_DESC
             Read an email from standard input.
             General options:
               unknown_user=ACTION      how to handle emails from an unknown user
                                        ACTION can be one of the following values:
                                        ignore: email is ignored (default)
                                        accept: accept as anonymous user
                                        create: create a user account
               no_permission_check=1    disable permission checking when receiving
                                        the email
               no_account_notice=1      disable new user account notification
               default_group=foo,bar    adds created user to foo and bar groups
             Issue attributes control options:
               project=PROJECT          identifier of the target project
               status=STATUS            name of the target status
               tracker=TRACKER          name of the target tracker
               category=CATEGORY        name of the target category
               priority=PRIORITY        name of the target priority
               allow_override=ATTRS     allow email content to override attributes
                                        specified by previous options
                                        ATTRS is a comma separated list of attributes
             Examples:
               # No project specified. Emails MUST contain the 'Project' keyword:
               rake redmine:email:read RAILS_ENV="production" < raw_email
               # Fixed project and default tracker specified, but emails can override
               # both tracker and priority attributes:
               rake redmine:email:read RAILS_ENV="production" \\
                               project=foo \\
                               tracker=bug \\
                               allow_override=tracker,priority < raw_email
             END_DESC
                 task :read => :environment do
                   Mailer.with_synched_deliveries do
                     MailHandler.receive(STDIN.read, MailHandler.extract_options_from_env(ENV))
                   end
                 end
                 desc <<-END_DESC
             Read emails from an IMAP server.
             General options:
               unknown_user=ACTION      how to handle emails from an unknown user
                                        ACTION can be one of the following values:
                                        ignore: email is ignored (default)
                                        accept: accept as anonymous user
                                        create: create a user account
               no_permission_check=1    disable permission checking when receiving
                                        the email
               no_account_notice=1      disable new user account notification
               default_group=foo,bar    adds created user to foo and bar groups
             Available IMAP options:
               host=HOST                IMAP server host (default: 127.0.0.1)
               port=PORT                IMAP server port (default: 143)
               ssl=SSL                  Use SSL? (default: false)
               username=USERNAME        IMAP account
               password=PASSWORD        IMAP password
               folder=FOLDER            IMAP folder to read (default: INBOX)
             Issue attributes control options:
               project=PROJECT          identifier of the target project
               status=STATUS            name of the target status
               tracker=TRACKER          name of the target tracker
               category=CATEGORY        name of the target category
               priority=PRIORITY        name of the target priority
               allow_override=ATTRS     allow email content to override attributes
                                        specified by previous options
                                        ATTRS is a comma separated list of attributes
             Processed emails control options:
               move_on_success=MAILBOX  move emails that were successfully received
                                        to MAILBOX instead of deleting them
               move_on_failure=MAILBOX  move emails that were ignored to MAILBOX
             Examples:
               # No project specified. Emails MUST contain the 'Project' keyword:
               rake redmine:email:receive_imap RAILS_ENV="production" \\
                 host=imap.foo.bar username=redmine@example.net password=xxx
               # Fixed project and default tracker specified, but emails can override
               # both tracker and priority attributes:
               rake redmine:email:receive_imap RAILS_ENV="production" \\
                 host=imap.foo.bar username=redmine@example.net password=xxx ssl=1 \\
                 project=foo \\
                 tracker=bug \\
                 allow_override=tracker,priority
             END_DESC
                 task :receive_imap => :environment do
                   imap_options = {:host => ENV['host'],
                                   :port => ENV['port'],
                                   :ssl => ENV['ssl'],
                                   :username => ENV['username'],
                                   :password => ENV['password'],
                                   :folder => ENV['folder'],
                                   :move_on_success => ENV['move_on_success'],
                                   :move_on_failure => ENV['move_on_failure']}
                   Mailer.with_synched_deliveries do
                     Redmine::IMAP.check(imap_options, MailHandler.extract_options_from_env(ENV))
                   end
                 end
                 desc <<-END_DESC
             Read emails from an POP3 server.
             Available POP3 options:
               host=HOST                POP3 server host (default: 127.0.0.1)
               port=PORT                POP3 server port (default: 110)
               username=USERNAME        POP3 account
               password=PASSWORD        POP3 password
               apop=1                   use APOP authentication (default: false)
+              ssl=SSL                  Use SSL? (default: false)
               delete_unprocessed=1     delete messages that could not be processed
                                        successfully from the server (default
                                        behaviour is to leave them on the server)
             See redmine:email:receive_imap for more options and examples.
             END_DESC
                 task :receive_pop3 => :environment do
                   pop_options  = {:host => ENV['host'],
                                   :port => ENV['port'],
                                   :apop => ENV['apop'],
+                                  :ssl => ENV['ssl'],
                                   :username => ENV['username'],
                                   :password => ENV['password'],
                                   :delete_unprocessed => ENV['delete_unprocessed']}
                   Mailer.with_synched_deliveries do
                     Redmine::POP3.check(pop_options, MailHandler.extract_options_from_env(ENV))
                   end
                 end
                 desc "Send a test email to the user with the provided login name"
                 task :test, [:login] => :environment do |task, args|
                   include Redmine::I18n
                   abort l(:notice_email_error, "Please include the user login to test with. Example: rake redmine:email:test[login]") if args[:login].blank?
                   user = User.find_by_login(args[:login])
                   abort l(:notice_email_error, "User #{args[:login]} not found") unless user && user.logged?
                   ActionMailer::Base.raise_delivery_errors = true
                   begin
                     Mailer.with_synched_deliveries do
                       Mailer.test_email(user).deliver
                     end
                     puts l(:notice_email_sent, user.mail)
                   rescue Exception => e
                     abort l(:notice_email_error, e.message)
                   end
                 end
               end
             end

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages