imap-filter 0.0.2

data/lib/imap-filter/functionality.rb

@@ -0,0 +1,128 @@
+# coding: utf-8
+module ImapFilter
+  module Functionality
+    include Forwardable
+    include ImapFilter::DSL
+
+    FULL ='(UID RFC822.SIZE ENVELOPE BODY.PEEK[TEXT])'
+    BODYTEXT = 'BODY[TEXT]'
+    SUBJECTPEEKLIST = '(UID RFC822.SIZE BODY.PEEK[HEADER.FIELDS (SUBJECT)])'
+    SUBJECTLIST = 'BODY[HEADER.FIELDS (SUBJECT)]'
+    class FunctFilter
+      extend Forwardable
+      
+      attr :dfilt, :seq, :acc
+      
+      def_delegators :@dfilt, :mbox, :directives, :actions
+                     
+      def initialize filt
+        @dfilt = filt
+        @seq = nil
+      end
+
+      # These strings come from the DSL in the form of
+      # "acct:mbox_path". Reslove and return the actual
+      # account object and mbox path as [account_ob, mbox]
+      def parse_and_resolve_account_mbox_string ambox, default_account = nil
+        a, b = ambox.split ':'
+        a, b = [nil, a] if b.nil?
+        a = nil if a == ''
+        acc = a.nil? ? default_account : _accounts[a.to_sym]
+        mbox = b
+        [acc, mbox]
+      end
+
+      def select_email
+        @acc, box = parse_and_resolve_account_mbox_string mbox
+        acc.imap.select box
+        @seq = acc.imap.search directives
+      end
+
+      def ensure_mailbox account, mailbox
+        begin
+          account.imap.create mailbox
+        rescue Net::IMAP::NoResponseError => e
+          # we ignore this because it -- probably -- means the mailbox already exists.
+          puts "  *** ignored mailbox error: #{e}".red unless _options[:verbose] < 1
+        end
+      end
+
+      def process_actions
+        actions.each do |action|
+          send *action
+        end
+      end
+
+      def subject_list
+        unless seq.empty?
+          acc.imap.fetch(seq, SUBJECTPEEKLIST).map do |subject|
+            subject.attr[SUBJECTLIST].to_s.strip.tr("\n\r", '')
+          end
+        else
+          []
+        end
+      end
+
+      def list *a, **h
+        subject_list.each do |subject|
+          puts subject.attr[subj].to_s.strip.tr("\n\r", '').light_yellow
+        end unless seq.empty?
+      end
+
+      def _cross_account_mvcp op, dest_acc, dest_mbox        
+        ensure_mailbox dest_acc, dest_mbox
+        begin
+          acc.imap.fetch(seq, FULL).each do |fdat|
+            unless _options[:verbose] < 2
+              print "  >>".yellow
+              puts " seq #{fdat.seqno} #{fdat.attr['ENVELOPE']['subject']} -> #{dest_acc.name}:#{dest_mbox}".light_blue
+            end
+            raw = fdat.attr['ENVELOPE'].email_header + fdat.attr[BODYTEXT]
+            dest_acc.imap.append dest_mbox, raw, fdat.attr['FLAGS']
+          end
+        rescue => e
+          puts "ERROR: #{e} -- perhaps you did a move or delete operation before copy?".light_red
+          exit 10
+        end
+      end
+      
+      def _mvcp op, destination
+        raise "Illegal operation #{op}" unless [:copy, :move].member? op
+        
+        dest_acc, dest_mbox = parse_and_resolve_account_mbox_string destination
+        ensure_mailbox dest_acc, dest_mbox
+        
+        if dest_acc == acc # in-account move
+          dest_acc.imap.send op, seq, dest_mbox
+        else # move or copy to different account
+          _cross_account_mvcp op, dest_acc, dest_mbox
+        end unless seq.empty?
+      end
+      
+      def move destination
+        puts "  move from #{acc.name} to #{destination}".light_blue unless _options[:verbose] < 1
+        _mvcp :move, destination unless _options[:dryrun]
+      end
+      
+      def copy destination
+        puts "  copy from #{acc.name} to #{destination}".light_blue unless _options[:verbose] < 1
+        _mvcp :copy, destination unless _options[:dryrun]
+      end
+
+      def delete
+        puts "  delete from #{acc.name}".light_blue unless _options[:verbose] < 1
+        mark :Deleted unless _options[:dryrun]
+      end
+      
+      def mark *flags
+        puts "  mark #{flags} in #{acc.name}".light_blue unless _options[:verbose] < 1
+        acc.imap.store seq, '+FLAGS.SILENT', flags unless seq.empty? or _options[:dryrun]
+      end
+      
+      def unmark *flags
+        puts "  unmark #{flags} in #{acc.name}".light_blue unless _options[:verbose] < 1
+        acc.imap.store seq, '-FLAGS.SILENT', flags unless seq.empty? or _options[:dryrun]
+      end
+    end
+  end
+end

data/lib/imap-filter/imap-filter.rb

