imap-backup 4.0.2 → 4.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14c0bd789a2532461bbfbe92dd3bb2466228fe0d14b676c308f766a5c62941cf
-  data.tar.gz: 06203ea6c126b17b26f784f2f91f3dd72d1bfd431fe100428931d624de85c53e
+  metadata.gz: 139120639e68abb1555421c5c63f28a6ede222f95767f86a52e3b8d548ceaf99
+  data.tar.gz: ef9ef718e09d4b812085c3e72f374f922ae760d318322fa2237d742aec826e37
 SHA512:
-  metadata.gz: a4de838badaaf992ae6ff46d590bb782810f4dae83aeeb9bd1495525bddfc396341374e18c51bec2e71a1cf66135335f2e21bdd6632ced9f64bc81f93f4eafe1
-  data.tar.gz: 20cc1c12289c753a3814205fd7cf125a2b234b567301a37f88da65b7f86b26a66274209fc8e2218975877f6568df3d991f1db03f76fe4262c8415adc3a59d6e6
+  metadata.gz: 3d7447ca37c7f2134ea7254fe90640ce3f6db6599a287b5b07796236d614e887cd05614045a57d8fb2b729d9e2da357f4cb42b083303dbfe1c3dc4b92b3b3dbd
+  data.tar.gz: 77ea7b8ba366c8416a6cef3c707b8942d4f3261f138c603b98128d2f43079880e12f241c8672a2f301c035204ccd68bc8a6bbbc6dce8d5d9590ecbd4c490844c

data/README.md

@@ -134,7 +134,15 @@ in the configuration file.
 
 The directory ~/.imap-backup, the configuration file and all backup
 directories have their access permissions set to only allow access
-by your user.
+by your user. This is not done on Windows - see below.
+
+## Windows
+
+Due to the complexity of managing permissions on Windows,
+directory and file access permissions are not set explicity.
+
+A pull request that implements permissions management on Windows
+would be welcome!
 
 # Run Backup
 

data/docs/development.md

@@ -41,8 +41,7 @@ response = imap.append("INBOX", message, nil, nil)
 imap.examine("INBOX")
 uids = imap.uid_search(["ALL"]).sort
 
