imap_clear 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3e32bbcd47c4d4f522bf4ca569795ebac1c14ed8
+  data.tar.gz: e3c066de9dfacc644e93b701bde00a70ac794f8c
+SHA512:
+  metadata.gz: c15c803121eb6af9bd54176b2fa548688c6fb90706eb984c3253eed6cfa7f1f345efef8c3a5cd87529a2642e723d7d597fb878153c61b81e3c1b13864f189555
+  data.tar.gz: 4a5bfac24fff65adb54c437a867810789312c2f0650ff934f0eb62a2d7d4af2f2698a536c760ce730c1e3b373a799f7eacebbb54aff40893cec4cfed7fc7f013

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.envsetup

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jeff McAffee
+
+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,55 @@
+# ImapClear
+
+`imap_clear` is a command line application to delete emails on an IMAP server.
+It is designed to be called from a cron job on a periodic basis.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'imap_clear'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install imap_clear
+
+## Usage
+
+From the command line:
+
+    imap_clear server-host username password
+
+Example:
+
+    imap_clear mail.example.com user@example.com userpassword
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jmcaffee/imap_clear.
+
+1. Fork it ( https://github.com/jmcaffee/imap_clear/fork )
+1. Clone it (`git clone git@github.com:[my-github-user-name]/imap_clear.git`)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Create tests for your feature branch
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,110 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "imap_clear"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+def get_app the_host, the_user, the_pass
+  app = ImapClear::App.new
+  app.host = the_host
+  app.port = 993
+  app.user = the_user
+  app.pass = the_pass
+
+  app
+end
+
+def connect_to_server
+  raise ArgumentError, "IMAPCLEAN_SERVER env var not set" if ENV["IMAPCLEAN_SERVER"].nil?
+  raise ArgumentError, "IMAPCLEAN_USER env var not set" if ENV["IMAPCLEAN_USER"].nil?
+  raise ArgumentError, "IMAPCLEAN_PASS env var not set" if ENV["IMAPCLEAN_PASS"].nil?
+
+  app = get_app(ENV["IMAPCLEAN_SERVER"], ENV["IMAPCLEAN_USER"], ENV["IMAPCLEAN_PASS"])
+
+  app.connect
+  app.login
+
+  app
+end
+
+def print text
+  $stdout.print text; $stdout.flush
+end
+
+def daemon_email
+  ENV["IMAPCLEAN_DAEMON_EMAIL"]
+end
+
+def uids_from_daemon app
+  app.get_uids_where_from(daemon_email)
+end
+
+def uids_of_bodies_with_invalid_email app
+  app.get_uids_where_body_contains "#{ENV["IMAPCLEAN_USER"]}@"
+end
+
+def emails_to_clean_count
+  app = connect_to_server
+
+  print "#{uids_from_daemon(app).count} emails to clean\n"
+
+  app.disconnect
+end
+
+def invalid_emails_to_clean_count
+  app = connect_to_server
+
+  print "#{uids_of_bodies_with_invalid_email(app).count} emails to clean\n"
+
+  app.disconnect
+end
+
+def clean_server
+  clean_emails_from_daemon
+
+  clean_emails_to_user
+end
+
+def clean_emails_from_daemon
+  app = connect_to_server
+  uids = uids_from_daemon(app)
+  start_count = uids.count
+
+  print "\nCleaning emails from #{daemon_email}.\n"
+  app.delete_uids uids
+
+  app.expunge
+
+  uids = uids_from_daemon(app)
+  final_count = uids.count
+
+  print "\nDeleted #{start_count - final_count} of #{start_count} emails."
+  app.disconnect
+end
+
+def clean_emails_to_user
+  app = connect_to_server
+  uids = uids_of_bodies_with_invalid_email(app)
+  start_count = uids.count
+
+  print "\nCleaning emails containing #{ENV["IMAPCLEAN_USER"]}@nnn.nnn.nnn.nnn.\n"
+  app.delete_uids uids
+
+  app.expunge
+
+  uids = uids_of_bodies_with_invalid_email(app)
+  final_count = uids.count
+
+  print "\nDeleted #{start_count - final_count} of #{start_count} emails."
+  app.disconnect
+end
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start
+
+#require "irb"
+#IRB.start
+

data/bin/setup

@@ -0,0 +1,61 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+#set -vx
+
+bundle install
+
+OUTFILE=.envsetup         # Name of the env value file
+
+write_envsetup() {
+
+# Write an example .envsetup file
+
+
+# -----------------------------------------------------------
+(
+cat <<'EOF'
+#!/bin/bash
+# vi: ft=shell
+
+export IMAPCLEAN_SERVER=mail.example.com
+export IMAPCLEAN_USER=john.doe@example.com
+export IMAPCLEAN_PASS=ENTER_SECRET_HERE
+
+export IMAPCLEAN_DAEMON_EMAIL=MAILER-DAEMON@envious.nexcess.net
+
+# Uncomment these and modify if needed (defaults are shown)
+#export IMAPCLEAN_INBOX=INBOX
+#export IMAPCLEAN_TRASHBOX=INBOX.Trash
+
+# Use this file by sourcing it before running app:
+# ex:
+#     source .envsetup && ./exe/imap_clean
+#
+# or:
+#     . .envsetup && ./exe/imap_clean
+#
+EOF
+) > $OUTFILE
+
+echo
+echo
+echo "$OUTFILE has been generated."
+echo "Edit $OUTFILE and replace the SERVER, USER and PASS values with credentials from your mail server."
+echo
+echo "Use $OUTFILE as:"
+echo
+echo "source $OUTFILE && ./exe/imap_clean"
+echo
+}
+
+# Create an .envsetup file if it doesn't exist.
+if [ ! -f $OUTFILE ]; then
+  write_envsetup
+fi
+
+echo
+echo
+echo
+echo "ImapClean setup complete. Confirm there are no errors."
+echo

data/exe/imap_clear

@@ -0,0 +1,138 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "imap_clear"
+
+$host = nil
+$user = nil
+$pass = nil
+
+def process_cmd_line_args
+  arg_errors = false
+  errs = []
+
+  $host = ARGV.shift
+  $user = ARGV.shift
+  $pass = ARGV.shift
+
+  if $host.nil?
+    arg_errors = true
+    errs << "Missing server host address (mail.example.com)"
+  end
+
+  if $user.nil?
+    arg_errors = true
+    errs << "Missing user name (user@example.com)"
+  end
+
+  if $pass.nil?
+    arg_errors = true
+    errs << "Missing user password"
+  end
+
+  if ARGV.count > 0
+    arg_errors = true
+    errs << "Unexpected arguments: #{ARGV.join("|")}"
+  end
+
+  if arg_errors
+    raise ArgumentError, "\n" + errs.join("\n")
+  end
+end
+
+def get_app the_host, the_user, the_pass
+  app = ImapClear::App.new
+  app.host = the_host
+  app.port = 993
+  app.user = the_user
+  app.pass = the_pass
+
+  app
+end
+
+def connect_to_server
+  app = get_app($host, $user, $pass)
+
+  app.connect
+  app.login
+
+  app
+end
+
+def print text
+  $stdout.print text; $stdout.flush
+end
+
+def daemon_email
+  ENV["IMAPCLEAN_DAEMON_EMAIL"]
+end
+
+def username
+  $user
+end
+
+def uids_from_daemon app
+  app.get_uids_where_from(daemon_email)
+end
+
+def uids_of_bodies_with_invalid_email app
+  app.get_uids_where_body_contains "#{username}@"
+end
+
+def emails_to_clean_count
+  app = connect_to_server
+
+  print "#{uids_from_daemon(app).count} emails to clean\n"
+
+  app.disconnect
+end
+
+def invalid_emails_to_clean_count
+  app = connect_to_server
+
+  print "#{uids_of_bodies_with_invalid_email(app).count} emails to clean\n"
+
+  app.disconnect
+end
+
+def clean_server
+  clean_emails_from_daemon
+
+  clean_emails_to_user
+end
+
+def clean_emails_from_daemon
+  app = connect_to_server
+  uids = uids_from_daemon(app)
+  start_count = uids.count
+
+  print "\nCleaning emails from #{daemon_email}.\n"
+  app.delete_uids uids
+
+  app.expunge
+
+  final_count = uids_from_daemon(app).count
+
+  print "\nDeleted #{start_count - final_count} of #{start_count} emails.\n"
+  app.disconnect
+end
+
+def clean_emails_to_user
+  app = connect_to_server
+  uids = uids_of_bodies_with_invalid_email(app)
+  start_count = uids.count
+
+  print "\nCleaning emails containing #{username}@nnn.nnn.nnn.nnn.\n"
+  app.delete_uids uids
+
+  app.expunge
+
+  final_count = uids_of_bodies_with_invalid_email(app).count
+
+  print "\nDeleted #{start_count - final_count} of #{start_count} emails.\n"
+  app.disconnect
+end
+
+
+process_cmd_line_args
+clean_server

data/imap_clear.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'imap_clear/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "imap_clear"
+  spec.version       = ImapClear::VERSION
+  spec.authors       = ["Jeff McAffee"]
+  spec.email         = ["jeff@ktechsystems.com"]
+
+  spec.summary       = %q{Clear out IMAP emailbox}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/jmcaffee/imap_clear"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+end

data/lib/imap_clear.rb

@@ -0,0 +1,8 @@
+require "imap_clear/version"
+
+module ImapClear
+  # Your code goes here...
+end
+
+require 'imap_clear/app.rb'
+

data/lib/imap_clear/app.rb

@@ -0,0 +1,96 @@
+##############################################################################
+# File::    app.rb
+# Purpose:: filedescription
+# 
+# Author::    Jeff McAffee 11/13/2016
+# Copyright:: Copyright (c) 2016, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+require 'net/imap'
+
+module ImapClear
+  class App
+
+    attr_accessor :host
+    attr_accessor :port
+    attr_accessor :user
+    attr_accessor :pass
+    attr_reader   :imap
+
+    attr_accessor :trashbox
+    attr_accessor :inbox
+
+
+    def initialize
+      @inbox = "INBOX"
+      @trashbox = "INBOX.Trash"
+    end
+
+    def connect
+      @imap = Net::IMAP.new(host, port, true, nil, false)
+    end
+
+    def login
+      @imap.login(user, pass)
+    end
+
+    def list_mailboxes
+      imap.list("", "*")
+    end
+
+    def select_mailbox mailbox
+      imap.select(mailbox)
+    end
+
+    def get_uids_where_from email_address
+      select_mailbox(inbox)
+      uids = imap.uid_search(["FROM", email_address])
+    end
+
+    def get_uids_where_body_contains value
+      select_mailbox(inbox)
+      uids = imap.uid_search(["BODY", value])
+    end
+
+    def fetch seqno
+      imap.fetch(seqno, ["UID","ENVELOPE"])
+    end
+
+    def uid_fetch uid
+      imap.uid_fetch(uid, "ENVELOPE")
+    end
+
+    def subject_line seqno
+      imap.fetch(seqno, "BODY[HEADER.FIELDS (SUBJECT)]")
+    end
+
+    def uid_subject_line uid
+      imap.uid_fetch(uid, "BODY[HEADER.FIELDS (SUBJECT)]")
+    end
+
+    def delete_uids uids
+      $stdout.print "Deleting #{uids.count} emails\n"
+      $stdout.flush
+      uids.each do |uid|
+        imap.uid_copy(uid, trashbox)
+        imap.uid_store(uid, "+FLAGS", [:Deleted])
+        $stdout.print "."
+        $stdout.flush
+      end
+    end
+
+    def show_envelope_for_uid uid
+      imap.uid_fetch(uid, "ENVELOPE")
+    end
+
+    def expunge
+      imap.expunge
+    end
+
+    def disconnect
+      imap.disconnect unless imap.disconnected?
+    end
+  end
+end # module
+

data/lib/imap_clear/version.rb

@@ -0,0 +1,3 @@
+module ImapClear
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: imap_clear
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeff McAffee
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.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'
+description: Clear out IMAP emailbox
+email:
+- jeff@ktechsystems.com
+executables:
+- imap_clear
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/imap_clear
+- imap_clear.gemspec
+- lib/imap_clear.rb
+- lib/imap_clear/app.rb
+- lib/imap_clear/version.rb
+homepage: https://github.com/jmcaffee/imap_clear
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+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: Clear out IMAP emailbox
+test_files: []
+has_rdoc: