openproject/lib/redmine/imap.rb

#-- encoding: UTF-8
#-- copyright
# OpenProject is a project management system.
# Copyright (C) 2012-2018 the OpenProject Foundation (OPF)
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License version 3.
#
# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
# Copyright (C) 2006-2017 Jean-Philippe Lang
# Copyright (C) 2010-2013 the ChiliProject Team
#
# 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.
#
# See docs/COPYRIGHT.rdoc for more details.
#++

require 'net/imap'

module Redmine
  module IMAP
    class << self
      def check(imap_options = {}, options = {})
        folder = imap_options[:folder] || 'INBOX'
        imap = connect_imap(imap_options)

        imap.select(folder)
        imap.search(['NOT', 'SEEN']).each do |message_id|
          receive(message_id, imap, imap_options, options)
        end

        imap.expunge
      end

      private

      def connect_imap(imap_options)
        host = imap_options[:host] || '127.0.0.1'
        port = imap_options[:port] || '143'
        ssl = ssl_option(imap_options)
        imap = Net::IMAP.new(host, port, ssl)

        imap.login(imap_options[:username], imap_options[:password]) unless imap_options[:username].nil?

        imap
      end

      def ssl_option(imap_options)
        return false if imap_options[:ssl] == false # don't use SSL

        if imap_options[:ssl_verification] == false
          { verify_mode: OpenSSL::SSL::VERIFY_NONE } # use SSL without verification
        else
          true # use SSL with verification
        end
      end

      def receive(message_id, imap, imap_options, options)
        msg = imap.fetch(message_id, 'RFC822')[0].attr['RFC822']

        log_debug { "Receiving message #{message_id}" }

        if MailHandler.receive(msg, options)
          message_received(message_id, imap, imap_options)
        else
          message_error(message_id, imap, imap_options)
        end
      end

      def message_received(message_id, imap, imap_options)
        log_debug { "Message #{message_id} successfully received" }

        if imap_options[:move_on_success]
          imap.copy(message_id, imap_options[:move_on_success])
        end

        imap.store(message_id, '+FLAGS', [:Seen, :Deleted])
      end

      def message_error(message_id, imap, imap_options)
        log_debug { "Message #{message_id} can not be processed" }

        imap.store(message_id, '+FLAGS', [:Seen])

        if imap_options[:move_on_failure]
          imap.copy(message_id, imap_options[:move_on_failure])
          imap.store(message_id, '+FLAGS', [:Deleted])
        end
      end

      def log_debug(&_message)
        logger.debug(yield) if logger && logger.debug?
      end

      def logger
        Rails.logger
      end
    end
  end
end