imap_processor 1.3 → 1.5

data/lib/imap_processor/learn.rb

@@ -0,0 +1,231 @@
+require 'imap_processor/client'
+require 'fileutils'
+
+require 'rubygems'
+
+begin
+  require 'rbayes'
+rescue LoadError
+  # ignoring
+  class RBayes
+    def initialize *args
+      # nothing to do
+    end
+  end
+end
+
+##
+# IMAPLearn flags messages per-folder based on what you've flagged before.
+#
+# aka part three of my Plan for Total Email Domination.
+
+class IMAPProcessor::Learn < IMAPProcessor::Client
+
+  ##
+  # IMAP keyword for learned messages
+
+  LEARN_KEYWORD = 'IMAPLEARN_FLAGGED'
+
+  ##
+  # IMAP keyword for tasty messages
+
+  TASTY_KEYWORD = LEARN_KEYWORD + '_TASTY'
+
+  ##
+  # IMAP keyword for bland messages
+
+  BLAND_KEYWORD = LEARN_KEYWORD + '_BLAND'
+
+  ##
+  # Handles processing of +args+.
+
+  def self.process_args(args)
+    @@options[:Threshold] = [0.85, 'Tastiness threshold not set']
+
+    super __FILE__, args, {} do |opts, options|
+      opts.on("-t", "--threshold THRESHOLD",
+              "Flag messages more tasty than THRESHOLD",
+              "Default: #{options[:Threshold].inspect}",
+              "Options file name: Threshold", Float) do |threshold|
+        options[:Threshold] = threshold
+      end
+    end
+  end
+
+  ##
+  # Creates a new IMAPLearn from +options+.
+  #
+  # Options include:
+  #   +:Threshold+:: Tastiness threshold for flagging
+  #
+  # and all options from IMAPClient
+
+  def initialize(options)
+    super
+
+    @db_root = File.join '~', '.imap_learn',
+                      "#{options[:User]}@#{options[:Host]}:#{options[:Port]}"
+    @db_root = File.expand_path @db_root
+
+    @threshold = options[:Threshold]
+
+    @classifiers = Hash.new do |h,k|
+      filter_db = File.join @db_root, "#{k}.db"
+      FileUtils.mkdir_p File.dirname(filter_db)
+      h[k] = RBayes.new filter_db
+    end
+
+    @unlearned_flagged = []
+    @tasty_unflagged = []
+    @bland_flagged = []
+    @tasty_unlearned = []
+    @bland_unlearned = []
+
+    @noop = false
+  end
+
+  ##
+  # Flags tasty messages from all selected mailboxes.
+
+  def run
+    log "Flagging tasty messages"
+
+    message_count = 0
+    mailboxes = find_mailboxes
+
+    mailboxes.each do |mailbox|
+      @mailbox = mailbox
+      @imap.select @mailbox
+      log "Selected #{@mailbox}"
+
+      message_count += process_unlearned_flagged
+      message_count += process_tasty_unflagged
+      message_count += process_bland_flagged
+      message_count += process_unlearned
+    end
+
+    log "Done. Found #{message_count} messages in #{mailboxes.length} mailboxes"
+  end
+
+  private
+
+  ##
+  # Returns an Array of tasty message sequence numbers.
+
+  def unlearned_flagged_in_curr
+    log "Finding unlearned, flagged messages"
+
+    @unlearned_flagged = @imap.search [
+      'FLAGGED',
+      'NOT', 'KEYWORD', LEARN_KEYWORD
+    ]
+
+    update_db @unlearned_flagged, :add_tasty
+
+    @unlearned_flagged.length
+  end
+
+  ##
+  # Returns an Array of message sequence numbers that should be marked as
+  # bland.
+
+  def tasty_unflagged_in_curr
+    log "Finding messages re-marked bland"
+
+    @bland_flagged = @imap.search [
+     'NOT', 'FLAGGED',
+     'KEYWORD', TASTY_KEYWORD
+    ]
+
+    update_db @tasty_unflagged, :remove_tasty, :add_bland
+    
+    @bland_flagged.length
+  end
+
+  ##
+  # Returns an Array of tasty message sequence numbers that should be marked
+  # as tasty.
+
+  def bland_flagged_in_curr
+    log "Finding messages re-marked tasty"
+    @bland_flagged = @imap.search [
+      'FLAGGED',
+      'KEYWORD', BLAND_KEYWORD
+    ]
+
+    update_db @bland_flagged, :remove_bland, :add_tasty
+
+    @bland_flagged.length
+  end
+
+  ##
+  # Returns two Arrays, one of tasty message sequence numbers and one of bland
+  # message sequence numbers.
+
+  def unlearned_in_curr
+    log "Learning new, unmarked messages"
+    unlearned = @imap.search [
+      'NOT', 'KEYWORD', LEARN_KEYWORD
+    ]
+
+    tasty = []
+    bland = []
+
+    chunk unlearned do |messages|
+      bodies = @imap.fetch messages, 'RFC822'
+      bodies.each do |body|
+        text = body.attr['RFC822']
+        bucket = classify(text) ? tasty : bland
+        bucket << body.seqno
+      end
+    end
+
+    update_db tasty, :add_tasty
+    update_db bland, :add_bland
+
+    tasty.length + bland.length
+  end
+
+  def chunk(messages, size = 20)
+    messages = messages.dup
+
+    until messages.empty? do
+      chunk = messages.slice! 0, size
+      yield chunk
+    end
+  end
+
+  ##
+  # Returns true if +text+ is "tasty"
+
+  def classify(text)
+    rating = @classifiers[@mailbox].rate text
+    rating > @threshold
+  end
+
+  def update_db(messages, *actions)
+    chunk messages do |chunk|
+      bodies = @imap.fetch chunk, 'RFC822'
+      bodies.each do |body|
+        text = body.attr['RFC822']
+        actions.each do |action|
+          @classifiers[@mailbox].update_db_with text, action
+          case action
+          when :add_bland then
+            @imap.store body.seqno, '+FLAG.SILENT',
+                        [LEARN_KEYWORD, BLAND_KEYWORD]
+          when :add_tasty then
+            @imap.store body.seqno, '+FLAG.SILENT',
+                        [:Flagged, LEARN_KEYWORD, TASTY_KEYWORD]
+          when :remove_bland then
+            @imap.store body.seqno, '-FLAG.SILENT', [BLAND_KEYWORD]
+          when :remove_tasty then
+            @imap.store body.seqno, '-FLAG.SILENT', [TASTY_KEYWORD]
+          end
+        end
+      end
+    end
+  end
+
+end
+

data/lib/imap_processor/mkdir.rb

@@ -0,0 +1,25 @@
+require 'imap_processor'
+
+##
+# Creates folders in IMAP.
+
+class IMAPProcessor::Mkdir < IMAPProcessor
+  attr_reader :sep
+
+  def self.process_args(args)
+    super __FILE__, args
+  end
+
+  def initialize(options)
+    super
+
+    @imap = connect.imap
+  end
+
+  def run
+    ARGV.each do |mailbox|
+      create_mailbox mailbox
+    end
+  end
+end
+

data/test/test_imap_processor.rb

@@ -1,3 +1,4 @@
+require 'rubygems'
 require 'minitest/autorun'
 require 'imap_processor'
 require 'time'
@@ -41,6 +42,8 @@ class TestIMAPProcessor < MiniTest::Unit::TestCase
     @ip.instance_variable_set :@imap, @imap
 
     @delim = @imap.list('', 'INBOX').first.delim
+
+    @NI = Net::IMAP
   end
 
   def teardown
@@ -60,6 +63,40 @@ class TestIMAPProcessor < MiniTest::Unit::TestCase
   test.setup
   test.teardown
 
+  def test_capability
+    res =
+      @NI::UntaggedResponse.new('OK',
+        @NI::ResponseText.new(
+          @NI::ResponseCode.new('CAPABILITY',
+            'IMAP4rev1 LITERAL+ SASL-IR LOGIN-REFERRALS ID ENABLE AUTH=PLAIN'),
+          'Dovecot ready.'),
+        "OK [CAPABAILITY ...] Dovecot ready.\r\n")
+
+    cap = @ip.capability @imap, res
+
+    assert_equal \
+      %w[IMAP4rev1 LITERAL+ SASL-IR LOGIN-REFERRALS ID ENABLE AUTH=PLAIN],
+      cap
+  end
+
+  def test_capability_no_cap
+    res =
+      @NI::TaggedResponse.new('RUBY0001', 'OK',
+        @NI::ResponseText.new(nil,
+          'User logged in'),
+        "RUBY0001 OK User logged in\r\n")
+
+    cap = @ip.capability @imap, res
+
+    assert_includes cap, 'IMAP4REV1'
+  end
+
+  def test_capability_no_res
+    cap = @ip.capability @imap
+
+    assert_includes cap, 'IMAP4REV1'
+  end
+
   def test_create_mailbox
     @imap.create "directory#{@delim}"
 

metadata

@@ -1,114 +1,163 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: imap_processor
-version: !ruby/object:Gem::Version 
-  version: "1.3"
+version: !ruby/object:Gem::Version
+  version: '1.5'
 platform: ruby
-authors: 
+authors:
 - Eric Hodel
+- Ryan Davis
 autorequire: 
 bindir: bin
-cert_chain: 
+cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDNjCCAh6gAwIBAgIBADANBgkqhkiG9w0BAQUFADBBMRAwDgYDVQQDDAdkcmJy
-  YWluMRgwFgYKCZImiZPyLGQBGRYIc2VnbWVudDcxEzARBgoJkiaJk/IsZAEZFgNu
-  ZXQwHhcNMDcxMjIxMDIwNDE0WhcNMDgxMjIwMDIwNDE0WjBBMRAwDgYDVQQDDAdk
-  cmJyYWluMRgwFgYKCZImiZPyLGQBGRYIc2VnbWVudDcxEzARBgoJkiaJk/IsZAEZ
-  FgNuZXQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCbbgLrGLGIDE76
-  LV/cvxdEzCuYuS3oG9PrSZnuDweySUfdp/so0cDq+j8bqy6OzZSw07gdjwFMSd6J
-  U5ddZCVywn5nnAQ+Ui7jMW54CYt5/H6f2US6U0hQOjJR6cpfiymgxGdfyTiVcvTm
-  Gj/okWrQl0NjYOYBpDi+9PPmaH2RmLJu0dB/NylsDnW5j6yN1BEI8MfJRR+HRKZY
-  mUtgzBwF1V4KIZQ8EuL6I/nHVu07i6IkrpAgxpXUfdJQJi0oZAqXurAV3yTxkFwd
-  g62YrrW26mDe+pZBzR6bpLE+PmXCzz7UxUq3AE0gPHbiMXie3EFE0oxnsU3lIduh
-  sCANiQ8BAgMBAAGjOTA3MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
-  BBS5k4Z75VSpdM0AclG2UvzFA/VW5DANBgkqhkiG9w0BAQUFAAOCAQEAHagT4lfX
-  kP/hDaiwGct7XPuVGbrOsKRVD59FF5kETBxEc9UQ1clKWngf8JoVuEoKD774dW19
-  bU0GOVWO+J6FMmT/Cp7nuFJ79egMf/gy4gfUfQMuvfcr6DvZUPIs9P/TlK59iMYF
-  DIOQ3DxdF3rMzztNUCizN4taVscEsjCcgW6WkUJnGdqlu3OHWpQxZBJkBTjPCoc6
-  UW6on70SFPmAy/5Cq0OJNGEWBfgD9q7rrs/X8GGwUWqXb85RXnUVi/P8Up75E0ag
-  14jEc90kN+C7oI/AGCBN0j6JnEtYIEJZibjjDJTSMWlUKKkj30kq7hlUC2CepJ4v
-  x52qPcexcYZR7w==
+  MIIDPjCCAiagAwIBAgIBATANBgkqhkiG9w0BAQUFADBFMRMwEQYDVQQDDApyeWFu
+  ZC1ydWJ5MRkwFwYKCZImiZPyLGQBGRYJemVuc3BpZGVyMRMwEQYKCZImiZPyLGQB
+  GRYDY29tMB4XDTEzMDkxNjIzMDQxMloXDTE0MDkxNjIzMDQxMlowRTETMBEGA1UE
+  AwwKcnlhbmQtcnVieTEZMBcGCgmSJomT8ixkARkWCXplbnNwaWRlcjETMBEGCgmS
+  JomT8ixkARkWA2NvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALda
+  b9DCgK+627gPJkB6XfjZ1itoOQvpqH1EXScSaba9/S2VF22VYQbXU1xQXL/WzCkx
+  taCPaLmfYIaFcHHCSY4hYDJijRQkLxPeB3xbOfzfLoBDbjvx5JxgJxUjmGa7xhcT
+  oOvjtt5P8+GSK9zLzxQP0gVLS/D0FmoE44XuDr3iQkVS2ujU5zZL84mMNqNB1znh
+  GiadM9GHRaDiaxuX0cIUBj19T01mVE2iymf9I6bEsiayK/n6QujtyCbTWsAS9Rqt
+  qhtV7HJxNKuPj/JFH0D2cswvzznE/a5FOYO68g+YCuFi5L8wZuuM8zzdwjrWHqSV
+  gBEfoTEGr7Zii72cx+sCAwEAAaM5MDcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAw
+  HQYDVR0OBBYEFEfFe9md/r/tj/Wmwpy+MI8d9k/hMA0GCSqGSIb3DQEBBQUAA4IB
+  AQCFZ7JTzoy1gcG4d8A6dmOJy7ygtO5MFpRIz8HuKCF5566nOvpy7aHhDDzFmQuu
+  FX3zDU6ghx5cQIueDhf2SGOncyBmmJRRYawm3wI0o1MeN6LZJ/3cRaOTjSFy6+S6
+  zqDmHBp8fVA2TGJtO0BLNkbGVrBJjh0UPmSoGzWlRhEVnYC33TpDAbNA+u39UrQI
+  ynwhNN7YbnmSR7+JU2cUjBFv2iPBO+TGuWC+9L2zn3NHjuc6tnmSYipA9y8Hv+As
+  Y4evBVezr3SjXz08vPqRO5YRdO3zfeMT8gBjRqZjWJGMZ2lD4XNfrs7eky74CyZw
+  xx3n58i0lQkBE1EpKE0lFu/y
   -----END CERTIFICATE-----
