imap-backup 4.0.1 → 4.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97ae9089aa19dee6fcf7a1c211091671a6befe882d5b664654a25d6d10e81704
-  data.tar.gz: 2677746ed662c457a738033224da11a40a76367e4031e7636b33391d51ee4659
+  metadata.gz: 6eebcf60acbb2e97a007e5da03c63fb7c32e24413397f28d3ec9f94154b8def5
+  data.tar.gz: 5f81961b55811c8c9fadabf2def11e1e00ab8572fd844f44b8fda371aa190bbb
 SHA512:
-  metadata.gz: 5e97ba8ab64e27924166609c1cb80e52dbfa8136b4248324a7589e143d64ebddbb415ad6c4c7a0e472732db55c717d14e08be47c7640efcb36029c80b10938ef
-  data.tar.gz: 2fd74f2b86946b79d07a1354a55b00444022838fcd4968a6a2f0dc15494f4c2d80d0ea06b1e0290b921e7f2242566a56fb8e9bd6bf03b5a88595871c91d08604
+  metadata.gz: 6ebb0d93413c0911487235584837f76f6409d66cc06a64ad9e7db7ec0a4ccca2694b9be363e02922bbf1c981d944a9772e6705190ad92b461252d7b57bf1e4b0
+  data.tar.gz: 6f29640122bf11c098050476e60caa073ebb868a0859624d6e7b74df435e85a1d6ebbcf964840058c6978a42d16034d86341741caead66d99722554ffc2ca4a3

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

@@ -2,18 +2,12 @@
 
 ## Integration Tests
 
