easy_imap 0.0.2

data/History.txt

@@ -0,0 +1,10 @@
+== 0.0.1 2008-12-10
+
+* 1 major enhancement:
+  * Initial release
+
+== 0.0.2 2008-12-17
+
+* 1 minor enhancement:
+  * Added support for simple LOGIN authentication. (intabulas)
+

data/Manifest.txt

@@ -0,0 +1,18 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/easy_imap.rb
+lib/easy_imap/attachment.rb
+lib/easy_imap/folder.rb
+lib/easy_imap/message.rb
+lib/easy_imap/server.rb
+script/console
+script/destroy
+script/generate
+script/txt2html
+spec/easy_imap_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+For more information on easy_imap, see http://easy_imap.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.rdoc

@@ -0,0 +1,62 @@
+= easy_imap
+
+* http://easy-imap.rubyforge.org/
+
+== DESCRIPTION:
+
+A simple interface to proccessing e-mail messages using IMAP, including handling multipart messages and attachments.
+
+== SYNOPSIS:
+
+Create a connection using EasyIMAP::Server.connect, and with the connection you can access Folders and Messages.  To
+get a list of all Folders use EasyIMAP::Server#folders, to access the messages in a folder use EasyIMAP::Folder#messages, and to
+access the Attachments on a Message use EasyIMAP::Message#attachments.
+
+  EasyIMAP::Server.connect('mail.example.com', :username => 'username, :password => 'password) do |conn|
+    inbox = conn.folders.first
+    inbox.messages.each do |m|
+      if m.attachments.any? && m.attachments.first.content_type == "application/vnd.ms-excel"
+        File.open("/tmp/first_attachment.xls", "w") do |f|
+          f.write(m.attachments.first.body)
+        end
+      end
+    end
+  end
+
+== REQUIREMENTS:
+
+* tmail
+
+== INSTALL:
+
+* sudo gem install easy_imap
+
+== CONTRIBUTORS:
+
+* Paul Stadig (pjstadig)
+* Mark Lussier (intabulas)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Paul Stadig
+
+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/Rakefile

