imap-backup 7.0.2 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb709e6431c47afc24c55d39ef7d9213fc0c27b42929c0692843a254cfd83c1d
-  data.tar.gz: 702d93af210afa826e64c0b5b1a4d1e16780c6078201e4a8db13dd4703ac62d3
+  metadata.gz: ccb9808337c50af0fe59f2cdc85dedcbab50b5b0980a60e2ccf10fc3734b9f37
+  data.tar.gz: e0b67bd5bfb040220f54c9a662c90ad545fce9c84a5fadaf6d93a485ac865ffc
 SHA512:
-  metadata.gz: 04a0c173fea0dd80e87443db040383402eb9eacbc7f557b4db8339cfd16c20153b068da8f4ade84d82643e3e9d3b9a76f04d654cbbc931620ef197546b24492a
-  data.tar.gz: e3cb1c12f73c421a66e41016b826ecdf3d199fd5920f9e5cbb04e0ef41619984791c8ce436283a91e6264707b04db7ecef94703f5df9af4c64cbcbb75c0fd7d7
+  metadata.gz: 4070e85e86a627a0791924cba209d044dd71fd54a7d0d79a7c34b9aade4d4827ae020ed3a78d5e4169d0d8aa188ce34741f5a6a44d4f0ae1b035e6bbead30df8
+  data.tar.gz: b20ac83f5bffea68ab4dd3ae12fcef6df78cb20aab136864ba97e23ddaa414fe344e122d430bf1de242e393e50ccef916ee4e1fba77353836aee9e148c5a3da8

data/README.md

@@ -70,7 +70,6 @@ Alternatively, add it to your crontab.
 # Commands
 
 * [backup](docs/commands/backup.md)
-* [folders](docs/commands/folders.md)
 * [local accounts](docs/commands/local-accounts.md)
 * [local folders](docs/commands/local-folders.md)
 * [local list](docs/commands/local-list.md)
@@ -80,7 +79,6 @@ Alternatively, add it to your crontab.
 * [remote folders](docs/commands/remote-folders.md)
 * [restore](docs/commands/restore.md)
 * [setup](docs/commands/setup.md)
-* [status](docs/commands/status.md)
 * [utils export-to-thunderbird](docs/commands/utils-export-to-thunderbird.md)
 * [utils ignore-history](docs/commands/utils-ignore-history.md)
 
@@ -105,4 +103,8 @@ If you have problems:
 
 # Development
 
-See the [Development documentation](./docs/development.md)
+See the [Development documentation](./docs/development.md) for notes
+on development and testing.
+
+See [the CHANGELOG](./CHANGELOG.md) to a list of changes that have been
+made in each release.

data/docs/configuration.md

@@ -1,6 +1,6 @@
 Configuration is stored in a JSON file.
 
-The format is documented [here](./docs/files/config.json).
+The format is documented [here](files/config.md).
 
 # Folders
 
@@ -11,6 +11,8 @@ specific folders.
 
 You can override the parameters passed to `Net::IMAP` with `connection_options`.
 
+See the Ruby Standard Library documentation for `Net::IMAP` of details of [supported parameters](https://ruby-doc.org/stdlib-3.1.2/libdoc/net-imap/rdoc/Net/IMAP.html#method-c-new).
+
 Specifically, if you are using a self-signed certificate and get SSL errors, e.g.
 `certificate verify failed`, you can choose to not verify the TLS connection.
 

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

@@ -12,16 +12,26 @@ module Imap::Backup
     end
 
     def run
+      all_names = Account::Connection::FolderNames.new(client: client, account: account).run
+
       names =
         if account.folders&.any?
           account.folders.map { |af| af[:name] }
         else
-          Account::Connection::FolderNames.new(client: client, account: account).run
+          all_names
         end
 
-      names.map do |name|
+      all_names.map do |name|
+        backup =
+          if account.folder_blacklist
+            !names.include?(name)
+          else
+            names.include?(name)
+          end
+        next if !backup
+
         Account::Folder.new(account.connection, name)
-      end
+      end.compact
     end
   end
 end

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

@@ -27,12 +27,8 @@ module Imap::Backup
         Account::Connection::BackupFolders.new(client: client, account: account).run
     end
 
-    def status
-      ensure_account_folder
-      backup_folders.map do |folder|
-        s = Serializer.new(account.local_path, folder.name)
-        {name: folder.name, local: s.uids, remote: folder.uids}
-      end
+    def namespaces
+      client.namespace
     end
 
     def run_backup(refresh: false)

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

@@ -100,24 +100,24 @@ module Imap::Backup
     end
 
     def delete_multi(uids)
-      set_flags(uids, [:Deleted])
+      add_flags(uids, [:Deleted])
       client.expunge
     end
 
-    def apply_flags(uids, flags)
+    def set_flags(uids, flags)
       client.select(utf7_encoded_name)
       flags.reject! { |f| f == :Recent }
       client.uid_store(uids, "FLAGS", flags)
     end
 
-    def set_flags(uids, flags)
+    def add_flags(uids, flags)
       # Use read-write access, via `select`
       client.select(utf7_encoded_name)
       flags.reject! { |f| f == :Recent }
       client.uid_store(uids, "+FLAGS", flags)
     end
 
-    def unset_flags(uids, flags)
+    def remove_flags(uids, flags)
       client.select(utf7_encoded_name)
       client.uid_store(uids, "-FLAGS", flags)
     end
@@ -126,7 +126,7 @@ module Imap::Backup
       existing = uids
       return if existing.empty?
 
-      set_flags(existing, [:Deleted])
+      add_flags(existing, [:Deleted])
       client.expunge
     end
 

data/lib/imap/backup/account.rb

@@ -8,6 +8,7 @@ module Imap::Backup
     attr_reader :password
     attr_reader :local_path
     attr_reader :folders
+    attr_reader :folder_blacklist
     attr_reader :mirror_mode
     attr_reader :server
     attr_reader :connection_options
@@ -19,6 +20,7 @@ module Imap::Backup
       @password = options[:password]
       @local_path = options[:local_path]
       @folders = options[:folders]
+      @folder_blacklist = options[:folder_blacklist]
       @mirror_mode = options[:mirror_mode]
       @server = options[:server]
       @connection_options = options[:connection_options]
@@ -57,6 +59,7 @@ module Imap::Backup
       h = {username: @username, password: @password}
       h[:local_path] = @local_path if @local_path
       h[:folders] = @folders if @folders
+      h[:folder_blacklist] = true if @folder_blacklist
       h[:mirror_mode] = true if @mirror_mode
       h[:server] = @server if @server
       h[:connection_options] = @connection_options if @connection_options
@@ -85,6 +88,10 @@ module Imap::Backup
       update(:folders, value)
     end
 
+    def folder_blacklist=(value)
+      update(:folder_blacklist, value)
+    end
+
     def mirror_mode=(value)
       update(:mirror_mode, value)
     end
@@ -94,7 +101,12 @@ module Imap::Backup
     end
 
     def connection_options=(value)
-      parsed = JSON.parse(value, symbolize_names: true)
+      parsed =
+        if value == ""
+          nil
+        else
+          JSON.parse(value, symbolize_names: true)
+        end
       update(:connection_options, parsed)
     end
 

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

@@ -3,21 +3,28 @@ module Imap::Backup
     include Thor::Actions
     include CLI::Helpers
 
-    attr_reader :account_names
-    attr_reader :refresh
+    attr_reader :options
 
     def initialize(options)
       super([])
-      @account_names = (options[:accounts] || "").split(",")
-      @refresh = options.key?(:refresh) ? !!options[:refresh] : false
+      @options = options
     end
 
     no_commands do
       def run
-        each_connection(account_names) do |connection|
+        config = load_config(**options)
+        each_connection(config, emails) do |connection|
           connection.run_backup(refresh: refresh)
         end
       end
+
+      def emails
+        (options[:accounts] || "").split(",")
+      end
+
+      def refresh
+        options.key?(:refresh) ? !!options[:refresh] : false
+      end
     end
   end
 end

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

@@ -1,16 +1,24 @@
 require "imap/backup"
-require "imap/backup/cli/accounts"
 
 module Imap::Backup
   module CLI::Helpers
     def self.included(base)
       base.class_eval do
-        def self.verbose_option
+        def self.config_option
           method_option(
-            "verbose",
-            type: :boolean,
-            desc: "increase the amount of logging",
-            aliases: ["-v"]
+            "config",
+            type: :string,
+            desc: "supply the configuration file path (default: ~/.imap-backup/config.json)",
+            aliases: ["-c"]
+          )
+        end
+
+        def self.format_option
+          method_option(
+            "format",
+            type: :string,
+            desc: "the output type, 'text' for plain text or 'json'",
+            aliases: ["-f"]
           )
         end
 
@@ -22,34 +30,64 @@ module Imap::Backup
             aliases: ["-q"]
           )
         end
+
+        def self.verbose_option
+          method_option(
+            "verbose",
+            type: :boolean,
+            desc: "increase the amount of logging",
+            aliases: ["-v"]
+          )
+        end
       end
     end
 
-    def symbolized(options)
-      options.each.with_object({}) do |(k, v), acc|
-        key = k.gsub("-", "_").intern
-        acc[key] = v
+    def options
+      @symbolized_options ||= # rubocop:disable Naming/MemoizedInstanceVariableName
+        begin
+          options = super()
+          options.each.with_object({}) do |(k, v), acc|
+            key =
+              if k.is_a?(String)
+                k.gsub("-", "_").intern
+              else
+                k
+              end
+            acc[key] = v
+          end
+        end
+    end
+
+    def load_config(**options)
+      path = options[:config]
+      require_exists = options.key?(:require_exists) ? options[:require_exists] : true
+      if require_exists
+        exists = Configuration.exist?(path: path)
+        if !exists
+          expected = path || Configuration.default_pathname
+          raise ConfigurationNotFound, "Configuration file '#{expected}' not found"
+        end
       end
+      Configuration.new(path: path)
     end
 
-    def account(email)
-      accounts = CLI::Accounts.new
-      account = accounts.find { |a| a.username == email }
+    def account(config, email)
+      account = config.accounts.find { |a| a.username == email }
       raise "#{email} is not a configured account" if !account
 
       account
     end
 
-    def connection(email)
-      account = account(email)
+    def connection(config, email)
+      account = account(config, email)
 
       Account::Connection.new(account)
     end
 
-    def each_connection(names)
-      accounts = CLI::Accounts.new(names)
+    def each_connection(config, names)
+      config.accounts.each do |account|
+        next if names.any? && !names.include?(account.username)
 
-      accounts.each do |account|
         yield account.connection
       end
     rescue ConfigurationNotFound

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

@@ -1,5 +1,3 @@
-require "imap/backup/cli/accounts"
-
 module Imap::Backup
   class CLI::Local < Thor
     include Thor::Actions
@@ -8,39 +6,56 @@ module Imap::Backup
     MAX_SUBJECT = 60
 
     desc "accounts", "List locally backed-up accounts"
+    config_option
+    format_option
     def accounts
-      accounts = CLI::Accounts.new
-      accounts.each { |a| Kernel.puts a.username }
+      config = load_config(**options)
+      names = config.accounts.map(&:username)
+      case options[:format]
+      when "json"
+        list = names.map { |n| {username: n} }
+        Kernel.puts list.to_json
+      else
+        names.each { |n| Kernel.puts n }
+      end
     end
 
     desc "folders EMAIL", "List backed up folders"
+    config_option
+    format_option
     def folders(email)
-      connection = connection(email)
+      config = load_config(**options)
+      connection = connection(config, email)
 
-      connection.local_folders.each do |_s, f|
-        Kernel.puts %("#{f.name}")
+      folders = connection.local_folders
+      case options[:format]
+      when "json"
+        list = folders.map { |_s, f| {name: f.name} }
+        Kernel.puts list.to_json
+      else
+        folders.each do |_s, f|
+          Kernel.puts %("#{f.name}")
+        end
       end
     end
 
     desc "list EMAIL FOLDER", "List emails in a folder"
+    config_option
+    format_option
     def list(email, folder_name)
-      connection = connection(email)
+      config = load_config(**options)
+      connection = connection(config, email)
 
-      folder_serializer, _folder = connection.local_folders.find do |(_s, f)|
+      serializer, _folder = connection.local_folders.find do |(_s, f)|
         f.name == folder_name
       end
-      raise "Folder '#{folder_name}' not found" if !folder_serializer
-
-      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
+      raise "Folder '#{folder_name}' not found" if !serializer
 
-      folder_serializer.each_message(uids).map do |message|
-        list_message message
+      case options[:format]
+      when "json"
+        list_emails_as_json serializer
+      else
+        list_emails_as_text serializer
       end
     end
 
@@ -50,29 +65,52 @@ module Imap::Backup
       If more than one UID is given, they are separated by a header indicating
       the UID.
     DESC
+    config_option
+    format_option
     def show(email, folder_name, uids)
-      connection = connection(email)
+      config = load_config(**options)
+      connection = connection(config, email)
 
-      folder_serializer, _folder = connection.local_folders.find do |(_s, f)|
+      serializer, _folder = connection.local_folders.find do |(_s, f)|
         f.name == folder_name
       end
