imap-backup 16.1.0 → 16.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf6997d289ca5babbecd35e683ede921273300779f3f7dac95e247c0478f1814
-  data.tar.gz: '009892c47699a0cc94ff28c2d3ea7346915732b7dc86c7231b7e606302219888'
+  metadata.gz: 1dbb91a882b2679944560fe5d0f16fd11b59dce626386626d151463a8354a981
+  data.tar.gz: 7b57013410b24ed4625a0405cc9b950f6cdf528e5d50d51b2919a81048f92947
 SHA512:
-  metadata.gz: 46bdbccf9be3efade25e500f6c67f37de4fc0a0aa8514b55f8eabf7e1171042b5be87d029f37d9cb449c23d1fcf0d5fd2a20c2e8595c6149eff0c20f89e6b3d3
-  data.tar.gz: d507a668897c325e2cc771d69b083f9929247b839b55d1fe86bfaeac3ee8be40df43b9f634d4f97c0188fe3bcbfba666456a9131236103455020fb45ecec9d61
+  metadata.gz: '04508eb2303ed44b9fdd8cd361958ed66eb5279a91dc310e10e404432a9e504094b4ff2d3972a645dc35ea2eff47f79f408466e3cf23cf6ac761ef1e5d3601fe'
+  data.tar.gz: a96050615e046863111e79a3350c38dc3d6e3e05f7be967fdd5003e295c1d896f07b48d0aad719c0d2571f0f7aa315833f343bb7b0432c0e3cef556f915b1cfc

data/docs/performance.md

@@ -43,7 +43,7 @@ By default, during backup, each message is downloaded one-by-one.
 Using this setting, you can download chunks of emails at a time,
 potentially speeding up the process.
 
-Using multi-fetch mean that the backup process *will* use
+Using multi-fetch means that the backup process *will* use
 more memory - equivalent to the size of the groups of messages
 that are downloaded.
 

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

@@ -196,7 +196,9 @@ module Imap::Backup
     def extract_uid(response)
       uid_data = response.data.code.data
       @uid_validity = uid_data.uidvalidity
-      uid_data.assigned_uids.first
+      # With net-imap >= 0.6, assigned_uids is a `Net::IMAP::SequenceSet`
+      uids = uid_data.assigned_uids.to_a
+      uids.to_a.first
     end
 
     def utf7_encoded_name

data/lib/imap/backup/account.rb

@@ -44,7 +44,7 @@ module Imap::Backup
     # The name of the download strategy to adopt during backups
     # @return [String]
     attr_accessor :download_strategy
-    # Should 'Seen' flags be cached before fetchiong emails and
+    # Should 'Seen' flags be cached before fetching emails and
     # rewritten to the server afterwards?
     #
     # Some IMAP providers, notably Apple Mail, set the '\Seen' flag
@@ -57,6 +57,12 @@ module Imap::Backup
     # mark messages as '\Seen' when accessed).
     # @return [Boolean]
     attr_reader :reset_seen_flags_after_fetch
+    # The status of the account - controls backup and migration behaviour
+    # "active" - the account is available for backup and migration,
+    # "archived" - the account is available for migration, but not backup,
+    # "offline" - the account is not available for backup or migration.
+    # @return [String] one of "active" (the default), "archived", or "offline"
+    attr_reader :status
 
     def initialize(options)
       check_options!(options)
@@ -72,6 +78,7 @@ module Imap::Backup
       @download_strategy = options[:download_strategy]
       @multi_fetch_size_orignal = options[:multi_fetch_size]
       @reset_seen_flags_after_fetch = options[:reset_seen_flags_after_fetch]
+      @status = options[:status] || DEFAULT_STATUS
       @client = nil
       @changes = {}
       @marked_for_deletion = false
@@ -122,7 +129,11 @@ module Imap::Backup
 
     # @return [Hash] all Account data for serialization
     def to_h
-      h = {username: @username, password: @password}
+      h = {
+        username: @username,
+        password: @password,
+        status: status
+      }
       h[:local_path] = @local_path if @local_path
       h[:folders] = @folders if @folders
       h[:folder_blacklist] = true if @folder_blacklist
@@ -230,6 +241,44 @@ module Imap::Backup
       update(:reset_seen_flags_after_fetch, value)
     end
 
