mail_autoconfig_revived 0.0.3

data/ispdb_data/xp.wind.jp.xml

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<clientConfig version="1.1">
+  <emailProvider id="xp.wind.jp">
+    <domain>xp.wind.jp</domain>
+    <displayName>群馬インターネット</displayName>
+    <displayShortName>wind</displayShortName>
+    <incomingServer type="pop3">
+      <hostname>xp.wind.jp</hostname>
+      <port>110</port>
+      <socketType>plain</socketType>
+      <username>%EMAILLOCALPART%</username>
+      <authentication>password-cleartext</authentication>
+    </incomingServer>
+    <outgoingServer type="smtp">
+      <hostname>xp.wind.jp</hostname>
+      <port>587</port>
+      <socketType>plain</socketType>
+      <username>%EMAILLOCALPART%</username>
+      <authentication>password-cleartext</authentication>
+      <addThisServer>true</addThisServer>
+      <useGlobalPreferredServer>false</useGlobalPreferredServer>
+    </outgoingServer>
+  </emailProvider>
+</clientConfig>

data/ispdb_data/xtra.co.nz.xml

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<clientConfig version="1.1">
+  <emailProvider id="xtra.co.nz">
+    <domain>xtra.co.nz</domain>
+    <displayName>Yahoo! Mail</displayName>
+    <displayShortName>Yahoo</displayShortName>
+    <incomingServer type="pop3">
+      <hostname>pop3.xtra.co.nz</hostname>
+      <port>995</port>
+      <socketType>SSL</socketType>
+      <username>%EMAILLOCALPART%</username>
+      <authentication>password-cleartext</authentication>
+    </incomingServer>
+    <outgoingServer type="smtp">
+      <hostname>send.xtra.co.nz</hostname>
+      <port>465</port>
+      <socketType>SSL</socketType>
+      <username>%EMAILLOCALPART%</username>
+      <authentication>password-cleartext</authentication>
+    </outgoingServer>
+  </emailProvider>
+</clientConfig>

data/ispdb_data/yahoo.co.jp.xml

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<clientConfig version="1.1">
+  <emailProvider id="yahoo.co.jp">
+    <domain>yahoo.co.jp</domain>
+    <displayName>Yahoo! メール</displayName>
+    <displayShortName>Yahoo! メール</displayShortName>
+    <incomingServer type="pop3">
+      <hostname>pop.mail.yahoo.co.jp</hostname>
+      <port>995</port>
+      <socketType>SSL</socketType>
+      <username>%EMAILLOCALPART%</username>
+      <authentication>password-cleartext</authentication>
+    </incomingServer>
+    <outgoingServer type="smtp">
+      <hostname>smtp.mail.yahoo.co.jp</hostname>
+      <port>465</port>
+      <socketType>SSL</socketType>
+      <username>%EMAILLOCALPART%</username>
+      <authentication>password-cleartext</authentication>
+    </outgoingServer>
+  </emailProvider>
+</clientConfig>

data/ispdb_data/yahoo.com.xml