@@ -0,0 +1,27 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/easy_imap'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('easy_imap', EasyIMAP::VERSION) do |p|
+  p.developer('Paul Stadig', 'paul@stadig.name')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  p.rubyforge_name       = p.name # TODO this is default value
+  p.extra_deps         = [
+    ['tmail','>= 1.2.3.1'],
+  ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+task :default => [:spec, :features]

data/lib/easy_imap/attachment.rb

@@ -0,0 +1,26 @@
+module EasyIMAP
+  class Attachment
+    def initialize(body)
+      @body = body
+    end
+
+    # The mime type of this attachment.
+    def content_type
+      @body.content_type
+    end
+
+    def filename
+      @body.disposition_param("filename")
+    end
+
+    # The body of this attachment.
+    def body
+      @body.body
+    end
+
+    def to_s
+      "<#{self.class}: @content_type='#{content_type}'>"
+    end
+    alias_method(:inspect, :to_s)
+  end
+end

data/lib/easy_imap/folder.rb

@@ -0,0 +1,33 @@
+module EasyIMAP
+  # A Folder on the IMAP server.
+  class Folder
+    # the name of the folder.
+    attr_reader :name
+
+    # Creates an instance representing a folder with +name+, on
+    # the server connection +conn+, with the folder delimiter +delim+.
+    #
+    # Normally this class is only instantiated internally.
+    def initialize(conn, name, delim)
+      @conn = conn
+      @full_name = name
+      @name = name.split(delim).last
+      @delim = delim
+    end
+
+    # An array of messages in this folder.
+    def messages
+      @conn.examine(@full_name)
+      @conn.uid_search(['ALL']).map do |uid|
+        Message.new(@conn, uid)
+      end
+    end
+
+    # An array of folders in this folder.
+    def folders
+      @conn.list("#{@full_name}#{@delim}", '%').map do |f|
+        Folder.new(@conn, f.name, f.delim)
+      end
+    end
+  end
+end

data/lib/easy_imap/message.rb

@@ -0,0 +1,116 @@
+gem 'tmail'
+require 'tmail'
+require 'time'
+
+module EasyIMAP
+  class Message
+    def initialize(conn, uid)
+      @conn = conn
+      @uid = uid
+    end
+
+    # The date this message was sent (an instance of Time).
+    def date
+      Time.parse(envelope[:date])
+    end
+
+    # The subject of this message.
+    def subject
+      envelope[:subject]
+    end
+
+    # An array of from e-mail addresses (as Strings).
+    def from
+      (envelope[:from] || []).map {|a| address(a)}
+    end
+
+    # An array of sender e-mail addresses (as Strings).
+    def sender
+      (envelope[:sender] || []).map{|a| address(a)}
+    end
+
+    # An array of reply_to e-mail addresses (as Strings).
+    def reply_to
+      (envelope[:reply_to] || []).map{|a| address(a)}
+    end
+
+    # An array of to e-mail addresses (as Strings).
+    def to
+      (envelope[:to] || []).map {|a| address(a)}
+    end
+
+    # An array of cc e-mail addresses (as Strings).
+    def cc
+      (envelope[:cc] || []).map {|a| address(a)}
+    end
+
+    # An array of bcc e-mail addresses (as Strings).
+    def bcc
+      (envelope[:bcc] || []).map {|a| address(a)}
+    end
+
+    # The in_reply_to attribute (as a String).
+    def in_reply_to
+      envelope[:in_reply_to]
+    end
+
+    # Returns true if this message is a multipart message.
+    def multipart?
+      body.multipart?
+    end
+
+    # Returns the text/plain portion of this message
+    # (which could be the body, or one of the parts
+    # if the message is multipart), or the empty
+    # string if there is no text/plain portion.
+    def text
+      text = find_part("text/plain")
+      text ? text.body : ""
+    end
+
+    # Returns the text/html portion of this message
+    # (which could be the body, or one of the parts
+    # if the message is multipart), or the empty
+    # string if there is no text/html portion.
+    def html
+      html = find_part("text/html")
+      html ? html.body : ""
+    end
+
+    # An array of Attachment instances if this
+    # message is a multipart message with
+    # attachments, or an empty array otherwise.
+    def attachments
+      @attachments ||= if body.multipart?
+        body.parts.find_all{|p| p.disposition == "attachment"}.map{|a| Attachment.new(a)}
+      else
+        []
+      end
+    end
+
+    private
+    def address(a)
+      if a[:name]
+        "\"#{a[:name]}\" <#{a[:mailbox]}@#{a[:host]}>"
+      else
+        "#{a[:mailbox]}@#{a[:host]}"
+      end
+    end
+
+    def envelope
+      @conn.uid_fetch(@uid, "ENVELOPE").first.attr["ENVELOPE"]
+    end
+
+    def body
+      @body ||= TMail::Mail.parse(@conn.uid_fetch(@uid, "BODY[]").first.attr["BODY[]"])
+    end
+
+    def find_part(mime_type)
+      if !body.multipart? && body.content_type == mime_type
+        body
+      elsif body.multipart?
+        body.parts.find{|p| p.content_type == mime_type}
+      end
+    end
+  end
+end

data/lib/easy_imap/server.rb

@@ -0,0 +1,59 @@
+require 'net/imap'
+
+module EasyIMAP
+  # A connection to an IMAP server.
+  class Server
+    # Makes a connection to +host+ and returns an instance of Server.
+    #
+    # It is recommended that you use this method to connect instead 
+    # of Server#new, because at some time in the future there may be
+    # multiple server classes to smooth over "quirks" in IMAP 
+    # implementations.  This method should automatically select the
+    # right server class for you.
+    #
+    # If given a block it will yield the Server instance to the
+    # block, and then close the connection to the IMAP server
+    # after the block has finished. Otherwise you must close the connection
+    # yourself.
+    #
+    # Valid options are:
+    # port:: the server port on which to connect (defaults to 143)
+    # username:: the username with which to connect
+    # password:: the password with which to connect
+    # auth_type:: the authentication type with which to connect (defaults to LOGIN)
+    def self.connect(host, options = nil)
+      conn = Server.new(host, options)
+      if block_given?
+        begin
+          yield conn
+        ensure
+          conn.close
+        end
+      end
+    end
+
+    def initialize(host, options = nil)
+      options ||= {}
+      @host = host
+      @conn = Net::IMAP.new(host, options[:port] || 143)
+      if options[:auth_type].to_s.downcase == "plain"
+        @conn.login(options[:username], options[:password])
+      else
+        @conn.authenticate(options[:auth_type] || "LOGIN", options[:username], options[:password])
+      end
+    end
+
+    # Returns an array of Folder instances, one for each
+    # root level folder on the server.
+    def folders
+      @conn.list('', '%').map do |f|
+        Folder.new(@conn, f.name, f.delim)
+      end
+    end
+
+    # Closes the connection to the IMAP server.
+    def close
+      @conn.disconnect
+    end
+  end
+end

data/lib/easy_imap.rb

@@ -0,0 +1,11 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module EasyIMAP
+  VERSION = '0.0.2'
+end
+
+require 'easy_imap/server'
+require 'easy_imap/folder'
+require 'easy_imap/message'
+require 'easy_imap/attachment'

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/easy_imap.rb'}"
+puts "Loading easy_imap gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/script/txt2html

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+
+load File.dirname(__FILE__) + "/../Rakefile"
+require 'rubyforge'
+require 'redcloth'
+require 'syntax/convertors/html'
+require 'erb'
+
+download = "http://rubyforge.org/projects/#{$hoe.rubyforge_name}"
+version  = $hoe.version
+
+def rubyforge_project_id
+  RubyForge.new.configure.autoconfig["group_ids"][$hoe.rubyforge_name]
+end
+
+class Fixnum
+  def ordinal
+    # teens
+    return 'th' if (10..19).include?(self % 100)
+    # others
+    case self % 10
+    when 1: return 'st'
+    when 2: return 'nd'
+    when 3: return 'rd'
+    else    return 'th'
+    end
+  end
+end
+
+class Time
+  def pretty
+    return "#{mday}#{mday.ordinal} #{strftime('%B')} #{year}"
+  end
+end
+
+def convert_syntax(syntax, source)
+  return Syntax::Convertors::HTML.for_syntax(syntax).convert(source).gsub(%r!^<pre>|</pre>$!,'')
+end
+
+if ARGV.length >= 1
+  src, template = ARGV
+  template ||= File.join(File.dirname(__FILE__), '/../website/template.html.erb')
+else
+  puts("Usage: #{File.split($0).last} source.txt [template.html.erb] > output.html")
+  exit!
+end
+
+template = ERB.new(File.open(template).read)
+
+title = nil
+body = nil
+File.open(src) do |fsrc|
+  title_text = fsrc.readline
+  body_text_template = fsrc.read
+  body_text = ERB.new(body_text_template).result(binding)
+  syntax_items = []
+  body_text.gsub!(%r!<(pre|code)[^>]*?syntax=['"]([^'"]+)[^>]*>(.*?)</\1>!m){
+    ident = syntax_items.length
+    element, syntax, source = $1, $2, $3
+    syntax_items << "<#{element} class='syntax'>#{convert_syntax(syntax, source)}</#{element}>"
+    "syntax-temp-#{ident}"
+  }
+  title = RedCloth.new(title_text).to_html.gsub(%r!<.*?>!,'').strip
+  body = RedCloth.new(body_text).to_html
+  body.gsub!(%r!(?:<pre><code>)?syntax-temp-(\d+)(?:</code></pre>)?!){ syntax_items[$1.to_i] }
+end
+stat = File.stat(src)
+created = stat.ctime
+modified = stat.mtime
+
+$stdout << template.result(binding)

data/spec/easy_imap_spec.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+# Time to add your specs!
+# http://rspec.info/
+describe "Place your specs here" do
+  
+  it "find this spec in spec directory" do
+    violated "Be sure to write your specs"
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'easy_imap'

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification 
+name: easy_imap
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Paul Stadig
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-17 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: tmail
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.3.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: A simple interface to proccessing e-mail messages using IMAP, including handling multipart messages and attachments.
+email: 
+- paul@stadig.name
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- lib/easy_imap.rb
+- lib/easy_imap/attachment.rb
+- lib/easy_imap/folder.rb
+- lib/easy_imap/message.rb
+- lib/easy_imap/server.rb
+- script/console
+- script/destroy
+- script/generate
+- script/txt2html
+- spec/easy_imap_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/rspec.rake
+has_rdoc: true
+homepage: http://easy-imap.rubyforge.org/
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: easy_imap
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: A simple interface to proccessing e-mail messages using IMAP, including handling multipart messages and attachments.
+test_files: []
+