IMAPCleanse 1.0.0

data/CVS/Entries

@@ -0,0 +1,6 @@
+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

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

data/CVS/Root

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

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright 2005 Eric Hodel.  All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+3. Neither the names of the authors nor the names of their contributors
+   may be used to endorse or promote products derived from this software
+   without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS
+OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
+OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/Manifest.txt

@@ -0,0 +1,16 @@
+.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
+lib/imap_cleanse.rb

data/README

@@ -0,0 +1,80 @@
+= IMAPCleanse
+
+Rubyforge Project:
+
+http://rubyforge.org/projects/seattlerb/
+
+Documentation:
+
+http://seattlerb.rubyforge.org/IMAPCleanse/
+
+== About
+
+IMAPCleanse removes old, read, unflagged messages from your IMAP mailboxes.
+
+== Why?
+
+I'm lazy.  I don't delete read messages from my mailboxes because I like to
+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.
+
+== Installing IMAPCleanse
+
+Just install the gem:
+
+  $ sudo gem install IMAPCleanse
+
+== Using IMAPCleanse
+
+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
+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
+from which mailboxes.
+
+  $ ruby -Ilib bin/imap_cleanse -nv
+  # Connected to mail.example.com:993
+  # Logged in as drbrain
+  # Cleansing read, unflagged messages older than 26-Feb-2006 17:04 PST
+  # Found 23 mailboxes to cleanse:
+  #       mail/Lists/FreeBSD/current
+  [...]
+  #       mail/Lists/Ruby/ZineBoard
+  # Selected mail/Lists/FreeBSD/current
+  # Scanning for messages
+  # Found 0 messages
+  [...]
+  # Selected mail/Lists/Ruby/ZineBoard
+  # Scanning for messages
+  # Found 0 messages
+  # Done. Found 0 messages in 23 mailboxes
+
+(Since I just ran IMAPCleanse 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.
+
+No whitespace is stripped from options, so be sure to do that yourself.  Mine
+looks something like this:
+
+  Host=mail.example.com
+  SSL=true
+  Username=drbrain
+  Boxes=Lists/FreeBSD/current,Lists/FreeBSD/performance,Lists/FreeBSD/Soekris,Lists/FreeBSD/stable,Lists/Ruby
+  Age=30
+  Password=my password
+

data/Rakefile

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+$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.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'
+end
+
+desc 'Run tests'
+task :default => [ :test ]
+
+Rake::TestTask.new('test') do |t|
+  t.libs << 'test'
+  t.pattern = 'test/test_*.rb'
+  t.verbose = true
+end
+
+desc 'Update Manifest.txt'
+task :update_manifest do
+  sh "find . -type f | sed -e 's%./%%' | egrep -v 'svn|swp|~' | egrep -v '^(doc|pkg)/' | sort > Manifest.txt"
+end
+
+desc 'Generate RDoc'
+Rake::RDocTask.new :rdoc do |rd|
+  rd.rdoc_dir = 'doc'
+  rd.rdoc_files.add 'lib', 'README', 'LICENSE'
+  rd.main = 'README'
+  rd.options << '-d' if `which dot` =~ /\/dot/
+  rd.options << '-t IMAPCreate'
+end
+
+desc 'Build Gem'
+Rake::GemPackageTask.new spec do |pkg|
+  pkg.need_tar = true
+end
+
+desc 'Clean up'
+task :clean => [ :clobber_rdoc, :clobber_package ]
+
+desc 'Clean up'
+task :clobber => [ :clean ]
+
+# vim: syntax=Ruby
+

data/bin/CVS/Entries

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

data/bin/CVS/Repository

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

data/bin/CVS/Root

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

data/bin/imap_cleanse

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

data/lib/CVS/Entries

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

data/lib/CVS/Repository

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

data/lib/CVS/Root

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

data/lib/imap_cleanse.rb

@@ -0,0 +1,347 @@
+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
+
+##
+# IMAPCleanse removes old messages from your IMAP mailboxes so you don't have
+# to!
+
+class IMAPCleanse
+
+  ##
+  # 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
+
+      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
+
+  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]
+  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
+    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 [
+      '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"
+  end
+
+end
+

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11.6
+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
+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!
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+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
+- lib/imap_cleanse.rb
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: 
+- imap_cleanse
+extensions: []
+
+requirements: []
+
+dependencies: []
+