mail_autoconfig_revived 0.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (197) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +4 -0
  3. data/.standard.yml +2 -0
  4. data/.yardopts +1 -0
  5. data/Gemfile +4 -0
  6. data/Gemfile.lock +80 -0
  7. data/LICENSE.txt +26 -0
  8. data/README.md +62 -0
  9. data/Rakefile +38 -0
  10. data/doc/MailAutoconfig/ClientConfig.html +1418 -0
  11. data/doc/MailAutoconfig/EmailAddress.html +651 -0
  12. data/doc/MailAutoconfig/IncomingServer.html +155 -0
  13. data/doc/MailAutoconfig/OutgoingServer.html +155 -0
  14. data/doc/MailAutoconfig/Server.html +972 -0
  15. data/doc/MailAutoconfig.html +428 -0
  16. data/doc/_index.html +182 -0
  17. data/doc/class_list.html +51 -0
  18. data/doc/css/common.css +1 -0
  19. data/doc/css/full_list.css +58 -0
  20. data/doc/css/style.css +497 -0
  21. data/doc/file.README.html +134 -0
  22. data/doc/file_list.html +56 -0
  23. data/doc/frames.html +17 -0
  24. data/doc/index.html +134 -0
  25. data/doc/js/app.js +314 -0
  26. data/doc/js/full_list.js +216 -0
  27. data/doc/js/jquery.js +4 -0
  28. data/doc/method_list.html +315 -0
  29. data/doc/top-level-namespace.html +110 -0
  30. data/ispdb_data/126.com.xml +21 -0
  31. data/ispdb_data/163.com.xml +21 -0
  32. data/ispdb_data/1und1.de.xml +75 -0
  33. data/ispdb_data/a1.net.xml +22 -0
  34. data/ispdb_data/active24.com.xml +36 -0
  35. data/ispdb_data/alice.it.xml +30 -0
  36. data/ispdb_data/aol.com.xml +76 -0
  37. data/ispdb_data/arcor.de.xml +68 -0
  38. data/ispdb_data/arubapec.it.xml +34 -0
  39. data/ispdb_data/att.net.xml +34 -0
  40. data/ispdb_data/bay.wind.ne.jp.xml +28 -0
  41. data/ispdb_data/bb-niigata.jp.xml +22 -0
  42. data/ispdb_data/bell.net.xml +30 -0
  43. data/ispdb_data/biglobe.ne.jp.xml +23 -0
  44. data/ispdb_data/bigpond.com.xml +35 -0
  45. data/ispdb_data/bluewin.ch.xml +34 -0
  46. data/ispdb_data/blueyonder.co.uk.xml +38 -0
  47. data/ispdb_data/bol.com.br.xml +40 -0
  48. data/ispdb_data/broba.cc.xml +25 -0
  49. data/ispdb_data/btinternet.com.xml +35 -0
  50. data/ispdb_data/cc9.ne.jp.xml +21 -0
  51. data/ispdb_data/cek.ne.jp.xml +21 -0
  52. data/ispdb_data/centurylink.net.xml +57 -0
  53. data/ispdb_data/centurytel.net.xml +55 -0
  54. data/ispdb_data/cgl.ucsf.edu.xml +22 -0
  55. data/ispdb_data/charter.net.xml +34 -0
  56. data/ispdb_data/clio.ne.jp.xml +22 -0
  57. data/ispdb_data/clustermail.de.xml +58 -0
  58. data/ispdb_data/co1.wind.ne.jp.xml +25 -0
  59. data/ispdb_data/co2.wind.ne.jp.xml +25 -0
  60. data/ispdb_data/co3.wind.ne.jp.xml +25 -0
  61. data/ispdb_data/comcast.net.xml +54 -0
  62. data/ispdb_data/cox.net.xml +36 -0
  63. data/ispdb_data/cty-net.ne.jp.xml +35 -0
  64. data/ispdb_data/dan.wind.ne.jp.xml +28 -0
  65. data/ispdb_data/dd.iij4u.or.jp.xml +33 -0
  66. data/ispdb_data/df.eu.xml +42 -0
  67. data/ispdb_data/dondominio.com.xml +32 -0
  68. data/ispdb_data/earthlink.net.xml +35 -0
  69. data/ispdb_data/educa.madrid.org.xml +48 -0
  70. data/ispdb_data/elpasotel.net.xml +53 -0
  71. data/ispdb_data/email.it.xml +33 -0
  72. data/ispdb_data/emailsrvr.com.xml +22 -0
  73. data/ispdb_data/fastwebnet.it.xml +23 -0
  74. data/ispdb_data/francetelecom.fr.xml +35 -0
  75. data/ispdb_data/free.fr.xml +48 -0
  76. data/ispdb_data/freenet.de.xml +37 -0
  77. data/ispdb_data/gandi.net.xml +58 -0
  78. data/ispdb_data/gigahost.dk.xml +32 -0
  79. data/ispdb_data/gmx.com.xml +72 -0
  80. data/ispdb_data/gmx.net.xml +66 -0
  81. data/ispdb_data/go.tvm.ne.jp.xml +22 -0
  82. data/ispdb_data/goneo.de.xml +56 -0
  83. data/ispdb_data/goo.jp.xml +22 -0
  84. data/ispdb_data/googlemail.com.xml +79 -0
  85. data/ispdb_data/gransy.com.xml +62 -0
  86. data/ispdb_data/hal.ne.jp.xml +22 -0
  87. data/ispdb_data/hana.or.jp.xml +22 -0
  88. data/ispdb_data/hotmail.com.xml +148 -0
  89. data/ispdb_data/i.softbank.jp.xml +22 -0
  90. data/ispdb_data/ic-net.or.jp.xml +22 -0
  91. data/ispdb_data/iijmio-mail.jp.xml +26 -0
  92. data/ispdb_data/iiyama-catv.ne.jp.xml +21 -0
  93. data/ispdb_data/inbox.lv.xml +57 -0
  94. data/ispdb_data/inet-shibata.or.jp.xml +22 -0
  95. data/ispdb_data/internode.on.net.xml +32 -0
  96. data/ispdb_data/ipax.at.xml +28 -0
  97. data/ispdb_data/iwafune.ne.jp.xml +22 -0
  98. data/ispdb_data/janis.or.jp.xml +23 -0
  99. data/ispdb_data/jet.ne.jp.xml +37 -0
  100. data/ispdb_data/ji.jet.ne.jp.xml +22 -0
  101. data/ispdb_data/kabelmail.de.xml +43 -0
  102. data/ispdb_data/kelcom.net.xml +21 -0
  103. data/ispdb_data/kl.wind.ne.jp.xml +32 -0
  104. data/ispdb_data/kokuyou.ne.jp.xml +21 -0
  105. data/ispdb_data/kpnmail.nl.xml +69 -0
  106. data/ispdb_data/laposte.net.xml +37 -0
  107. data/ispdb_data/libero.it.xml +34 -0
  108. data/ispdb_data/mahoroba.ne.jp.xml +22 -0
  109. data/ispdb_data/mail.com.xml +248 -0
  110. data/ispdb_data/mail.dk.xml +30 -0
  111. data/ispdb_data/mail.ee.xml +54 -0
  112. data/ispdb_data/mail.iwafune.ne.jp.xml +22 -0
  113. data/ispdb_data/mail.ru.xml +72 -0
  114. data/ispdb_data/mail.telenor.dk.xml +121 -0
  115. data/ispdb_data/mail.wind.ne.jp.xml +29 -0
  116. data/ispdb_data/me.com.xml +24 -0
  117. data/ispdb_data/messagingengine.com.xml +35 -0
  118. data/ispdb_data/ml.murakami.ne.jp.xml +22 -0
  119. data/ispdb_data/mnet.ne.jp.xml +48 -0
  120. data/ispdb_data/mopera.net.xml +50 -0
  121. data/ispdb_data/mx1.tiki.ne.jp.xml +54 -0
  122. data/ispdb_data/nifty.com.xml +22 -0
  123. data/ispdb_data/nsat.jp.xml +22 -0
  124. data/ispdb_data/ntlworld.com.xml +38 -0
  125. data/ispdb_data/o2.pl.xml +47 -0
  126. data/ispdb_data/ocn.ne.jp.xml +23 -0
  127. data/ispdb_data/office365.com.xml +55 -0
  128. data/ispdb_data/one.com.xml +22 -0
  129. data/ispdb_data/one.cz.xml +29 -0
  130. data/ispdb_data/onet.pl.xml +55 -0
  131. data/ispdb_data/outlook.com.xml +54 -0
  132. data/ispdb_data/ovh.net.xml +32 -0
  133. data/ispdb_data/pal.kijimadaira.jp.xml +21 -0
  134. data/ispdb_data/parabox.or.jp.xml +22 -0
  135. data/ispdb_data/pdx.edu.xml +41 -0
  136. data/ispdb_data/peoplepc.com.xml +29 -0
  137. data/ispdb_data/po.dcn.ne.jp.xml +21 -0
  138. data/ispdb_data/po.wind.ne.jp.xml +28 -0
  139. data/ispdb_data/pobox.com.xml +53 -0
  140. data/ispdb_data/pop.shibata.ne.jp.xml +23 -0
  141. data/ispdb_data/posteo.de.xml +25 -0
  142. data/ispdb_data/ptd.net.xml +53 -0
  143. data/ispdb_data/q.com.xml +53 -0
  144. data/ispdb_data/qq.com.xml +21 -0
  145. data/ispdb_data/rambler.ru.xml +35 -0
  146. data/ispdb_data/rr.com.xml +30 -0
  147. data/ispdb_data/runestone.net.xml +26 -0
  148. data/ispdb_data/sakunet.ne.jp.xml +21 -0
  149. data/ispdb_data/sapo.pt.xml +37 -0
  150. data/ispdb_data/schwaz.net.xml +49 -0
  151. data/ispdb_data/seznam.cz.xml +32 -0
  152. data/ispdb_data/sfr.fr.xml +33 -0
  153. data/ispdb_data/sky.com.xml +35 -0
  154. data/ispdb_data/skynet.be.xml +35 -0
  155. data/ispdb_data/so.wind.ne.jp.xml +25 -0
  156. data/ispdb_data/strato.de.xml +43 -0
  157. data/ispdb_data/studenti.univr.it.xml +37 -0
  158. data/ispdb_data/t-online.de.xml +56 -0
  159. data/ispdb_data/terra.es.xml +29 -0
  160. data/ispdb_data/thinline.cz.xml +60 -0
  161. data/ispdb_data/tiki.ne.jp.xml +24 -0
  162. data/ispdb_data/tiscali.cz.xml +25 -0
  163. data/ispdb_data/tiscali.it.xml +31 -0
  164. data/ispdb_data/umich.edu.xml +32 -0
  165. data/ispdb_data/uol.com.br.xml +42 -0
  166. data/ispdb_data/verizon.net.xml +21 -0
  167. data/ispdb_data/versatel.de.xml +43 -0
  168. data/ispdb_data/virgin.net.xml +38 -0
  169. data/ispdb_data/virginmedia.com.xml +35 -0
  170. data/ispdb_data/vm.aikis.or.jp.xml +22 -0
  171. data/ispdb_data/vp.tiki.ne.jp.xml +24 -0
  172. data/ispdb_data/web.de.xml +55 -0
  173. data/ispdb_data/webhuset.no.xml +42 -0
  174. data/ispdb_data/websupport.sk.xml +50 -0
  175. data/ispdb_data/wildwestdomains.com.xml +37 -0
  176. data/ispdb_data/wp.pl.xml +34 -0
  177. data/ispdb_data/xp.wind.jp.xml +24 -0
  178. data/ispdb_data/xtra.co.nz.xml +22 -0
  179. data/ispdb_data/yahoo.co.jp.xml +22 -0
  180. data/ispdb_data/yahoo.com.xml +84 -0
  181. data/ispdb_data/yandex.ru.xml +49 -0
  182. data/ispdb_data/ybb.ne.jp.xml +22 -0
  183. data/ispdb_data/yeah.net.xml +21 -0
  184. data/ispdb_data/zeelandnet.nl.xml +29 -0
  185. data/ispdb_data/ziggo.nl.xml +46 -0
  186. data/ispdb_data/zoho.com.xml +62 -0
  187. data/lib/mail_autoconfig/client_config.rb +113 -0
  188. data/lib/mail_autoconfig/email_address.rb +52 -0
  189. data/lib/mail_autoconfig/server.rb +72 -0
  190. data/lib/mail_autoconfig/version.rb +4 -0
  191. data/lib/mail_autoconfig.rb +33 -0
  192. data/mail_autoconfig_revived.gemspec +25 -0
  193. data/test/client_config_test.rb +45 -0
  194. data/test/email_address_test.rb +49 -0
  195. data/test/examples/client_config_yahoo.xml +40 -0
  196. data/test/server_test.rb +89 -0
  197. metadata +336 -0
