mail_autoconfig 0.0.1

data/ispdb_data/xpost.plala.or.jp

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<clientConfig>
+  <emailProvider id="xpost.plala.or.jp">
+    <domain>xpost.plala.or.jp</domain>
+    <displayName>ぷらら</displayName>
+    <displayShortName>ぷらら</displayShortName>
+    <incomingServer type="pop3">
+      <hostname>xpost.mail.plala.or.jp</hostname>
+      <port>110</port>
+      <socketType>plain</socketType>
+      <username>%EMAILLOCALPART%</username>
+      <authentication>plain</authentication>
+    </incomingServer>
+    <outgoingServer type="smtp">
+      <hostname>xpost.mail.plala.or.jp</hostname>
+      <port>587</port>
+      <socketType>plain</socketType>
+      <username>%EMAILLOCALPART%</username>
+      <authentication>plain</authentication>
+      <addThisServer>true</addThisServer>
+      <useGlobalPreferredServer>false</useGlobalPreferredServer>
+    </outgoingServer>
+  </emailProvider>
+</clientConfig>

data/ispdb_data/xs4all.nl

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<clientConfig version="1.1">
+  <emailProvider id="xs4all.nl">
+    <domain>xs4all.nl</domain>
+    <displayName>XS4All</displayName>
+    <displayShortName>XS4All</displayShortName>
+    <incomingServer type="pop3">
+      <hostname>pops.xs4all.nl</hostname>
+      <port>995</port>
+      <socketType>SSL</socketType>
+      <username>%EMAILLOCALPART%</username>
+      <authentication>password-cleartext</authentication>
+    </incomingServer>
+    <outgoingServer type="smtp">
+      <hostname>smtps.xs4all.nl</hostname>
+      <port>465</port>
+      <socketType>SSL</socketType>
+      <username>%EMAILLOCALPART%</username>
+      <authentication>password-cleartext</authentication>
+    </outgoingServer>
+  </emailProvider>
+</clientConfig>

data/ispdb_data/xtra.co.nz

@@ -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

@@ -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

@@ -0,0 +1,41 @@
+<?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.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>
+    <displayName>Yahoo! Mail</displayName>
+    <displayShortName>Yahoo</displayShortName>
+    <incomingServer type="pop3">
+      <hostname>pop.mail.yahoo.com</hostname>
+      <port>995</port>
+      <socketType>SSL</socketType>
+      <username>%EMAILADDRESS%</username>
+      <authentication>password-cleartext</authentication>
+    </incomingServer>
+    <incomingServer type="imap">
+      <hostname>imap.mail.yahoo.com</hostname>
+      <port>993</port>
+      <socketType>SSL</socketType>
+      <username>%EMAILADDRESS%</username>
+      <authentication>password-cleartext</authentication>
+    </incomingServer>
+    <outgoingServer type="smtp">
+      <hostname>smtp.mail.yahoo.com</hostname>
+      <port>465</port>
+      <socketType>SSL</socketType>
+      <username>%EMAILADDRESS%</username>
+      <authentication>password-cleartext</authentication>
+    </outgoingServer>
+  </emailProvider>
+</clientConfig>

data/ispdb_data/yandex.ru

@@ -0,0 +1,39 @@
+<?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>
+    <enable visiturl="http://mail.yandex.ru/neo/setup_client">
+      <instruction>Check 'Enable IMAP' on Yandex.Mail setup page</instruction>
+    </enable>
+  </emailProvider>
+</clientConfig>

data/ispdb_data/ybb.ne.jp

@@ -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/yellow.plala.or.jp

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<clientConfig>
+  <emailProvider id="yellow.plala.or.jp">
+    <domain>yellow.plala.or.jp</domain>
+    <displayName>ぷらら</displayName>
+    <displayShortName>ぷらら</displayShortName>
+    <incomingServer type="pop3">
+      <hostname>yellow.mail.plala.or.jp</hostname>
+      <port>110</port>
+      <socketType>plain</socketType>
+      <username>%EMAILLOCALPART%</username>
+      <authentication>plain</authentication>
+    </incomingServer>
+    <outgoingServer type="smtp">
+      <hostname>yellow.mail.plala.or.jp</hostname>
+      <port>587</port>
+      <socketType>plain</socketType>
+      <username>%EMAILLOCALPART%</username>
+      <authentication>plain</authentication>
+      <addThisServer>true</addThisServer>
+      <useGlobalPreferredServer>false</useGlobalPreferredServer>
+    </outgoingServer>
+  </emailProvider>
+</clientConfig>

