imapcli 1.0.5 → 2.0.0

data/Guardfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
@@ -15,7 +17,7 @@
 #
 # and, you'll have to watch "config/Guardfile" instead of "Guardfile"
 
-# Note: The cmd option is now required due to the increasing number of ways
+# NOTE: The cmd option is now required due to the increasing number of ways
 #       rspec may be run, below are examples of the most common uses.
 #  * bundler: 'bundle exec rspec'
 #  * bundler binstubs: 'bin/rspec'
@@ -24,8 +26,8 @@
 #  * zeus: 'zeus rspec' (requires the server to be started separately)
 #  * 'just' rspec: 'rspec'
 
-guard :rspec, cmd: "bundle exec rspec" do
-  require "guard/rspec/dsl"
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
   dsl = Guard::RSpec::Dsl.new(self)
 
   # Feel free to open issues for suggestions and improvements
@@ -41,7 +43,7 @@ guard :rspec, cmd: "bundle exec rspec" do
   dsl.watch_spec_files_for(ruby.lib_files)
 
   # Rails files
-  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  rails = dsl.rails(view_extensions: %w[erb haml slim])
   dsl.watch_spec_files_for(rails.app_files)
   dsl.watch_spec_files_for(rails.views)
 
@@ -49,7 +51,7 @@ guard :rspec, cmd: "bundle exec rspec" do
     [
       rspec.spec.call("routing/#{m[1]}_routing"),
       rspec.spec.call("controllers/#{m[1]}_controller"),
-      rspec.spec.call("acceptance/#{m[1]}")
+      rspec.spec.call("acceptance/#{m[1]}"),
     ]
   end
 
@@ -60,6 +62,6 @@ guard :rspec, cmd: "bundle exec rspec" do
   # Turnip features and steps
   watch(%r{^spec/acceptance/(.+)\.feature$})
   watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
-    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+    Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance'
   end
 end

data/README.md