-REQUESTED_ATTRIBUTES = ["RFC822", "FLAGS", "INTERNALDATE"].freeze
-fetch_data_items = imap.uid_fetch(uids, REQUESTED_ATTRIBUTES)
+fetch_data_items = imap.uid_fetch(uids, ["BODY[]"])
 ```
 
 # Contributing

data/imap-backup.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |gem|
 
   gem.add_runtime_dependency "highline"
   gem.add_runtime_dependency "mail"
+  gem.add_runtime_dependency "os"
   gem.add_runtime_dependency "rake"
   gem.add_runtime_dependency "thor", "~> 1.1"
 

data/lib/email/provider/apple_mail.rb

@@ -0,0 +1,7 @@
+require "email/provider/default"
+
+class Email::Provider::AppleMail < Email::Provider::Default
+  def host
+    "imap.mail.me.com"
+  end
+end

data/lib/email/provider/default.rb

@@ -0,0 +1,12 @@
+module Email; end
+class Email::Provider; end
+
+class Email::Provider::Default
+  # We don't know how to guess the IMAP server
+  def host
+  end
+
+  def options
+    {port: 993, ssl: {ssl_version: :TLSv1_2}}
+  end
+end

data/lib/email/provider/fastmail.rb

@@ -0,0 +1,7 @@
+require "email/provider/default"
+
+class Email::Provider::Fastmail < Email::Provider::Default
+  def host
+    "imap.fastmail.com"
+  end
+end

data/lib/email/provider/gmail.rb

@@ -0,0 +1,7 @@
+require "email/provider/default"
+
+class Email::Provider::GMail < Email::Provider::Default
+  def host
+    "imap.gmail.com"
+  end
+end

data/lib/email/provider.rb

@@ -1,37 +1,27 @@
+require "email/provider/default"
+require "email/provider/apple_mail"
+require "email/provider/fastmail"
+require "email/provider/gmail"
+
 module Email; end
 
 class Email::Provider
-  GMAIL_IMAP_SERVER = "imap.gmail.com".freeze
-
   def self.for_address(address)
     case
     when address.end_with?("@fastmail.com")
-      new(:fastmail)
-    when address.end_with?("@gmail.com")
-      new(:gmail)
+      Email::Provider::Fastmail.new
     when address.end_with?("@fastmail.fm")
-      new(:fastmail)
+      Email::Provider::Fastmail.new
+    when address.end_with?("@gmail.com")
+      Email::Provider::GMail.new
+    when address.end_with?("@icloud.com")
+      Email::Provider::AppleMail.new
+    when address.end_with?("@mac.com")
+      Email::Provider::AppleMail.new
+    when address.end_with?("@me.com")
+      Email::Provider::AppleMail.new
     else
-      new(:default)
-    end
-  end
-
-  attr_reader :provider
-
-  def initialize(provider)
-    @provider = provider
-  end
-
-  def options
-    {port: 993, ssl: {ssl_version: :TLSv1_2}}
-  end
-
-  def host
-    case provider
-    when :gmail
-      GMAIL_IMAP_SERVER
-    when :fastmail
-      "imap.fastmail.com"
+      Email::Provider::Default.new
     end
   end
 end

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

@@ -1,4 +1,5 @@
-require "net/imap"
+require "imap/backup/client/apple_mail"
+require "imap/backup/client/default"
 
 require "retry_on_error"
 
@@ -29,17 +30,15 @@ module Imap::Backup
     def folders
       @folders ||=
         begin
-          root = provider_root
-          mailbox_lists = imap.list(root, "*")
+          folders = client.list
 
-          if mailbox_lists.nil?
+          if folders.empty?
             message = "Unable to get folder list for account #{username}"
             Imap::Backup.logger.info message
             raise message
           end
 
-          utf7_encoded = mailbox_lists.map(&:name)
-          utf7_encoded.map { |n| Net::IMAP.decode_utf7(n) }
+          folders
         end
     end
 
@@ -54,7 +53,7 @@ module Imap::Backup
     def run_backup
       Imap::Backup.logger.debug "Running backup of account: #{username}"
       # start the connection so we get logging messages in the right order
-      imap
+      client
       each_folder do |folder, serializer|
         next if !folder.exist?
 
@@ -89,34 +88,36 @@ module Imap::Backup
     end
 
     def disconnect
-      imap.disconnect if @imap
+      client.disconnect if @client
     end
 
     def reconnect
       disconnect
-      @imap = nil
+      @client = nil
     end
 
-    def imap
-      @imap ||=
+    def client
+      @client ||=
         retry_on_error(errors: LOGIN_RETRY_CLASSES) do
           options = provider_options
           Imap::Backup.logger.debug(
             "Creating IMAP instance: #{server}, options: #{options.inspect}"
           )
-          imap = Net::IMAP.new(server, options)
+          client =
+            if provider.is_a?(Email::Provider::AppleMail)
+              Client::AppleMail.new(server, options)
+            else
+              Client::Default.new(server, options)
+            end
           Imap::Backup.logger.debug "Logging in: #{username}/#{masked_password}"
-          imap.login(username, password)
+          client.login(username, password)
           Imap::Backup.logger.debug "Login complete"
-          imap
+          client
         end
     end
 
     def server
-      return @server if @server
-      return nil if provider.nil?
-
-      @server = provider.host
+      @server ||= provider.host
     end
 
     private
@@ -186,16 +187,5 @@ module Imap::Backup
     def provider_options
       provider.options.merge(connection_options)
     end
-
-    # 6.3.8. LIST Command
-    # An empty ("" string) mailbox name argument is a special request to
-    # return the hierarchy delimiter and the root name of the name given
-    # in the reference.
-    def provider_root
-      return @provider_root if @provider_root
-
-      root_info = imap.list("", "")[0]
-      @provider_root = root_info.name
-    end
   end
 end

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

@@ -11,13 +11,13 @@ module Imap::Backup
     extend Forwardable
     include RetryOnError
 
-    REQUESTED_ATTRIBUTES = %w[RFC822 FLAGS INTERNALDATE].freeze
+    BODY_ATTRIBUTE = "BODY[]".freeze
     UID_FETCH_RETRY_CLASSES = [EOFError].freeze
 
     attr_reader :connection
     attr_reader :name
 
-    delegate imap: :connection
+    delegate client: :connection
 
     def initialize(connection, name)
       @connection = connection
@@ -40,20 +40,20 @@ module Imap::Backup
     def create
       return if exist?
 
-      imap.create(utf7_encoded_name)
+      client.create(utf7_encoded_name)
     end
 
     def uid_validity
       @uid_validity ||=
         begin
           examine
-          imap.responses["UIDVALIDITY"][-1]
+          client.responses["UIDVALIDITY"][-1]
         end
     end
 
     def uids
       examine
-      imap.uid_search(["ALL"]).sort
+      client.uid_search(["ALL"]).sort
     rescue FolderNotFound
       []
     rescue NoMethodError
@@ -72,15 +72,14 @@ module Imap::Backup
       examine
       fetch_data_items =
         retry_on_error(errors: UID_FETCH_RETRY_CLASSES) do
-          imap.uid_fetch([uid.to_i], REQUESTED_ATTRIBUTES)
+          client.uid_fetch([uid.to_i], [BODY_ATTRIBUTE])
         end
       return nil if fetch_data_items.nil?
 
       fetch_data_item = fetch_data_items[0]
       attributes = fetch_data_item.attr
-      return nil if !attributes.key?("RFC822")
 
-      attributes
+      attributes[BODY_ATTRIBUTE]
     rescue FolderNotFound
       nil
     end
@@ -88,14 +87,14 @@ module Imap::Backup
     def append(message)
       body = message.imap_body
       date = message.date&.to_time
-      response = imap.append(utf7_encoded_name, body, nil, date)
+      response = client.append(utf7_encoded_name, body, nil, date)
       extract_uid(response)
     end
 
     private
 
     def examine
-      imap.examine(utf7_encoded_name)
+      client.examine(utf7_encoded_name)
     rescue Net::IMAP::NoResponseError
       Imap::Backup.logger.warn "Folder '#{name}' does not exist on server"
       raise FolderNotFound, "Folder '#{name}' does not exist on server"

data/lib/imap/backup/cli/helpers.rb

@@ -9,6 +9,7 @@ module Imap::Backup::CLI::Helpers
     connections = Imap::Backup::Configuration::List.new
     account = connections.accounts.find { |a| a[:username] == email }
     raise "#{email} is not a configured account" if !account
+
     account
   end
 

data/lib/imap/backup/cli/local.rb

@@ -28,7 +28,10 @@ module Imap::Backup
       raise "Folder '#{folder_name}' not found" if !folder_serializer
 
       max_subject = 60
-      Kernel.puts format("%-10<uid>s  %-#{max_subject}<subject>s - %<date>s", {uid: "UID", subject: "Subject", date: "Date"})
+      Kernel.puts format(
+        "%-10<uid>s  %-#{max_subject}<subject>s - %<date>s",
+        {uid: "UID", subject: "Subject", date: "Date"}
+      )
       Kernel.puts "-" * (12 + max_subject + 28)
 
       uids = folder_serializer.uids

data/lib/imap/backup/cli/utils.rb

@@ -5,7 +5,7 @@ module Imap::Backup
     include Thor::Actions
     include CLI::Helpers
 
-    FAKE_EMAIL = "fake@email.com"
+    FAKE_EMAIL = "fake@email.com".freeze
 
     desc "ignore-history EMAIL", "Skip downloading emails up to today for all configured folders"
     def ignore_history(email)
@@ -13,15 +13,18 @@ module Imap::Backup
 
       connection.local_folders.each do |serializer, folder|
         next if !folder.exist?
+
         do_ignore_folder_history(folder, serializer)
       end
     end
 
-    desc "export-to-thunderbird EMAIL [OPTIONS]",
+    desc(
+      "export-to-thunderbird EMAIL [OPTIONS]",
       <<~DOC
         [Experimental] Copy backed up emails to Thunderbird.
         A folder called 'imap-backup/EMAIL' is created under 'Local Folders'.
       DOC
+    )
     method_option(
       "force",
       type: :boolean,
@@ -50,7 +53,7 @@ module Imap::Backup
         end
       end
 
-      connection.local_folders.each do |serializer, folder|
+      connection.local_folders.each do |serializer, _folder|
         Thunderbird::MailboxExporter.new(
           email, serializer, profile, force: force
         ).run
@@ -76,10 +79,18 @@ module Imap::Backup
       end
 
       def thunderbird_profile(name = nil)
+        profiles = Thunderbird::Profiles.new
         if name
-          Thunderbird::Profiles.new.profile(name)
+          profiles.profile(name)
         else
-          Thunderbird::Profiles.new.default
+          if profiles.installs.count > 1
+            raise <<~MESSAGE
+              Thunderbird has multiple installs, so no default profile exists.
+              Please supply a profile name
+            MESSAGE
+          end
+
+          profiles.installs[0].default
         end
       end
     end

data/lib/imap/backup/client/apple_mail.rb

@@ -0,0 +1,11 @@
+require "imap/backup/client/default"
+
+module Imap::Backup
+  class Client::AppleMail < Client::Default
+    # With Apple Mails's IMAP, passing "/" to list
+    # results in an empty list
+    def provider_root
+      ""
+    end
+  end
+end

data/lib/imap/backup/client/default.rb

@@ -0,0 +1,51 @@
+require "forwardable"
+require "net/imap"
+
+module Imap::Backup
+  module Client; end
+
+  class Client::Default
+    extend Forwardable
+    def_delegators :imap, *%i(
+      append authenticate create disconnect examine
+      login responses uid_fetch uid_search
+    )
+
+    attr_reader :args
+
+    def initialize(*args)
+      @args = args
+    end
+
+    def list
+      root = provider_root
+      mailbox_lists = imap.list(root, "*")
+
+      return [] if mailbox_lists.nil?
+
+      mailbox_lists.map { |ml| extract_name(ml) }
+    end
+
+    private
+
+    def imap
+      @imap ||= Net::IMAP.new(*args)
+    end
+
+    def extract_name(mailbox_list)
+      utf7_encoded = mailbox_list.name
+      Net::IMAP.decode_utf7(utf7_encoded)
+    end
+
+    # 6.3.8. LIST Command
+    # An empty ("" string) mailbox name argument is a special request to
+    # return the hierarchy delimiter and the root name of the name given
+    # in the reference.
+    def provider_root
+      @provider_root ||= begin
+        root_info = imap.list("", "")[0]
+        root_info.name
+      end
+    end
+  end
+end

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

@@ -147,10 +147,12 @@ module Imap::Backup
 
     def default_server(username)
       provider = Email::Provider.for_address(username)
-      if provider.provider == :default
+
+      if provider.is_a?(Email::Provider::Default)
         Kernel.puts "Can't decide provider for email address '#{username}'"
         return nil
       end
+
       provider.host
     end
   end

data/lib/imap/backup/configuration/connection_tester.rb

@@ -3,7 +3,7 @@ module Imap::Backup
 
   module Configuration::ConnectionTester
     def self.test(account)
-      Account::Connection.new(account).imap
+      Account::Connection.new(account).client
       "Connection successful"
     rescue Net::IMAP::NoResponseError
       "No response"

data/lib/imap/backup/configuration/store.rb

@@ -1,4 +1,5 @@
 require "json"
+require "os"
 
 module Imap::Backup
   module Configuration; end
@@ -25,11 +26,12 @@ module Imap::Backup
     end
 
     def save
-      mkdir_private path
+      FileUtils.mkdir(path) if !File.directory?(path)
+      make_private(path) if !windows?
       remove_modified_flags
       remove_deleted_accounts
       File.open(pathname, "w") { |f| f.write(JSON.pretty_generate(data)) }
-      FileUtils.chmod 0o600, pathname
+      FileUtils.chmod(0o600, pathname) if !windows?
     end
 
     def accounts
@@ -54,7 +56,7 @@ module Imap::Backup
       @data ||=
         begin
           if File.exist?(pathname)
-            Utils.check_permissions pathname, 0o600
+            Utils.check_permissions(pathname, 0o600) if !windows?
             contents = File.read(pathname)
             data = JSON.parse(contents, symbolize_names: true)
           else
@@ -73,9 +75,12 @@ module Imap::Backup
       accounts.reject! { |a| a[:delete] }
     end
 
-    def mkdir_private(path)
-      FileUtils.mkdir(path) if !File.directory?(path)
+    def make_private(path)
       FileUtils.chmod(0o700, path) if Utils.mode(path) != 0o700
     end
+
+    def windows?
+      OS.windows?
+    end
   end
 end

data/lib/imap/backup/downloader.rb

@@ -13,16 +13,15 @@ module Imap::Backup
       count = uids.count
       Imap::Backup.logger.debug "[#{folder.name}] #{count} new messages"
       uids.each.with_index do |uid, i|
-        message = folder.fetch(uid)
+        body = folder.fetch(uid)
         log_prefix = "[#{folder.name}] uid: #{uid} (#{i + 1}/#{count}) -"
-        if message.nil?
+        if body.nil?
           Imap::Backup.logger.debug("#{log_prefix} not available - skipped")
           next
         end
         Imap::Backup.logger.debug(
-          "#{log_prefix} #{message['RFC822'].size} bytes"
+          "#{log_prefix} #{body.size} bytes"
         )
-        body = message["RFC822"]
         serializer.save(uid, body)
       end
     end

data/lib/imap/backup/thunderbird/mailbox_exporter.rb

@@ -1,10 +1,9 @@
 require "thunderbird/local_folder"
-require "thunderbird/mailbox"
 require "thunderbird/profiles"
 
 module Imap::Backup
   class Thunderbird::MailboxExporter
-    EXPORT_PREFIX = "imap-backup"
+    EXPORT_PREFIX = "imap-backup".freeze
 
     attr_reader :email
     attr_reader :serializer
@@ -19,28 +18,29 @@ module Imap::Backup
     end
 
     def run
-      local_folder.set_up
+      local_folder_ok = local_folder.set_up
+      return if !local_folder_ok
 
-      if mailbox.msf_exists?
+      if local_folder.msf_exists?
         if force
-          Kernel.puts "Deleting '#{mailbox.msf_path}' as --force option was supplied"
-          File.unlink mailbox.msf_path
+          Kernel.puts "Deleting '#{local_folder.msf_path}' as --force option was supplied"
+          File.unlink local_folder.msf_path
         else
-          Kernel.puts "Skipping export of '#{folder.name}' as '#{mailbox.msf_path}' exists"
+          Kernel.puts "Skipping export of '#{serializer.folder}' as '#{local_folder.msf_path}' exists"
           return false
         end
       end
 
-      if mailbox.exists?
+      if local_folder.exists?
         if force
-          Kernel.puts "Overwriting '#{mailbox.path}' as --force option was supplied"
+          Kernel.puts "Overwriting '#{local_folder.path}' as --force option was supplied"
         else
-          Kernel.puts "Skipping export of '#{folder.name}' as '#{mailbox.path}' exists"
+          Kernel.puts "Skipping export of '#{serializer.folder}' as '#{local_folder.path}' exists"
           return false
         end
       end
 
-      FileUtils.cp serializer.mbox_pathname, mailbox.path
+      FileUtils.cp serializer.mbox_pathname, local_folder.full_path
 
       true
     end
@@ -49,23 +49,10 @@ module Imap::Backup
 
     def local_folder
       @local_folder ||= begin
-        folder_path = File.dirname(serializer.folder)
         top_level_folders = [EXPORT_PREFIX, email]
-        prefixed_folder_path =
-          if folder_path == "."
-            File.join(top_level_folders)
-          else
-            File.join(top_level_folders, folder_path)
-          end
+        prefixed_folder_path = File.join(top_level_folders, serializer.folder)
         Thunderbird::LocalFolder.new(profile, prefixed_folder_path)
       end
     end
-
-    def mailbox
-      @mailbox ||= begin
-        mailbox_name = File.basename(serializer.folder)
-        Thunderbird::Mailbox.new(local_folder, mailbox_name)
-      end
-    end
   end
 end

data/lib/imap/backup/version.rb

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

data/lib/thunderbird/install.rb

@@ -0,0 +1,16 @@
+require "thunderbird/profiles"
+
+class Thunderbird::Install
+  attr_reader :title
+  attr_reader :entries
+
+  # entries are lines from profile.ini
+  def initialize(title, entries)
+    @title = title
+    @entries = entries
+  end
+
+  def default
+    Thunderbird::Profiles.new.profile_for_path(entries[:Default])
+  end
+end