IMAPCleanse 1.0.0 → 1.1.0

data/Manifest.txt

@@ -1,16 +1,10 @@
-.DS_Store
-CVS/Entries
-CVS/Repository
-CVS/Root
 LICENSE
 Manifest.txt
 README
 Rakefile
-bin/CVS/Entries
-bin/CVS/Repository
-bin/CVS/Root
 bin/imap_cleanse
-lib/CVS/Entries
-lib/CVS/Repository
-lib/CVS/Root
+bin/imap_flag
 lib/imap_cleanse.rb
+lib/imap_client.rb
+lib/imap_flag.rb
+lib/imap_sasl_plain.rb

data/README

@@ -10,7 +10,11 @@ http://seattlerb.rubyforge.org/IMAPCleanse/
 
 == About
 
-IMAPCleanse removes old, read, unflagged messages from your IMAP mailboxes.
+IMAPCleanse removes old, read, unflagged messages from my IMAP mailboxes.
+
+IMAPFlag flags messages I find interesting so I don\'t have to!
+
+Both these tools can do this for you, too!
 
 == Why?
 
@@ -19,8 +23,20 @@ have context when reading threads.  Since I'm lazy my more-trafficed mailboxes
 can end up with tens of thousands of read messages.  Deleting this many
 messages with Mail.app is time consuming and boring.
 
-So I wrote IMAPCleanse to clean out my old mailboxes for me.  If I want to keep
-a message around for forever I'll just flag it and IMAPCleanse won't touch it.
+So I wrote imap_cleanse  to clean out my old mailboxes for me.  If I want to
+keep a message around for forever I'll just flag it and imap_cleanse won't
+touch it.
+
+imap_cleanse eventually became known as Part One of my Plan for Total Email
+Domination.
+
+Next up I decided to automatically flag messages that were interesting.  (Part
+Two of my Plan for Total Email Domination.)  I defined interesting as messages
+I responded to, messages I wrote (naturally!) and messages in response to
+messages I wrote.
+
+Part Three of my Plan for Total Email Domination is awaiting more flagged
+messages.
 
 == Installing IMAPCleanse
 
@@ -28,19 +44,19 @@ Just install the gem:
 
   $ sudo gem install IMAPCleanse
 
-== Using IMAPCleanse
+== Using imap_cleanse
 
 In short:
 
   imap_cleanse -H mail.example.com -p mypassword -b Lists/FreeBSD/current,Lists/Ruby -a 30
 
-The help for IMAPCleanse should be sufficiently verbose, but here's a couple of
+The help for imap_cleanse should be sufficiently verbose, but here's a couple of
 tips:
 
 === --noop and --verbose
 
-The --noop flag tells IMAPCleanse not to delete anything.  When combined with
-the --verbose flag you can see how many messages IMAPCleanse would have deleted
+The --noop flag tells imap_cleanse not to delete anything.  When combined with
+the --verbose flag you can see how many messages imap_cleanse would have deleted
 from which mailboxes.
 
   $ ruby -Ilib bin/imap_cleanse -nv
@@ -60,13 +76,14 @@ from which mailboxes.
   # Found 0 messages
   # Done. Found 0 messages in 23 mailboxes
 
-(Since I just ran IMAPCleanse it didn't have anything to do.)
+(Since I just ran imap_cleanse it didn't have anything to do.)
 
 === ~/.imap_cleanse
 
 The ~/.imap_cleanse file can hold your password and other options so you don't
 have to type them in on the command line every time.  The format is simple,
-just the options file name followed by '=' followed by the argument.
+just the option name followed by '=' followed by the argument.  (Check -v for
+option names.)
 
 No whitespace is stripped from options, so be sure to do that yourself.  Mine
 looks something like this:
@@ -77,4 +94,21 @@ looks something like this:
   Boxes=Lists/FreeBSD/current,Lists/FreeBSD/performance,Lists/FreeBSD/Soekris,Lists/FreeBSD/stable,Lists/Ruby
   Age=30
   Password=my password
+  Email=drbrain@segment7.net
+
+== Using imap_flag
+
+In short:
+
+  imap_flag -H mail.example.com -p mypassword -b Lists/FreeBSD/current,Lists/Ruby -e drbrain@segment7.net
+
+The help for imap_flag should be sufficiently verbose and the tips are the same
+as those for imap_cleanse.  (imap_flag even reads ~/.imap_cleanse, so you can
+shove that extra Email option right in there!)
+
+== Bugs
+
+Yeah, there probably is one, or maybe even three.  Report them here:
+
+http://rubyforge.org/tracker/?group_id=1513
 

data/Rakefile

@@ -3,21 +3,24 @@ require 'rake'
 require 'rake/testtask'
 require 'rake/rdoctask'
 require 'rake/gempackagetask'
+require 'rake/contrib/sshpublisher'
 
 $VERBOSE = nil
 
 spec = Gem::Specification.new do |s|
   s.name = 'IMAPCleanse'
-  s.version = '1.0.0'
-  s.summary = 'Cleanses your IMAP mailboxes of oldness'
-  s.description = 'IMAPCleanse removes old, read, unflagged messages from your IMAP mailboxes so you don\'t have to!'
+  s.version = '1.1.0'
+  s.summary = 'Removes mailbox oldness, finds mailbox interestingness!'
+  s.description = 'IMAPCleanse removes old, read, unflagged messages from your IMAP mailboxes so you don\'t have to!
+  
+IMAPFlag flags messages I find interesting so I don\'t have to!'
   s.author = 'Eric Hodel'
   s.email = 'drbrain@segment7.net'
 
   s.has_rdoc = true
   s.files = File.read('Manifest.txt').split($/)
   s.require_path = 'lib'
-  s.executables = 'imap_cleanse'
+  s.executables = %w[imap_cleanse imap_flag]
 end
 
 desc 'Run tests'
@@ -40,7 +43,16 @@ Rake::RDocTask.new :rdoc do |rd|
   rd.rdoc_files.add 'lib', 'README', 'LICENSE'
   rd.main = 'README'
   rd.options << '-d' if `which dot` =~ /\/dot/
-  rd.options << '-t IMAPCreate'
+  rd.options << '-t IMAPCleanse'
+end
+
+desc 'Upload RDoc to RubyForge'
+task :upload => :rdoc do
+  user = "#{ENV['USER']}@rubyforge.org"
+  project = '/var/www/gforge-projects/seattlerb/IMAPCleanse'
+  local_dir = 'doc'
+  pub = Rake::SshDirPublisher.new user, project, local_dir
+  pub.upload
 end
 
 desc 'Build Gem'

data/bin/imap_flag

@@ -0,0 +1,6 @@
+#!/usr/local/bin/ruby -w
+
+require 'imap_flag'
+
+IMAPFlag.run
+

data/lib/imap_cleanse.rb

@@ -1,346 +1,68 @@
-require 'net/imap'
-require 'optparse'
-require 'pp'
-require 'time'
-
-class Time
-
-  ##
-  # Formats this Time as an IMAP-style date.
-  #
-  # RFC 2060 doesn't specify the format of its times.  Unfortunately it is
-  # almost but not quite RFC 822 dates.
-
-  def imapdate
-    strftime '%d-%b-%Y %H:%M %Z'
-  end
-end
-
-##
-# RFC 2595 PLAIN Authenticator for Net::IMAP.  Only for use with SSL (but not
-# enforced).
-
-class Net::IMAP::PlainAuthenticator
-
-  ##
-  # From RFC 2595 Section 6. PLAIN SASL Authentication
-  #
-  #  The mechanism consists of a single message from the client to the
-  #  server.  The client sends the authorization identity (identity to
-  #  login as), followed by a US-ASCII NUL character, followed by the
-  #  authentication identity (identity whose password will be used),
-  #  followed by a US-ASCII NUL character, followed by the clear-text
-  #  password.  The client may leave the authorization identity empty to
-  #  indicate that it is the same as the authentication identity.
-
-  def process(data)
-    return [@user, @user, @password].join("\0")
-  end
-
-  private
-
-  ##
-  # Creates a new PlainAuthenticator that will authenticate with +user+ and
-  # +password+.
-
-  def initialize(user, password)
-    @user = user
-    @password = password
-  end
-
-end
-
-if defined? OpenSSL then
-  Net::IMAP.add_authenticator 'PLAIN', Net::IMAP::PlainAuthenticator
-end
+require 'imap_client'
 
 ##
 # IMAPCleanse removes old messages from your IMAP mailboxes so you don't have
 # to!
+#
+# aka part three of my Plan for Total Email Domination.
+#
+# IMAPClient doesn't remove messages you haven't read nor messages you've
+# flagged.  See also IMAPFlag for automatic flagging goodness!
 
-class IMAPCleanse
+class IMAPCleanse < IMAPClient
 
   ##
   # Handles processing of +args+.
 
   def self.process_args(args)
-    opts_file = File.expand_path '~/.imap_cleanse'
-
-    unless File.stat(opts_file).mode & 077 == 0 then
-      STDERR.puts "WARNING! #{opts_file} is group/other readable or writable!"
-      STDERR.puts "WARNING! I'm not doing a thing until you fix it!"
-      exit 1
-    end
-
-    options = {}
-
-    File.readlines(opts_file).map { |l| l.chomp.split '=', 2 }.each do |k,v|
-      v = true  if v == 'true'
-      v = false if v == 'false'
-      v = Integer(v) rescue v
-      options[k.intern] = v
-    end
-
-    options[:SSL]      ||= true
-    options[:Username] ||= ENV['USER']
-    options[:Root]     ||= 'mail'
-    options[:Noop]     ||= false
-    options[:Verbose]  ||= false
-
-    opts = OptionParser.new do |opts|
-      opts.banner = 'Usage: imap_cleanse [options]'
-      opts.separator ''
-      opts.separator 'Options may also be set in the options file ~/.imap_cleanse.'
-      opts.separator ''
-      opts.separator 'Example ~/.imap_cleanse:'
-      opts.separator "\tHost=mail.example.com"
-      opts.separator "\tPassword=my password"
-
-      opts.separator ''
-      opts.separator 'Connection options:'
-
-      opts.on("-H", "--host HOST",
-              "IMAP server host",
-              "Default: #{options[:Host].inspect}",
-              "Options file name: Host") do |host|
-        options[:Host] = host
-      end
-
-      opts.on("-P", "--port PORT",
-              "IMAP server port",
-              "Default: The correct port SSL/non-SSL mode",
-              "Options file name: Port") do |port|
-        options[:Port] = port
-      end
-
-      opts.on("-s", "--[no-]ssl",
-              "Use SSL for IMAP connection",
-              "Default: #{options[:SSL].inspect}",
-              "Options file name: SSL") do |ssl|
-        options[:SSL] = ssl
-      end
-
-      opts.separator ''
-      opts.separator 'Login options:'
-
-      opts.on("-u", "--username USERNAME",
-              "IMAP username",
-              "Default: #{options[:Username].inspect}",
-              "Options file name: Username") do |username|
-        options[:Username] = username
-      end
-
-      opts.on("-p", "--password PASSWORD",
-              "IMAP password",
-              "Default: Read from ~/.imap_cleanse",
-              "Options file name: Password") do |password|
-        options[:Password] = password
-      end
-
-      opts.separator ''
-      opts.separator 'Cleansing options:'
-
-      opts.on("-r", "--root ROOT",
-              "Root of mailbox hierarchy",
-              "Default: #{options[:Root].inspect}",
-              "Options file name: Root") do |root|
-        options[:Root] = root
-      end
-
-      opts.on("-b", "--boxes BOXES",
-              "Comma-separated list of mailbox name",
-              "prefixes to cleanse",
-              "Default: #{options[:Boxes].inspect}",
-              "Options file name: Boxes") do |boxes|
-        options[:Boxes] = boxes
-      end
+    extra_options = { :Age => [nil, 'Age option not set'] }
 
+    super args, extra_options do |opts, options|
       opts.on("-a", "--age AGE",
               "Delete messages more than AGE days old",
               "Default: #{options[:Age].inspect}",
               "Options file name: Age", Integer) do |age|
         options[:Age] = age
       end
-
-      opts.on("-n", "--noop",
-              "Perform no destructive operations",
-              "Best used with the verbose option",
-              "Default: #{options[:Noop].inspect}",
-              "Options file name: Noop") do |noop|
-        options[:Noop] = noop
-      end
-
-      opts.on("-v", "--[no-]verbose",
-              "Be verbose",
-              "Default: #{options[:Verbose].inspect}",
-              "Options file name: Verbose") do |verbose|
-        options[:Verbose] = verbose
-      end
-
-      opts.separator ''
-
-      opts.on("-h", "--help",
-              "You're looking at it") do
-        STDERR.puts opts
-        exit 1
-      end
-
-      opts.separator ''
-    end
-
-    opts.parse! args
-
-    options[:Port] ||= options[:SSL] ? 993 : 143
-
-    if options[:Host].nil? or
-       options[:Password].nil? or
-       options[:Boxes].nil? or
-       options[:Age].nil? then
-      STDERR.puts opts
-      STDERR.puts
-      STDERR.puts "Host name not set"    if options[:Host].nil?
-      STDERR.puts "Password not set"     if options[:Password].nil?
-      STDERR.puts "Boxes option not set" if options[:Boxes].nil?
-      STDERR.puts "Age option not set"   if options[:Age].nil?
-      exit 1
     end
-
-    return options
-  end
-
-  ##
-  # Sets up IMAPCleanse options then cleanses mailboxes.
-
-  def self.run(args = ARGV)
-    options = process_args args
-    cleanser = new options
-    cleanser.cleanse
   end
 
   ##
   # Creates a new IMAPCleanse from +options+.
   #
   # Options include:
-  #   +:Verbose+:: Verbose flag
-  #   +:Noop+:: Don't delete anything flag
-  #   +:Root+:: IMAP root path
-  #   +:Boxes+:: Comma-separated list of mailbox prefixes to cleanse
   #   +:Age+:: Delete messages older than this many days ago
-  #   +:Host+:: IMAP server
-  #   +:Port+:: IMAP server port
-  #   +:SSL+:: SSL flag
-  #   +:Username+:: IMAP username
-  #   +:Password+:: IMAP password
+  #
+  # and all options from IMAPClient
 
   def initialize(options)
-    @verbose = options[:Verbose]
-    @noop    = options[:Noop]
-    @root    = options[:Root]
-
-    boxes = options[:Boxes].split(',').map { |b| Regexp.escape b }
-    @box_re = /^#{Regexp.escape @root}\/#{Regexp.union(*boxes)}/
-
     @before_date = (Time.now - 86400 * options[:Age]).imapdate
-
-    connect options[:Host], options[:Port], options[:SSL],
-            options[:Username], options[:Password]
+    super
   end
 
   ##
   # Removes read, unflagged messages from all selected mailboxes...
-  # 
-  # Unless :Noop was set, then it just prints out what it would do.
-
-  def cleanse
-    log "Cleansing read, unflagged messages older than #{@before_date}"
-
-    message_count = 0
-    mailboxes = find_mailboxes
 
-    mailboxes.each do |mailbox|
-      @imap.select mailbox
-      log "Selected #{mailbox}"
-
-      messages = old_messages_in_curr
-      next if messages.empty?
-
-      message_count += messages.length
-
-      if @noop then
-        log "Noop - nothing deleted"
-        next
-      end
-
-      purge messages
+  def run
+    super "Cleansing read, unflagged messages older than #{@before_date}",
+          [:Deleted] do
+      @imap.expunge
+      log "Expunged deleted messages"
     end
-
-    log "Done. Found #{message_count} messages in #{mailboxes.length} mailboxes"
   end
 
   private
 
-  ##
-  # Connects to IMAP server +host+ at +port+ using ssl if +ssl+ is true then
-  # logs in as +username+ with +password+.  IMAPCleanse will really only work
-  # with PLAIN auth on SSL sockets, sorry.
-
-  def connect(host, port, ssl, username, password)
-    @imap = Net::IMAP.new host, port, ssl
-    log "Connected to #{host}:#{port}"
-    @imap.authenticate 'PLAIN', username, password
-    log "Logged in as #{username}"
-  end
-
-  ##
-  # Finds mailboxes with messages that were selected by the :Boxes option.
-
-  def find_mailboxes
-    mailboxes = @imap.list(@root, "*")
-    mailboxes.reject! { |mailbox| mailbox.attr.include? :Noselect }
-    mailboxes.map! { |mailbox| mailbox.name }
-    mailboxes.reject! { |mailbox| mailbox !~ @box_re }
-    mailboxes = mailboxes.sort_by { |m| m.downcase }
-    log "Found #{mailboxes.length} mailboxes to cleanse:"
-    mailboxes.each { |mailbox| log "\t#{mailbox}" } if @verbose
-    return mailboxes
-  end
-
-  ##
-  # Logs +message+ to STDERR if :Verbose was selected.
-
-  def log(message)
-    return unless @verbose
-    STDERR.puts "# #{message}"
-  end
-
   ##
   # Searches for read, unflagged messages older than :Age in the currently
   # selected mailbox (see Net::IMAP#select).
 
-  def old_messages_in_curr
-    log "Scanning for messages"
-    messages = @imap.search [
+  def find_messages
+    search [
       'NOT', 'NEW',
       'NOT', 'FLAGGED',
       'BEFORE', @before_date
-    ]
-    log "Found #{messages.length} messages"
-    return messages
-  end
-
-  ##
-  # Marks +messages+ in the currently selected mailbox for deletion then
-  # expunges the mailbox (see Net::IMAP#store and Net::IMAP#expunge).
-
-  def purge(messages)
-    until messages.empty? do
-      chunk = messages.slice! 0, 500
-      @imap.store chunk, '+FLAGS', [:Deleted]
-    end
-    log "Marked messages for deletion"
-
-    @imap.expunge
-    log "Expunged deleted messages"
+    ], 'read, unflagged messages'
   end
 
 end

data/lib/imap_client.rb

@@ -0,0 +1,293 @@
+require 'net/imap'
+require 'imap_sasl_plain'
+require 'optparse'
+
+##
+# An IMAPClient used by IMAPFlag and IMAPCleanse.
+#
+# Probably not very reusable by you, but it has lots of example code.
+
+class IMAPClient
+
+  ##
+  # Handles processing of +args+.
+
+  def self.process_args(args, extra_options)
+    opts_file = File.expand_path '~/.imap_cleanse'
+
+    unless File.stat(opts_file).mode & 077 == 0 then
+      $stderr.puts "WARNING! #{opts_file} is group/other readable or writable!"
+      $stderr.puts "WARNING! I'm not doing a thing until you fix it!"
+      exit 1
+    end
+
+    options = {}
+
+    File.readlines(opts_file).map { |l| l.chomp.split '=', 2 }.each do |k,v|
+      v = true  if v == 'true'
+      v = false if v == 'false'
+      v = Integer(v) rescue v
+      options[k.intern] = v
+    end
+
+    options[:SSL]      ||= true
+    options[:Username] ||= ENV['USER']
+    options[:Root]     ||= 'mail'
+    options[:Noop]     ||= false
+    options[:Verbose]  ||= false
+
+    extra_options.each do |k,(v,m)|
+      options[k]       ||= v
+    end
+
+    opts = OptionParser.new do |opts|
+      opts.banner = "Usage: #{File.basename $0} [options]"
+      opts.separator ''
+      opts.separator 'Options may also be set in the options file ~/.imap_cleanse.'
+      opts.separator ''
+      opts.separator 'Example ~/.imap_cleanse:'
+      opts.separator "\tHost=mail.example.com"
+      opts.separator "\tPassword=my password"
+
+      opts.separator ''
+      opts.separator 'Connection options:'
+
+      opts.on("-H", "--host HOST",
+              "IMAP server host",
+              "Default: #{options[:Host].inspect}",
+              "Options file name: Host") do |host|
+        options[:Host] = host
+      end
+
+      opts.on("-P", "--port PORT",
+              "IMAP server port",
+              "Default: The correct port SSL/non-SSL mode",
+              "Options file name: Port") do |port|
+        options[:Port] = port
+      end
+
+      opts.on("-s", "--[no-]ssl",
+              "Use SSL for IMAP connection",
+              "Default: #{options[:SSL].inspect}",
+              "Options file name: SSL") do |ssl|
+        options[:SSL] = ssl
+      end
+
+      opts.separator ''
+      opts.separator 'Login options:'
+
+      opts.on("-u", "--username USERNAME",
+              "IMAP username",
+              "Default: #{options[:Username].inspect}",
+              "Options file name: Username") do |username|
+        options[:Username] = username
+      end
+
+      opts.on("-p", "--password PASSWORD",
+              "IMAP password",
+              "Default: Read from ~/.imap_cleanse",
+              "Options file name: Password") do |password|
+        options[:Password] = password
+      end
+
+      opts.separator ''
+      opts.separator "#{self.class} options:"
+
+      opts.on("-r", "--root ROOT",
+              "Root of mailbox hierarchy",
+              "Default: #{options[:Root].inspect}",
+              "Options file name: Root") do |root|
+        options[:Root] = root
+      end
+
+      opts.on("-b", "--boxes BOXES",
+              "Comma-separated list of mailbox name",
+              "prefixes to search",
+              "Default: #{options[:Boxes].inspect}",
+              "Options file name: Boxes") do |boxes|
+        options[:Boxes] = boxes
+      end
+
+      yield opts, options
+
+      opts.on("-n", "--noop",
+              "Perform no destructive operations",
+              "Best used with the verbose option",
+              "Default: #{options[:Noop].inspect}",
+              "Options file name: Noop") do |noop|
+        options[:Noop] = noop
+      end
+
+      opts.on("-v", "--[no-]verbose",
+              "Be verbose",
+              "Default: #{options[:Verbose].inspect}",
+              "Options file name: Verbose") do |verbose|
+        options[:Verbose] = verbose
+      end
+
+      opts.separator ''
+
+      opts.on("-h", "--help",
+              "You're looking at it") do
+        $stderr.puts opts
+        exit 1
+      end
+
+      opts.separator ''
+    end
+
+    opts.parse! args
+
+    options[:Port] ||= options[:SSL] ? 993 : 143
+
+    if options[:Host].nil? or
+       options[:Password].nil? or
+       options[:Boxes].nil? or
+       extra_options.any? { |k,v| options[k].nil? } then
+      $stderr.puts opts
+      $stderr.puts
+      $stderr.puts "Host name not set"     if options[:Host].nil?
+      $stderr.puts "Password not set"      if options[:Password].nil?
+      $stderr.puts "Boxes option not set"  if options[:Boxes].nil?
+      extra_options.each do |k,(v,msg)|
+        $stderr.puts msg if options[k].nil?
+      end
+      exit 1
+    end
+
+    return options
+  end
+
+  ##
+  # Sets up an IMAPClient options then runs.
+
+  def self.run(args = ARGV)
+    options = process_args args
+    client = new options
+    client.run
+  end
+
+  ##
+  # Creates a new IMAPClient from +options+.
+  #
+  # Options include:
+  #   +:Verbose+:: Verbose flag
+  #   +:Noop+:: Don't delete anything flag
+  #   +:Root+:: IMAP root path
+  #   +:Boxes+:: Comma-separated list of mailbox prefixes to search
+  #   +:Host+:: IMAP server
+  #   +:Port+:: IMAP server port
+  #   +:SSL+:: SSL flag
+  #   +:Username+:: IMAP username
+  #   +:Password+:: IMAP password
+
+  def initialize(options)
+    @verbose = options[:Verbose]
+    @noop    = options[:Noop]
+    @root    = options[:Root]
+
+    boxes = options[:Boxes].split(',').map { |b| Regexp.escape b }
+    @box_re = /^#{Regexp.escape @root}\/#{Regexp.union(*boxes)}/
+
+    connect options[:Host], options[:Port], options[:SSL],
+            options[:Username], options[:Password]
+  end
+
+  ##
+  # Runs the main selecting messages from mailboxes then marking them
+  # with +flags+.  If a block is given it is run after message marking.
+  # 
+  # Unless :Noop was set, then it just prints out what it would do.
+  #
+  # Automatically called by IMAPClient::run
+
+  def run(message, flags)
+    log message
+
+    message_count = 0
+    mailboxes = find_mailboxes
+
+    mailboxes.each do |mailbox|
+      @imap.select mailbox
+      log "Selected #{mailbox}"
+
+      messages = find_messages
+
+      next if messages.empty?
+
+      message_count += messages.length
+
+      if @noop then
+        log "Noop - doing nothing"
+        next
+      end
+
+      mark messages, flags
+
+      yield if block_given?
+    end
+
+    log "Done. Found #{message_count} messages in #{mailboxes.length} mailboxes"
+  end
+
+  private
+
+  ##
+  # Connects to IMAP server +host+ at +port+ using ssl if +ssl+ is true then
+  # logs in as +username+ with +password+.  IMAPClient will really only work
+  # with PLAIN auth on SSL sockets, sorry.
+
+  def connect(host, port, ssl, username, password)
+    @imap = Net::IMAP.new host, port, ssl
+    log "Connected to #{host}:#{port}"
+    @imap.authenticate 'PLAIN', username, password
+    log "Logged in as #{username}"
+  end
+
+  ##
+  # Finds mailboxes with messages that were selected by the :Boxes option.
+
+  def find_mailboxes
+    mailboxes = @imap.list(@root, "*")
+    mailboxes.reject! { |mailbox| mailbox.attr.include? :Noselect }
+    mailboxes.map! { |mailbox| mailbox.name }
+    mailboxes.reject! { |mailbox| mailbox !~ @box_re }
+    mailboxes = mailboxes.sort_by { |m| m.downcase }
+    log "Found #{mailboxes.length} mailboxes to search:"
+    mailboxes.each { |mailbox| log "\t#{mailbox}" } if @verbose
+    return mailboxes
+  end
+
+  ##
+  # Logs +message+ to $stderr if :Verbose was selected.
+
+  def log(message)
+    return unless @verbose
+    $stderr.puts "# #{message}"
+  end
+
+  ##
+  # Searches for messages matching +query+ in the selected mailbox
+  # (see Net::IMAP#select).  Logs 'Scanning for +message+' before searching.
+
+  def search(query, message)
+    log "Scanning for #{message}"
+    messages = @imap.search query
+    log "Found #{messages.length} messages"
+    return messages
+  end
+
+  ##
+  # Marks +messages+ in the currently selected mailbox with +flags+
+  # (see Net::IMAP#store).
+
+  def mark(messages, flags)
+    until messages.empty? do
+      chunk = messages.slice! 0, 500
+      @imap.store chunk, '+FLAGS.SILENT', flags
+    end
+    log "Marked messages with flags"
+  end
+
+end
+

data/lib/imap_flag.rb

@@ -0,0 +1,126 @@
+require 'imap_client'
+
+##
+# Automatically flag your messages, yo!
+#
+# aka part two of my Plan for Total Email Domination.
+#
+# IMAPFlag flags messages you've responded to, messages you've written and
+# messages in response to messages you've written.
+#
+# If you unflag a message IMAPFlag is smart and doesn't re-flag it.
+#
+# I chose these settings because I find these messages interesting but don't
+# want to manually flag them.  Why should I do all the clicking when the
+# computer can do it for me?
+
+class IMAPFlag < IMAPClient
+
+  ##
+  # IMAP keyword for automatically flagged messages
+
+  AUTO_FLAG_KEYWORD = 'IMAPFLAG_AUTO_FLAGGED'
+
+  ##
+  # Message-Id query
+
+  MESSAGE_ID = 'HEADER.FIELDS (MESSAGE-ID)'
+
+  ##
+  # Handles processing of +args+.
+
+  def self.process_args(args)
+    extra_options = { :Email => [nil, 'Email address not set'] }
+
+    super args, extra_options do |opts, options|
+      opts.on("-e", "--email EMAIL",
+              "The email address you use to write email",
+              "Default: #{options[:Email].inspect}",
+              "Options file name: Email") do |email|
+        options[:Email] = email
+      end
+    end
+  end
+
+  ##
+  # Creates a new IMAPFlag from +options+.
+  #
+  # Options include:
+  #   +:Email:: Email address used for sending email
+  #
+  # and all options from IMAPClient
+
+  def initialize(options)
+    @email = options[:Email]
+    super
+  end
+
+  ##
+  # Removes read, unflagged messages from all selected mailboxes...
+
+  def run
+    super "Flagging messages", [:Flagged, AUTO_FLAG_KEYWORD]
+  end
+
+  private
+
+  ##
+  # Searches for messages I answered and messages I wrote.
+
+  def find_messages
+    return [answered_in_curr, wrote_in_curr, responses_in_curr].flatten
+  end
+
+  ##
+  # Answered messages in the selected mailbox.
+
+  def answered_in_curr
+    search [
+      'ANSWERED',
+      'NOT', 'FLAGGED',
+      'NOT', 'KEYWORD', AUTO_FLAG_KEYWORD
+    ], 'answered messages'
+  end
+
+  ##
+  # Messages I wrote in the selected mailbox.
+
+  def wrote_in_curr
+    search [
+      'FROM', @email,
+      'NOT', 'FLAGGED',
+      'NOT', 'KEYWORD', AUTO_FLAG_KEYWORD
+    ], 'messages I wrote'
+  end
+
+  ##
+  # Messages in response to messages I wrote in the selected mailbox.
+
+  def responses_in_curr
+    log "Scanning for responses to messages I wrote"
+    my_mail = @imap.search [ 'FROM', @email ]
+
+    return [] if my_mail.empty?
+
+    msg_ids = @imap.fetch my_mail, "BODY.PEEK[#{MESSAGE_ID}]"
+    msg_ids.map! do |data|
+      data.attr["BODY[#{MESSAGE_ID}]"].split(':', 2).last.strip
+    end
+
+    messages = msg_ids.map do |id|
+      @imap.search([
+        'HEADER', 'In-Reply-To', id,
+        'NOT', 'FLAGGED',
+        'NOT', 'KEYWORD', AUTO_FLAG_KEYWORD
+      ])
+    end
+
+    messages.flatten!
+
+    log "Found #{messages.length} messages"
+
+    return messages
+  end
+
+end
+

data/lib/imap_sasl_plain.rb

@@ -0,0 +1,57 @@
+require 'time'
+require 'net/imap'
+
+class Time
+
+  ##
+  # Formats this Time as an IMAP-style date.
+  #
+  # RFC 2060 doesn't specify the format of its times.  Unfortunately it is
+  # almost but not quite RFC 822 dates.
+  #--
+  # Go Mr. Leatherpants!
+
+  def imapdate
+    strftime '%d-%b-%Y %H:%M %Z'
+  end
+end
+
+##
+# RFC 2595 PLAIN Authenticator for Net::IMAP.  Only for use with SSL (but not
+# enforced).
+
+class Net::IMAP::PlainAuthenticator
+
+  ##
+  # From RFC 2595 Section 6. PLAIN SASL Authentication
+  #
+  #  The mechanism consists of a single message from the client to the
+  #  server.  The client sends the authorization identity (identity to
+  #  login as), followed by a US-ASCII NUL character, followed by the
+  #  authentication identity (identity whose password will be used),
+  #  followed by a US-ASCII NUL character, followed by the clear-text
+  #  password.  The client may leave the authorization identity empty to
+  #  indicate that it is the same as the authentication identity.
+
+  def process(data)
+    return [@user, @user, @password].join("\0")
+  end
+
+  private
+
+  ##
+  # Creates a new PlainAuthenticator that will authenticate with +user+ and
+  # +password+.
+
+  def initialize(user, password)
+    @user = user
+    @password = password
+  end
+
+end
+
+if defined? OpenSSL then
+  Net::IMAP.add_authenticator 'PLAIN', Net::IMAP::PlainAuthenticator
+end
+
+

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.11.6
+rubygems_version: 0.8.11.15
 specification_version: 1
 name: IMAPCleanse
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
-date: 2006-03-28 00:00:00 -08:00
-summary: Cleanses your IMAP mailboxes of oldness
+  version: 1.1.0
+date: 2006-05-05 00:00:00 -07:00
+summary: Removes mailbox oldness, finds mailbox interestingness!
 require_paths: 
 - lib
 email: drbrain@segment7.net
 homepage: 
 rubyforge_project: 
-description: IMAPCleanse removes old, read, unflagged messages from your IMAP mailboxes so you don't have to!
+description: IMAPCleanse removes old, read, unflagged messages from your IMAP mailboxes so you don't have to!  IMAPFlag flags messages I find interesting so I don't have to!
 autorequire: 
 default_executable: 
 bindir: bin
@@ -29,22 +29,16 @@ post_install_message:
 authors: 
 - Eric Hodel
 files: 
-- .DS_Store
-- CVS/Entries
-- CVS/Repository
-- CVS/Root
 - LICENSE
 - Manifest.txt
 - README
 - Rakefile
-- bin/CVS/Entries
-- bin/CVS/Repository
-- bin/CVS/Root
 - bin/imap_cleanse
-- lib/CVS/Entries
-- lib/CVS/Repository
-- lib/CVS/Root
+- bin/imap_flag
 - lib/imap_cleanse.rb
+- lib/imap_client.rb
+- lib/imap_flag.rb
+- lib/imap_sasl_plain.rb
 test_files: []
 
 rdoc_options: []
@@ -53,6 +47,7 @@ extra_rdoc_files: []
 
 executables: 
 - imap_cleanse
+- imap_flag
 extensions: []
 
 requirements: []

data/CVS/Entries

@@ -1,6 +0,0 @@
-D/bin////
-D/lib////
-/Manifest.txt/1.1/Wed Mar 29 02:21:53 2006//
-/README/1.1/Wed Mar 29 01:49:02 2006//
-/Rakefile/1.1/Wed Mar 29 02:23:42 2006//
-/LICENSE/0/dummy timestamp//

data/CVS/Repository

@@ -1 +0,0 @@
-ruby/imap_cleanse

data/CVS/Root

@@ -1 +0,0 @@
-:ext:drbrain@ziz:/home/cvs/

data/bin/CVS/Entries

@@ -1,2 +0,0 @@
-/imap_cleanse/1.1/Wed Mar 29 02:25:22 2006//
-D

data/bin/CVS/Repository

@@ -1 +0,0 @@
-ruby/imap_cleanse/bin

data/bin/CVS/Root

@@ -1 +0,0 @@
-:ext:drbrain@ziz:/home/cvs/

data/lib/CVS/Entries

@@ -1,2 +0,0 @@
-/imap_cleanse.rb/1.1/Wed Mar 29 00:45:15 2006//
-D

data/lib/CVS/Repository

@@ -1 +0,0 @@
-ruby/imap_cleanse/lib

data/lib/CVS/Root

@@ -1 +0,0 @@
-:ext:drbrain@ziz:/home/cvs/