imap-backup 6.0.1 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d4b9386097e77af34706992fb42b6ff9edd3a62a3cfb98e0b3363d864ee75dc
-  data.tar.gz: d72ec8493ea2436ccb033f2957d44236b71d3c607e25b15b0b755e93f011da10
+  metadata.gz: 2a05fedc57275cadd2a1bd22efbe88ef5ec6ee72843400499cac8b8df8e80c35
+  data.tar.gz: f0e8e859b5fb1bb8480730b3ea62abc7470f5d0ddb469113bbdac0e4f2a88d1a
 SHA512:
-  metadata.gz: ab38ba548fa009c6f718f8da9b9fbb971751297eac03d2839e14f247c06d6858a155350291619090ef8165ffeb865674a19ef51c13dbf1220928106abfc79fa5
-  data.tar.gz: ad4e17a2b6b0b5a9ee1cc4737c324981069525a129018278514e51e8664008c71fc610539df58a2da590084bb7e3c46cd635fe1409ba0b53ad56bd241edfb9c8
+  metadata.gz: bfb4de1a3048a9f29ee30fb56c7493524a7d688a6eab2ec3307005ba3c8d341a99c961acd1d8f588384dc91571b4528482931e52724df42dff19a26553568fb0
+  data.tar.gz: a411ad26b4ce3eb631c97d94c9242c1eb48fd57d23cffcec84f5c829d9354b506115b6c8278ee38430e27f0d6ca1400d55f74adce5eb99f94db2963f235c6d7a

data/lib/email/provider/apple_mail.rb

@@ -4,4 +4,8 @@ class Email::Provider::AppleMail < Email::Provider::Base
   def host
     "imap.mail.me.com"
   end
+
+  def sets_seen_flags_on_fetch?
+    true
+  end
 end

data/lib/email/provider/base.rb

@@ -7,4 +7,8 @@ class Email::Provider::Base
     {port: 993, ssl: {ssl_version: :TLSv1_2}}
     # rubocop:enable Naming/VariableNumber
   end
+
+  def sets_seen_flags_on_fetch?
+    false
+  end
 end

data/lib/email/provider/purelymail.rb

@@ -0,0 +1,11 @@
+require "email/provider/base"
+
+class Email::Provider::Purelymail < Email::Provider::Base
+  def host
+    "mailserver.purelymail.com"
+  end
+
+  def sets_seen_flags_on_fetch?
+    true
+  end
+end

data/lib/email/provider.rb

@@ -1,6 +1,7 @@
 require "email/provider/apple_mail"
 require "email/provider/fastmail"
 require "email/provider/gmail"
+require "email/provider/purelymail"
 require "email/provider/unknown"
 
 module Email; end
@@ -21,6 +22,8 @@ class Email::Provider
       Email::Provider::AppleMail.new
     when address.end_with?("@me.com")
       Email::Provider::AppleMail.new
+    when address.end_with?("@purelymail.com")
+      Email::Provider::Purelymail.new
     else
       Email::Provider::Unknown.new
     end

data/lib/imap/backup/account/connection/client_factory.rb

@@ -1,3 +1,4 @@
+require "email/provider"
 require "retry_on_error"
 
 module Imap::Backup

data/lib/imap/backup/account/connection.rb

@@ -1,4 +1,3 @@
-require "email/provider"
 require "imap/backup/client/apple_mail"
 require "imap/backup/client/default"
 require "imap/backup/account/connection/backup_folders"
@@ -46,7 +45,10 @@ module Imap::Backup
         serializer.apply_uid_validity(folder.uid_validity)
         begin
           Downloader.new(
-            folder, serializer, multi_fetch_size: account.multi_fetch_size
+            folder,
+            serializer,
+            multi_fetch_size: account.multi_fetch_size,
+            reset_seen_flags_after_fetch: account.reset_seen_flags_after_fetch
           ).run
         rescue Net::IMAP::ByeResponseError
           reconnect
@@ -105,6 +107,8 @@ module Imap::Backup
     end
 
     def ensure_account_folder