-      raise "Folder '#{folder_name}' not found" if !folder_serializer
+      raise "Folder '#{folder_name}' not found" if !serializer
 
       uid_list = uids.split(",")
-      folder_serializer.each_message(uid_list).each do |message|
-        if uid_list.count > 1
-          Kernel.puts <<~HEADER
-            #{'-' * 80}
-            #{format('| UID: %-71s |', message.uid)}
-            #{'-' * 80}
-          HEADER
-        end
-        Kernel.puts message.body
+
+      case options[:format]
+      when "json"
+        show_emails_as_json serializer, uid_list
+      else
+        show_emails_as_text serializer, uid_list
       end
     end
 
     no_commands do
-      def list_message(message)
+      def list_emails_as_json(serializer)
+        emails = serializer.each_message.map do |message|
+          {
+            uid: message.uid,
+            date: message.date.to_s,
+            subject: message.subject || ""
+          }
+        end
+        Kernel.puts emails.to_json
+      end
+
+      def list_emails_as_text(serializer)
+        Kernel.puts format(
+          "%-10<uid>s  %-#{MAX_SUBJECT}<subject>s - %<date>s",
+          {uid: "UID", subject: "Subject", date: "Date"}
+        )
+        Kernel.puts "-" * (12 + MAX_SUBJECT + 28)
+
+        serializer.each_message.map do |message|
+          list_message_as_text message
+        end
+      end
+
+      def list_message_as_text(message)
         m = {
           uid: message.uid,
           date: message.date.to_s,
@@ -84,6 +122,26 @@ module Imap::Backup
           Kernel.puts format("% 10<uid>u: %-#{MAX_SUBJECT}<subject>s - %<date>s", m)
         end
       end
+
+      def show_emails_as_json(serializer, uids)
+        emails = serializer.each_message(uids).map do |m|
+          m.to_h.tap { |h| h[:body] = m.body }
+        end
+        Kernel.puts emails.to_json
+      end
+
+      def show_emails_as_text(serializer, uids)
+        serializer.each_message(uids).each do |message|
+          if uids.count > 1
+            Kernel.puts <<~HEADER
+              #{'-' * 80}
+              #{format('| UID: %-71s |', message.uid)}
+              #{'-' * 80}
+            HEADER
+          end
+          Kernel.puts message.body
+        end
+      end
     end
   end
 end

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

@@ -3,9 +3,11 @@ require "imap/backup/migrator"
 module Imap::Backup
   class CLI::Migrate < Thor
     include Thor::Actions
+    include CLI::Helpers
 
     attr_reader :destination_email
     attr_reader :destination_prefix
+    attr_reader :config_path
     attr_reader :reset
     attr_reader :source_email
     attr_reader :source_prefix
@@ -13,6 +15,7 @@ module Imap::Backup
     def initialize(
       source_email,
       destination_email,
+      config: nil,
       destination_prefix: "",
       reset: false,
       source_prefix: ""
@@ -20,6 +23,7 @@ module Imap::Backup
       super([])
       @destination_email = destination_email
       @destination_prefix = destination_prefix
+      @config_path = config
       @reset = reset
       @source_email = source_email
       @source_prefix = source_prefix
@@ -44,7 +48,7 @@ module Imap::Backup
       end
 
       def config
-        Configuration.new
+        @config ||= load_config(config: config_path)
       end
 
       def destination_account

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

@@ -3,21 +3,25 @@ require "imap/backup/mirror"
 module Imap::Backup
   class CLI::Mirror < Thor
     include Thor::Actions
+    include CLI::Helpers
 
     attr_reader :destination_email
     attr_reader :destination_prefix
+    attr_reader :config_path
     attr_reader :source_email
     attr_reader :source_prefix
 
     def initialize(
       source_email,
       destination_email,
+      config: nil,
       destination_prefix: "",
       source_prefix: ""
     )
       super([])
       @destination_email = destination_email
       @destination_prefix = destination_prefix
+      @config_path = config
       @source_email = source_email
       @source_prefix = source_prefix
     end
@@ -27,7 +31,7 @@ module Imap::Backup
         check_accounts!
         warn_if_source_account_is_not_in_mirror_mode
 
-        CLI::Backup.new(accounts: source_email).run
+        CLI::Backup.new(config: config_path, accounts: source_email).run
 
         folders.each do |serializer, folder|
           Mirror.new(serializer, folder).run
@@ -54,7 +58,7 @@ module Imap::Backup
       end
 
       def config
-        Configuration.new
+        @config = load_config(config: config_path)
       end
 
       def destination_account