allow fetching email by envelope or body

Author: ibalosh

Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # A sample Gemfile
 source 'https://rubygems.org'
 

Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:default)

lib/mailhandler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'mailhandler/sender'
 require_relative 'mailhandler/receiver'
 

lib/mailhandler/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MailHandler
   # base error
   class Error < StandardError

lib/mailhandler/receiver.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'receiving/folder'
 require_relative 'receiving/imap'
 require_relative 'receiving/observer'

lib/mailhandler/receiving/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../errors'
 
 module MailHandler

lib/mailhandler/receiving/filelist/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'fileutils'
 
 # Base filtering class, which is used for reading list of all files based on passed pattern.

lib/mailhandler/receiving/filelist/filter/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../base'
 require_relative '../../../errors'
 

lib/mailhandler/receiving/filelist/filter/email.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mail'
 require_relative 'base'
 

lib/mailhandler/receiving/folder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mail'
 require_relative 'base.rb'
 require_relative '../errors'

lib/mailhandler/receiving/imap.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mail'
 require_relative 'base.rb'
 require_relative '../errors'
@@ -92,6 +94,7 @@ def reconnect
         archive
         by_recipient
         fast_check
+        fetch_type
       ].freeze
 
       RETRY_ON_ERROR_COUNT = 3
@@ -118,7 +121,7 @@ def imap_search(retry_count, options)
                                     count: search_options[:count],
                                     order: :desc,
                                     keys: imap_filter_keys(options),
-                                    delete_after_find: options[:archive])
+                                    delete_after_find: options[:archive], fetch_type: options[:fetch_type])
         result.is_a?(Array) ? result : [result]
 
       # Silently ignore IMAP search errors, [RETRY_ON_ERROR_COUNT] times

lib/mailhandler/receiving/mail.rb

@@ -1,11 +1,10 @@
+# frozen_string_literal: true
+
 module Mail
   # IMAP class patch to better manage connection and search of emails
   class IMAP
     attr_accessor :imap_connection
 
-    # fetch emails with different flag, to make it work with icloud
-    FETCH_EMAIL_FLAG = "BODY[]" #"RFC822"
-
     def find_emails(options = {}, &block) # rubocop:disable all
       options = validate_options(options)
       options[:read_only] ? imap_connection.examine(options[:mailbox]) : imap_connection.select(options[:mailbox])
@@ -19,8 +18,7 @@ def find_emails(options = {}, &block) # rubocop:disable all
       if block_given?
         uids.each do |uid|
           uid = options[:uid].to_i unless options[:uid].nil?
-          fetchdata = imap_connection.uid_fetch(uid, ['RFC822'])[0]
-          new_message = Mail.new(fetchdata.attr['RFC822'])
+          new_message = retrieve_email_content(uid, options[:fetch_type])
           new_message.mark_for_delete = true if options[:delete_after_find]
 
           if block.arity == 3
@@ -39,8 +37,7 @@ def find_emails(options = {}, &block) # rubocop:disable all
 
         uids.each do |uid|
           uid = options[:uid].to_i unless options[:uid].nil?
-          fetchdata = imap_connection.uid_fetch(uid, [FETCH_EMAIL_FLAG])[0]
-          emails << Mail.new(fetchdata.attr[FETCH_EMAIL_FLAG])
+          emails << retrieve_email_content(uid, options[:fetch_type])
           imap_connection.uid_store(uid, '+FLAGS', [Net::IMAP::DELETED]) if options[:delete_after_find]
           break unless options[:uid].nil?
         end
@@ -66,5 +63,44 @@ def connect(_config = Mail::Configuration.instance) # rubocop:disable all
     def disconnect
       imap_connection.disconnect if defined?(imap_connection) && imap_connection && !imap_connection.disconnected?
     end
+
+    private
+
+    # fetch emails with different flag
+    # to make it work with icloud
+    FETCH_FLAG = {
+      body: 'BODY[]',
+      rfc: 'RFC822',
+      envelope: 'ENVELOPE'
+    }.freeze
+
+    def retrieve_email_content(uid, flag_type = :body)
+      case flag_type
+      when :body
+        retrieve_email_content_by_body(uid)
+      when :envelope
+        retrieve_email_content_by_envelope(uid)
+
+      else
+        retrieve_email_content_by_body(uid)
+      end
+    end
+
+    def retrieve_email_content_by_body(uid)
+      fetchdata = retrieve_fetch_type_data(FETCH_FLAG[:body], uid)
+      Mail.new(fetchdata)
+    end
+
+    def retrieve_email_content_by_envelope(uid)
+      fetchdata = retrieve_fetch_type_data(FETCH_FLAG[:envelope], uid)
+      mail = Mail.new
+      mail.subject = fetchdata.subject
+      mail
+    end
+
+    def retrieve_fetch_type_data(fetch_type, uid)
+      fetchdata = imap_connection.uid_fetch(uid, fetch_type)[0]
+      fetchdata.attr[fetch_type]
+    end
   end
 end