+    # Sets the status attribute and marks it as modified, storing the original value
+    #
+    # @param value [String] one of "active", "archived", or "offline"
+    # @raise [ArgumentError] if the value is not a valid status
+    # @return [void]
+    def status=(value)
+      if !VALID_STATUSES.include?(value)
+        raise ArgumentError, "status must be one of: #{VALID_STATUSES.join(', ')}"
+      end
+
+      update(:status, value)
+    end
+
+    # @return [Boolean] true if the account is active
+    def active?
+      @status == "active"
+    end
+
+    # @return [Boolean] true if the account is archived
+    def archived?
+      @status == "archived"
+    end
+
+    # @return [Boolean] true if the account is offline
+    def offline?
+      @status == "offline"
+    end
+
+    # @return [Boolean] true if the account is available for backup operations
+    def available_for_backup?
+      active?
+    end
+
+    # @return [Boolean] true if the account is available for migration operations
+    def available_for_migration?
+      active? || archived?
+    end
+
     private
 
     attr_reader :changes
@@ -237,9 +286,11 @@ module Imap::Backup
     REQUIRED_ATTRIBUTES = %i[password username].freeze
     OPTIONAL_ATTRIBUTES = %i[
       connection_options download_strategy folders folder_blacklist local_path mirror_mode
-      multi_fetch_size reset_seen_flags_after_fetch server
+      multi_fetch_size reset_seen_flags_after_fetch server status
     ].freeze
     KNOWN_ATTRIBUTES = REQUIRED_ATTRIBUTES + OPTIONAL_ATTRIBUTES
+    VALID_STATUSES = %w[active archived offline].freeze
+    DEFAULT_STATUS = "active".freeze
 
     def check_options!(options)
       missing_required = REQUIRED_ATTRIBUTES - options.keys

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

@@ -28,6 +28,8 @@ module Imap::Backup
         config = load_config(**options)
         exit_code = nil
         accounts = requested_accounts(config)
+        # Filter to only include accounts available for backup
+        accounts = accounts.select(&:available_for_backup?)
         if accounts.none?
           Logger.logger.warn "No matching accounts found to backup"
           return

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

@@ -1,3 +1,6 @@
+require "erb"
+require "json"
+require "tempfile"
 require "thor"
 
 require "imap/backup/cli/options"
@@ -19,7 +22,7 @@ module Imap::Backup
     # @return [String] a description of the namespace configuration
     NAMESPACE_CONFIGURATION_DESCRIPTION = <<~DESC.freeze
       Some IMAP servers use namespaces (i.e. prefixes like "INBOX"),
-      while others, while others concatenate the names of subfolders
+      while others concatenate the names of subfolders
       with a charater ("delimiter") other than "/".
 
       In these cases there are two choices.
@@ -60,9 +63,24 @@ module Imap::Backup
 
     # Loads the application configuration
     # @raise [ConfigurationNotFound] if the configuration file does not exist
+    # @raise [RuntimeError] if both config and erb_configuration are provided
+    # @raise [RuntimeError] if ERB template has syntax errors
+    # @raise [RuntimeError] if ERB template renders invalid JSON
     # @return [Configuration]
     def load_config(**options)
-      path = options[:config]
+      config_path = options[:config]
+      erb_config_path = options[:erb_configuration]
+
+      # Check mutual exclusivity
+      if config_path && erb_config_path
+        raise "Cannot specify both --config and --erb-configuration options"
+      end
+
+      # Handle ERB configuration
+      return load_erb_config(erb_config_path, options) if erb_config_path
+
+      # Handle regular JSON configuration
+      path = config_path
       require_exists = options.key?(:require_exists) ? options[:require_exists] : true
       if require_exists
         exists = Configuration.exist?(path: path)
@@ -94,5 +112,54 @@ module Imap::Backup
         config.accounts
       end
     end