@@ -0,0 +1,84 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<clientConfig version="1.1">
+  <emailProvider id="yahoo.com">
+    <domain>yahoo.com</domain>
+    <domain>yahoo.de</domain>
+    <domain>yahoo.it</domain>
+    <domain>yahoo.fr</domain>
+    <domain>yahoo.es</domain>
+    <domain>yahoo.se</domain>
+    <domain>yahoo.co.uk</domain>
+    <domain>yahoo.co.nz</domain>
+    <domain>yahoo.com.au</domain>
+    <domain>yahoo.com.ar</domain>
+    <domain>yahoo.com.br</domain>
+    <domain>yahoo.com.mx</domain>
+    <domain>ymail.com</domain>
+    <domain>rocketmail.com</domain>
+    <!-- MX -->
+    <domain>mail.am0.yahoodns.net</domain>
+    <domain>am0.yahoodns.net</domain>
+    <!-- Unfortunately, also used for AOL :-( -->
+    <domain>yahoodns.net</domain>
+
+    <displayName>Yahoo! Mail</displayName>
+    <displayShortName>Yahoo</displayShortName>
+
+    <incomingServer type="imap">
+      <hostname>imap.mail.yahoo.com</hostname>
+      <port>993</port>
+      <socketType>SSL</socketType>
+      <username>%EMAILADDRESS%</username>
+      <authentication>OAuth2</authentication>
+      <authentication>password-cleartext</authentication>
+    </incomingServer>
+    <incomingServer type="imap">
+      <hostname>export.imap.mail.yahoo.com</hostname>
+      <port>993</port>
+      <socketType>SSL</socketType>
+      <username>%EMAILADDRESS%</username>
+      <authentication>OAuth2</authentication>
+      <authentication>password-cleartext</authentication>
+    </incomingServer>
+    <incomingServer type="pop3">
+      <hostname>pop.mail.yahoo.com</hostname>
+      <port>995</port>
+      <socketType>SSL</socketType>
+      <username>%EMAILADDRESS%</username>
+      <authentication>OAuth2</authentication>
+      <authentication>password-cleartext</authentication>
+    </incomingServer>
+    <outgoingServer type="smtp">
+      <hostname>smtp.mail.yahoo.com</hostname>
+      <port>465</port>
+      <socketType>SSL</socketType>
+      <username>%EMAILADDRESS%</username>
+      <authentication>OAuth2</authentication>
+      <authentication>password-cleartext</authentication>
+    </outgoingServer>
+
+    <documentation url="https://help.yahoo.com/kb/new-mail-for-desktop/imap-server-settings-yahoo-mail-sln4075.html">
+      <descr lang="en">How to setup email applications with imap to receive Yahoo! mail?</descr>
+    </documentation>
+    <documentation url="https://help.yahoo.com/kb/new-mail-for-desktop/pop-access-settings-instructions-yahoo-mail-sln4724.html">
+      <descr lang="en">How to setup email applications with pop to receive Yahoo! mail?</descr>
+    </documentation>
+  </emailProvider>
+
+  <oAuth2>
+    <issuer>login.yahoo.com</issuer>
+    <scope>mail-w</scope>
+    <authURL>https://api.login.yahoo.com/oauth2/request_auth</authURL>
+    <tokenURL>https://api.login.yahoo.com/oauth2/get_token</tokenURL>
+  </oAuth2>
+
+  <webMail>
+    <loginPage url="https://mail.yahoo.com" />
+    <loginPageInfo url="https://mail.yahoo.com/">
+      <username>%EMAILADDRESS%</username>
+      <usernameField id="login-username" />
+      <passwordField id="login-passwd" />
+      <loginButton id="login-signin" />
+    </loginPageInfo>
+  </webMail>
+</clientConfig>

data/ispdb_data/yandex.ru.xml

@@ -0,0 +1,49 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<clientConfig version="1.1">
+  <emailProvider id="yandex.ru">
+    <domain>yandex.ru</domain>
+    <domain>yandex.com</domain>
+    <domain>yandex.net</domain>
+    <domain>yandex.by</domain>
+    <domain>yandex.kz</domain>
+    <domain>yandex.ua</domain>
+    <domain>ya.ru</domain>
+    <domain>narod.ru</domain>
+
+    <displayName>Yandex Mail</displayName>
+    <displayShortName>Yandex</displayShortName>
+
+    <incomingServer type="imap">
+      <hostname>imap.yandex.com</hostname>
+      <port>993</port>
+      <socketType>SSL</socketType>
+      <username>%EMAILADDRESS%</username>
+      <authentication>password-cleartext</authentication>
+    </incomingServer>
+    <incomingServer type="pop3">
+      <hostname>pop.yandex.com</hostname>
+      <port>995</port>
+      <socketType>SSL</socketType>
+      <username>%EMAILADDRESS%</username>
+      <authentication>password-cleartext</authentication>
+    </incomingServer>
+    <outgoingServer type="smtp">
+      <hostname>smtp.yandex.com</hostname>
+      <port>465</port>
+      <socketType>SSL</socketType>
+      <username>%EMAILADDRESS%</username>
+      <authentication>password-cleartext</authentication>
+    </outgoingServer>
+  </emailProvider>
+
+  <oAuth2>
+    <issuer>oauth.yandex.com</issuer>
+    <scope>mail:imap_full mail:smtp</scope>
+    <authURL>https://oauth.yandex.com/authorize</authURL>
+    <tokenURL>https://oauth.yandex.com/token</tokenURL>
+  </oAuth2>
+
+  <enable visiturl="http://mail.yandex.ru/neo/setup_client">
+    <instruction>Check 'Enable IMAP' on Yandex.Mail setup page</instruction>
+  </enable>
+</clientConfig>

data/ispdb_data/ybb.ne.jp.xml

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<clientConfig version="1.1">
+  <emailProvider id="ybb.ne.jp">
+    <domain>ybb.ne.jp</domain>
+    <displayName>Yahoo! BB</displayName>
+    <displayShortName>Yahoo! BB</displayShortName>
+    <incomingServer type="pop3">
+      <hostname>ybbpop.mail.yahoo.co.jp</hostname>
+      <port>995</port>
+      <socketType>SSL</socketType>
+      <username>%EMAILLOCALPART%</username>
+      <authentication>password-cleartext</authentication>
+    </incomingServer>
+    <outgoingServer type="smtp">
+      <hostname>ybbsmtp.mail.yahoo.co.jp</hostname>
+      <port>465</port>
+      <socketType>SSL</socketType>
+      <username>%EMAILLOCALPART%</username>
+      <authentication>password-cleartext</authentication>
+    </outgoingServer>
+  </emailProvider>
+</clientConfig>

data/ispdb_data/yeah.net.xml

@@ -0,0 +1,21 @@
+<clientConfig version="1.1">
+  <emailProvider id="yeah.net">
+    <domain>yeah.net</domain>
+    <displayName>yeah.net</displayName>
+    <displayShortName>yeah.net</displayShortName>
+    <incomingServer type="imap">
+      <hostname>imap.yeah.net</hostname>
+      <port>993</port>
+      <socketType>SSL</socketType>
+      <username>%EMAILADDRESS%</username>
+      <authentication>password-cleartext</authentication>
+    </incomingServer>
+    <outgoingServer type="smtp">
+      <hostname>smtp.yeah.net</hostname>
+      <port>465</port>
+      <socketType>SSL</socketType>
+      <username>%EMAILADDRESS%</username>
+      <authentication>password-cleartext</authentication>
+    </outgoingServer>
+  </emailProvider>
+</clientConfig>

data/ispdb_data/zeelandnet.nl.xml

@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<clientConfig version="1.1">
+  <emailProvider id="zeelandnet.nl">
+    <domain>zeelandnet.nl</domain>
+    <displayName>ZeelandNet e-mail</displayName>
+    <displayShortName>ZeelandNet</displayShortName>
+    <incomingServer type="imap">
+      <hostname>mail.zeelandnet.nl</hostname>
+      <port>993</port>
+      <socketType>SSL</socketType>
+      <authentication>password-cleartext</authentication>
+      <username>%EMAILLOCALPART%</username>
+    </incomingServer>
+    <incomingServer type="pop3">
+      <hostname>mail.zeelandnet.nl</hostname>
+      <port>995</port>
+      <socketType>SSL</socketType>
+      <authentication>password-cleartext</authentication>
+      <username>%EMAILLOCALPART%</username>
+    </incomingServer>
+    <outgoingServer type="smtp">
+      <hostname>mail.zeelandnet.nl</hostname>
+      <port>465</port>
+      <socketType>SSL</socketType>
+      <authentication>password-cleartext</authentication>
+      <username>%EMAILLOCALPART%</username>
+    </outgoingServer>
+  </emailProvider>
+</clientConfig>

data/ispdb_data/ziggo.nl.xml

@@ -0,0 +1,46 @@
+<?xml version="1.0"?>
+<clientConfig version="1.1">
+  <emailProvider id="ziggo.nl">
+    <domain>hahah.nl</domain>
+    <domain>ziggomail.com</domain>
+    <domain>casema.nl</domain>
+    <domain>zinders.nl</domain>
+    <domain>ziggo.nl</domain>
+    <domain>zeggis.nl</domain>
+    <domain>zeggis.com</domain>
+    <domain>razcall.nl</domain>
+    <domain>razcall.com</domain>
+    <domain>upcmail.nl</domain>
+    <domain>chello.nl</domain>
+    <domain>multiweb.nl</domain>
+    <domain>home.nl</domain>
+    <domain>quicknet.nl</domain>
+    <displayName>Ziggo Mail</displayName>
+    <displayShortName>Ziggo</displayShortName>
+    <incomingServer type="imap">
+      <hostname>imap.ziggo.nl</hostname>
+      <port>993</port>
+      <socketType>SSL</socketType>
+      <username>%EMAILADDRESS%</username>
+      <authentication>password-cleartext</authentication>
+    </incomingServer>
+    <incomingServer type="pop3">
+      <hostname>pop.ziggo.nl</hostname>
+      <port>995</port>
+      <socketType>SSL</socketType>
+      <username>%EMAILADDRESS%</username>
+      <authentication>password-cleartext</authentication>
+    </incomingServer>
+    <outgoingServer type="smtp">
+      <hostname>smtp.ziggo.nl</hostname>
+      <port>587</port>
+      <socketType>STARTTLS</socketType>
+      <username>%EMAILADDRESS%</username>
+      <authentication>password-cleartext</authentication>
+    </outgoingServer>
+  </emailProvider>
+  <documentation url="https://www.ziggo.nl/klantenservice/e-mail/?src=autoconfig">
+    <descr lang="en">E-mail Settings</descr>
+    <descr lang="nl">Instellingen voor e-mail</descr>
+  </documentation>
+</clientConfig>

data/ispdb_data/zoho.com.xml

@@ -0,0 +1,62 @@
+<?xml version="1.0"?>
+<clientConfig version="1.1">
+  <emailProvider id="zoho.com">
+    <domain>zoho.com</domain>
+    <domain>zohomail.com</domain>
+    <displayName>Zoho Mail</displayName>
+    <displayShortName>Zoho</displayShortName>
+    <incomingServer type="imap">
+      <hostname>imap.zoho.com</hostname>
+      <port>993</port>
+      <socketType>SSL</socketType>
+      <username>%EMAILADDRESS%</username>
+      <authentication>password-cleartext</authentication>
+    </incomingServer>
+    <!-- You must enable IMAP Access for your account  
+	     before you begin the configuration in the email client.  -->
+    <incomingServer type="pop3">
+      <hostname>pop.zoho.com</hostname>
+      <port>995</port>
+      <socketType>SSL</socketType>
+      <username>%EMAILADDRESS%</username>
+      <authentication>password-cleartext</authentication>
+    </incomingServer>
+    <!-- You must enable POP Access for your account  
+	     before you begin the configuration in the email client.  -->
+    <outgoingServer type="smtp">
+      <hostname>smtp.zoho.com</hostname>
+      <port>465</port>
+      <socketType>SSL</socketType>
+      <username>%EMAILADDRESS%</username>
+      <authentication>password-cleartext</authentication>
+    </outgoingServer>
+    <outgoingServer type="smtp">
+      <hostname>smtp.zoho.com</hostname>
+      <port>587</port>
+      <socketType>STARTTLS</socketType>
+      <username>%EMAILADDRESS%</username>
+      <authentication>password-cleartext</authentication>
+    </outgoingServer>
+  </emailProvider>
+  <documentation url="https://www.zoho.com/mail/help/imap-access.html">
+    <descr lang="en">Zoho Mail - Access via IMAP</descr>
+  </documentation>
+  <documentation url="https://www.zoho.com/mail/help/imap-access.html">
+    <descr lang="en">Zoho Mail - POP configuration details</descr>
+  </documentation>
+  <documentation url="https://www.zoho.com/mail/help/zoho-smtp.html">
+    <descr lang="en">Zoho Mail - SMTP Server Configuration</descr>
+  </documentation>
+  <documentation url="https://www.zoho.com/mail/help/thunderbird-imap-access.html">
+    <descr lang="en">Configure Zoho Mail as IMAP Account in Thunderbird</descr>
+  </documentation>
+  <documentation url="https://www.zoho.com/mail/help/thunderbird-pop-access.html">
+    <descr lang="en">Configure your Zoho Account as POP in Thunderbird</descr>
+  </documentation>
+  <documentation url="https://www.zoho.com/mail/help/pop-access.html#EnablePOPAccess">
+    <descr lang="en">Enable POP Access</descr>
+  </documentation>
+  <documentation url="https://www.zoho.com/mail/help/imap-access.html#EnableIMAP">
+    <descr lang="en">Enable IMAP Access</descr>
+  </documentation>
+</clientConfig>

data/lib/mail_autoconfig/client_config.rb

@@ -0,0 +1,113 @@
+module MailAutoconfig
+  # Parse the Autoconfig XML file and create a ruby representation
+  class ClientConfig
+    attr_reader :config
+    attr_accessor :email_address
+
+    class << self
+      # Build a configuration from the specified path
+      # @param path [String] the loction of the client configuartion file
+      # @return [ClientConfig] new client configuration
+      def from_file(path)
+        new(File.read(path))
+      end
+
+      # Try to find a configuration for the given domain, locally or remotely
+      # @param domain [String] the domain to lookup the configuration for
+      # @return [ClientConfig] client configuration for the domain
+      def search(domain)
+        search_local_files(domain) || search_autoconfig_domain(domain)
+      end
+
+      # Search local ISPDB for configurations matching the domain
+      # @param domain [String] the domain to look for
+      # @return [ClientConfig] client configuration for the domain
+      def search_local_files(domain)
+        last_config = false
+        match = Dir.glob(File.join(MailAutoconfig.local_ispdb_path, "*")).find do |config_file|
+          last_config = from_file(config_file)
+          last_config.valid_for_domain?(domain)
+        end
+        match ? last_config : false
+      end
+
+      # Try a remote server for the configuration for the domain.
+      # Search `http://autoconfig.#{domain}/mail/config-v1.1.xml` first,
+      # followed by `http://#{domain}/.well-known/autoconfig/mail/config-v1.1.xml`
+      # @param domain [String] the domain to look for
+      # @return [ClientConfig] the client configuration for the domain
+      def search_autoconfig_domain(domain)
+        last_config = false
+        match = ["http://autoconfig.#{domain}/mail/config-v1.1.xml", "http://#{domain}/.well-known/autoconfig/mail/config-v1.1.xml"].find do |url|
+          response = Faraday.get(url)
+          if response.status == 200
+            last_config = new(response.body)
+          else
+            false
+          end
+        rescue
+          false
+        end
+        match ? last_config : false
+      end
+    end
+
+    # @param client_config_xml [String] the raw XML to build the ClientConfig from.
+    def initialize(client_config_xml)
+      @config = Nokogiri::XML(client_config_xml)
+    end
+
+    # A list of domain aliases that this configuration applies to
+    # @return [Array] list of domains for this configuration
+    def domains
+      @domains ||= provider.xpath("domain").map { |domain| domain.content }
+    end
+
+    # Does this configuration file apply to the specified domain?
+    # @param domain [String] the domain to check
+    # @return [Boolean] Does the domain match?
+    def valid_for_domain?(domain)
+      domains.any? { |d| d == domain }
+    end
+
+    # @return [String] The unique string identifying this service (e.g. googlemail.com)
+    def provider_id
+      @provider_id ||= provider.attr("id").value
+    end
+
+    # @return [String] the full name of this service (e.g. Google Mail)
+    def name
+      @name ||= provider.xpath("displayName").first.content
+    end
+
+    # @return [String] the short name of this service (e.g. GMail)
+    def short_name
+      @short_name ||= provider.xpath("displayShortName").first.content
+    end
+
+    # The incoming servers for this configuration. There can be multiple servers per
+    # configuration e.g. for IMAP and POP3, ordered in list of preference.
+    # @return [Array] list of incoming servers
+    def incoming_servers
+      @incoming_servers ||= provider.xpath("incomingServer").map do |incoming|
+        MailAutoconfig::IncomingServer.new(incoming, self)
+      end
+    end
+
+    # The outgoing servers for this configuration. There can be multiple servers per
+    # configuration, ordered in list of preference.
+    # @return [Array] list of outgoing servers
+    def outgoing_servers
+      @outgoing_servers ||= provider.xpath("outgoingServer").map do |outgoing|
+        MailAutoconfig::OutgoingServer.new(outgoing, self)
+      end
+    end
+
+    private
+
+    # @return [Nokogiri::XML::Node] the root configuration node
+    def provider
+      @provider ||= config.xpath("//clientConfig/emailProvider")
+    end
+  end
+end

data/lib/mail_autoconfig/email_address.rb

@@ -0,0 +1,52 @@
+module MailAutoconfig
+  # Email address that we're going to investigate
+  class EmailAddress
+    attr_reader :address
+
+    # @param address [String] the email address to look up
+    def initialize(address)
+      @address = address
+    end
+
+    # Fetch the client configuration for this email address.
+    # First of all try the domain determined by {#domain}. If nothing is found there,
+    # check the domain specified in {#primary_mx_domain}. Returns false if none found.
+    # @return [MailAutoconfig::ClientConfig] the client configuration for this address
+    def client_config
+      @client_config ||= begin
+        config = MailAutoconfig::ClientConfig.search(domain)
+        config ||= MailAutoconfig::ClientConfig.search(primary_mx_domain)
+        config.email_address = self if config
+        config
+      end
+    end
+
+    # The local part of the emai address (before the @ symbol).
+    # Useful for usage with the %EMAILLOCALPART% substitution.
+    # @return [String] the local part of the email address
+    def local_part
+      @local_part ||= @address.split("@", 2).first
+    end
+
+    # The domain of the email address (the part after the @ symbol)
+    # @return [String] the domain of the email address
+    def domain
+      @domain ||= @address.split("@", 2).last
+    end
+
+    # Finds the primary MX domain for this address. Would change gmail-smtp-in.l.google.com to google.com
+    # @return [String] the domain of the pimary MX record for this address
+    def primary_mx_domain
+      # Not very nice to 2nd level domains
+      @primary_mx_domain ||= (mx_records.first.split(".")[-2..].join(".") unless mx_records.empty?)
+    end
+
+    private
+
+    # Finds MX records for the associated email address, ordered by preference.
+    # @return [Array] MX records for this email address
+    def mx_records
+      @mx_records ||= Resolv::DNS.open.getresources(domain, Resolv::DNS::Resource::IN::MX).sort_by(&:preference).map { |r| r.exchange.to_s }
+    end
+  end
+end

data/lib/mail_autoconfig/server.rb

@@ -0,0 +1,72 @@
+module MailAutoconfig
+  # Superclass for {IncomingServer} and {OutgoingServer}.
+  # Never used directly.
+  class Server
+    attr_reader :config
+    attr_reader :client_config
+
+    # @param config [Nokogiri::XML::Node] an XML representation of this server
+    def initialize(config, client_config)
+      @config = config
+      @client_config = client_config
+    end
+
+    # Returns the protocol of the mail server e.g. `smtp`, `pop3`, `imap`
+    # @return [String] The protocol for the server
+    def protocol
+      @protocol ||= config.attr("type")
+    end
+
+    # @return [String] The hostname for this server
+    def hostname
+      @hostname ||= config.xpath("hostname").first.content
+    end
+
+    # @return [Integer] The port to connect ot this server on
+    def port
+      @port ||= config.xpath("port").first.content.to_i
+    end
+
+    # The connection type for this server. `plain`, `STARTTLS`, `SSL` are acceptable
+    # @return [String] The connection type
+    def socket_type
+      @socket_type ||= config.xpath("socketType").first.content
+    end
+
+    # The username for this mailbox, combines {username_format} and [EmailAddress] details
+    # @return [String] The username
+    def username
+      @username ||= begin
+        name = username_format
+        name.gsub! "%EMAILADDRESS%", client_config.email_address.address
+        name.gsub! "%EMAILLOCALPART%", client_config.email_address.local_part
+        name.gsub! "%EMAILDOMAIN%", client_config.email_address.domain
+        name
+      end
+    end
+
+    # Return the username format for this server. There are substitutions that can be made.
+    #
+    # * `%EMAILADDRESS%` - full email address of the user, usually entered by the user
+    # * `%EMAILLOCALPART%` - email address, part before @
+    # * `%EMAILDOMAIN%` - email address, part after @
+    #
+    # @return [String] the username format
+    def username_format
+      @username_format ||= config.xpath("username").first.content
+    end
+
+    # The authentication type for this server. Valid responses:
+    # `password-cleartext`, `NTLM`, `GSSAPI`, `client-IP-address`, `TLS-client-cert`, `none`
+    # @return [String] the authentication method for this server
+    def authentication
+      @authentication ||= config.xpath("authentication").first.content
+    end
+  end
+
+  # Configuration details for an incoming server.
+  class IncomingServer < Server; end
+
+  # Configuration details for an outgoing server.
+  class OutgoingServer < Server; end
+end

data/lib/mail_autoconfig/version.rb

@@ -0,0 +1,4 @@
+module MailAutoconfig
+  # The version
+  VERSION = "0.0.3"
+end

data/lib/mail_autoconfig.rb

@@ -0,0 +1,33 @@
+require "nokogiri"
+require "faraday"
+require "resolv"
+
+require "mail_autoconfig/version"
+require "mail_autoconfig/client_config"
+require "mail_autoconfig/server"
+require "mail_autoconfig/email_address"
+
+# Module to lookup mailbox autoconfiguration according to Thunderbird
+# spec (https://wiki.mozilla.org/Thunderbird:Autoconfiguration:ConfigFileFormat)
+# and guidelines (https://developer.mozilla.org/en-US/docs/Mozilla/Thunderbird/Autoconfiguration)
+module MailAutoconfig
+  # The path for the locally stored Thunderbird ISPDB configurations
+  # @return [String] absolute path to the ispdb data directory
+  def self.local_ispdb_path
+    File.expand_path(File.join(__FILE__, "../", "../", "ispdb_data"))
+  end
+
+  # The URL to the canonical SVN repository containing the Thunderbird IPSDB
+  # @return [String] GIT repository location
+  def self.ispdb_github_url
+    "https://github.com/thunderbird/autoconfig"
+  end
+
+  # Fetch the client configuration for a given email address, if any.
+  # Returns false if none found.
+  # @param email [String] the email address to lookup
+  # @return [MailAutoconfig::ClientConfig]
+  def self.for_address(email)
+    MailAutoconfig::EmailAddress.new(email).client_config
+  end
+end