imap_guard 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in imap_guard.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Cédric Félizard
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+# ImapGuard
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'imap_guard'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install imap_guard
+
+## Usage
+
+TODO: Write usage instructions here
+
+
+```ruby
+require 'imap_guard'
+load File.expand_path('../settings.rb', __FILE__)
+settings = SETTINGS.merge({ read_only: true })
+
+s = IMAPGuard::Guard.new settings
+s.select 'INBOX.ops'
+
+query = IMAPGuard::Query.new.before(7).subject("abc").from("root")
+s.delete query
+
+pattern = "monit alert -- Resource limit "
+query = IMAPGuard::Query.new.subject(pattern).before(7)
+s.delete query do |mail|
+  # the pattern given to subject() is a mere string
+  # pass an optional block to perform advanced filtering such as regexp matching
+  # the yielded mail object is an instance of the current mail providing many methods
+  mail.subject.start_with? pattern
+end
+
+query = IMAPGuard::Query.new.before(7).subject("Logwatch for ")
+s.delete query do |mail|
+  mail.subject =~ /\ALogwatch for \w \(Linux\)\Z/
+end
+
+# You can also forge your own raw IMAP search queries like this
+query = 'SEEN SUBJECT "ALERT" FROM "root"'
+s.delete query do |mail|
+  mail.subject == "ALERT" and \
+  mail.body == "ALERT"
+end
+
+s.close
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/imap_guard.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'imap_guard/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "imap_guard"
+  spec.version       = ImapGuard::VERSION
+  spec.authors       = ["Cédric Félizard"]
+  spec.email         = ["cedric@felizard.fr"]
+  spec.description   = %q{A guard for your IMAP server}
+  spec.summary       = spec.description
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'mail', '~> 2.5.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

data/lib/imap_guard.rb

@@ -0,0 +1,6 @@
+require "imap_guard/version"
+require "imap_guard/guard"
+require "imap_guard/query"
+
+module ImapGuard
+end

data/lib/imap_guard/guard.rb

@@ -0,0 +1,71 @@
+require 'net/imap'
+require 'mail'
+require 'ostruct'
+
+module IMAPGuard
+  class Guard
+    def initialize settings
+      @settings = OpenStruct.new(settings).freeze
+
+      # http://www.ruby-doc.org/stdlib-1.9.3/libdoc/net/imap/rdoc/Net/IMAP.html#method-c-new
+      @imap = Net::IMAP.new(@settings.host, @settings.port, true, nil, false)
+      @imap.login(@settings.username, @settings.password)
+    end
+
+    def select mailbox
+      if @settings.read_only
+        @imap.examine(mailbox) # open in read-only
+      else
+        @imap.select(mailbox) # open in read-write
+      end
+    end
+
+    def delete query
+      unless query.is_a? String
+        if query.respond_to? :to_s
+          query = query.to_s
+        else
+          raise ArgumentError, "query must provide #to_s"
+        end
+      end
+
+      messages = @imap.search query
+      count = messages.size
+      puts "Query: #{query.inspect}: #{count} results"
+
+      counter = 0
+      messages.each do |message_id|
+        counter += 1
+        # puts message_id
+        mail = nil
+        if block_given?
+          msg = @imap.fetch(message_id, 'RFC822')[0].attr['RFC822']
+          mail = Mail.read_from_string msg
+          result = yield mail
+          if result
+            # puts "Given filter matched"
+          else
+            # puts "Given filter returned falsy"
+            next
+          end
+        end
+
+        print "Deleting UID #{message_id} (#{counter}/#{count})"
+        print " (DRY-RUN)" if @settings.read_only
+        if mail
+          puts ": #{mail.subject} (#{mail.body.to_s.length})"
+        else
+          puts
+        end
+        @imap.store(message_id, "+FLAGS", [:Deleted])
+      end
+    end
+
+    def close
+      puts "Expunging deleted messages and closing mailbox..."
+      # p imap.expunge
+      @imap.close
+    end
+  end
+end
+

data/lib/imap_guard/query.rb

@@ -0,0 +1,50 @@
+module IMAPGuard
+  class Query
+    def initialize
+      @criteria = []
+      seen.unanswered.unflagged
+    end
+
+    def to_s
+      @criteria.join ' '
+    end
+
+    def seen
+      @criteria << 'SEEN'
+      self
+    end
+
+    def unanswered
+      @criteria << 'UNANSWERED'
+      self
+    end
+
+    def unflagged
+      @criteria << 'UNFLAGGED'
+      self
+    end
+
+    def subject string
+      @criteria << "SUBJECT \"#{string}\""
+      self
+    end
+
+    def from string
+      @criteria << "FROM \"#{string}\""
+      self
+    end
+
+    def before date
+      case date
+      when Fixnum
+        date = (Date.today - date).strftime '%e-%b-%Y'
+      when Date
+        date = Date.strptime date, '%e-%b-%Y'
+      end
+
+      @criteria << "BEFORE #{date}"
+      self
+    end
+  end
+end
+

data/lib/imap_guard/version.rb

@@ -0,0 +1,3 @@
+module ImapGuard
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: imap_guard
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Cédric Félizard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A guard for your IMAP server
+email:
+- cedric@felizard.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- imap_guard.gemspec
+- lib/imap_guard.rb
+- lib/imap_guard/guard.rb
+- lib/imap_guard/query.rb
+- lib/imap_guard/version.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -502947235
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -502947235
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: A guard for your IMAP server
+test_files: []