@@ -1,8 +1,4 @@
-**Heads up! Code contributions welcome. Please issue pull requests against the
-`develop` branch.**
-
-imapcli
-=======
+# imapcli
 
 > Command-line interface (CLI) for IMAP servers
 > (<https://github.com/bovender/imapcli>)
@@ -11,23 +7,19 @@ imapcli
 server for configuration details and e-mail statistics. It can be used to gather
 IMAP mailbox sizes.
 
+## Table of contents
 
-Table of contents
------------------
-
-*   [Motivation](#motivation)
-*   [Warning](#warning)
-*   [Installing and executing `imapcli`](#installing-and-executing-imapcli)
-*   [Terminology](#terminology)
-*   [Usage](#usage)
-*   [Alternative resources](#alternative-resources)
-*   [State of the project](#state-of-the-project)
-*   [Credits](#credits)
-*   [License](#license)
+- [Motivation](#motivation)
+- [Warning](#warning)
+- [Installing and executing `imapcli`](#installing-and-executing-imapcli)
+- [Terminology](#terminology)
+- [Usage](#usage)
+- [Alternative resources](#alternative-resources)
+- [State of the project](#state-of-the-project)
+- [Credits](#credits)
+- [License](#license)
 
-
-Motivation
-----------
+## Motivation
 
 When my university mail account had almost reached the quota, I needed to find
 out what the largest mail folders were (in terms of megabytes, not message
@@ -39,9 +31,7 @@ with the server by telnet or OpenSSL.
 
 `imapcli` offers a convenient way to query an IMAP server.
 
-
-Warning
--------
+## Warning
 
 Some servers are configured to detect potentially malicious login attempts by
 the frequency of repeat connections from a given source. **It may happen that
@@ -71,13 +61,7 @@ Do not forget to reload the `jail2ban` configuration afterwards:
 
 Of course this only works if your IP addresses do not change too much.
 
-(On Ubuntu Linux, the [indicator-ip](https://github.com/bovender/indicator-ip)
-applet may be useful to know your remote IP. Disclaimer: I am the author of this
-tool.)
-
-
-Installing and executing `imapcli`
---------------------------------
+## Installing and executing `imapcli`
 
 `imapcli` is a Ruby project and as such does not need to be compiled. To run it
 on your machine, you can either pull the repository, install a Gem, or use a
@@ -86,8 +70,7 @@ Docker image.
 Detailed usage instructions follow [below](#usage).
 
 I don't currently provide a .deb package because Debian packaging done right
-is kind of complicated.
-
+is kind of complicated (for me).
 
 ### Run in the repository
 
@@ -100,8 +83,7 @@ Install:
 Run:
 
     cd imapcli
-    bundle exec bin/imapcli
-
+    bundle exec exe/imapcli
 
 ### Install the gem
 
@@ -115,7 +97,6 @@ Run:
 
     imapcli
 
-
 ### Docker image
 
 With [Docker](https://www.docker.com), you do not have to install Ruby and the
@@ -125,36 +106,31 @@ smaller).
 
 Run:
 
-    docker run bvndr/imapcli <arguments>
+    docker run -it --rm bovender/imapcli <arguments>
 
 Example:
 
-    docker run bvndr/imapcli -s myserver.example.com -u user -P info
-
-The Docker repository is at <https://hub.docker.com/r/bvndr/imapcli>.
+    docker run -it --rm bovender/imapcli -s myserver.example.com -u user -P info
 
+The Docker repository is at <https://hub.docker.com/r/bovender/imapcli>.
 
-Terminology
------------
+## Terminology
 
 `imapcli` attempts to use the typical IMAP terminology. I guess most people
 have their mails organized in **folders**; in IMAP speak, a folder is a **maibox**.
 
-
-Usage
------
+## Usage
 
 For basic usage instructions and possible options, run `imapcli` and examine
 the output. Please note that `imapcli` distinguishes between global and
 command-specific options. Global options *precede* and command-specific options
-*follow* a `command`, see the output of `imapcli` (without command or options)
+-follow* a `command`, see the output of `imapcli` (without command or options)
 for more information.
 
 Note: The following examples use the command `imapcli`. Depending on how you
 [installed](#installing-and-executing-imapcli) `imapcli`, you may need to use a
 different command.
 
-
 ### Setting your server and account information
 
 Server and account information are given as *global options*:
@@ -179,7 +155,6 @@ environment variables:
 These variables can also be set in a `.env` file that resides in the root
 directory of the repository. Never add this `.env` file to the repository!
 
-
 ### Obtain general information about the IMAP server
 
     $ bundle exec bin/imapcli -s yourserver.example.com -u myusername -P info
@@ -191,7 +166,6 @@ directory of the repository. Never add this `.env` file to the repository!
     hierarchy separator: /
     quota: IMAP QUOTA extension not supported by this server
 
-
 ### List all mailboxes (folders) without size information
 
     $ bundle exec bin/imapcli -s yourserver.example.com -u myusername -P list
@@ -205,7 +179,6 @@ directory of the repository. Never add this `.env` file to the repository!
     - Sports
     ...
 
-
 ### Obtain size information about mailboxes
 
 To obtain mailbox sizes, the server has to be queried for the message sizes for
@@ -214,14 +187,15 @@ of messages in them, this may take a little while.
 
 `imapcli` prints the following statistics about the message sizes in a mailbox:
 
-*   `Count`: Number of individual messages
-*   `Total size`: Total size of all messages in the mailbox (in kiB)
-*   `Min`: Size of the smallest message in the mailbox (in kiB)
-*   `Q1`: First quartile of message sizes in the mailbox (in kiB)
-*   `Median`: Median of all message sizes in the mailbox (in kiB)
-*   `Q3`: First quartile of message sizes in the mailbox (in kiB)
-*   `Max`: Size of the largest message in the mailbox (in kiB)
+- `Count`: Number of individual messages
+- `Total size`: Total size of all messages in the mailbox
+- `Min`: Size of the smallest message in the mailbox
+- `Q1`: First quartile of message sizes in the mailbox
+- `Median`: Median of all message sizes in the mailbox
+- `Q3`: Third quartile of message sizes in the mailbox
+- `Max`: Size of the largest message in the mailbox
 
+Use the `-H` or `--human` switch to output the message sizes with SI prefixes.
 
 #### All mailboxes
 
@@ -273,88 +247,81 @@ Use the `-r`/`--recurse` flag:
 By default, mailboxes are sorted alphabetically. To sort by a specific statistic,
 use an `-o`/`--sort` option:
 
-*   `-o count`
-*   `-o total_size`
-*   `-o min_size`
-*   `-o q1`
-*   `-o median_size`
-*   `-o q3`
-*   `-o max_size`
+- `-o count`
+- `-o total_size`
+- `-o min_size`
+- `-o q1_size`
+- `-o median_size`
+- `-o q3_size`
+- `-o max_size`
+
+This will sort the output from smallest to largest (ascending).
+
+Use the `--reverse` switch to sort from largest to smallest (descending).
+
+Note that these are options to the `stats` command and need to come after the `stats`
+keyword, as shown below.
 
 Example:
 
-    $ bundle exec bin/imapcli -s yourserver.example.com -u myusername -P stats -r -o max_size Archive
+    bundle exec -it bin/imapcli -s yourserver.example.com -u myusername -P stats -r -o max_size Archive
 
 #### Obtaining comma-separated values (CSV)
 
 Use the `--csv` flag.
 
-
-Alternative resources
----------------------
+## Alternative resources
 
 While researching command-line tools for IMAP servers, I came across the
 following:
 
-
 ### IMAP folder size script
 
-*   <https://code.iamcal.com/pl/imap_folders>
-
-    Ad-hoc perl script that computes the sizes of each mailbox. `imapcli` was
-    inspired by this!
+- <https://code.iamcal.com/pl/imap_folders>
 
+  Ad-hoc perl script that computes the sizes of each mailbox. `imapcli` was
+  inspired by this!
 
 ### IMAP synchronization and backup tools
 
-*   <https://github.com/OfflineIMAP/imapfw>
-
-    Framework to work with mails
+- <https://github.com/OfflineIMAP/imapfw>
 
-*   <https://github.com/polo2ro/imapbox>
+  Framework to work with mails
 
-    Pull down e-mails from an IMAP server to your local disk
+- <https://github.com/polo2ro/imapbox>
 
+  Pull down e-mails from an IMAP server to your local disk
 
+## State of the project
 
-### IMAP via Telnet or OpenSSL
-
-
-State of the project
---------------------
-
-While `imapcli` does what I need it to do, there are a lot of things that could
-be improved. I'll be happy to take **pull request**. Please issue those against
-the **develop** branch as I like to follow *[a successful Git branching
-model](http://nvie.com/git-model)*.
-
-
-### Versioning
+I have not been able to work on this project for quite some time. It still
+serves me well when I occasionally need it. Pull requests are of course welcome.
 
 This project is [semantically versioned](https://semver.org).
 
 ### To do
 
--   More human-friendly number formatting (e.g., MiB/GiB as appropriate)
--   Output to file
--   Deal with server-specific mailbox separator characters (e.g. '.' vs. '/')
--   Man page
--   More commands?
-
+[x] More human-friendly number formatting (e.g., MiB/GiB as appropriate)
+[ ] Output to file
+[ ] Deal with server-specific mailbox separator characters (e.g. '.' vs. '/')
+[ ] Man page
+[ ] More commands?
 
-Credits
--------
+## Credits
 
 This tool is build around the awesome [GLI](https://github.com/davetron5000/gli)
 gem by [David Copeland](https://github.com/davetron5000) and makes extensive use
 of [Piotr Murach's](https://github.com/piotrmurach) excellent `TTY` tools. See
 the `Gemfile` for other work that this tool depends on.
 
+## Contributors
+
+- [@bovender](https://github.com/bovender)
+- [@n-rodriguez](https://github.com/n-rodriguez)
 
-License
--------
+## License
 
-&copy; 2017 Daniel Kraus (bovender)
+&copy; 2017-2025 Daniel Kraus (@bovender)
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/Rakefile

@@ -1,20 +1,18 @@
+# frozen_string_literal: true
+
 require 'rake/clean'
 require 'rubygems'
 require 'rubygems/package_task'
 require 'rdoc/task'
 # require 'cucumber'
 # require 'cucumber/rake/task'
+
 Rake::RDocTask.new do |rd|
-  rd.main = "README.md"
-  rd.rdoc_files.include("README.md","lib/**/*.rb","bin/**/*")
+  rd.main = 'README.md'
+  rd.rdoc_files.include('README.md', 'lib/**/*.rb', 'bin/**/*')
   rd.title = 'imapcli'
 end
 
-spec = eval(File.read('imapcli.gemspec'))
-
-Gem::PackageTask.new(spec) do |pkg|
-end
-
 # CUKE_RESULTS = 'results.html'
 # CLEAN << CUKE_RESULTS
 # desc 'Run features'

data/bin/bundle

@@ -0,0 +1,109 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundle' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "rubygems"
+
+m = Module.new do
+  module_function
+
+  def invoked_as_script?
+    File.expand_path($0) == File.expand_path(__FILE__)
+  end
+
+  def env_var_version
+    ENV["BUNDLER_VERSION"]
+  end
+
+  def cli_arg_version
+    return unless invoked_as_script? # don't want to hijack other binstubs
+    return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
+    bundler_version = nil
+    update_index = nil
+    ARGV.each_with_index do |a, i|
+      if update_index && update_index.succ == i && a.match?(Gem::Version::ANCHORED_VERSION_PATTERN)
+        bundler_version = a
+      end
+      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
+      bundler_version = $1
+      update_index = i
+    end
+    bundler_version
+  end
+
+  def gemfile
+    gemfile = ENV["BUNDLE_GEMFILE"]
+    return gemfile if gemfile && !gemfile.empty?
+
+    File.expand_path("../Gemfile", __dir__)
+  end
+
+  def lockfile
+    lockfile =
+      case File.basename(gemfile)
+      when "gems.rb" then gemfile.sub(/\.rb$/, ".locked")
+      else "#{gemfile}.lock"
+      end
+    File.expand_path(lockfile)
+  end
+
+  def lockfile_version
+    return unless File.file?(lockfile)
+    lockfile_contents = File.read(lockfile)
+    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
+    Regexp.last_match(1)
+  end
+
+  def bundler_requirement
+    @bundler_requirement ||=
+      env_var_version ||
+      cli_arg_version ||
+      bundler_requirement_for(lockfile_version)
+  end
+
+  def bundler_requirement_for(version)
+    return "#{Gem::Requirement.default}.a" unless version
+
+    bundler_gem_version = Gem::Version.new(version)
+
+    bundler_gem_version.approximate_recommendation
+  end
+
+  def load_bundler!
+    ENV["BUNDLE_GEMFILE"] ||= gemfile
+
+    activate_bundler
+  end
+
+  def activate_bundler
+    gem_error = activation_error_handling do
+      gem "bundler", bundler_requirement
+    end
+    return if gem_error.nil?
+    require_error = activation_error_handling do
+      require "bundler/version"
+    end
+    return if require_error.nil? && Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+    warn "Activating bundler (#{bundler_requirement}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_requirement}'`"
+    exit 42
+  end
+
+  def activation_error_handling
+    yield
+    nil
+  rescue StandardError, LoadError => e
+    e
+  end
+end
+
+m.load_bundler!
+
+if m.invoked_as_script?
+  load Gem.bin_path("bundler", "bundle")
+end

data/bin/rspec

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/rubocop

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?('This file was generated by Bundler')
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rubocop', 'rubocop')

data/exe/imapcli

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/imapcli'
+
+Dotenv.load
+
+exit Imapcli::Cli.run(ARGV)

data/imapcli.gemspec

@@ -1,28 +1,35 @@
-# Ensure we require the local version and not one we might have installed already
-require File.join([File.dirname(__FILE__),'lib','imapcli','version.rb'])
-spec = Gem::Specification.new do |s|
+# frozen_string_literal: true
+
+require_relative 'lib/imapcli/version'
+
+Gem::Specification.new do |s|
   s.name = 'imapcli'
   s.version = Imapcli::VERSION
+  s.platform = Gem::Platform::RUBY
   s.author = 'Daniel Kraus (bovender)'
   s.email = 'bovender@bovender.de'
   s.homepage = 'https://github.com/bovender/imapcli'
-  s.license = 'Apache-2.0'
-  s.platform = Gem::Platform::RUBY
   s.summary = 'Command-line tool to query IMAP servers'
+  s.license = 'Apache-2.0'
+
+  s.required_ruby_version = '>= 3.1.0'
+
   s.files = `git ls-files`.split("\n")
-  s.require_paths << 'lib'
-  s.has_rdoc = true
-  s.extra_rdoc_files = ['README.md','imapcli.rdoc']
+
+  s.extra_rdoc_files = ['README.md', 'imapcli.rdoc']
   s.rdoc_options << '--title' << 'imapcli' << '--main' << 'README.md' << '-ri'
-  s.bindir = 'bin'
-  s.executables << 'imapcli'
-  s.add_development_dependency('rake', '~> 12.3.3')
-  s.add_development_dependency('rdoc', '~> 5.1')
-  s.add_runtime_dependency('descriptive_statistics', '~> 2.5')
-  s.add_runtime_dependency('dotenv', '~> 2.2')
-  s.add_runtime_dependency('filesize', '~> 0.1')
-  s.add_runtime_dependency('gli','~> 2.17')
-  s.add_runtime_dependency('tty-progressbar', '~> 0.13')
-  s.add_runtime_dependency('tty-prompt', '~> 0.13')
-  s.add_runtime_dependency('tty-table', '~> 0.9')
+
+  s.bindir = 'exe'
+  s.executables = ['imapcli']
+
+  s.add_dependency('csv')
+  s.add_dependency('descriptive_statistics', '~> 2.5')
+  s.add_dependency('dotenv', '~> 3.1')
+  s.add_dependency('activesupport', '~> 8.0')
+  s.add_dependency('gli', '~> 2.22')
+  s.add_dependency('net-imap')
+  s.add_dependency('tty-progressbar', '~> 0.18')
+  s.add_dependency('tty-prompt', '~> 0.23')
+  s.add_dependency('tty-table', '~> 0.12')
+  s.add_dependency('zeitwerk', '~> 2.7.0')
 end