+      raise "The backup path for #{account.username} is not set" if !account.local_path
+
       Utils.make_folder(
         File.dirname(account.local_path),
         File.basename(account.local_path),

data/lib/imap/backup/account/folder.rb

@@ -98,14 +98,33 @@ module Imap::Backup
       end
     end
 
-    def clear
-      existing = uids
+    def set_flags(uids, flags)
       # Use read-write access, via `select`
       client.select(utf7_encoded_name)
-      client.uid_store(existing, "+FLAGS", [:Deleted])
+      client.uid_store(uids, "+FLAGS", flags)
+    end
+
+    def unset_flags(uids, flags)
+      client.select(utf7_encoded_name)
+      client.uid_store(uids, "-FLAGS", flags)
+    end
+
+    def clear
+      set_flags(uids, [:Deleted])
       client.expunge
     end
 
+    def unseen(uids)
+      messages = uids.map(&:to_s).join(",")
+      examine
+      client.uid_search([messages, "UNSEEN"])
+    rescue NoMethodError
+      # Apple Mail returns an empty response when searches have no results
+      []
+    rescue FolderNotFound
+      nil
+    end
+
     private
 
     def examine

data/lib/imap/backup/account.rb

@@ -8,6 +8,7 @@ module Imap::Backup
     attr_reader :folders
     attr_reader :server
     attr_reader :connection_options
+    attr_reader :reset_seen_flags_after_fetch
     attr_reader :changes
 
     def initialize(options)
@@ -18,6 +19,7 @@ module Imap::Backup
       @server = options[:server]
       @connection_options = options[:connection_options]
       @multi_fetch_size = options[:multi_fetch_size]
+      @reset_seen_flags_after_fetch = options[:reset_seen_flags_after_fetch]
       @connection = nil
       @changes = {}
       @marked_for_deletion = false
@@ -54,6 +56,9 @@ module Imap::Backup
       h[:server] = @server if @server
       h[:connection_options] = @connection_options if @connection_options
       h[:multi_fetch_size] = multi_fetch_size if @multi_fetch_size
+      if @reset_seen_flags_after_fetch
+        h[:reset_seen_flags_after_fetch] = @reset_seen_flags_after_fetch
+      end
       h
     end
 
@@ -99,6 +104,10 @@ module Imap::Backup
       update(:multi_fetch_size, parsed)
     end
 
+    def reset_seen_flags_after_fetch=(value)
+      update(:reset_seen_flags_after_fetch, value)
+    end
+
     private
 
     def update(field, value)

data/lib/imap/backup/downloader.rb

@@ -5,11 +5,21 @@ module Imap::Backup
     attr_reader :folder
     attr_reader :serializer
     attr_reader :multi_fetch_size
+    # Some IMAP providers, notably Apple Mail, set the '\Seen' flag
+    # on emails when they are fetched. By setting `:reset_seen_flags_after_fetch`,
+    # a workaround is activated which checks which emails are 'unseen' before
+    # and after the fetch, and removes the '\Seen' flag from those which have changed.
+    # As this check is susceptible to 'race conditions', i.e. when a different
+    # client sets the '\Seen' flag while imap-backup is fetching, it is best
+    # to only use it when required (i.e. for IMAP providers which always
+    # mark messages as '\Seen' when accessed).
+    attr_reader :reset_seen_flags_after_fetch
 
-    def initialize(folder, serializer, multi_fetch_size: 1)
+    def initialize(folder, serializer, multi_fetch_size: 1, reset_seen_flags_after_fetch: false)
       @folder = folder
       @serializer = serializer
       @multi_fetch_size = multi_fetch_size
+      @reset_seen_flags_after_fetch = reset_seen_flags_after_fetch
       @uids = nil
     end
 
@@ -30,7 +40,23 @@ module Imap::Backup
     private
 
     def download_block(block, index)
-      uids_and_bodies = folder.fetch_multi(block)
+      uids_and_bodies =
+        if reset_seen_flags_after_fetch
+          before_unseen = folder.unseen(block)
+          debug "Pre-fetch unseen messages: #{before_unseen.join(', ')}"
+          uids_and_bodies = folder.fetch_multi(block)
+          after_unseen = folder.unseen(block)
+          debug "Post-fetch unseen messages: #{after_unseen.join(', ')}"
+          changed = before_unseen - after_unseen
+          if changed.any?
+            ids = changed.join(", ")
+            debug "Removing '\Seen' flag for the following messages: #{ids}"
+            folder.unset_flags(changed, [:Seen])
+          end
+          uids_and_bodies
+        else
+          folder.fetch_multi(block)
+        end
       if uids_and_bodies.nil?
         if multi_fetch_size > 1
           uids = block.join(", ")

data/lib/imap/backup/setup/account/header.rb

@@ -21,7 +21,7 @@ module Imap::Backup
         password#{space}#{masked_password}
         path    #{space}#{local_path}
         folders #{space}#{folders.map { |f| f[:name] }.join(', ')}#{multi_fetch_size}
-        server  #{space}#{account.server}#{connection_options}
+        server  #{space}#{account.server}#{connection_options}#{reset_seen_flags_after_fetch}
 
         Choose an action
       HEADER
@@ -53,6 +53,12 @@ module Imap::Backup
       "\nconnection options  '#{escaped}'"
     end
 
+    def reset_seen_flags_after_fetch
+      return nil if !account.reset_seen_flags_after_fetch
+
+      "\nchanges to unread flags will be reset during download"
+    end
+
     def space
       account.connection_options ? " " * 12 : " " * 4
     end

data/lib/imap/backup/setup/account.rb

@@ -37,6 +37,7 @@ module Imap::Backup
         modify_multi_fetch_size menu
         modify_server menu
         modify_connection_options menu
+        toggle_reset_seen_flags_after_fetch menu
         test_connection menu
         delete_account menu
         menu.choice("(q) return to main menu") { throw :done }
@@ -103,6 +104,19 @@ module Imap::Backup
       end
     end
 
+    def toggle_reset_seen_flags_after_fetch(menu)
+      menu_item =
+        if account.reset_seen_flags_after_fetch
+          "don't fix changes to unread flags during download"
+        else
+          "fix changes to unread flags during download"
+        end
+      new_value = account.reset_seen_flags_after_fetch ? nil : true
+      menu.choice(menu_item) do
+        account.reset_seen_flags_after_fetch = new_value
+      end
+    end
+
     def test_connection(menu)
       menu.choice("test connection") do
         result = Setup::ConnectionTester.new(account).test

data/lib/imap/backup/setup/backup_path.rb

@@ -12,13 +12,17 @@ module Imap::Backup
 
     def run
       account.local_path = highline.ask("backup directory: ") do |q|
-        q.default  = account.local_path
+        q.default  = account.local_path || default
         q.readline = true
         q.validate = ->(path) { path_modification_validator(path) }
         q.responses[:not_valid] = "Choose a different directory "
       end
     end
 
+    def default
+      File.join(config.path, account.username.tr("@", "_"))
+    end
+
     private
 
     def highline

data/lib/imap/backup/setup.rb

@@ -80,11 +80,11 @@ module Imap::Backup
       Imap::Backup::Account.new(
         username: username,
         password: "",
-        local_path: File.join(config.path, username.tr("@", "_")),
         folders: []
       ).tap do |a|
-        server = ::Email::Provider.for_address(username)
-        a.server = server.host if server.host
+        provider = ::Email::Provider.for_address(username)
+        a.server = provider.host if provider.host
+        a.reset_seen_flags_after_fetch = true if provider.sets_seen_flags_on_fetch?
       end
     end
 

data/lib/imap/backup/version.rb

@@ -2,8 +2,8 @@ module Imap; end
 
 module Imap::Backup
   MAJOR    = 6
-  MINOR    = 0
-  REVISION = 1
+  MINOR    = 1
+  REVISION = 0
   PRE      = nil
   VERSION  = [MAJOR, MINOR, REVISION, PRE].compact.map(&:to_s).join(".")
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imap-backup
 version: !ruby/object:Gem::Version
-  version: 6.0.1
+  version: 6.1.0
 platform: ruby
 authors:
 - Joe Yates
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-09 00:00:00.000000000 Z
+date: 2022-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -200,6 +200,7 @@ files:
 - lib/email/provider/base.rb
 - lib/email/provider/fastmail.rb
 - lib/email/provider/gmail.rb
+- lib/email/provider/purelymail.rb
 - lib/email/provider/unknown.rb
 - lib/imap/backup.rb
 - lib/imap/backup/account.rb