imap-backup 16.1.0 → 16.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf6997d289ca5babbecd35e683ede921273300779f3f7dac95e247c0478f1814
-  data.tar.gz: '009892c47699a0cc94ff28c2d3ea7346915732b7dc86c7231b7e606302219888'
+  metadata.gz: 773e831319b208a930da663eae601d32236281104f4712960bfdb42dbc9d7794
+  data.tar.gz: 0da5b5f25c8e89022b387f08e5a5bee101284067fa6c5b9db7b35c95890e92da
 SHA512:
-  metadata.gz: 46bdbccf9be3efade25e500f6c67f37de4fc0a0aa8514b55f8eabf7e1171042b5be87d029f37d9cb449c23d1fcf0d5fd2a20c2e8595c6149eff0c20f89e6b3d3
-  data.tar.gz: d507a668897c325e2cc771d69b083f9929247b839b55d1fe86bfaeac3ee8be40df43b9f634d4f97c0188fe3bcbfba666456a9131236103455020fb45ecec9d61
+  metadata.gz: ccd49d19ec804c70c5aaaadcc40129ad8fcccf129c8de01c2c9e74cec0068bd2268fe6ea4e79f1d313539069e727891da9d0fc16e91a9e64c2301b00248204d8
+  data.tar.gz: 92553f44cf28d9c3a19b4cc3ff63fbd5a2dae59056663e9222ba0481ac6768d77f91c33e6d2aec652e451fbc1a5c9ae8f3933fcc2b9d601a5d3ce04865720af3

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 behavior
+    # "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/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/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    = 2
   # @private
   REVISION = 0
   # @private

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imap-backup
 version: !ruby/object:Gem::Version
-  version: 16.1.0
+  version: 16.2.0
 platform: ruby
 authors:
 - Joe Yates
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-08-02 00:00:00.000000000 Z
+date: 2025-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline