imap_processor 1.1.1 → 1.7

data/lib/imap_processor/idle.rb

@@ -0,0 +1,74 @@
+require 'imap_processor'
+require 'net/imap/idle'
+
+##
+# Example class that supports IDLE on a mailbox and lists messages added or
+# expunged.
+
+class IMAPProcessor::IDLE < IMAPProcessor
+
+  def self.process_args(args)
+    super __FILE__, args do |opts, options|
+      opts.banner << <<-EOF
+imap_idle lists messages added or expunged from a mailbox
+      EOF
+    end
+  end
+
+  def initialize(options)
+    super
+
+    raise IMAPProcessor::Error, 'only one mailbox is supported' if
+      @boxes.length > 1
+  end
+
+  def run
+    mailbox = @boxes.first
+
+    connect do |connection|
+      raise IMAPProcessor::Error, 'IDLE not supported on this server' unless
+        connection.idle?
+
+      imap = connection.imap
+
+      imap.select mailbox
+      exists = imap.responses['EXISTS'].first
+
+      log "Starting IDLE"
+
+      imap.idle do |response|
+        next unless Net::IMAP::UntaggedResponse === response
+
+        case response.name
+        when 'EXPUNGE' then
+          puts "Expunged message #{response.data}"
+        when 'EXISTS' then
+          latest_uid = response.data
+          new = latest_uid - exists
+          puts "#{new} messages added"
+
+          show_messages_in mailbox, ((exists + 1)..latest_uid)
+
+          exists = response.data
+        when 'RECENT' then
+          puts "#{response.data} recent messages"
+        when 'OK' then # ending IDLE
+        else
+          log "Unhandled untagged response: #{response.name}"
+        end
+      end
+    end
+  end
+
+  def show_messages_in(mailbox, uids)
+    connect do |connection|
+      imap = connection.imap
+
+      imap.select mailbox
+
+      show_messages uids
+    end
+  end
+
+end
+

data/lib/imap_processor/keywords.rb

@@ -33,7 +33,7 @@ previously set keywords.
       end
 
       opts.on(      "--[no-]list",
-              "Don't display messages") do |list|
+              "Display messages") do |list|
         options[:List] = list
       end
 
@@ -47,11 +47,11 @@ previously set keywords.
   def initialize(options)
     super
 
-    @add = options[:Add]
-    @delete = options[:Delete]
+    @add      = options[:Add]
+    @delete   = options[:Delete]
     @keywords = options[:Keywords]
-    @not = options[:Not] ? 'NOT' : nil
-    @list = options[:List]
+    @not      = options[:Not] ? 'NOT' : nil
+    @list     = options[:List]
 
     if @add and @delete then
       raise OptionParser::InvalidOption, "--add and --delete are exclusive"
@@ -60,8 +60,7 @@ previously set keywords.
             "--add and --delete require --keywords"
     end
 
-    connection = connect options[:Host], options[:Port], options[:SSL],
-                         options[:Username], options[:Password], options[:Auth]
+    connection = connect
 
     @imap = connection.imap
   end
@@ -134,18 +133,14 @@ previously set keywords.
     return unless @list
 
     responses = @imap.fetch uids, [
-      'BODY.PEEK[HEADER]',
+      Net::IMAP::RawData.new('BODY.PEEK[HEADER.FIELDS (SUBJECT MESSAGE-ID)]'),
       'FLAGS'
     ]
 
     responses.each do |res|
-      header = res.attr['BODY[HEADER]']
+      header = res.attr['BODY[HEADER.FIELDS (SUBJECT MESSAGE-ID)]']
 
-      header =~ /^Subject: (.*)/i
-      puts "Subject: #{$1}"
-
-      header =~ /^Message-Id: (.*)/i
-      puts "Message-Id: #{$1}"
+      puts header.chomp
 
       flags = res.attr['FLAGS'].map { |flag| flag.inspect }.join ', '
 

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/lib/imap_sasl_plain.rb

@@ -1,29 +1,5 @@
-require 'time'
 require 'net/imap'
 
-class Time
-
-  ##
-  # Formats this Time as an IMAP-style date.
-
-  def imapdate
-    strftime '%d-%b-%Y'
-  end
-
-  ##
-  # Formats this Time as an IMAP-style datetime.
-  #
-  # RFC 2060 doesn't specify the format of its times.  Unfortunately it is
-  # almost but not quite RFC 822 compliant.
-  #--
-  # Go Mr. Leatherpants!
-
-  def imapdatetime
-    strftime '%d-%b-%Y %H:%M %Z'
-  end
-
-end
-
 ##
 # RFC 2595 PLAIN Authenticator for Net::IMAP.  Only for use with SSL (but not
 # enforced).
@@ -56,10 +32,9 @@ class Net::IMAP::PlainAuthenticator
     @password = password
   end
 
-end
+end unless defined? Net::IMAP::PlainAuthenticator
 
 if defined? OpenSSL then
   Net::IMAP.add_authenticator 'PLAIN', Net::IMAP::PlainAuthenticator
 end
 
-

data/lib/net/imap/date.rb

@@ -0,0 +1,24 @@
+
+class Time
+
+  ##
+  # Formats this Time as an IMAP-style date.
+
+  def imapdate
+    strftime '%d-%b-%Y'
+  end
+
+  ##
+  # Formats this Time as an IMAP-style datetime.
+  #
+  # RFC 2060 doesn't specify the format of its times.  Unfortunately it is
+  # almost but not quite RFC 822 compliant.
+  #--
+  # Go Mr. Leatherpants!
+
+  def imapdatetime
+    strftime '%d-%b-%Y %H:%M %Z'
+  end
+
+end
+