lib/mailhandler/receiving/notification/console.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MailHandler
   module Receiving
     module Notification

lib/mailhandler/receiving/notification/email.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'email/content'
 require_relative 'email/states'
 require_relative '../../errors'

lib/mailhandler/receiving/notification/email/content.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mail'
 
 module MailHandler

lib/mailhandler/receiving/notification/email/states.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../email'
 require_relative '../../../errors'
 

lib/mailhandler/receiving/observer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MailHandler
   module Receiving
     # observer handler

lib/mailhandler/sender.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'sending/smtp'
 require_relative 'sending/api'
 require_relative 'sending/api_batch'

lib/mailhandler/sending/api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mail'
 require 'postmark'
 require_relative 'base.rb'

lib/mailhandler/sending/api_batch.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'api.rb'
 require_relative '../errors'
 

lib/mailhandler/sending/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../errors'
 
 module MailHandler

lib/mailhandler/sending/smtp.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'net/imap'
 require_relative 'base'
 

lib/mailhandler/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MailHandler
-  VERSION = '1.0.40'.freeze
+  VERSION = '1.0.41'.freeze
 end

mailhandler.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'mailhandler/version'

spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rspec'
 require 'mail'
 require 'postmark'

spec/unit/mailhandler/receiver_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe MailHandler::Receiver do
@@ -57,7 +59,7 @@
       end
     end
 
-    context '.search' do
+    describe '.search' do
       let(:checker) do
         checker = instance_double('Checker')
 

spec/unit/mailhandler/receiving/base_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe MailHandler::Receiving::Checker do

spec/unit/mailhandler/receiving/folder_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe MailHandler::Receiving::FolderChecker do
@@ -10,7 +12,7 @@
   context 'search emails' do
     let(:checker) { described_class.new(data_folder, data_folder) }
 
-    context '.find email' do
+    describe '.find email' do
       context 'search options' do
         it 'by multiple search options' do
           time = Time.now

spec/unit/mailhandler/receiving/imap_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe MailHandler::Receiving::IMAPChecker do

spec/unit/mailhandler/receiving/notification/console_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe MailHandler::Receiving::Notification::Console do

spec/unit/mailhandler/receiving/notification/email/content_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe MailHandler::Receiving::Notification::EmailContent do
@@ -7,7 +9,7 @@
   let(:from) { '[email protected]' }
   let(:options) { { test: 'test' } }
 
-  context '.email_received' do
+  describe '.email_received' do
     it 'create email' do
       expect(notification_email_content.retrieve(:received, options, 60, from, to)).to be_kind_of Mail::Message
     end
@@ -43,7 +45,7 @@
     end
   end
 
-  context '.email_delayed' do
+  describe '.email_delayed' do
     it 'sender' do
       expect(notification_email_content.retrieve(:delayed, options, 60, from, to)[:from].to_s).to eq from
     end

spec/unit/mailhandler/receiving/notification/email_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe MailHandler::Receiving::Notification::Email do

spec/unit/mailhandler/sender_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe MailHandler::Sender do

spec/unit/mailhandler/sending/sender_api_batch_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe MailHandler::Sending::PostmarkBatchAPISender do

spec/unit/mailhandler/sending/sender_api_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe MailHandler::Sending::PostmarkAPISender do

spec/unit/mailhandler/sending/sender_smtp_spec.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe MailHandler::Sending::SMTPSender do
   subject(:smtp_sender) { described_class }
 
-  context '.send' do
+  describe '.send' do
     context 'invalid' do
       it 'incorrect mail type' do
         sender = smtp_sender.new
@@ -12,7 +14,7 @@
     end
   end
 
-  context '.new' do
+  describe '.new' do
     context 'smtp timeouts' do
       it 'open' do
         sender = smtp_sender.new

spec/unit/mailhandler_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe MailHandler::Handler do