data/ispdb_data/ymail.plala.or.jp

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<clientConfig>
+  <emailProvider id="ymail.plala.or.jp">
+    <domain>ymail.plala.or.jp</domain>
+    <displayName>ぷらら</displayName>
+    <displayShortName>ぷらら</displayShortName>
+    <incomingServer type="pop3">
+      <hostname>ymail.mail.plala.or.jp</hostname>
+      <port>110</port>
+      <socketType>plain</socketType>
+      <username>%EMAILLOCALPART%</username>
+      <authentication>plain</authentication>
+    </incomingServer>
+    <outgoingServer type="smtp">
+      <hostname>ymail.mail.plala.or.jp</hostname>
+      <port>587</port>
+      <socketType>plain</socketType>
+      <username>%EMAILLOCALPART%</username>
+      <authentication>plain</authentication>
+      <addThisServer>true</addThisServer>
+      <useGlobalPreferredServer>false</useGlobalPreferredServer>
+    </outgoingServer>
+  </emailProvider>
+</clientConfig>

data/ispdb_data/ypost.plala.or.jp

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<clientConfig>
+  <emailProvider id="ypost.plala.or.jp">
+    <domain>ypost.plala.or.jp</domain>
+    <displayName>ぷらら</displayName>
+    <displayShortName>ぷらら</displayShortName>
+    <incomingServer type="pop3">
+      <hostname>ypost.mail.plala.or.jp</hostname>
+      <port>110</port>
+      <socketType>plain</socketType>
+      <username>%EMAILLOCALPART%</username>
+      <authentication>plain</authentication>
+    </incomingServer>
+    <outgoingServer type="smtp">
+      <hostname>ypost.mail.plala.or.jp</hostname>
+      <port>587</port>
+      <socketType>plain</socketType>
+      <username>%EMAILLOCALPART%</username>
+      <authentication>plain</authentication>
+      <addThisServer>true</addThisServer>
+      <useGlobalPreferredServer>false</useGlobalPreferredServer>
+    </outgoingServer>
+  </emailProvider>
+</clientConfig>

data/ispdb_data/ziggo.nl

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<clientConfig version="1.1">
+  <emailProvider id="ziggo.nl">
+    <domain>ziggo.nl</domain>
+    <domain>casema.nl</domain>
+    <domain>quicknet.nl</domain>
+    <domain>home.nl</domain>
+    <displayName>Ziggo</displayName>
+    <displayShortName>Ziggo</displayShortName>
+    <incomingServer type="pop3">
+      <hostname>pop.ziggo.nl</hostname>
+      <port>110</port>
+      <socketType>plain</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>
+</clientConfig>

data/ispdb_data/zmail.plala.or.jp

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<clientConfig>
+  <emailProvider id="zmail.plala.or.jp">
+    <domain>zmail.plala.or.jp</domain>
+    <displayName>ぷらら</displayName>
+    <displayShortName>ぷらら</displayShortName>
+    <incomingServer type="pop3">
+      <hostname>zmail.mail.plala.or.jp</hostname>
+      <port>110</port>
+      <socketType>plain</socketType>
+      <username>%EMAILLOCALPART%</username>
+      <authentication>plain</authentication>
+    </incomingServer>
+    <outgoingServer type="smtp">
+      <hostname>zmail.mail.plala.or.jp</hostname>
+      <port>587</port>
+      <socketType>plain</socketType>
+      <username>%EMAILLOCALPART%</username>
+      <authentication>plain</authentication>
+      <addThisServer>true</addThisServer>
+      <useGlobalPreferredServer>false</useGlobalPreferredServer>
+    </outgoingServer>
+  </emailProvider>
+</clientConfig>

data/ispdb_data/zpost.plala.or.jp

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<clientConfig>
+  <emailProvider id="zpost.plala.or.jp">
+    <domain>zpost.plala.or.jp</domain>
+    <displayName>ぷらら</displayName>
+    <displayShortName>ぷらら</displayShortName>
+    <incomingServer type="pop3">
+      <hostname>zpost.mail.plala.or.jp</hostname>
+      <port>110</port>
+      <socketType>plain</socketType>
+      <username>%EMAILLOCALPART%</username>
+      <authentication>plain</authentication>
+    </incomingServer>
+    <outgoingServer type="smtp">
+      <hostname>zpost.mail.plala.or.jp</hostname>
+      <port>587</port>
+      <socketType>plain</socketType>
+      <username>%EMAILLOCALPART%</username>
+      <authentication>plain</authentication>
+      <addThisServer>true</addThisServer>
+      <useGlobalPreferredServer>false</useGlobalPreferredServer>
+    </outgoingServer>
+  </emailProvider>
+</clientConfig>

data/lib/mail_autoconfig/client_config.rb

@@ -0,0 +1,118 @@
+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)
+        self.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 = self.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|
+          begin
+            response = Faraday.get(url)
+            if response.status == 200
+              last_config = self.new(response.body)
+            else
+              false
+            end
+          rescue
+            false
+          end
+        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