imapcli 2.1.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0736f0dbe2cb473770fb5f92f0f37546b9f26a6e892bbca3c69b072c1f06db9f
-  data.tar.gz: '0609a383ac74799eb2aade3d52fa0c5c811fc5cb4b253f1607e0b6f2dbe7cf01'
+  metadata.gz: cf3da9229783f1c5eff9461b6062e36ae8d51eac5ce818a980425c25d9c5e431
+  data.tar.gz: b2a6c6476a95644f7a4a97e2f7da6120858d2057afca64372a69424a1e6f036e
 SHA512:
-  metadata.gz: 69d818a1780fda1549bbd83581c2d0abbc4ecda7274cb411bedd450a8365e322153263c1f5b490b03a183e7c8cb02e5d382c82c8628ee43e1c1c1294f6e76afa
-  data.tar.gz: e664577a0949609bebd90a7bc08b94e4559001fcb7b26429958fe38801acd835089b030cad3d3b1fa09a95ccc51b400f6cb8f66befc4903ebe1cb9b4bb56746d
+  metadata.gz: 7df011d6f9e64d4cfc387227e2eba187f921f4a80618fb12055ed616e357a9c8b80d3c129072768a453f3d63d4f221bd7b87c691cb1b73b7133dc6962f6fad03
+  data.tar.gz: 66fe3edbe82ce039b7d38e9f6f1836220adef5e71f6d8b268409daa838a6b1976252bac8d01514ef400ae645f2bf8b6c3e0f00bbd71f4f8b945d05d6715034a0

data/.devcontainer/devcontainer.json

@@ -3,7 +3,7 @@
 {
 	"name": "Ruby",
 	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
-	"image": "mcr.microsoft.com/devcontainers/ruby:1-3.3-bullseye"
+	"image": "mcr.microsoft.com/devcontainers/ruby:1-3.4-bullseye"
 
 	// Features to add to the dev container. More info: https://containers.dev/features.
 	// "features": {},

data/CHANGELOG.md

@@ -5,6 +5,30 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Version 3.0.1 (2025-06-29)][v3.0.1]
+
+### Changed
+
+- Updated dependencies.
+
+### Fixed
+
+- Docker image now works again for real (finally fixes #10?).
+
+## [Version 3.0.0 (2025-04-21)][v3.0.0]
+
+### Fixed
+
+- Docker image now works again (fixes #10).
+
+## [Version 3.0.0 (2025-04-21)][v3.0.0]
+
+### Changed
+
+ - **BREAKING:** Removed the `-v`/`--verbose` switch which was not functional
+   anyway and added a new option `-O`/`--log-output` flag to write IMAP responses
+   to a file in JSON format.
+
 ## [Version 2.1.0 (2025-03-16)][v2.1.0]
 
 ### Added
@@ -79,6 +103,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fix: Docker image.
 - Fix: Options error message.
 
+[v3.0.1]: https://github.com/bovender/imapcli/releases/tag/v3.0.1
+[v3.0.0]: https://github.com/bovender/imapcli/releases/tag/v3.0.0
 [v2.1.0]: https://github.com/bovender/imapcli/releases/tag/v2.1.0
 [v2.0.1]: https://github.com/bovender/imapcli/releases/tag/v2.0.1
 [v2.0.0]: https://github.com/bovender/imapcli/releases/tag/v2.0.0

data/Dockerfile

@@ -1,18 +1,22 @@
-FROM ruby:3.4-alpine
-LABEL maintainer="bovender@bovender.de"
-LABEL description="Command-line tool to query IMAP servers, collect stats etc."
-
-WORKDIR /
-ADD . /imapcli
-RUN apk add --no-cache git build-base && \
+FROM ruby:3.5-rc AS builder
+WORKDIR /imapcli
+COPY Gemfile Gemfile.lock imapcli.gemspec .
+COPY lib/imapcli/version.rb lib/imapcli/version.rb
+RUN apt-get update -qq && \
+  apt-get install -y build-essential libc6 && \
   gem update --system && \
-  cd imapcli && \
   bundle config set --local without development test && \
   bundle config set --local deployment true && \
-  bundle install && \
-  apk del build-base && \
-  rm -rf /var/cache/apk/*
+  bundle install
 
+FROM ruby:3.5-rc-slim
+LABEL maintainer="bovender@bovender.de"
+LABEL description="Command-line tool to query IMAP servers, collect stats etc."
 WORKDIR /imapcli
+RUN apt-get update -qq && \
+  apt-get install -y git && \
+  apt-get clean && rm -rf /var/lib/apt/lists/*
+COPY --from=builder /usr/local/bundle /usr/local/bundle
+COPY --from=builder /imapcli/vendor /imapcli/vendor
+COPY . .
 ENTRYPOINT ["bundle", "exec", "exe/imapcli"]
-

data/Gemfile.lock

@@ -1,13 +1,14 @@
 PATH
   remote: .
   specs:
-    imapcli (2.0.1)
+    imapcli (3.0.1)
       activesupport (~> 8.0)
       csv
       descriptive_statistics (~> 2.5)
       dotenv (~> 3.1)
       gli (~> 2.22)
       net-imap
+      oj (~> 3.16)
       tty-progressbar (~> 0.18)
       tty-prompt (~> 0.23)
       tty-table (~> 0.12)
@@ -29,34 +30,35 @@ GEM
       securerandom (>= 0.3)
       tzinfo (~> 2.0, >= 2.0.5)
       uri (>= 0.13.1)
-    ast (2.4.2)
-    base64 (0.2.0)
-    benchmark (0.4.0)
-    bigdecimal (3.1.9)
+    ast (2.4.3)
+    base64 (0.3.0)
+    benchmark (0.4.1)
+    bigdecimal (3.2.2)
     coderay (1.1.3)
     concurrent-ruby (1.3.5)
-    connection_pool (2.5.0)
-    csv (3.3.2)
+    connection_pool (2.5.3)
+    csv (3.3.5)
     date (3.4.1)
-    debug (1.10.0)
+    debug (1.11.0)
       irb (~> 1.10)
       reline (>= 0.3.8)
     descriptive_statistics (2.5.1)
-    diff-lcs (1.6.0)
+    diff-lcs (1.6.2)
     docile (1.4.1)
-    dotenv (3.1.7)
-    drb (2.2.1)
-    ffi (1.17.1)
-    ffi (1.17.1-aarch64-linux-gnu)
-    ffi (1.17.1-aarch64-linux-musl)
-    ffi (1.17.1-arm-linux-gnu)
-    ffi (1.17.1-arm-linux-musl)
-    ffi (1.17.1-arm64-darwin)
-    ffi (1.17.1-x86-linux-gnu)
-    ffi (1.17.1-x86-linux-musl)
-    ffi (1.17.1-x86_64-darwin)
-    ffi (1.17.1-x86_64-linux-gnu)
-    ffi (1.17.1-x86_64-linux-musl)
+    dotenv (3.1.8)
+    drb (2.2.3)
+    erb (5.0.1)
+    ffi (1.17.2)
+    ffi (1.17.2-aarch64-linux-gnu)
+    ffi (1.17.2-aarch64-linux-musl)
+    ffi (1.17.2-arm-linux-gnu)
+    ffi (1.17.2-arm-linux-musl)
+    ffi (1.17.2-arm64-darwin)
+    ffi (1.17.2-x86-linux-gnu)
+    ffi (1.17.2-x86-linux-musl)
+    ffi (1.17.2-x86_64-darwin)
+    ffi (1.17.2-x86_64-linux-gnu)
+    ffi (1.17.2-x86_64-linux-musl)
     formatador (1.1.0)
     gli (2.22.2)
       ostruct
@@ -79,22 +81,22 @@ GEM
     i18n (1.14.7)
       concurrent-ruby (~> 1.0)
     io-console (0.8.0)
-    irb (1.15.1)
+    irb (1.15.2)
       pp (>= 0.6.0)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
-    json (2.10.2)
-    language_server-protocol (3.17.0.4)
+    json (2.12.2)
+    language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     listen (3.9.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    logger (1.6.6)
+    logger (1.7.0)
     lumberjack (1.2.10)
     method_source (1.1.0)
     minitest (5.25.5)
     nenv (0.3.0)
-    net-imap (0.5.6)
+    net-imap (0.5.9)
       date
       net-protocol
     net-protocol (0.2.2)
@@ -102,9 +104,12 @@ GEM
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    ostruct (0.6.1)
-    parallel (1.26.3)
-    parser (3.3.7.1)
+    oj (3.16.11)
+      bigdecimal (>= 3.0)
+      ostruct (>= 0.2)
+    ostruct (0.6.2)
+    parallel (1.27.0)
+    parser (3.3.8.0)
       ast (~> 2.4.1)
       racc
     pastel (0.8.0)
@@ -112,37 +117,39 @@ GEM
     pp (0.6.2)
       prettyprint
     prettyprint (0.2.0)
+    prism (1.4.0)
     pry (0.15.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    psych (5.2.3)
+    psych (5.2.6)
       date
       stringio
     racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.2.1)
+    rake (13.3.0)
     rb-fsevent (0.11.2)
     rb-inotify (0.11.1)
       ffi (~> 1.0)
-    rdoc (6.12.0)
+    rdoc (6.14.1)
+      erb
       psych (>= 4.0.0)
     regexp_parser (2.10.0)
-    reline (0.6.0)
+    reline (0.6.1)
       io-console (~> 0.5)
-    rspec (3.13.0)
+    rspec (3.13.1)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.3)
+    rspec-core (3.13.5)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.3)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.2)
+    rspec-mocks (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.2)
-    rubocop (1.74.0)
+    rspec-support (3.13.4)
+    rubocop (1.77.0)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -150,19 +157,20 @@ GEM
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.38.0, < 2.0)
+      rubocop-ast (>= 1.45.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.39.0)
-      parser (>= 3.3.1.0)
-    rubocop-performance (1.24.0)
+    rubocop-ast (1.45.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-performance (1.25.0)
       lint_roller (~> 1.1)
-      rubocop (>= 1.72.1, < 2.0)
+      rubocop (>= 1.75.0, < 2.0)
       rubocop-ast (>= 1.38.0, < 2.0)
     rubocop-rake (0.7.1)
       lint_roller (~> 1.1)
       rubocop (>= 1.72.1)
-    rubocop-rspec (3.5.0)
+    rubocop-rspec (3.6.0)
       lint_roller (~> 1.1)
       rubocop (~> 1.72, >= 1.72.1)
     ruby-progressbar (1.13.0)
@@ -174,7 +182,7 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.13.1)
     simplecov_json_formatter (0.1.4)
-    stringio (3.1.5)
+    stringio (3.1.7)
     strings (0.2.1)
       strings-ansi (~> 0.2)
       unicode-display_width (>= 1.5, < 3.0)
@@ -207,7 +215,7 @@ GEM
     unicode_utils (1.4.0)
     uri (1.0.3)
     wisper (2.0.1)
-    zeitwerk (2.7.2)
+    zeitwerk (2.7.3)
 
 PLATFORMS
   aarch64-linux-gnu
@@ -237,4 +245,4 @@ DEPENDENCIES
   simplecov
 
 BUNDLED WITH
-   2.6.5
+   2.6.9

data/README.md

@@ -280,6 +280,17 @@ Use case: Say you have a very large IMAP account, and you would like to know the
 
 Use the `--csv` flag.
 
+### Writing IMAP responses to file
+
+Using the `-O`/`--log-output` flag, you can have `imapcli` write the IMAP responses
+to a file in JSON format:
+
+```bash
+imapcli -s yourserver.example.com -u username -P -O output_file.json stats Inbox 
+```
+
+**WARNING:** The output file will be overwritten without notice!
+
 ## Alternative resources
 
 While researching command-line tools for IMAP servers, I came across the

data/imapcli.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |s|
   s.add_dependency('dotenv', '~> 3.1')
   s.add_dependency('gli', '~> 2.22')
   s.add_dependency('net-imap')
+  s.add_dependency('oj', '~> 3.16')
   s.add_dependency('tty-progressbar', '~> 0.18')
   s.add_dependency('tty-prompt', '~> 0.23')
   s.add_dependency('tty-table', '~> 0.12')

data/lib/imapcli/cli.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'oj'
+
 module Imapcli
   class Cli # rubocop:disable Metrics/ClassLength,Style/Documentation
     extend GLI::App
@@ -31,8 +33,8 @@ module Imapcli
     desc 'Prompt for password'
     switch %i[P prompt], negatable: false
 
-    desc 'Verbose output (e.g., response values from Rubys Net::IMAP)'
-    switch %i[v verbose], negatable: false
+    desc 'Output responses from Rubys Net::IMAP to file in JSON format. File will be overwritten if it exists!'
+    flag %i[O log-output]
 
     desc 'Tests if the server is available and log-in succeeds with the credentials'
     command :check do |c|
@@ -89,7 +91,7 @@ module Imapcli
           if progress_bar
             progress_bar.advance
           else
-            @prompt.say "info: collecting stats for #{n} folders" if n > 1
+            @prompt.warn "info: collecting stats for #{n} folders" if n > 1
             progress_bar = TTY::ProgressBar.new(
               'collecting stats... :current/:total (:percent, :eta remaining)',
               total: n, clear: true
@@ -111,9 +113,9 @@ module Imapcli
           formatted_body = formatted_body.insert(0, :separator).insert(-2, :separator)
 
           if options[:human]
-            @prompt.say "notice: -H/--human flag present, message sizes are given with SI prefixes"
+            @prompt.warn "notice: -H/--human flag present, message sizes are given with SI prefixes"
           else
-            @prompt.say "notice: message sizes are given in bytes"
+            @prompt.warn "notice: message sizes are given in bytes"
           end
 
           table = TTY::Table.new(head, formatted_body)
@@ -143,27 +145,25 @@ module Imapcli
       global[:p] = @prompt.mask 'Enter password:' if global[:P]
       global[:p] ||= ENV.fetch('IMAP_PASS', nil)
 
-      client = Imapcli::Client.new(global[:s], global[:u], global[:p])
+      @client = Imapcli::Client.new(global[:s], global[:u], global[:p])
       @prompt.say "server: #{global[:s]}"
       @prompt.say "user: #{global[:u]}"
-      raise 'invalid server name' unless client.server_valid?
-      raise 'invalid user name' unless client.user_valid?
+      raise 'invalid server name' unless @client.server_valid?
+      raise 'invalid user name' unless @client.user_valid?
 
       @prompt.warn 'warning: no password was provided (missing -p/-P option)' unless global[:p]
-      raise 'unable to connect to server' unless client.connection
+      raise 'unable to connect to server' unless @client.connection
 
-      @command = Imapcli::Command.new(client)
+      @command = Imapcli::Command.new(@client)
 
       true
     end
 
     post do |global, _command, _options, _args|
       @client&.logout
-      if global[:v]
-        @prompt.say "\n>>> --verbose switch on, listing server responses <<<"
-        @client.responses.each do |response|
-          @prompt.say response
-        end
+      if file_name = global[:o]
+        @prompt.warn "notice: writing IMAP responses to #{file_name.dump}"
+        File.write(file_name, Oj.dump(@client.responses, mode: :object, indent: 2, escape: :unicode_xss, symbolize_names: false))
       end
     end
 

data/lib/imapcli/client.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
+require 'json'
+
 module Imapcli
   # Wrapper for Net::IMAP
   class Client # rubocop:disable Metrics/ClassLength
     attr_accessor :port, :user, :pass
-    attr_reader :responses
 
     ## Initializs the Client class.
     ##
@@ -17,7 +18,7 @@ module Imapcli
       self.server = server_with_optional_port
       @user = user
       @pass = pass
-      clear_log
+      clear_responses
     end
 
     # Attribute reader for the server domain name
@@ -57,10 +58,15 @@ module Imapcli
     end
 
     # Clears the server response log
-    def clear_log
+    def clear_responses
       @log = []
     end
 
+    # Returns the IMAP server response log
+    def responses
+      @log
+    end
+
     # Returns the last response from the server
     def last_response
       @log.last
@@ -96,17 +102,17 @@ module Imapcli
     # Returns the server's greeting (which may reveal the server software name
     # such as 'Dovecot').
     def greeting
-      query_server { connection.greeting.data.text.strip }
+      query_server('greeting') { connection.greeting.data.text.strip }
     end
 
     # Returns the server's capabilities.
     def capability
-      @capability ||= query_server { connection.capability }
+      @capability ||= query_server('capability') { connection.capability }
     end
 
     # Returns the character that is used to separate nested mailbox names.
     def separator
-      @separator ||= query_server { connection.list('', '')[0].delim }
+      @separator ||= query_server("list('')") { connection.list('', '')[0].delim }
     end
 
     # Returns true if the server supports the IMAP QUOTA extension.
@@ -120,7 +126,7 @@ module Imapcli
       return unless supports_quota
 
       @quota ||= begin
-        info = query_server { @connection.getquotaroot('INBOX')[1] }
+        info = query_server("getquotaroot('INBOX')") { @connection.getquotaroot('INBOX')[1] }
         percent = info.quota.to_i.positive? ? info.usage.to_i.fdiv(info.quota.to_i) * 100 : nil
         [info.usage, info.quota, percent]
       end
@@ -130,8 +136,8 @@ module Imapcli
     #
     # The value is currently NOT cached.
     def messages(mailbox)
-      query_server { connection.examine(mailbox) }
-      query_server { connection.search('ALL') }
+      query_server("examine('#{mailbox}')") { connection.examine(mailbox) }
+      query_server("search('ALL')") { connection.search('ALL') }
     end
 
     # Examines a mailbox and returns statistics about the messages in it.
@@ -149,7 +155,7 @@ module Imapcli
       if messages.empty?
         []
       else
-        query_server do
+        query_server('fetch(...)') do
           messages.each_slice(1000).map do |some_messages|
             connection.fetch(some_messages, 'RFC822.SIZE').map do |f|
               f.attr['RFC822.SIZE']
@@ -168,7 +174,7 @@ module Imapcli
     #
     # The value is cached.
     def mailboxes
-      @mailboxes ||= query_server { @connection.list('', '*') }
+      @mailboxes ||= query_server('list') { @connection.list('', '*') }
     end
 
     # Returns a tree of +Imapcli::Mailbox+ objects.
@@ -188,12 +194,10 @@ module Imapcli
     private
 
     def response_ok?(response)
-      @log << response
       response.name == 'OK'
     end
 
     def log_error(error)
-      @log << error
       false
     end
 
@@ -203,13 +207,31 @@ module Imapcli
     # error if not. The code that queries the server must be contained in the
     # +block+, and the +block+'s return value is returned by this function.
     # The +connection+'s responses are logged.
-    def query_server
+    def query_server(imap_command)
       raise('no connection to a server') unless connection
 
       result = yield
-      @log << connection.responses
+      @log << {
+                'imap_command': imap_command,
+                'imap_response': connection.responses.to_h
+              }
       result
     end
 
+    # Recursively convert structs in an array of hashes to hashes
+    # Inspired by  https://stackoverflow.com/a/62804063/270712
+    # and rephrased to improve readability a bit
+    def to_h_recursively(hash)
+      hash.map do |value|
+        if value.is_a?(Arry)
+          to_h_recursively(value)
+        elsif value.is_a?(Struct)
+          value.to_h
+        else
+          value
+        end
+     end
+    end
+
   end
 end

data/lib/imapcli/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Imapcli
-  VERSION = '2.1.0'
+  VERSION = '3.0.1'
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: imapcli
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Daniel Kraus (bovender)
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-16 00:00:00.000000000 Z
+date: 2025-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -94,6 +93,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.16'
 - !ruby/object:Gem::Dependency
   name: tty-progressbar
   requirement: !ruby/object:Gem::Requirement
@@ -150,7 +163,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.7.0
-description:
 email: bovender@bovender.de
 executables:
 - imapcli
@@ -195,7 +207,6 @@ homepage: https://github.com/bovender/imapcli
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message:
 rdoc_options:
 - "--title"
 - imapcli
@@ -215,8 +226,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Command-line tool to query IMAP servers
 test_files: []