+
+    private
+
+    # Processes an ERB template and loads it as configuration
+    # @raise [ConfigurationNotFound] if the ERB file does not exist
+    # @raise [RuntimeError] if ERB processing fails
+    # @raise [RuntimeError] if rendered output is invalid JSON
+    # @return [Configuration]
+    def load_erb_config(erb_path, _options)
+      # Check if file exists
+      unless File.exist?(erb_path)
+        raise ConfigurationNotFound, "ERB configuration file '#{erb_path}' not found"
+      end
+
+      begin
+        # Read and process ERB template
+        erb_content = File.read(erb_path)
+        erb = ERB.new(erb_content)
+        rendered_json = erb.result
+      rescue SyntaxError => e
+        raise "ERB template has syntax error: #{e.message}"
+      rescue StandardError => e
+        raise "Error processing ERB template: #{e.message}"
+      end
+
+      # Validate rendered JSON
+      begin
+        JSON.parse(rendered_json)
+      rescue JSON::ParserError => e
+        raise "ERB template rendered invalid JSON: #{e.message}"
+      end
+
+      # Create temporary file with rendered JSON
+      temp_file = Tempfile.new(["config", ".json"])
+      begin
+        temp_file.write(rendered_json)
+        temp_file.flush
+        temp_file.close
+
+        # Load configuration from temporary file
+        config = Configuration.new(path: temp_file.path)
+        # Force loading of data before temp file is deleted
+        config.accounts
+        config
+      ensure
+        # Clean up temporary file
+        temp_file&.unlink
+      end
+    end
   end
 end

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

@@ -17,6 +17,7 @@ module Imap::Backup
 
     desc "accounts [OPTIONS]", "List locally backed-up accounts"
     config_option
+    erb_configuration_option
     format_option
     quiet_option
     verbose_option
@@ -44,6 +45,7 @@ module Imap::Backup
     )
     accounts_option
     config_option
+    erb_configuration_option
     format_option
     quiet_option
     verbose_option
@@ -56,6 +58,7 @@ module Imap::Backup
 
     desc "folders EMAIL [OPTIONS]", "List backed up folders"
     config_option
+    erb_configuration_option
     format_option
     quiet_option
     verbose_option
@@ -78,6 +81,7 @@ module Imap::Backup
 
     desc "list EMAIL FOLDER [OPTIONS]", "List emails in a folder"
     config_option
+    erb_configuration_option
     format_option
     quiet_option
     verbose_option
@@ -108,6 +112,7 @@ module Imap::Backup
       the UID.
     DESC
     config_option
+    erb_configuration_option
     format_option
     quiet_option
     verbose_option

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

@@ -31,6 +31,7 @@ module Imap::Backup
         )
         long_desc LONG_DESCRIPTION
         config_option
+        erb_configuration_option
         quiet_option
         verbose_option
         method_option(

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

@@ -38,6 +38,7 @@ module Imap::Backup
         )
         long_desc LONG_DESCRIPTION
         config_option
+        erb_configuration_option
         quiet_option
         verbose_option
         method_option(

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

@@ -25,6 +25,19 @@ module Imap::Backup
           desc: "supply the configuration file path (default: ~/.imap-backup/config.json)"
         }
       },
+      {
+        name: "erb_configuration",
+        parameters: {
+          type: :string,
+          desc:
+          "supply an ERB template file path for configuration. " \
+          "This is an alternative to the --config option. " \
+          "The file will be processed with ERB before being parsed as JSON. " \
+          "This allows use of environment variables and other dynamic content. " \
+          "Note that using this option is a potential security risk as it allows " \
+          "execution of arbitrary code."
+        }
+      },
       {
         name: "format",
         parameters: {

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

@@ -15,6 +15,7 @@ module Imap::Backup
 
     desc "folders EMAIL [OPTIONS]", "List account folders"
     config_option
+    erb_configuration_option
     format_option
     quiet_option
     verbose_option
@@ -36,6 +37,7 @@ module Imap::Backup
       Lists the IMAP capabilities supported by the IMAP server.
     DESC
     config_option
+    erb_configuration_option
     format_option
     quiet_option
     verbose_option
@@ -57,6 +59,7 @@ module Imap::Backup
       the `imap-backup migrate` and `imap-backup mirror` commands.
     DESC
     config_option
+    erb_configuration_option
     format_option
     quiet_option
     verbose_option

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

@@ -105,7 +105,7 @@ module Imap::Backup
       type: "string",
       desc: "the path of the directory where backups are to be saved. " \
             "If the directory does not exist, it will be created. " \
-            "If not set, this is set to a diretory under the current path " \
+            "If not set, this is set to a directory under the current path " \
             "which is derived from the username, by replacing '@' with '_'." \
             "If this path parameter is not indicated, " \
             "the default is the current directory plus the email " \

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

@@ -88,6 +88,16 @@ module Imap::Backup
       raise "Account '#{destination_email}' does not exist" if !destination_account
 
       raise "Account '#{source_email}' does not exist" if !source_account
+
+      if !source_account.available_for_migration?
+        raise "Account '#{source_email}' is not available for migration " \
+              "(status: #{source_account.status})"
+      end
+
+      return if destination_account.available_for_migration?
+
+      raise "Account '#{destination_email}' is not available for migration " \
+            "(status: #{destination_account.status})"
     end
 
     def choose_prefixes_and_delimiters!

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

@@ -23,6 +23,7 @@ module Imap::Backup
       "Skip downloading emails up to today for all configured folders"
     )
     config_option
+    erb_configuration_option
     quiet_option
     verbose_option
     # Creates fake downloaded emails so that only the account's future emails
@@ -52,6 +53,7 @@ module Imap::Backup
       DOC
     )
     config_option
