imap_processor 1.7 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 632f5afa32e055708809e6817e2532f5a5f880b48d9bb808102e63e2bad6cff7
-  data.tar.gz: 145bf8485b69a4629b32b12748edc780899db542e6a180db88a61ee6fc93ba56
+  metadata.gz: ce222f1cb8f32b1db12c7d73f70df7651435e2a2a84c0a6a50bd22dc3a07d8b5
+  data.tar.gz: 6bc68677e713f0d6414995ef51861166d3316131b6ada39c4e506f2fba4c6b7c
 SHA512:
-  metadata.gz: e1c5b332b9d8e3dbb9f105d888cb796a1e901633f40147a241ed2ac0ec7f63664f8a9b78a0eed149d8653eace16de68190d2737462294192ecaaa0bf331d1746
-  data.tar.gz: 5561900484e14b7fe02508402af345a07a8999c56b2fdf05dd91989698b4b5a87bdd9f09acebf84232e7505b3a9ce8e57e8e9fc42041567555cf889592ec055c
+  metadata.gz: 07f96e7acb7aae8846b6f5c95c8abf4ac981f0ca0ea18506c0d596380fd57687d40b5bddaca06fd8b2383484c1d8da42596e3a93c1558195d111ab396ac1893f
+  data.tar.gz: 2c869d58045ea7b20916ee5b7f65570af46e1938dc4034e20ab2d9ae11557ea58d9b4a9e568c0e6d35b6c418fbdfb4b681e5bed18b34bc6d02c7f8cb5b4a4c4f

data/History.rdoc

@@ -1,3 +1,18 @@
+=== 1.8.0 / 2023-01-09
+
+* 1 major enhancement:
+
+  * Added imap_tidy, a hybrid between cleanse and archive.
+
+* 1 minor enhancement:
+
+  * Added Time.imapdate(s), Time.imapdatetime(s), and #yyyy_mm.
+
+* 2 bug fixes:
+
+  * Fixes for net/imap changes in ruby 3.x.
+  * Removed unused last_month from IMAPProcessor::Archive
+
 === 1.7 / 2020-06-04
 
 * 4 minor enhancements:
@@ -100,4 +115,3 @@
 
 * 1 major enhancement
   * Birthday!
-

data/Manifest.txt

@@ -10,6 +10,7 @@ bin/imap_idle
 bin/imap_keywords
 bin/imap_learn
 bin/imap_mkdir
+bin/imap_tidy
 lib/imap_processor.rb
 lib/imap_processor/archive.rb
 lib/imap_processor/cleanse.rb
@@ -19,6 +20,7 @@ lib/imap_processor/idle.rb
 lib/imap_processor/keywords.rb
 lib/imap_processor/learn.rb
 lib/imap_processor/mkdir.rb
+lib/imap_processor/tidy.rb
 lib/imap_sasl_plain.rb
 lib/net/imap/date.rb
 lib/net/imap/idle.rb

data/bin/imap_tidy

@@ -0,0 +1,5 @@
+#!/usr/local/bin/ruby -w
+
+require 'imap_processor/tidy'
+
+IMAPProcessor::Tidy.run ARGV

data/lib/imap_processor/archive.rb

@@ -60,11 +60,6 @@ imap_archive archives old mail on IMAP server by moving it to dated mailboxen.
     Time.local(t.year, t.month, 1)
   end
 
-  def last_month
-    t = the_first - 1
-    Time.local(t.year, t.month, 1).strftime("%Y-%m")
-  end
-
   ##
   # Makes a SEARCH argument set from +keywords+
 
@@ -82,8 +77,7 @@ imap_archive archives old mail on IMAP server by moving it to dated mailboxen.
       next if uids_by_date.empty?
 
       unless split then
-        today = Time.now
-        d = today - 86400 * today.day
+        d = the_first - 1       # one second back into last month
         latest = [d.year, d.month]
 
         uids_by_date = {

data/lib/imap_processor/tidy.rb

@@ -0,0 +1,106 @@
+require "imap_processor"
+require "net/imap/date"
+
+##
+# Whereas Archive moves all mail before this month into a dated mailbox, and
+# whereas Cleanse deletes all read unflagged mail over N days old,
+# Tidy moves all read unflagged mail into a dated mailbox.
+#
+# It's somewhere in-between Archive and Cleanse in that it is used for
+# mail you want to keep, but also keep out of the way of your active
+# inbox.
+
+class IMAPProcessor::Tidy < IMAPProcessor
+
+  ##
+  # Whether to move the mail or just display. default:false
+
+  attr_accessor :move
+
+  def self.process_args args # :nodoc:
+    required_options = {
+      :move => false,
+    }
+
+    super __FILE__, args, required_options do |opts, options|
+      opts.banner << <<~EOF
+        imap_tidy moves older messages from your mailboxen into dated mailboxen.
+      EOF
+
+      opts.on "--days=N", Integer, "Override age to move messages" do |n|
+        options[:age] = n
+      end
+
+      opts.on "--[no-]move", "Move the messages (off by default)" do |move|
+        options[:move] = move
+      end
+    end
+  end
+
+  def initialize options # :nodoc:
+    super
+
+    log "Tidy: #{options[:Host]}"
+
+    self.move = options[:move]
+
+    connection = connect
+
+    @imap = connection.imap
+  end
+
+  ##
+  # Select a mailbox
+  # TODO: push up
+
+  def select mailbox
+    log "SELECT #{mailbox}"
+    imap.select mailbox
+  end
+
+  ##
+  # Search a selected mailbox with +args+
+  # TODO: push up
+
+  def search args
+    log "SEARCH #{args.join " "}"
+    imap.search args
+  end
+
+  def uids_to_dates uids
+    imap
+      .fetch(uids, "INTERNALDATE")
+      .to_h { |fd| [fd.seqno, Time.imapdate(fd.attr["INTERNALDATE"]).yyyy_mm] }
+  end
+
+  def run
+    @boxes.each do |mailbox, days_old|
+      select mailbox
+
+      before_date = Time.now - 86_400 * (options[:age] || days_old)
+      uids        = search %W[SEEN UNFLAGGED BEFORE #{before_date.imapdate}]
+
+      next if uids.empty?
+
+      log "FOUND %p" % [uids]
+
+      uids_to_dates(uids)                 # id => "YYYY-MM"
+        .multi_invert                     # "YYYY-MM" => [id,...]
+        .sort
+        .each do |date, uids|
+          destination = "%s-%s" % [mailbox, date]
+          show_messages uids
+          move_messages uids, destination, false if move
+        end
+
+      log "EXPUNGE"
+      imap.expunge if move unless noop?
+    end
+  end
+end
+
+class Hash
+  def multi_invert
+    keys.group_by { |k| self[k] }.to_h
+  end
+end

data/lib/imap_processor.rb

@@ -5,6 +5,8 @@ require 'net/imap/date'
 require 'imap_sasl_plain'
 require 'yaml'
 
+Net::IMAP::Authenticators.send :public, :authenticators
+
 ##
 # IMAPProcessor is a client for processing messages on an IMAP server.
 #
@@ -26,7 +28,7 @@ class IMAPProcessor
   ##
   # The version of IMAPProcessor you are using
 
-  VERSION = "1.7"
+  VERSION = "1.8.0"
 
   ##
   # Base IMAPProcessor error class
@@ -210,7 +212,7 @@ class IMAPProcessor
           options[:Password] = password
         end
 
-        authenticators = Net::IMAP.send :class_variable_get, :@@authenticators
+        authenticators = Net::IMAP.authenticators
         auth_types = authenticators.keys.sort.join ', '
         opts.on("-a", "--auth AUTH", auth_types,
                 "IMAP authentication type override",
@@ -351,7 +353,14 @@ Example ~/.#{@@opts_file_name}:
     data = res.data
 
     if data.code and data.code.name == 'CAPABILITY' then
-      data.code.data.split ' '
+      case data.code.data
+      when Array then
+        data.code.data
+      when String then
+        data.code.data.split ' '
+      else
+        raise ArgumentError, "unknown type: #{data.code.data.class}"
+      end
     else
       imap.capability
     end
@@ -550,7 +559,8 @@ Example ~/.#{@@opts_file_name}:
 
   def move_messages uids, destination, expunge = true
     return if uids.empty?
-    log "COPY [...#{uids.size} uids]"
+    verb = expunge ? "MOVE" : "COPY"
+    log "%s %d uids to %s:" % [verb, uids.size, destination]
 
     begin
       imap.copy uids, destination unless noop?

data/lib/net/imap/date.rb

@@ -1,11 +1,28 @@
+require "time"
 
-class Time
+class Time                           # :nodoc:
+  IMAPDATE     = "%d-%b-%Y"          # :nodoc:
+  IMAPDATETIME = "%d-%b-%Y %H:%M %Z" # :nodoc:
+
+  ##
+  # Parse an IMAP date formatted string into a Time.
+
+  def self.imapdate str
+    Time.strptime str, IMAPDATE
+  end
+
+  ##
+  # Parse an IMAP datetime formatted string into a Time.
+
+  def self.imapdatetime str
+    Time.strptime str, IMAPDATETIME
+  end
 
   ##
   # Formats this Time as an IMAP-style date.
 
   def imapdate
-    strftime '%d-%b-%Y'
+    strftime IMAPDATE
   end
 
   ##
@@ -17,8 +34,13 @@ class Time
   # Go Mr. Leatherpants!
 
   def imapdatetime
-    strftime '%d-%b-%Y %H:%M %Z'
+    strftime IMAPDATETIME
   end
 
-end
+  ##
+  # Format a date into YYYY-MM, common for mailbox extensions.
 
+  def yyyy_mm
+    strftime("%Y-%m")
+  end
+end

data.tar.gz.sig

@@ -1,2 +1,2 @@
-C��>Ƙo�3����0��:��Oɩ��KiXZ��$���foL(�=��=��W-
-5m���݆+cV�1���㹶-\�GLD��W���U���
��0�&
1-�͔C���*��0��n~��C��8�;)���8���x���.ϔ1�/�e����1��AN$�F�ͭDK9�6��V5��g�
+$��q�h�n�D��ǁ��:8�����9rzV��#����	��yz(�������ګIg,����
+I5K�a�P>"4�Ql�3�r��ݣhӻ~%�嶌[���4��J���23�}����

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: imap_processor
 version: !ruby/object:Gem::Version
-  version: '1.7'
+  version: 1.8.0
 platform: ruby
 authors:
 - Ryan Davis
 - Eric Hodel
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDPjCCAiagAwIBAgIBBDANBgkqhkiG9w0BAQsFADBFMRMwEQYDVQQDDApyeWFu
+  MIIDPjCCAiagAwIBAgIBBzANBgkqhkiG9w0BAQsFADBFMRMwEQYDVQQDDApyeWFu
   ZC1ydWJ5MRkwFwYKCZImiZPyLGQBGRYJemVuc3BpZGVyMRMwEQYKCZImiZPyLGQB
-  GRYDY29tMB4XDTE5MTIxMzAwMDIwNFoXDTIwMTIxMjAwMDIwNFowRTETMBEGA1UE
+  GRYDY29tMB4XDTIzMDEwMTA3NTExN1oXDTI0MDEwMTA3NTExN1owRTETMBEGA1UE
   AwwKcnlhbmQtcnVieTEZMBcGCgmSJomT8ixkARkWCXplbnNwaWRlcjETMBEGCgmS
   JomT8ixkARkWA2NvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALda
   b9DCgK+627gPJkB6XfjZ1itoOQvpqH1EXScSaba9/S2VF22VYQbXU1xQXL/WzCkx
@@ -23,14 +23,14 @@ cert_chain:
   qhtV7HJxNKuPj/JFH0D2cswvzznE/a5FOYO68g+YCuFi5L8wZuuM8zzdwjrWHqSV
   gBEfoTEGr7Zii72cx+sCAwEAAaM5MDcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAw
   HQYDVR0OBBYEFEfFe9md/r/tj/Wmwpy+MI8d9k/hMA0GCSqGSIb3DQEBCwUAA4IB
-  AQCkkcHqAa6IKLYGl93rn78J3L+LnqyxaA059n4IGMHWN5bv9KBQnIjOrpLadtYZ
-  vhWkunWDKdfVapBEq5+T4HzqnsEXC3aCv6JEKJY6Zw7iSzl0M8hozuzRr+w46wvT
-  fV2yTN6QTVxqbMsJJyjosks4ZdQYov2zdvQpt1HsLi+Qmckmg8SPZsd+T8uiiBCf
-  b+1ORSM5eEfBQenPXy83LZcoQz8i6zVB4aAfTGGdhxjoMGUEmSZ6xpkOzmnGa9QK
-  m5x9IDiApM+vCELNwDXXGNFEnQBBK+wAe4Pek8o1V1TTOxL1kGPewVOitX1p3xoN
-  h7iEjga8iM1LbZUfiISZ+WrB
+  AQAkg3y+PBnBAPWdxxITm5sPHqdWQgSyCpRA20o4LTuWr8BWhSXBkfQNa7cY6fOn
+  xyM34VPzBFbExv6XOGDfOMFBVaYTHuN9peC/5/umL7kLl+nflXzL2QA7K6LYj5Bg
+  sM574Onr0dZDM6Vn69bzQ7rBIFDfK/OhlPzqKZad4nsdcsVH8ODCiT+ATMIZyz5K
+  WCnNtqlyiWXI8tdTpahDgcUwfcN/oN7v4K8iU5IbLJX6HQ5DKgmKjfb6XyMth16k
+  ROfWo9Uyp8ba/j9eVG14KkYRaLydAY1MNQk2yd3R5CGfeOpD1kttxjoypoUJ2dOG
+  nsNBRuQJ1UfiCG97a6DNm+Fr
   -----END CERTIFICATE-----
-date: 2020-06-04 00:00:00.000000000 Z
+date: 2023-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.22'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.22'
+        version: '4.0'
 description: |-
   IMAPProcessor is a client for processing messages on an IMAP server.  It
   provides some basic mechanisms for connecting to an IMAP server, determining
@@ -92,6 +92,7 @@ executables:
 - imap_keywords
 - imap_learn
 - imap_mkdir
+- imap_tidy
 extensions: []
 extra_rdoc_files:
 - History.rdoc
@@ -110,6 +111,7 @@ files:
 - bin/imap_keywords
 - bin/imap_learn
 - bin/imap_mkdir
+- bin/imap_tidy
 - lib/imap_processor.rb
 - lib/imap_processor/archive.rb
 - lib/imap_processor/cleanse.rb
@@ -119,6 +121,7 @@ files:
 - lib/imap_processor/keywords.rb
 - lib/imap_processor/learn.rb
 - lib/imap_processor/mkdir.rb
+- lib/imap_processor/tidy.rb
 - lib/imap_sasl_plain.rb
 - lib/net/imap/date.rb
 - lib/net/imap/idle.rb
@@ -128,7 +131,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/seattlerb/imap_processor
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--main"
 - README.rdoc
@@ -145,8 +148,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.4.1
+signing_key:
 specification_version: 4
 summary: IMAPProcessor is a client for processing messages on an IMAP server
 test_files: []