detect_email_settings 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/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jonathan Jeffus
+
+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,50 @@
+# DetectEmailSettings
+
+This gem is intended to detect email settings for use with Mikel Lindsaar's mail gem. The idea is that a user can give your site their email address and password and the correct connection settings will be auto-detected.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'detect_email_settings'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install detect_email_settings
+
+## Usage
+
+To guess detect email settings for all possible mail servers. This
+process can take up to 10 minutes for some server configurations and is
+not guaranteed to work. If you need faster service you may consider
+using C<detect_known_only()>.
+
+    settings = DetectEmailSettings.detect_settings('someemail@somedomain.com', 'password')
+    if settings.nil?
+      puts "Couldn't detect email settings."
+    else
+      Mail.defaults do
+        retriever_method settings[:method],
+                            :address    => settings[:address],
+                            :port       => settings[:port],
+                            :user_name  => settings[:user_name],
+                            :password   => settings[:password],
+                            :enable_ssl => settings[:enable_ssl]
+      end
+    end
+
+You will get almost immediate results using C<detect_known_only()>. This
+checks for major free or premium mail services with known connection
+settings.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/test.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$: << File.join(File.dirname(__FILE__), "../lib")
+
+require 'detect_email_settings'
+
+STDERR.puts "Final: #{DetectEmailSettings.detect_settings(ARGV[0], ARGV[1])}"

data/detect_email_settings.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/detect_email_settings/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jonathan Jeffus"]
+  gem.email         = ["jjeffus@gmail.com"]
+  gem.homepage      = "http://github.com/jjeffus/detect_email_settings"
+  gem.summary     = "Detect incoming mail settings."
+  gem.description = "The library detects incoming mail settings (imap,pop3) given an email address and password."
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "detect_email_settings"
+  gem.require_paths = ["lib"]
+  gem.version       = DetectEmailSettings::VERSION
+  gem.add_runtime_dependency 'mail'
+end

data/lib/detect_email_settings.rb

@@ -0,0 +1,82 @@
+require 'mail'
+require 'resolv'
+require "detect_email_settings/version"
+require "detect_email_settings/detect_known"
+
+module DetectEmailSettings
+  def self.check_settings(settings)
+    if    settings[:method] == :imap
+      mail = Mail::IMAP.new(settings)
+    elsif settings[:method] == :pop3
+      mail = Mail::POP3.new(settings)
+    end
+    begin
+      mail.connection do |con|
+        ''
+      end
+      return settings
+    rescue Exception => e
+      # STDERR.puts "Fail: #{e.message}"
+      return nil
+    end
+  end
+
+  def self.detect_known_only(email, password)
+    settings = self.get_known_settings(email)
+    if settings
+      settings[:user_name] = email
+      settings[:password]  = password
+      return self.check_settings(settings)
+    end
+    nil
+  end
+
+  def self.detect_settings(email, password)
+    settings = self.detect_known_only(email, password)
+    if settings
+      return settings
+    else
+      methods = {
+        :imap => [[993,true],[585,true],[143,false]],
+        :pop3 => [[110,false],[995,true]]
+      }
+      settings            = {}
+      settings[:password] = password
+      resolver            = Resolv::DNS.new
+      address             = Mail::Address.new(email)
+
+      # Look at these addresses for the server.
+      servers  = ["mail.#{address.domain}", "pop.#{address.domain}", "pop3.#{address.domain}", "imap.#{address.domain}"]
+      begin
+        # And check for an MX record.
+        mx = resolver.getresource(address.domain, Resolv::DNS::Resource::IN::MX)
+        servers.push mx.exchange.to_s
+      rescue
+      end
+
+      # Check each server
+      servers.each do |server|
+        settings[:address] = server
+        # And each method
+        methods.each_key do |method|
+          settings[:method] = method
+          methods[method].each do |combo|
+            # And each port and ssl option
+            settings[:port]       = combo[0]
+            settings[:enable_ssl] = combo[1]
+            # Check with email as username and just the account name
+            [email, address.local].each do |username|
+              settings[:user_name] = username
+              ret                  = self.check_settings(settings)
+              unless ret.nil?
+                return ret
+              end
+            end
+          end
+        end
+      end
+      nil
+    end
+
+  end
+end