+    erb_configuration_option
     quiet_option
     verbose_option
     method_option(

data/lib/imap/backup/cli.rb

@@ -64,6 +64,7 @@ module Imap::Backup
     DESC
     accounts_option
     config_option
+    erb_configuration_option
     quiet_option
     refresh_option
     verbose_option
@@ -101,6 +102,7 @@ module Imap::Backup
       #{Helpers::NAMESPACE_CONFIGURATION_DESCRIPTION}
     DESC
     config_option
+    erb_configuration_option
     quiet_option
     verbose_option
     method_option(
@@ -153,6 +155,7 @@ module Imap::Backup
     DESC
     accounts_option
     config_option
+    erb_configuration_option
     quiet_option
     verbose_option
     method_option(
@@ -203,6 +206,7 @@ module Imap::Backup
         on the server).
     DESC
     config_option
+    erb_configuration_option
     format_option
     quiet_option
     verbose_option

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

@@ -30,7 +30,8 @@ module Imap::Backup
         path,
         folders,
         multi_fetch,
-        reset_seen_flags_after_fetch
+        reset_seen_flags_after_fetch,
+        status_row
       ].compact
 
       menu.header = <<~HEADER.chomp
@@ -127,6 +128,12 @@ module Imap::Backup
       ["changes to unread flags will be reset during download"]
     end
 
+    def status_row
+      return nil if account.status == "active"
+
+      ["status", account.status]
+    end
+
     def format_rows(rows)
       largest_label, _value = rows.max_by do |(label, value)|
         if value

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

@@ -56,6 +56,7 @@ module Imap::Backup
         choose_folders menu
         modify_multi_fetch_size menu
         toggle_reset_seen_flags_after_fetch menu
+        rotate_status menu
         delete_account menu
         menu.choice("(q) return to main menu") { throw :done }
         menu.hidden("quit") { throw :done }
@@ -151,6 +152,19 @@ module Imap::Backup
       end
     end
 
+    def rotate_status(menu)
+      current_status = account.status
+      statuses = %w[active archived offline]
+      current_index = statuses.index(current_status) || 0
+      next_index = (current_index + 1) % statuses.length
+      next_status = statuses[next_index]
+
+      menu_item = "change status (currently: #{current_status} -> #{next_status})"
+      menu.choice(menu_item) do
+        account.status = next_status
+      end
+    end
+
     def test_connection(menu)
       menu.choice("test connection") do
         result = Setup::ConnectionTester.new(account).test

data/lib/imap/backup/version.rb

@@ -4,7 +4,7 @@ module Imap::Backup
   # @private
   MAJOR    = 16
   # @private
-  MINOR    = 1
+  MINOR    = 3
   # @private
   REVISION = 0
   # @private

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: imap-backup
 version: !ruby/object:Gem::Version
-  version: 16.1.0
+  version: 16.3.0
 platform: ruby
 authors:
 - Joe Yates
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-08-02 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -248,7 +247,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -263,8 +261,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Backup GMail (or other IMAP) accounts to disk
 test_files: []