-
-date: 2009-08-04 00:00:00 -07:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-08-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.4'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
   name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
   type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 2.3.2
-    version: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
 description: |-
   IMAPProcessor is a client for processing messages on an IMAP server.  It
   provides some basic mechanisms for connecting to an IMAP server, determining
   capabilities and handling messages.
-  
-  IMAPProcessor ships with the executables imap_keywords which can query an IMAP
-  server for keywords set on messages in mailboxes, imap_idle which can show new
-  messages in a mailbox and imap_archive which will archive old messages to a
-  new mailbox.
-email: 
+
+
+  IMAPProcessor ships with several executables which can query and
+  manipulate IMAP mailboxes in several different ways:
+
+  imap_archive  :: Archives old messages to a new dated mailbox.
+  imap_cleanse  :: Delete messages older than a certain age in specified mailboxes.
+  imap_flag     :: Flag messages to/from certain people.
+  imap_idle     :: Shows new messages in a mailbox.
+  imap_keywords :: Queries an IMAP server for keywords set on messages
+  imap_learn    :: Flags messages based on what you've flagged before.
+  imap_mkdir    :: Ensures that certain mailboxes exist.
+email:
 - drbrain@segment7.net
-executables: 
+- ryand-ruby@zenspider.com
+executables:
 - imap_archive
+- imap_cleanse
+- imap_flag
 - imap_idle
 - imap_keywords
+- imap_learn
+- imap_mkdir
 extensions: []
-
-extra_rdoc_files: 
-- History.txt
+extra_rdoc_files:
+- History.rdoc
 - Manifest.txt
-- README.txt
-files: 
+- README.rdoc
+files:
 - .autotest
-- History.txt
+- .gemtest
+- History.rdoc
 - Manifest.txt
-- README.txt
+- README.rdoc
 - Rakefile
 - bin/imap_archive
+- bin/imap_cleanse
+- bin/imap_flag
 - bin/imap_idle
 - bin/imap_keywords
+- bin/imap_learn
+- bin/imap_mkdir
 - lib/imap_processor.rb
 - lib/imap_processor/archive.rb
+- lib/imap_processor/cleanse.rb
+- lib/imap_processor/client.rb
+- lib/imap_processor/flag.rb
 - lib/imap_processor/idle.rb
 - lib/imap_processor/keywords.rb
+- lib/imap_processor/learn.rb
+- lib/imap_processor/mkdir.rb
 - lib/imap_sasl_plain.rb
 - lib/net/imap/date.rb
 - lib/net/imap/idle.rb
 - test/test_imap_processor.rb
-has_rdoc: true
 homepage: http://seattlerb.rubyforge.org/imap_processor
-licenses: []
-
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --main
-- README.txt
-require_paths: 
+- README.rdoc
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: seattlerb
-rubygems_version: 1.3.5
+rubyforge_project: 
+rubygems_version: 2.2.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: IMAPProcessor is a client for processing messages on an IMAP server
-test_files: 
+test_files:
 - test/test_imap_processor.rb