data/lib/detect_email_settings/detect_known.rb

@@ -0,0 +1,54 @@
+module DetectEmailSettings
+  def self.get_known_settings(email)
+      aol = {
+        :method     => :imap,
+        :port       => 143,
+        :address    => 'imap.aol.com',
+        :enable_ssl => false,
+        :domains    => ['aol.com']
+      }
+      gmail = {
+        :method     => :imap,
+        :port       => 993,
+        :address    => 'imap.gmail.com',
+        :enable_ssl => true,
+        :domains    => ['gmail.com'],
+        :notice     => "You need to <a href=\"http://support.google.com/mail/bin/answer.py?hl=en&answer=77695\">Enable IMAP Access</a> on your GMail account if you want to use this account with our service."
+      }
+      hotmail = {
+        :method     => :pop3,
+        :port       => 995,
+        :address    => 'pop3.live.com',
+        :enable_ssl => true,
+        :domains    => ['hotmail.com', 'live.com', 'msn.com'],
+        :notice     => "MSN.com email addresses are known to have issues."
+      }
+      mailcom = {
+        :method     => :pop3,
+        :port       => 110,
+        :address    => 'pop.mail.com',
+        :enable_ssl => false,
+        :domains    => ["mail.com", "email.com", "usa.com", "myself.com", "consultant.com", "post.com", "europe.com", "london.com", "asia.com", "iname.com", "writeme.com", "dr.com", "engineer.com", "cheerful.com", "accountant.com", "techie.com", "linuxmail.org", "lawyer.com", "uymail.com", "contractor.net", "accountant.com", "activist.com", "adexec.com", "allergist.com", "alumni.com", "alumnidirector.com", "angelic.com", "appraiser.net", "archaeologist.com", "arcticmail.com", "artlover.com", "asia.com", "auctioneer.net", "bartender.net", "bikerider.com", "birdlover.com", "brew-meister.com", "cash4u.com", "chef.net", "chemist.com", "clerk.com", "clubmember.org", "collector.org", "columnist.com", "comic.com", "computer4u.com", "consultant.com", "contractor.net", "coolsite.net", "counsellor.com", "cyberservices.com", "deliveryman.com", "diplomats.com", "disposable.com", "doctor.com", "dr.com", "engineer.com", "execs.com", "fastservice.com", "financier.com", "fireman.net", "gardener.com", "geologist.com", "graduate.org", "graphic-designer.com", "groupmail.com", "hairdresser.net", "homemail.com", "hot-shot.com", "instruction.com", "instructor.net", "insurer.com", "job4u.com", "journalist.com", "lawyer.com", "legislator.com", "lobbyist.com", "minister.com", "musician.org", "myself.com", "net-shopping.com", "optician.com", "orthodontist.net", "pediatrician.com", "photographer.net", "physicist.net", "planetmail.com", "planetmail.net", "politician.com", "post.com", "presidency.com", "priest.com", "programmer.net", "publicist.com", "qualityservice.com", "radiologist.net", "realtyagent.com", "registerednurses.com", "repairman.com", "representative.com", "rescueteam.com", "revenue.com", "salesperson.net", "scientist.com", "secretary.net", "socialworker.net", "sociologist.com", "solution4u.com", "songwriter.net", "surgical.net", "teachers.org", "tech-center.com", "techie.com", "technologist.com", "theplate.com", "therapist.net", "toothfairy.com", "tvstar.com", "umpire.com", "webname.com", "worker.com", "workmail.com", "writeme.com", "activist.com", "aircraftmail.com", "artlover.com", "atheist.com", "bikerider.com", "birdlover.com", "blader.com", "boardermail.com", "brew-master.com", "brew-meister.com", "bsdmail.com", "catlover.com", "chef.net", "clubmember.org", "collector.org", "cutey.com", "dbzmail.com", "doglover.com", "doramail.com", "gardener.com", "greenmail.net", "hackermail.com", "hilarious.com", "keromail.com", "kittymail.com", "linuxmail.org", "lovecat.com", "marchmail.com", "musician.org", "nonpartisan.com", "petlover.com", "photographer.net", "snakebite.com", "songwriter.net", "techie.com", "theplate.com", "toke.com", "uymail.com", "computer4u.com", "consultant.com", "contractor.net", "coolsite.net", "cyberdude.com", "cybergal.com", "cyberservices.com", "cyber-wizard.com", "engineer.com", "fastservice.com", "graphic-designer.com", "groupmail.com", "homemail.com", "hot-shot.com", "housemail.com", "humanoid.net", "iname.com", "inorbit.com", "mail-me.com", "myself.com", "net-shopping.com", "null.net", "physicist.net", "planetmail.com", "planetmail.net", "post.com", "programmer.net", "qualityservice.com", "rocketship.com", "scientist.com", "solution4u.com", "tech-center.com", "techie.com", "technologist.com", "webname.com", "workmail.com", "writeme.com", "acdcfan.com", "angelic.com", "artlover.com", "atheist.com", "chemist.com", "diplomats.com", "discofan.com", "elvisfan.com", "execs.com", "hiphopfan.com", "housemail.com", "kissfans.com", "madonnafan.com", "metalfan.com", "minister.com", "musician.org", "ninfan.com", "oath.com", "ravemail.com", "reborn.com", "reggaefan.com", "snakebite.com", "songwriter.net", "bellair.net", "californiamail.com", "dallasmail.com", "nycmail.com", "pacific-ocean.com", "pacificwest.com", "sanfranmail.com", "usa.com", "africamail.com", "arcticmail.com", "asia.com", "asia-mail.com", "australiamail.com", "berlin.com", "brazilmail.com", "chinamail.com", "dublin.com", "dutchmail.com", "englandmail.com", "europe.com", "europemail.com", "germanymail.com", "irelandmail.com", "israelmail.com", "italymail.com", "japan.com", "koreamail.com", "london.com", "madrid.com", "mexicomail.com", "moscowmail.com", "munich.com", "polandmail.com", "rome.com", "safrica.com", "samerica.com", "scotlandmail.com", "singapore.com", "spainmail.com", "swedenmail.com", "swissmail.com", "tokyo.com", "torontomail.com", "angelic.com", "atheist.com", "disciples.com", "innocent.com", "minister.com", "muslim.com", "oath.com", "priest.com", "protestant.com", "reborn.com", "reincarnate.com", "religious.com", "saintly.com"],
+        :notice     => "Your email provider requires a Plus account or higher in order to use this address for our service."
+      }
+      yahoo = {
+        :method     => :pop3,
+        :port       => 995,
+        :address    => 'pop.mail.yahoo.com',
+        :enable_ssl => true,
+        :domains    => ['yahoo.com', 'ymail.com', 'rocketmail.com']
+      }
+      domains = {}
+      [aol, gmail, hotmail, mailcom, yahoo].each do |site|
+        site[:domains].each do |domain|
+          domains[domain] = site
+        end
+      end
+      address  = Mail::Address.new(email)
+
+      if domains.has_key? address.domain.downcase
+        return domains[address.domain]
+      end
+      nil
+    end
+ end

data/lib/detect_email_settings/version.rb

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

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: detect_email_settings
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jonathan Jeffus
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-17 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: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The library detects incoming mail settings (imap,pop3) given an email
+  address and password.
+email:
+- jjeffus@gmail.com
+executables:
+- test.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/test.rb
+- detect_email_settings.gemspec
+- lib/detect_email_settings.rb
+- lib/detect_email_settings/detect_known.rb
+- lib/detect_email_settings/version.rb
+homepage: http://github.com/jjeffus/detect_email_settings
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Detect incoming mail settings.
+test_files: []