@@ -0,0 +1,108 @@
+# coding: utf-8
+require 'imap-filter'
+
+include ImapFilter::DSL
+
+module ImapFilter
+  module Functionality
+    STATUS = {messages: 'MESSAGES', recent: 'RECENT', unseen: 'UNSEEN'}
+    ISTAT = STATUS.map{ |k, v| [v, k] }.to_h
+    
+    def self.show_imap_plan
+      puts '====== Accounts'.light_yellow
+      _accounts.each do |name, account|
+        print " #{name}: ".light_green
+        print account.to_s.light_blue
+        puts
+      end
+      puts '====== Filters'.light_yellow
+      _filters.each do |name, filter|
+        print " #{name}: ".light_green
+        print filter.to_s.light_blue
+        puts          
+      end
+    end
+
+    # List all mboxes of given account and their statuses
+    def self.list_mboxes account
+      account.imap.list('', '*')
+        .map { |m| [m['name'], m['attr']] }
+        .map { |mbox, attr|
+        begin
+          [mbox,
+           account.imap.status(mbox, STATUS.values)
+             .map{ |k, v| "#{ISTAT[k]}:#{v}" }
+             .join(' '),
+           attr]
+        rescue
+          nil
+        end }
+        .compact
+    end
+    
+    def self.login_imap_accounts test: false
+      puts "====== #{test ? 'Test' : 'Login'} Accounts".light_yellow
+      _accounts.each do |name, account|
+        print "  #{name}...".light_white
+        begin
+          account._open_connection
+          puts "SUCCESS, delim #{account.delim}".light_green
+          list_mboxes(account).each do |mbox, stat, attr|
+            print "  #{mbox}".light_blue
+            print " #{stat}".light_red
+            puts " #{attr}".light_cyan
+          end unless _options[:verbose] < 2
+        rescue => e
+          puts "FAILED: #{e}".light_red
+          exit unless test
+        end
+      end
+    end
+
+    def self.list_of_filters_to_run
+      unless _options[:filters].nil?
+        _options[:filters].map{ |f| f.to_sym }
+      else
+        _filters.keys
+      end
+    end
+
+    # do the selection based on directives
+    # then perform the actions on the set selected.
+    # optimize for copy/moves that are to the same account.
+    def self.run_filter filt
+      f = FunctFilter.new _filters[filt]
+      f.select_email
+      
+      unless _options[:verbose] < 1
+        puts "====== Email to be processed by #{filt}".light_yellow
+        f.subject_list.each do |subject|
+          print '  ##'.yellow
+          puts subject.light_blue
+        end
+      end
+      
+      f.process_actions 
+      f.acc.imap.expunge unless _options[:dryrun]
+    end
+    
+    def self.execute_filters
+      #login_imap_accounts
+      list_of_filters_to_run.each do |f|
+        print "Running filter: ".light_white
+        puts "#{f}".light_yellow
+        run_filter f
+      end
+    end
+    
+    def self.run_filters filters
+      show_imap_plan unless _options[:verbose] < 1
+      if _options[:test]
+        login_imap_accounts test: true
+      else
+        login_imap_accounts
+        execute_filters
+      end
+    end
+  end
+end

data/lib/imap-filter/monkeypatches.rb

@@ -0,0 +1,37 @@
+class Net::IMAP::Envelope
+  CRLF = "\r\n"
+  HEDCNS = [
+    ['Date:', ->(s){ s.date } ],
+    ['Subject:', ->(s){ s.subject } ],
+    ['Date:', ->(s){ s.date } ],
+    ['Message-ID:', ->(s){ s.message_id }],
+    ['Sender:', ->(s){
+       s.sender.map{ |f|
+         "#{f.name} <#{f.mailbox}@#{f.host}>"
+       }.join ',' unless s.sender.nil? } ],
+    ['From:', ->(s){
+       s.from.map{ |f|
+         "#{f.name} <#{f.mailbox}@#{f.host}>"
+       }.join ',' unless s.from.nil? } ],
+    ['To:', ->(s){
+       s.to.map{ |f|
+         "#{f.name} <#{f.mailbox}@#{f.host}>"
+       }.join ',' unless s.to.nil? } ],
+    ['Cc:', ->(s){
+       s.cc.map{ |f|
+         "#{f.name} <#{f.mailbox}@#{f.host}>"
+       }.join ',' unless s.cc.nil? } ],
+    ['Bcc:', ->(s){
+       s.bcc.map{ |f|
+         "#{f.name} <#{f.mailbox}@#{f.host}>"
+       }.join ',' unless s.bcc.nil? } ],
+    ['In-Reply-To:', ->(s){ s.in_reply_to }],
+  ].to_h
+  
+  def email_header
+    HEDCNS.map{ |field, fun| "#{field} #{fun.(self)}" }
+      .join CRLF
+  end
+end
+
+

data/spec/imap-filter_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "ImapFilter" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+require 'simplecov'
+
+module SimpleCov::Configuration
+  def clean_filters
+    @filters = []
+  end
+end
+
+SimpleCov.configure do
+  clean_filters
+  load_adapter 'test_frameworks'
+end
+
+ENV["COVERAGE"] && SimpleCov.start do
+  add_filter "/.rvm/"
+end
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require 'imap-filter'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+
+end

metadata

@@ -0,0 +1,311 @@
+--- !ruby/object:Gem::Specification
+name: imap-filter
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Fred Mitchell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: semver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: text-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: juwelier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-remote
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-rescue
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: pry-stack_explorer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2-
+
+    imap-filter is a Ruby implementation of an IMAP filtering application.
+    it can handle multiple IMAP accounts, and create IMAP folders automatically
+    where none exists.
+
+    The imap-filter DSL makes it easy to filter. You can also do "dry-runs"
+    to make sure what happens is what is expected.
+email: fred.mitchell@gmx.de
+executables:
+- imap-filter
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.org
+files:
+- ".document"
+- ".rspec"
+- ".ruby-version"
+- ".semver"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.org
+- Rakefile
+- bin/imap-filter
+- examples/default.imap
+- imap-filter.gemspec
+- lib/imap-filter.rb
+- lib/imap-filter/cli.rb
+- lib/imap-filter/dsl.rb
+- lib/imap-filter/functionality.rb
+- lib/imap-filter/imap-filter.rb
+- lib/imap-filter/monkeypatches.rb
+- spec/imap-filter_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/flajann2/imap-filter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: IMAP Scriptable filter for one or multiple Email accounts.
+test_files: []