@@ -0,0 +1,134 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="UTF-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ File: README
8
+
9
+ &mdash; Documentation by YARD 0.9.34
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" />
14
+
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" />
16
+
17
+ <script type="text/javascript">
18
+ pathId = "README";
19
+ relpath = '';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="file_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="_index.html">Index</a> &raquo;
40
+ <span class="title">File: README</span>
41
+
42
+ </div>
43
+
44
+ <div id="search">
45
+
46
+ <a class="full_list_link" id="class_list_link"
47
+ href="class_list.html">
48
+
49
+ <svg width="24" height="24">
50
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
51
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
52
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
53
+ </svg>
54
+ </a>
55
+
56
+ </div>
57
+ <div class="clear"></div>
58
+ </div>
59
+
60
+ <div id="content"><div id='filecontents'><h1 id="mail-autoconfig-revived">Mail Autoconfig Revived</h1>
61
+
62
+ <p>This fork revives mail_autoconfig, which was abandoned by the original author.</p>
63
+
64
+ <p>A ruby gem to detect and parse any Thunderbird autoconfig file for a domain. Includes a copy of the Mozilla ISPDB.</p>
65
+
66
+ <p>For general information about autoconf visit (<a href="https://developer.mozilla.org/en-US/docs/Mozilla/Thunderbird/Autoconfiguration">https://developer.mozilla.org/en-US/docs/Mozilla/Thunderbird/Autoconfiguration</a>),
67
+ for the autoconfig schema you should have a look at (<a href="https://wiki.mozilla.org/Thunderbird:Autoconfiguration:ConfigFileFormat">https://wiki.mozilla.org/Thunderbird:Autoconfiguration:ConfigFileFormat</a>).</p>
68
+
69
+ <p>Although I&#39;ve tried to keep parsing as accurate as possible, there may be omissions or errors. Please feel free
70
+ to submit a patch in these cases.</p>
71
+
72
+ <h2 id="installation">Installation</h2>
73
+
74
+ <p>Add this line to your application&#39;s Gemfile:</p>
75
+
76
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>mail_autoconfig_revived</span><span class='tstring_end'>&#39;</span></span>
77
+ </code></pre>
78
+
79
+ <p>And then execute:</p>
80
+
81
+ <pre class="code ruby"><code class="ruby">$ bundle
82
+ </code></pre>
83
+
84
+ <p>Or install it yourself as:</p>
85
+
86
+ <pre class="code ruby"><code class="ruby">$ gem install mail_autoconfig_revived
87
+ </code></pre>
88
+
89
+ <h2 id="usage">Usage</h2>
90
+
91
+ <p>Generally, you just want to get any associated configuration for an email address. In this case we&#39;ll use
92
+ &#39;<a href="mailto:example@gmail.com">example@gmail.com</a>&#39;.</p>
93
+
94
+ <pre class="code ruby"><code class="ruby">client_config = MailAutoconfig::for_address(&#39;example@gmail.com&#39;)
95
+ client_config.short_name
96
+ =&gt; &quot;GMail&quot;
97
+ outbound_server = client_config.outgoing_servers.first
98
+ outbound_server.protocol
99
+ =&gt; &quot;smtp&quot;
100
+ outnound_server.hostname
101
+ =&gt; &quot;smtp.googlemail.com&quot;
102
+ </code></pre>
103
+
104
+ <p>When searching for a configuration, autoconfig first looks to it&#39;s local database for the domain of the address,
105
+ if this fails it will check <code>http://autoconfig.#{domain}/mail/config-v1.1.xml</code> and then
106
+ <code>http://#{domain}/.well-known/autoconfig/mail/config-v1.1.xml</code>. If both of these fail, Autoconfig will then look up
107
+ the MX records for the address, and perform the same searches on the domain of the primary MX record.</p>
108
+
109
+ <h3 id="updating-the-database">Updating the database</h3>
110
+
111
+ <p>You may wish to update the database at some point to fetch the latest from Mozilla&#39;s ISPDB,
112
+ just run the rake task <code>rake fetch_ispdb</code>.</p>
113
+
114
+ <h2 id="contributing">Contributing</h2>
115
+
116
+ <ol>
117
+ <li>Fork it ( <a href="https://github.com/gobijan/mail-autoconfig-revived/fork">https://github.com/gobijan/mail-autoconfig-revived/fork</a> )</li>
118
+ <li>Create your feature branch (<code>git checkout -b my-new-feature</code>)</li>
119
+ <li>Run the test suite, check out haven&#39;t broken anything (<code>bundle exec rspec spec</code>)</li>
120
+ <li>Commit your changes (<code>git commit -am &#39;Add some feature&#39;</code>)</li>
121
+ <li>Push to the branch (<code>git push origin my-new-feature</code>)</li>
122
+ <li>Create new Pull Request</li>
123
+ </ol>
124
+ </div></div>
125
+
126
+ <div id="footer">
127
+ Generated on Wed Nov 15 16:38:27 2023 by
128
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
129
+ 0.9.34 (ruby-3.2.2).
130
+ </div>
131
+
132
+ </div>
133
+ </body>
134
+ </html>
@@ -0,0 +1,56 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
5
+ <meta charset="utf-8" />
6
+
7
+ <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" />
8
+
9
+ <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" />
10
+
11
+
12
+
13
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
14
+
15
+ <script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
16
+
17
+
18
+ <title>File List</title>
19
+ <base id="base_target" target="_parent" />
20
+ </head>
21
+ <body>
22
+ <div id="content">
23
+ <div class="fixed_header">
24
+ <h1 id="full_list_header">File List</h1>
25
+ <div id="full_list_nav">
26
+
27
+ <span><a target="_self" href="class_list.html">
28
+ Classes
29
+ </a></span>
30
+
31
+ <span><a target="_self" href="method_list.html">
32
+ Methods
33
+ </a></span>
34
+
35
+ <span><a target="_self" href="file_list.html">
36
+ Files
37
+ </a></span>
38
+
39
+ </div>
40
+
41
+ <div id="search">Search: <input type="text" /></div>
42
+ </div>
43
+
44
+ <ul id="full_list" class="file">
45
+
46
+
47
+ <li id="object_README" class="odd">
48
+ <div class="item"><span class="object_link"><a href="index.html" title="README">README</a></span></div>
49
+ </li>
50
+
51
+
52
+
53
+ </ul>
54
+ </div>
55
+ </body>
56
+ </html>
data/doc/frames.html ADDED
@@ -0,0 +1,17 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <title>Documentation by YARD 0.9.34</title>
6
+ </head>
7
+ <script type="text/javascript">
8
+ var match = unescape(window.location.hash).match(/^#!(.+)/);
9
+ var name = match ? match[1] : 'index.html';
10
+ name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
11
+ window.top.location = name;
12
+ </script>
13
+ <noscript>
14
+ <h1>Oops!</h1>
15
+ <h2>YARD requires JavaScript!</h2>
16
+ </noscript>
17
+ </html>
data/doc/index.html ADDED
@@ -0,0 +1,134 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="UTF-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ File: README
8
+
9
+ &mdash; Documentation by YARD 0.9.34
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" />
14
+
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" />
16
+
17
+ <script type="text/javascript">
18
+ pathId = "README";
19
+ relpath = '';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="_index.html">Index</a> &raquo;
40
+ <span class="title">File: README</span>
41
+
42
+ </div>
43
+
44
+ <div id="search">
45
+
46
+ <a class="full_list_link" id="class_list_link"
47
+ href="class_list.html">
48
+
49
+ <svg width="24" height="24">
50
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
51
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
52
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
53
+ </svg>
54
+ </a>
55
+
56
+ </div>
57
+ <div class="clear"></div>
58
+ </div>
59
+
60
+ <div id="content"><div id='filecontents'><h1 id="mail-autoconfig-revived">Mail Autoconfig Revived</h1>
61
+
62
+ <p>This fork revives mail_autoconfig, which was abandoned by the original author.</p>
63
+
64
+ <p>A ruby gem to detect and parse any Thunderbird autoconfig file for a domain. Includes a copy of the Mozilla ISPDB.</p>
65
+
66
+ <p>For general information about autoconf visit (<a href="https://developer.mozilla.org/en-US/docs/Mozilla/Thunderbird/Autoconfiguration">https://developer.mozilla.org/en-US/docs/Mozilla/Thunderbird/Autoconfiguration</a>),
67
+ for the autoconfig schema you should have a look at (<a href="https://wiki.mozilla.org/Thunderbird:Autoconfiguration:ConfigFileFormat">https://wiki.mozilla.org/Thunderbird:Autoconfiguration:ConfigFileFormat</a>).</p>
68
+
69
+ <p>Although I&#39;ve tried to keep parsing as accurate as possible, there may be omissions or errors. Please feel free
70
+ to submit a patch in these cases.</p>
71
+
72
+ <h2 id="installation">Installation</h2>
73
+
74
+ <p>Add this line to your application&#39;s Gemfile:</p>
75
+
76
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>mail_autoconfig_revived</span><span class='tstring_end'>&#39;</span></span>
77
+ </code></pre>
78
+
79
+ <p>And then execute:</p>
80
+
81
+ <pre class="code ruby"><code class="ruby">$ bundle
82
+ </code></pre>
83
+
84
+ <p>Or install it yourself as:</p>
85
+
86
+ <pre class="code ruby"><code class="ruby">$ gem install mail_autoconfig_revived
87
+ </code></pre>
88
+
89
+ <h2 id="usage">Usage</h2>
90
+
91
+ <p>Generally, you just want to get any associated configuration for an email address. In this case we&#39;ll use
92
+ &#39;<a href="mailto:example@gmail.com">example@gmail.com</a>&#39;.</p>
93
+
94
+ <pre class="code ruby"><code class="ruby">client_config = MailAutoconfig::for_address(&#39;example@gmail.com&#39;)
95
+ client_config.short_name
96
+ =&gt; &quot;GMail&quot;
97
+ outbound_server = client_config.outgoing_servers.first
98
+ outbound_server.protocol
99
+ =&gt; &quot;smtp&quot;
100
+ outnound_server.hostname
101
+ =&gt; &quot;smtp.googlemail.com&quot;
102
+ </code></pre>
103
+
104
+ <p>When searching for a configuration, autoconfig first looks to it&#39;s local database for the domain of the address,
105
+ if this fails it will check <code>http://autoconfig.#{domain}/mail/config-v1.1.xml</code> and then
106
+ <code>http://#{domain}/.well-known/autoconfig/mail/config-v1.1.xml</code>. If both of these fail, Autoconfig will then look up
107
+ the MX records for the address, and perform the same searches on the domain of the primary MX record.</p>
108
+
109
+ <h3 id="updating-the-database">Updating the database</h3>
110
+
111
+ <p>You may wish to update the database at some point to fetch the latest from Mozilla&#39;s ISPDB,
112
+ just run the rake task <code>rake fetch_ispdb</code>.</p>
113
+
114
+ <h2 id="contributing">Contributing</h2>
115
+
116
+ <ol>
117
+ <li>Fork it ( <a href="https://github.com/gobijan/mail-autoconfig-revived/fork">https://github.com/gobijan/mail-autoconfig-revived/fork</a> )</li>
118
+ <li>Create your feature branch (<code>git checkout -b my-new-feature</code>)</li>
119
+ <li>Run the test suite, check out haven&#39;t broken anything (<code>bundle exec rspec spec</code>)</li>
120
+ <li>Commit your changes (<code>git commit -am &#39;Add some feature&#39;</code>)</li>
121
+ <li>Push to the branch (<code>git push origin my-new-feature</code>)</li>
122
+ <li>Create new Pull Request</li>
123
+ </ol>
124
+ </div></div>
125
+
126
+ <div id="footer">
127
+ Generated on Wed Nov 15 16:38:27 2023 by
128
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
129
+ 0.9.34 (ruby-3.2.2).
130
+ </div>
131
+
132
+ </div>
133
+ </body>
134
+ </html>
data/doc/js/app.js ADDED
@@ -0,0 +1,314 @@
1
+ (function() {
2
+
3
+ var localStorage = {}, sessionStorage = {};
4
+ try { localStorage = window.localStorage; } catch (e) { }
5
+ try { sessionStorage = window.sessionStorage; } catch (e) { }
6
+
7
+ function createSourceLinks() {
8
+ $('.method_details_list .source_code').
9
+ before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
10
+ $('.toggleSource').toggle(function() {
11
+ $(this).parent().nextAll('.source_code').slideDown(100);
12
+ $(this).text("Hide source");
13
+ },
14
+ function() {
15
+ $(this).parent().nextAll('.source_code').slideUp(100);
16
+ $(this).text("View source");
17
+ });
18
+ }
19
+
20
+ function createDefineLinks() {
21
+ var tHeight = 0;
22
+ $('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
23
+ $('.toggleDefines').toggle(function() {
24
+ tHeight = $(this).parent().prev().height();
25
+ $(this).prev().css('display', 'inline');
26
+ $(this).parent().prev().height($(this).parent().height());
27
+ $(this).text("(less)");
28
+ },
29
+ function() {
30
+ $(this).prev().hide();
31
+ $(this).parent().prev().height(tHeight);
32
+ $(this).text("more...");
33
+ });
34
+ }
35
+
36
+ function createFullTreeLinks() {
37
+ var tHeight = 0;
38
+ $('.inheritanceTree').toggle(function() {
39
+ tHeight = $(this).parent().prev().height();
40
+ $(this).parent().toggleClass('showAll');
41
+ $(this).text("(hide)");
42
+ $(this).parent().prev().height($(this).parent().height());
43
+ },
44
+ function() {
45
+ $(this).parent().toggleClass('showAll');
46
+ $(this).parent().prev().height(tHeight);
47
+ $(this).text("show all");
48
+ });
49
+ }
50
+
51
+ function searchFrameButtons() {
52
+ $('.full_list_link').click(function() {
53
+ toggleSearchFrame(this, $(this).attr('href'));
54
+ return false;
55
+ });
56
+ window.addEventListener('message', function(e) {
57
+ if (e.data === 'navEscape') {
58
+ $('#nav').slideUp(100);
59
+ $('#search a').removeClass('active inactive');
60
+ $(window).focus();
61
+ }
62
+ });
63
+
64
+ $(window).resize(function() {
65
+ if ($('#search:visible').length === 0) {
66
+ $('#nav').removeAttr('style');
67
+ $('#search a').removeClass('active inactive');
68
+ $(window).focus();
69
+ }
70
+ });
71
+ }
72
+
73
+ function toggleSearchFrame(id, link) {
74
+ var frame = $('#nav');
75
+ $('#search a').removeClass('active').addClass('inactive');
76
+ if (frame.attr('src') === link && frame.css('display') !== "none") {
77
+ frame.slideUp(100);
78
+ $('#search a').removeClass('active inactive');
79
+ }
80
+ else {
81
+ $(id).addClass('active').removeClass('inactive');
82
+ if (frame.attr('src') !== link) frame.attr('src', link);
83
+ frame.slideDown(100);
84
+ }
85
+ }
86
+
87
+ function linkSummaries() {
88
+ $('.summary_signature').click(function() {
89
+ document.location = $(this).find('a').attr('href');
90
+ });
91
+ }
92
+
93
+ function summaryToggle() {
94
+ $('.summary_toggle').click(function(e) {
95
+ e.preventDefault();
96
+ localStorage.summaryCollapsed = $(this).text();
97
+ $('.summary_toggle').each(function() {
98
+ $(this).text($(this).text() == "collapse" ? "expand" : "collapse");
99
+ var next = $(this).parent().parent().nextAll('ul.summary').first();
100
+ if (next.hasClass('compact')) {
101
+ next.toggle();
102
+ next.nextAll('ul.summary').first().toggle();
103
+ }
104
+ else if (next.hasClass('summary')) {
105
+ var list = $('<ul class="summary compact" />');
106
+ list.html(next.html());
107
+ list.find('.summary_desc, .note').remove();
108
+ list.find('a').each(function() {
109
+ $(this).html($(this).find('strong').html());
110
+ $(this).parent().html($(this)[0].outerHTML);
111
+ });
112
+ next.before(list);
113
+ next.toggle();
114
+ }
115
+ });
116
+ return false;
117
+ });
118
+ if (localStorage.summaryCollapsed == "collapse") {
119
+ $('.summary_toggle').first().click();
120
+ } else { localStorage.summaryCollapsed = "expand"; }
121
+ }
122
+
123
+ function constantSummaryToggle() {
124
+ $('.constants_summary_toggle').click(function(e) {
125
+ e.preventDefault();
126
+ localStorage.summaryCollapsed = $(this).text();
127
+ $('.constants_summary_toggle').each(function() {
128
+ $(this).text($(this).text() == "collapse" ? "expand" : "collapse");
129
+ var next = $(this).parent().parent().nextAll('dl.constants').first();
130
+ if (next.hasClass('compact')) {
131
+ next.toggle();
132
+ next.nextAll('dl.constants').first().toggle();
133
+ }
134
+ else if (next.hasClass('constants')) {
135
+ var list = $('<dl class="constants compact" />');
136
+ list.html(next.html());
137
+ list.find('dt').each(function() {
138
+ $(this).addClass('summary_signature');
139
+ $(this).text( $(this).text().split('=')[0]);
140
+ if ($(this).has(".deprecated").length) {
141
+ $(this).addClass('deprecated');
142
+ };
143
+ });
144
+ // Add the value of the constant as "Tooltip" to the summary object
145
+ list.find('pre.code').each(function() {
146
+ console.log($(this).parent());
147
+ var dt_element = $(this).parent().prev();
148
+ var tooltip = $(this).text();
149
+ if (dt_element.hasClass("deprecated")) {
150
+ tooltip = 'Deprecated. ' + tooltip;
151
+ };
152
+ dt_element.attr('title', tooltip);
153
+ });
154
+ list.find('.docstring, .tags, dd').remove();
155
+ next.before(list);
156
+ next.toggle();
157
+ }
158
+ });
159
+ return false;
160
+ });
161
+ if (localStorage.summaryCollapsed == "collapse") {
162
+ $('.constants_summary_toggle').first().click();
163
+ } else { localStorage.summaryCollapsed = "expand"; }
164
+ }
165
+
166
+ function generateTOC() {
167
+ if ($('#filecontents').length === 0) return;
168
+ var _toc = $('<ol class="top"></ol>');
169
+ var show = false;
170
+ var toc = _toc;
171
+ var counter = 0;
172
+ var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
173
+ var i;
174
+ var curli;
175
+ if ($('#filecontents h1').length > 1) tags.unshift('h1');
176
+ for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
177
+ var lastTag = parseInt(tags[0][1], 10);
178
+ $(tags.join(', ')).each(function() {
179
+ if ($(this).parents('.method_details .docstring').length != 0) return;
180
+ if (this.id == "filecontents") return;
181
+ show = true;
182
+ var thisTag = parseInt(this.tagName[1], 10);
183
+ if (this.id.length === 0) {
184
+ var proposedId = $(this).attr('toc-id');
185
+ if (typeof(proposedId) != "undefined") this.id = proposedId;
186
+ else {
187
+ var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
188
+ if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
189
+ this.id = proposedId;
190
+ }
191
+ }
192
+ if (thisTag > lastTag) {
193
+ for (i = 0; i < thisTag - lastTag; i++) {
194
+ if ( typeof(curli) == "undefined" ) {
195
+ curli = $('<li/>');
196
+ toc.append(curli);
197
+ }
198
+ toc = $('<ol/>');
199
+ curli.append(toc);
200
+ curli = undefined;
201
+ }
202
+ }
203
+ if (thisTag < lastTag) {
204
+ for (i = 0; i < lastTag - thisTag; i++) {
205
+ toc = toc.parent();
206
+ toc = toc.parent();
207
+ }
208
+ }
209
+ var title = $(this).attr('toc-title');
210
+ if (typeof(title) == "undefined") title = $(this).text();
211
+ curli =$('<li><a href="#' + this.id + '">' + title + '</a></li>');
212
+ toc.append(curli);
213
+ lastTag = thisTag;
214
+ });
215
+ if (!show) return;
216
+ html = '<div id="toc"><p class="title hide_toc"><a href="#"><strong>Table of Contents</strong></a></p></div>';
217
+ $('#content').prepend(html);
218
+ $('#toc').append(_toc);
219
+ $('#toc .hide_toc').toggle(function() {
220
+ $('#toc .top').slideUp('fast');
221
+ $('#toc').toggleClass('hidden');
222
+ $('#toc .title small').toggle();
223
+ }, function() {
224
+ $('#toc .top').slideDown('fast');
225
+ $('#toc').toggleClass('hidden');
226
+ $('#toc .title small').toggle();
227
+ });
228
+ }
229
+
230
+ function navResizeFn(e) {
231
+ if (e.which !== 1) {
232
+ navResizeFnStop();
233
+ return;
234
+ }
235
+
236
+ sessionStorage.navWidth = e.pageX.toString();
237
+ $('.nav_wrap').css('width', e.pageX);
238
+ $('.nav_wrap').css('-ms-flex', 'inherit');
239
+ }
240
+
241
+ function navResizeFnStop() {
242
+ $(window).unbind('mousemove', navResizeFn);
243
+ window.removeEventListener('message', navMessageFn, false);
244
+ }
245
+
246
+ function navMessageFn(e) {
247
+ if (e.data.action === 'mousemove') navResizeFn(e.data.event);
248
+ if (e.data.action === 'mouseup') navResizeFnStop();
249
+ }
250
+
251
+ function navResizer() {
252
+ $('#resizer').mousedown(function(e) {
253
+ e.preventDefault();
254
+ $(window).mousemove(navResizeFn);
255
+ window.addEventListener('message', navMessageFn, false);
256
+ });
257
+ $(window).mouseup(navResizeFnStop);
258
+
259
+ if (sessionStorage.navWidth) {
260
+ navResizeFn({which: 1, pageX: parseInt(sessionStorage.navWidth, 10)});
261
+ }
262
+ }
263
+
264
+ function navExpander() {
265
+ var done = false, timer = setTimeout(postMessage, 500);
266
+ function postMessage() {
267
+ if (done) return;
268
+ clearTimeout(timer);
269
+ var opts = { action: 'expand', path: pathId };
270
+ document.getElementById('nav').contentWindow.postMessage(opts, '*');
271
+ done = true;
272
+ }
273
+
274
+ window.addEventListener('message', function(event) {
275
+ if (event.data === 'navReady') postMessage();
276
+ return false;
277
+ }, false);
278
+ }
279
+
280
+ function mainFocus() {
281
+ var hash = window.location.hash;
282
+ if (hash !== '' && $(hash)[0]) {
283
+ $(hash)[0].scrollIntoView();
284
+ }
285
+
286
+ setTimeout(function() { $('#main').focus(); }, 10);
287
+ }
288
+
289
+ function navigationChange() {
290
+ // This works around the broken anchor navigation with the YARD template.
291
+ window.onpopstate = function() {
292
+ var hash = window.location.hash;
293
+ if (hash !== '' && $(hash)[0]) {
294
+ $(hash)[0].scrollIntoView();
295
+ }
296
+ };
297
+ }
298
+
299
+ $(document).ready(function() {
300
+ navResizer();
301
+ navExpander();
302
+ createSourceLinks();
303
+ createDefineLinks();
304
+ createFullTreeLinks();
305
+ searchFrameButtons();
306
+ linkSummaries();
307
+ summaryToggle();
308
+ constantSummaryToggle();
309
+ generateTOC();
310
+ mainFocus();
311
+ navigationChange();
312
+ });
313
+
314
+ })();