-Integration tests (feature specs) are run against a Docker image
-(antespi/docker-imap-devel:latest).
-
-In one shell, run the Docker image:
+Integration tests (feature specs) are run against a local IMAP server
+controlled by Docker Compose, which needs to be started
+before running the test suite.
 
 ```sh
-$ docker run \
-  --env MAIL_ADDRESS=address@example.org \
-  --env MAIL_PASS=pass \
-  --env MAILNAME=example.org \
-  --publish 8993:993 \
-  antespi/docker-imap-devel:latest
+$ docker-compose up -d
 ```
 
 ```sh
@@ -47,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

@@ -17,10 +17,6 @@ Gem::Specification.new do |gem|
   gem.files         += %w[imap-backup.gemspec]
   gem.files         += %w[LICENSE README.md]
 
-  gem.extra_rdoc_files += Dir.glob("README.md")
-  gem.extra_rdoc_files += Dir.glob("docs/*.md")
-  gem.rdoc_options = ["--main", "README.md"]
-
   gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = Dir.glob("spec/**/*{.rb,.yml}")
   gem.require_paths = ["lib"]
@@ -28,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/mboxrd/message.rb

@@ -1,9 +1,13 @@
+require "forwardable"
 require "mail"
 
 module Email; end
 
 module Email::Mboxrd
   class Message
+    extend Forwardable
+    def_delegators :@parsed, :subject
+
     attr_reader :supplied_body
 
     def self.from_serialized(serialized)
@@ -36,12 +40,12 @@ module Email::Mboxrd
       supplied_body.gsub(/(?<!\r)\n/, "\r\n")
     end
 
+    private
+
     def parsed
       @parsed ||= Mail.new(supplied_body)
     end
 
-    private
-
     def from
       @from ||=
         begin

data/lib/email/provider/apple_mail.rb

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

data/lib/email/provider/base.rb

@@ -0,0 +1,8 @@
+module Email; end
+class Email::Provider; end
+
+class Email::Provider::Base
+  def options
+    {port: 993, ssl: {ssl_version: :TLSv1_2}}
+  end
+end

data/lib/email/provider/fastmail.rb

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

data/lib/email/provider/gmail.rb

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

data/lib/email/provider/unknown.rb

@@ -0,0 +1,11 @@
+require "email/provider/base"
+
+class Email::Provider::Unknown < Email::Provider::Base
+  # 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.rb

@@ -1,37 +1,27 @@
+require "email/provider/apple_mail"
+require "email/provider/fastmail"
+require "email/provider/gmail"
+require "email/provider/unknown"
+
 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::Unknown.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/account.rb

@@ -0,0 +1,103 @@
+module Imap::Backup
+  class Account
+    attr_reader :username
+    attr_reader :password
+    attr_reader :local_path
+    attr_reader :folders
+    attr_reader :server
+    attr_reader :connection_options
+    attr_reader :changes
+    attr_reader :marked_for_deletion
+
+    def initialize(options)
+      @username = options[:username]
+      @password = options[:password]
+      @local_path = options[:local_path]
+      @folders = options[:folders]
+      @server = options[:server]
+      @connection_options = options[:connection_options]
+      @changes = {}
+      @marked_for_deletion = false
+    end
+
+    def valid?
+      username && password
+    end
+
+    def modified?
+      changes.any?
+    end
+
+    def clear_changes!
+      @changes = {}
+    end
+
+    def mark_for_deletion!
+      @marked_for_deletion = true
+    end
+
+    def marked_for_deletion?
+      @marked_for_deletion
+    end
+
+    def to_h
+      h = {
+        username: @username,
+        password: @password,
+      }
+      h[:local_path] = @local_path if @local_path
+      h[:folders] = @folders if @folders
+      h[:server] = @server if @server
+      h[:connection_options] = @connection_options if @connection_options
+      h
+    end
+
+    def username=(value)
+      update(:username, value)
+    end
+
+    def password=(value)
+      update(:password, value)
+    end
+
+    def local_path=(value)
+      update(:local_path, value)
+    end
+
+    def folders=(value)
+      raise "folders must be an Array" if !value.is_a?(Array)
+      update(:folders, value)
+    end
+
+    def server=(value)
+      update(:server, value)
+    end
+
+    def connection_options=(value)
+      parsed = JSON.parse(value)
+      update(:connection_options, parsed)
+    end
+
+    private
+
+    def update(field, value)
+      if changes[field]
+        change = changes[field]
+        if change[:from] == value
+          changes.delete(field)
+        else
+          set_field!(field, value)
+        end
+      else
+        set_field!(field, value)
+      end
+    end
+
+    def set_field!(field, value)
+      key = :"@#{field}"
+      current = instance_variable_get(key)
+      changes[field] = {from: current, to: value}
+      instance_variable_set(key, value)
+    end
+  end
+end

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

@@ -5,6 +5,20 @@ module Imap::Backup::CLI::Helpers
     options.each.with_object({}) { |(k, v), acc| acc[k.intern] = v }
   end
 
+  def account(email)
+    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
+
+  def connection(email)
+    account = account(email)
+
+    Imap::Backup::Account::Connection.new(account)
+  end
+
   def each_connection(names)
     begin
       connections = Imap::Backup::Configuration::List.new(names)

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

@@ -6,49 +6,46 @@ module Imap::Backup
     desc "accounts", "List locally backed-up accounts"
     def accounts
       connections = Imap::Backup::Configuration::List.new
-      connections.accounts.each { |a| puts a[:username] }
+      connections.accounts.each { |a| Kernel.puts a[:username] }
     end
 
     desc "folders EMAIL", "List account folders"
     def folders(email)
-      connections = Imap::Backup::Configuration::List.new
-      account = connections.accounts.find { |a| a[:username] == email }
-      raise "#{email} is not a configured account" if !account
+      connection = connection(email)
 
-      account_connection = Imap::Backup::Account::Connection.new(account)
-      account_connection.local_folders.each do |_s, f|
-        puts %("#{f.name}")
+      connection.local_folders.each do |_s, f|
+        Kernel.puts %("#{f.name}")
       end
     end
 
     desc "list EMAIL FOLDER", "List emails in a folder"
     def list(email, folder_name)
-      connections = Imap::Backup::Configuration::List.new
-      account = connections.accounts.find { |a| a[:username] == email }
-      raise "#{email} is not a configured account" if !account
+      connection = connection(email)
 
-      account_connection = Imap::Backup::Account::Connection.new(account)
-      folder_serializer, _folder = account_connection.local_folders.find do |(_s, f)|
+      folder_serializer, _folder = connection.local_folders.find do |(_s, f)|
         f.name == folder_name
       end
       raise "Folder '#{folder_name}' not found" if !folder_serializer
 
       max_subject = 60
-      puts format("%-10<uid>s  %-#{max_subject}<subject>s - %<date>s", {uid: "UID", subject: "Subject", date: "Date"})
-      puts "-" * (12 + max_subject + 28)
+      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
 
       folder_serializer.each_message(uids).map do |uid, message|
         m = {
           uid: uid,
-          date: message.parsed.date.to_s,
-          subject: message.parsed.subject || ""
+          date: message.date.to_s,
+          subject: message.subject || ""
         }
         if m[:subject].length > max_subject
-          puts format("% 10<uid>u: %.#{max_subject - 3}<subject>s... - %<date>s", m)
+          Kernel.puts format("% 10<uid>u: %.#{max_subject - 3}<subject>s... - %<date>s", m)
         else
-          puts format("% 10<uid>u: %-#{max_subject}<subject>s - %<date>s", m)
+          Kernel.puts format("% 10<uid>u: %-#{max_subject}<subject>s - %<date>s", m)
         end
       end
     end
@@ -60,12 +57,9 @@ module Imap::Backup
       the UID.
     DESC
     def show(email, folder_name, uids)
-      connections = Imap::Backup::Configuration::List.new
-      account = connections.accounts.find { |a| a[:username] == email }
-      raise "#{email} is not a configured account" if !account
+      connection = connection(email)
 
-      account_connection = Imap::Backup::Account::Connection.new(account)
-      folder_serializer, _folder = account_connection.local_folders.find do |(_s, f)|
+      folder_serializer, _folder = connection.local_folders.find do |(_s, f)|
         f.name == folder_name
       end
       raise "Folder '#{folder_name}' not found" if !folder_serializer
@@ -73,13 +67,13 @@ module Imap::Backup
       uid_list = uids.split(",")
       folder_serializer.each_message(uid_list).each do |uid, message|
         if uid_list.count > 1
-          puts <<~HEADER
+          Kernel.puts <<~HEADER
             #{'-' * 80}
             #{format('| UID: %-71s |', uid)}
             #{'-' * 80}
           HEADER
         end
-        puts message.supplied_body
+        Kernel.puts message.supplied_body
       end
     end
   end