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.
- checksums.yaml +7 -0
- data/.gitignore +4 -0
- data/.standard.yml +2 -0
- data/.yardopts +1 -0
- data/Gemfile +4 -0
- data/Gemfile.lock +80 -0
- data/LICENSE.txt +26 -0
- data/README.md +62 -0
- data/Rakefile +38 -0
- data/doc/MailAutoconfig/ClientConfig.html +1418 -0
- data/doc/MailAutoconfig/EmailAddress.html +651 -0
- data/doc/MailAutoconfig/IncomingServer.html +155 -0
- data/doc/MailAutoconfig/OutgoingServer.html +155 -0
- data/doc/MailAutoconfig/Server.html +972 -0
- data/doc/MailAutoconfig.html +428 -0
- data/doc/_index.html +182 -0
- data/doc/class_list.html +51 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +58 -0
- data/doc/css/style.css +497 -0
- data/doc/file.README.html +134 -0
- data/doc/file_list.html +56 -0
- data/doc/frames.html +17 -0
- data/doc/index.html +134 -0
- data/doc/js/app.js +314 -0
- data/doc/js/full_list.js +216 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +315 -0
- data/doc/top-level-namespace.html +110 -0
- data/ispdb_data/126.com.xml +21 -0
- data/ispdb_data/163.com.xml +21 -0
- data/ispdb_data/1und1.de.xml +75 -0
- data/ispdb_data/a1.net.xml +22 -0
- data/ispdb_data/active24.com.xml +36 -0
- data/ispdb_data/alice.it.xml +30 -0
- data/ispdb_data/aol.com.xml +76 -0
- data/ispdb_data/arcor.de.xml +68 -0
- data/ispdb_data/arubapec.it.xml +34 -0
- data/ispdb_data/att.net.xml +34 -0
- data/ispdb_data/bay.wind.ne.jp.xml +28 -0
- data/ispdb_data/bb-niigata.jp.xml +22 -0
- data/ispdb_data/bell.net.xml +30 -0
- data/ispdb_data/biglobe.ne.jp.xml +23 -0
- data/ispdb_data/bigpond.com.xml +35 -0
- data/ispdb_data/bluewin.ch.xml +34 -0
- data/ispdb_data/blueyonder.co.uk.xml +38 -0
- data/ispdb_data/bol.com.br.xml +40 -0
- data/ispdb_data/broba.cc.xml +25 -0
- data/ispdb_data/btinternet.com.xml +35 -0
- data/ispdb_data/cc9.ne.jp.xml +21 -0
- data/ispdb_data/cek.ne.jp.xml +21 -0
- data/ispdb_data/centurylink.net.xml +57 -0
- data/ispdb_data/centurytel.net.xml +55 -0
- data/ispdb_data/cgl.ucsf.edu.xml +22 -0
- data/ispdb_data/charter.net.xml +34 -0
- data/ispdb_data/clio.ne.jp.xml +22 -0
- data/ispdb_data/clustermail.de.xml +58 -0
- data/ispdb_data/co1.wind.ne.jp.xml +25 -0
- data/ispdb_data/co2.wind.ne.jp.xml +25 -0
- data/ispdb_data/co3.wind.ne.jp.xml +25 -0
- data/ispdb_data/comcast.net.xml +54 -0
- data/ispdb_data/cox.net.xml +36 -0
- data/ispdb_data/cty-net.ne.jp.xml +35 -0
- data/ispdb_data/dan.wind.ne.jp.xml +28 -0
- data/ispdb_data/dd.iij4u.or.jp.xml +33 -0
- data/ispdb_data/df.eu.xml +42 -0
- data/ispdb_data/dondominio.com.xml +32 -0
- data/ispdb_data/earthlink.net.xml +35 -0
- data/ispdb_data/educa.madrid.org.xml +48 -0
- data/ispdb_data/elpasotel.net.xml +53 -0
- data/ispdb_data/email.it.xml +33 -0
- data/ispdb_data/emailsrvr.com.xml +22 -0
- data/ispdb_data/fastwebnet.it.xml +23 -0
- data/ispdb_data/francetelecom.fr.xml +35 -0
- data/ispdb_data/free.fr.xml +48 -0
- data/ispdb_data/freenet.de.xml +37 -0
- data/ispdb_data/gandi.net.xml +58 -0
- data/ispdb_data/gigahost.dk.xml +32 -0
- data/ispdb_data/gmx.com.xml +72 -0
- data/ispdb_data/gmx.net.xml +66 -0
- data/ispdb_data/go.tvm.ne.jp.xml +22 -0
- data/ispdb_data/goneo.de.xml +56 -0
- data/ispdb_data/goo.jp.xml +22 -0
- data/ispdb_data/googlemail.com.xml +79 -0
- data/ispdb_data/gransy.com.xml +62 -0
- data/ispdb_data/hal.ne.jp.xml +22 -0
- data/ispdb_data/hana.or.jp.xml +22 -0
- data/ispdb_data/hotmail.com.xml +148 -0
- data/ispdb_data/i.softbank.jp.xml +22 -0
- data/ispdb_data/ic-net.or.jp.xml +22 -0
- data/ispdb_data/iijmio-mail.jp.xml +26 -0
- data/ispdb_data/iiyama-catv.ne.jp.xml +21 -0
- data/ispdb_data/inbox.lv.xml +57 -0
- data/ispdb_data/inet-shibata.or.jp.xml +22 -0
- data/ispdb_data/internode.on.net.xml +32 -0
- data/ispdb_data/ipax.at.xml +28 -0
- data/ispdb_data/iwafune.ne.jp.xml +22 -0
- data/ispdb_data/janis.or.jp.xml +23 -0
- data/ispdb_data/jet.ne.jp.xml +37 -0
- data/ispdb_data/ji.jet.ne.jp.xml +22 -0
- data/ispdb_data/kabelmail.de.xml +43 -0
- data/ispdb_data/kelcom.net.xml +21 -0
- data/ispdb_data/kl.wind.ne.jp.xml +32 -0
- data/ispdb_data/kokuyou.ne.jp.xml +21 -0
- data/ispdb_data/kpnmail.nl.xml +69 -0
- data/ispdb_data/laposte.net.xml +37 -0
- data/ispdb_data/libero.it.xml +34 -0
- data/ispdb_data/mahoroba.ne.jp.xml +22 -0
- data/ispdb_data/mail.com.xml +248 -0
- data/ispdb_data/mail.dk.xml +30 -0
- data/ispdb_data/mail.ee.xml +54 -0
- data/ispdb_data/mail.iwafune.ne.jp.xml +22 -0
- data/ispdb_data/mail.ru.xml +72 -0
- data/ispdb_data/mail.telenor.dk.xml +121 -0
- data/ispdb_data/mail.wind.ne.jp.xml +29 -0
- data/ispdb_data/me.com.xml +24 -0
- data/ispdb_data/messagingengine.com.xml +35 -0
- data/ispdb_data/ml.murakami.ne.jp.xml +22 -0
- data/ispdb_data/mnet.ne.jp.xml +48 -0
- data/ispdb_data/mopera.net.xml +50 -0
- data/ispdb_data/mx1.tiki.ne.jp.xml +54 -0
- data/ispdb_data/nifty.com.xml +22 -0
- data/ispdb_data/nsat.jp.xml +22 -0
- data/ispdb_data/ntlworld.com.xml +38 -0
- data/ispdb_data/o2.pl.xml +47 -0
- data/ispdb_data/ocn.ne.jp.xml +23 -0
- data/ispdb_data/office365.com.xml +55 -0
- data/ispdb_data/one.com.xml +22 -0
- data/ispdb_data/one.cz.xml +29 -0
- data/ispdb_data/onet.pl.xml +55 -0
- data/ispdb_data/outlook.com.xml +54 -0
- data/ispdb_data/ovh.net.xml +32 -0
- data/ispdb_data/pal.kijimadaira.jp.xml +21 -0
- data/ispdb_data/parabox.or.jp.xml +22 -0
- data/ispdb_data/pdx.edu.xml +41 -0
- data/ispdb_data/peoplepc.com.xml +29 -0
- data/ispdb_data/po.dcn.ne.jp.xml +21 -0
- data/ispdb_data/po.wind.ne.jp.xml +28 -0
- data/ispdb_data/pobox.com.xml +53 -0
- data/ispdb_data/pop.shibata.ne.jp.xml +23 -0
- data/ispdb_data/posteo.de.xml +25 -0
- data/ispdb_data/ptd.net.xml +53 -0
- data/ispdb_data/q.com.xml +53 -0
- data/ispdb_data/qq.com.xml +21 -0
- data/ispdb_data/rambler.ru.xml +35 -0
- data/ispdb_data/rr.com.xml +30 -0
- data/ispdb_data/runestone.net.xml +26 -0
- data/ispdb_data/sakunet.ne.jp.xml +21 -0
- data/ispdb_data/sapo.pt.xml +37 -0
- data/ispdb_data/schwaz.net.xml +49 -0
- data/ispdb_data/seznam.cz.xml +32 -0
- data/ispdb_data/sfr.fr.xml +33 -0
- data/ispdb_data/sky.com.xml +35 -0
- data/ispdb_data/skynet.be.xml +35 -0
- data/ispdb_data/so.wind.ne.jp.xml +25 -0
- data/ispdb_data/strato.de.xml +43 -0
- data/ispdb_data/studenti.univr.it.xml +37 -0
- data/ispdb_data/t-online.de.xml +56 -0
- data/ispdb_data/terra.es.xml +29 -0
- data/ispdb_data/thinline.cz.xml +60 -0
- data/ispdb_data/tiki.ne.jp.xml +24 -0
- data/ispdb_data/tiscali.cz.xml +25 -0
- data/ispdb_data/tiscali.it.xml +31 -0
- data/ispdb_data/umich.edu.xml +32 -0
- data/ispdb_data/uol.com.br.xml +42 -0
- data/ispdb_data/verizon.net.xml +21 -0
- data/ispdb_data/versatel.de.xml +43 -0
- data/ispdb_data/virgin.net.xml +38 -0
- data/ispdb_data/virginmedia.com.xml +35 -0
- data/ispdb_data/vm.aikis.or.jp.xml +22 -0
- data/ispdb_data/vp.tiki.ne.jp.xml +24 -0
- data/ispdb_data/web.de.xml +55 -0
- data/ispdb_data/webhuset.no.xml +42 -0
- data/ispdb_data/websupport.sk.xml +50 -0
- data/ispdb_data/wildwestdomains.com.xml +37 -0
- data/ispdb_data/wp.pl.xml +34 -0
- data/ispdb_data/xp.wind.jp.xml +24 -0
- data/ispdb_data/xtra.co.nz.xml +22 -0
- data/ispdb_data/yahoo.co.jp.xml +22 -0
- data/ispdb_data/yahoo.com.xml +84 -0
- data/ispdb_data/yandex.ru.xml +49 -0
- data/ispdb_data/ybb.ne.jp.xml +22 -0
- data/ispdb_data/yeah.net.xml +21 -0
- data/ispdb_data/zeelandnet.nl.xml +29 -0
- data/ispdb_data/ziggo.nl.xml +46 -0
- data/ispdb_data/zoho.com.xml +62 -0
- data/lib/mail_autoconfig/client_config.rb +113 -0
- data/lib/mail_autoconfig/email_address.rb +52 -0
- data/lib/mail_autoconfig/server.rb +72 -0
- data/lib/mail_autoconfig/version.rb +4 -0
- data/lib/mail_autoconfig.rb +33 -0
- data/mail_autoconfig_revived.gemspec +25 -0
- data/test/client_config_test.rb +45 -0
- data/test/email_address_test.rb +49 -0
- data/test/examples/client_config_yahoo.xml +40 -0
- data/test/server_test.rb +89 -0
- metadata +336 -0
|
@@ -0,0 +1,972 @@
|
|
|
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
|
+
Class: MailAutoconfig::Server
|
|
8
|
+
|
|
9
|
+
— 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 = "MailAutoconfig::Server";
|
|
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 (S)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../MailAutoconfig.html" title="MailAutoconfig (module)">MailAutoconfig</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">Server</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="../class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Class: MailAutoconfig::Server
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName">Object</span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next">MailAutoconfig::Server</li>
|
|
78
|
+
|
|
79
|
+
</ul>
|
|
80
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
81
|
+
|
|
82
|
+
</dd>
|
|
83
|
+
</dl>
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
<dl>
|
|
96
|
+
<dt>Defined in:</dt>
|
|
97
|
+
<dd>lib/mail_autoconfig/server.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
<p>Superclass for <span class='object_link'><a href="IncomingServer.html" title="MailAutoconfig::IncomingServer (class)">IncomingServer</a></span> and <span class='object_link'><a href="OutgoingServer.html" title="MailAutoconfig::OutgoingServer (class)">OutgoingServer</a></span>.
|
|
105
|
+
Never used directly.</p>
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
</div>
|
|
109
|
+
</div>
|
|
110
|
+
<div class="tags">
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
</div><div id="subclasses">
|
|
114
|
+
<h2>Direct Known Subclasses</h2>
|
|
115
|
+
<p class="children"><span class='object_link'><a href="IncomingServer.html" title="MailAutoconfig::IncomingServer (class)">IncomingServer</a></span>, <span class='object_link'><a href="OutgoingServer.html" title="MailAutoconfig::OutgoingServer (class)">OutgoingServer</a></span></p>
|
|
116
|
+
</div>
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
122
|
+
<ul class="summary">
|
|
123
|
+
|
|
124
|
+
<li class="public ">
|
|
125
|
+
<span class="summary_signature">
|
|
126
|
+
|
|
127
|
+
<a href="#client_config-instance_method" title="#client_config (instance method)">#<strong>client_config</strong> ⇒ Object </a>
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
</span>
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
<span class="note title readonly">readonly</span>
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute client_config.</p>
|
|
147
|
+
</div></span>
|
|
148
|
+
|
|
149
|
+
</li>
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
<li class="public ">
|
|
153
|
+
<span class="summary_signature">
|
|
154
|
+
|
|
155
|
+
<a href="#config-instance_method" title="#config (instance method)">#<strong>config</strong> ⇒ Object </a>
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
</span>
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
<span class="note title readonly">readonly</span>
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute config.</p>
|
|
175
|
+
</div></span>
|
|
176
|
+
|
|
177
|
+
</li>
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
</ul>
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
<h2>
|
|
187
|
+
Instance Method Summary
|
|
188
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
189
|
+
</h2>
|
|
190
|
+
|
|
191
|
+
<ul class="summary">
|
|
192
|
+
|
|
193
|
+
<li class="public ">
|
|
194
|
+
<span class="summary_signature">
|
|
195
|
+
|
|
196
|
+
<a href="#authentication-instance_method" title="#authentication (instance method)">#<strong>authentication</strong> ⇒ String </a>
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
</span>
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
<span class="summary_desc"><div class='inline'><p>The authentication type for this server.</p>
|
|
211
|
+
</div></span>
|
|
212
|
+
|
|
213
|
+
</li>
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
<li class="public ">
|
|
217
|
+
<span class="summary_signature">
|
|
218
|
+
|
|
219
|
+
<a href="#hostname-instance_method" title="#hostname (instance method)">#<strong>hostname</strong> ⇒ String </a>
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
</span>
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
<span class="summary_desc"><div class='inline'><p>The hostname for this server.</p>
|
|
234
|
+
</div></span>
|
|
235
|
+
|
|
236
|
+
</li>
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
<li class="public ">
|
|
240
|
+
<span class="summary_signature">
|
|
241
|
+
|
|
242
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(config, client_config) ⇒ Server </a>
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
</span>
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
<span class="note title constructor">constructor</span>
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
<span class="summary_desc"><div class='inline'><p>A new instance of Server.</p>
|
|
259
|
+
</div></span>
|
|
260
|
+
|
|
261
|
+
</li>
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
<li class="public ">
|
|
265
|
+
<span class="summary_signature">
|
|
266
|
+
|
|
267
|
+
<a href="#port-instance_method" title="#port (instance method)">#<strong>port</strong> ⇒ Integer </a>
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
</span>
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
<span class="summary_desc"><div class='inline'><p>The port to connect ot this server on.</p>
|
|
282
|
+
</div></span>
|
|
283
|
+
|
|
284
|
+
</li>
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
<li class="public ">
|
|
288
|
+
<span class="summary_signature">
|
|
289
|
+
|
|
290
|
+
<a href="#protocol-instance_method" title="#protocol (instance method)">#<strong>protocol</strong> ⇒ String </a>
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
</span>
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
<span class="summary_desc"><div class='inline'><p>Returns the protocol of the mail server e.g.</p>
|
|
305
|
+
</div></span>
|
|
306
|
+
|
|
307
|
+
</li>
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
<li class="public ">
|
|
311
|
+
<span class="summary_signature">
|
|
312
|
+
|
|
313
|
+
<a href="#socket_type-instance_method" title="#socket_type (instance method)">#<strong>socket_type</strong> ⇒ String </a>
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
</span>
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
<span class="summary_desc"><div class='inline'><p>The connection type for this server.</p>
|
|
328
|
+
</div></span>
|
|
329
|
+
|
|
330
|
+
</li>
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
<li class="public ">
|
|
334
|
+
<span class="summary_signature">
|
|
335
|
+
|
|
336
|
+
<a href="#username-instance_method" title="#username (instance method)">#<strong>username</strong> ⇒ String </a>
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
</span>
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
<span class="summary_desc"><div class='inline'><p>The username for this mailbox, combines <span class='object_link'><a href="#username_format-instance_method" title="MailAutoconfig::Server#username_format (method)">#username_format</a></span> and [EmailAddress] details.</p>
|
|
351
|
+
</div></span>
|
|
352
|
+
|
|
353
|
+
</li>
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
<li class="public ">
|
|
357
|
+
<span class="summary_signature">
|
|
358
|
+
|
|
359
|
+
<a href="#username_format-instance_method" title="#username_format (instance method)">#<strong>username_format</strong> ⇒ String </a>
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
</span>
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
<span class="summary_desc"><div class='inline'><p>Return the username format for this server.</p>
|
|
374
|
+
</div></span>
|
|
375
|
+
|
|
376
|
+
</li>
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
</ul>
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
<div id="constructor_details" class="method_details_list">
|
|
383
|
+
<h2>Constructor Details</h2>
|
|
384
|
+
|
|
385
|
+
<div class="method_details first">
|
|
386
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
387
|
+
|
|
388
|
+
#<strong>initialize</strong>(config, client_config) ⇒ <tt><span class='object_link'><a href="" title="MailAutoconfig::Server (class)">Server</a></span></tt>
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
</h3><div class="docstring">
|
|
395
|
+
<div class="discussion">
|
|
396
|
+
<p>Returns a new instance of Server.</p>
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
</div>
|
|
400
|
+
</div>
|
|
401
|
+
<div class="tags">
|
|
402
|
+
<p class="tag_title">Parameters:</p>
|
|
403
|
+
<ul class="param">
|
|
404
|
+
|
|
405
|
+
<li>
|
|
406
|
+
|
|
407
|
+
<span class='name'>config</span>
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
<span class='type'>(<tt>Nokogiri::XML::Node</tt>)</span>
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
—
|
|
415
|
+
<div class='inline'><p>an XML representation of this server</p>
|
|
416
|
+
</div>
|
|
417
|
+
|
|
418
|
+
</li>
|
|
419
|
+
|
|
420
|
+
</ul>
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
</div><table class="source_code">
|
|
424
|
+
<tr>
|
|
425
|
+
<td>
|
|
426
|
+
<pre class="lines">
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
9
|
|
430
|
+
10
|
|
431
|
+
11
|
|
432
|
+
12</pre>
|
|
433
|
+
</td>
|
|
434
|
+
<td>
|
|
435
|
+
<pre class="code"><span class="info file"># File 'lib/mail_autoconfig/server.rb', line 9</span>
|
|
436
|
+
|
|
437
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_config'>config</span><span class='comma'>,</span> <span class='id identifier rubyid_client_config'>client_config</span><span class='rparen'>)</span>
|
|
438
|
+
<span class='ivar'>@config</span> <span class='op'>=</span> <span class='id identifier rubyid_config'>config</span>
|
|
439
|
+
<span class='ivar'>@client_config</span> <span class='op'>=</span> <span class='id identifier rubyid_client_config'>client_config</span>
|
|
440
|
+
<span class='kw'>end</span></pre>
|
|
441
|
+
</td>
|
|
442
|
+
</tr>
|
|
443
|
+
</table>
|
|
444
|
+
</div>
|
|
445
|
+
|
|
446
|
+
</div>
|
|
447
|
+
|
|
448
|
+
<div id="instance_attr_details" class="attr_details">
|
|
449
|
+
<h2>Instance Attribute Details</h2>
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
<span id=""></span>
|
|
453
|
+
<div class="method_details first">
|
|
454
|
+
<h3 class="signature first" id="client_config-instance_method">
|
|
455
|
+
|
|
456
|
+
#<strong>client_config</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
</h3><div class="docstring">
|
|
463
|
+
<div class="discussion">
|
|
464
|
+
<p>Returns the value of attribute client_config.</p>
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
</div>
|
|
468
|
+
</div>
|
|
469
|
+
<div class="tags">
|
|
470
|
+
|
|
471
|
+
|
|
472
|
+
</div><table class="source_code">
|
|
473
|
+
<tr>
|
|
474
|
+
<td>
|
|
475
|
+
<pre class="lines">
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
6
|
|
479
|
+
7
|
|
480
|
+
8</pre>
|
|
481
|
+
</td>
|
|
482
|
+
<td>
|
|
483
|
+
<pre class="code"><span class="info file"># File 'lib/mail_autoconfig/server.rb', line 6</span>
|
|
484
|
+
|
|
485
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_client_config'>client_config</span>
|
|
486
|
+
<span class='ivar'>@client_config</span>
|
|
487
|
+
<span class='kw'>end</span></pre>
|
|
488
|
+
</td>
|
|
489
|
+
</tr>
|
|
490
|
+
</table>
|
|
491
|
+
</div>
|
|
492
|
+
|
|
493
|
+
|
|
494
|
+
<span id=""></span>
|
|
495
|
+
<div class="method_details ">
|
|
496
|
+
<h3 class="signature " id="config-instance_method">
|
|
497
|
+
|
|
498
|
+
#<strong>config</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
499
|
+
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
|
|
504
|
+
</h3><div class="docstring">
|
|
505
|
+
<div class="discussion">
|
|
506
|
+
<p>Returns the value of attribute config.</p>
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
</div>
|
|
510
|
+
</div>
|
|
511
|
+
<div class="tags">
|
|
512
|
+
|
|
513
|
+
|
|
514
|
+
</div><table class="source_code">
|
|
515
|
+
<tr>
|
|
516
|
+
<td>
|
|
517
|
+
<pre class="lines">
|
|
518
|
+
|
|
519
|
+
|
|
520
|
+
5
|
|
521
|
+
6
|
|
522
|
+
7</pre>
|
|
523
|
+
</td>
|
|
524
|
+
<td>
|
|
525
|
+
<pre class="code"><span class="info file"># File 'lib/mail_autoconfig/server.rb', line 5</span>
|
|
526
|
+
|
|
527
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_config'>config</span>
|
|
528
|
+
<span class='ivar'>@config</span>
|
|
529
|
+
<span class='kw'>end</span></pre>
|
|
530
|
+
</td>
|
|
531
|
+
</tr>
|
|
532
|
+
</table>
|
|
533
|
+
</div>
|
|
534
|
+
|
|
535
|
+
</div>
|
|
536
|
+
|
|
537
|
+
|
|
538
|
+
<div id="instance_method_details" class="method_details_list">
|
|
539
|
+
<h2>Instance Method Details</h2>
|
|
540
|
+
|
|
541
|
+
|
|
542
|
+
<div class="method_details first">
|
|
543
|
+
<h3 class="signature first" id="authentication-instance_method">
|
|
544
|
+
|
|
545
|
+
#<strong>authentication</strong> ⇒ <tt>String</tt>
|
|
546
|
+
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
|
|
550
|
+
|
|
551
|
+
</h3><div class="docstring">
|
|
552
|
+
<div class="discussion">
|
|
553
|
+
<p>The authentication type for this server. Valid responses:
|
|
554
|
+
<code>password-cleartext</code>, <code>NTLM</code>, <code>GSSAPI</code>, <code>client-IP-address</code>, <code>TLS-client-cert</code>, <code>none</code></p>
|
|
555
|
+
|
|
556
|
+
|
|
557
|
+
</div>
|
|
558
|
+
</div>
|
|
559
|
+
<div class="tags">
|
|
560
|
+
|
|
561
|
+
<p class="tag_title">Returns:</p>
|
|
562
|
+
<ul class="return">
|
|
563
|
+
|
|
564
|
+
<li>
|
|
565
|
+
|
|
566
|
+
|
|
567
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
568
|
+
|
|
569
|
+
|
|
570
|
+
|
|
571
|
+
—
|
|
572
|
+
<div class='inline'><p>the authentication method for this server</p>
|
|
573
|
+
</div>
|
|
574
|
+
|
|
575
|
+
</li>
|
|
576
|
+
|
|
577
|
+
</ul>
|
|
578
|
+
|
|
579
|
+
</div><table class="source_code">
|
|
580
|
+
<tr>
|
|
581
|
+
<td>
|
|
582
|
+
<pre class="lines">
|
|
583
|
+
|
|
584
|
+
|
|
585
|
+
62
|
|
586
|
+
63
|
|
587
|
+
64</pre>
|
|
588
|
+
</td>
|
|
589
|
+
<td>
|
|
590
|
+
<pre class="code"><span class="info file"># File 'lib/mail_autoconfig/server.rb', line 62</span>
|
|
591
|
+
|
|
592
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_authentication'>authentication</span>
|
|
593
|
+
<span class='ivar'>@authentication</span> <span class='op'>||=</span> <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_xpath'>xpath</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>authentication</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_content'>content</span>
|
|
594
|
+
<span class='kw'>end</span></pre>
|
|
595
|
+
</td>
|
|
596
|
+
</tr>
|
|
597
|
+
</table>
|
|
598
|
+
</div>
|
|
599
|
+
|
|
600
|
+
<div class="method_details ">
|
|
601
|
+
<h3 class="signature " id="hostname-instance_method">
|
|
602
|
+
|
|
603
|
+
#<strong>hostname</strong> ⇒ <tt>String</tt>
|
|
604
|
+
|
|
605
|
+
|
|
606
|
+
|
|
607
|
+
|
|
608
|
+
|
|
609
|
+
</h3><div class="docstring">
|
|
610
|
+
<div class="discussion">
|
|
611
|
+
<p>Returns The hostname for this server.</p>
|
|
612
|
+
|
|
613
|
+
|
|
614
|
+
</div>
|
|
615
|
+
</div>
|
|
616
|
+
<div class="tags">
|
|
617
|
+
|
|
618
|
+
<p class="tag_title">Returns:</p>
|
|
619
|
+
<ul class="return">
|
|
620
|
+
|
|
621
|
+
<li>
|
|
622
|
+
|
|
623
|
+
|
|
624
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
625
|
+
|
|
626
|
+
|
|
627
|
+
|
|
628
|
+
—
|
|
629
|
+
<div class='inline'><p>The hostname for this server</p>
|
|
630
|
+
</div>
|
|
631
|
+
|
|
632
|
+
</li>
|
|
633
|
+
|
|
634
|
+
</ul>
|
|
635
|
+
|
|
636
|
+
</div><table class="source_code">
|
|
637
|
+
<tr>
|
|
638
|
+
<td>
|
|
639
|
+
<pre class="lines">
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
21
|
|
643
|
+
22
|
|
644
|
+
23</pre>
|
|
645
|
+
</td>
|
|
646
|
+
<td>
|
|
647
|
+
<pre class="code"><span class="info file"># File 'lib/mail_autoconfig/server.rb', line 21</span>
|
|
648
|
+
|
|
649
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_hostname'>hostname</span>
|
|
650
|
+
<span class='ivar'>@hostname</span> <span class='op'>||=</span> <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_xpath'>xpath</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>hostname</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_content'>content</span>
|
|
651
|
+
<span class='kw'>end</span></pre>
|
|
652
|
+
</td>
|
|
653
|
+
</tr>
|
|
654
|
+
</table>
|
|
655
|
+
</div>
|
|
656
|
+
|
|
657
|
+
<div class="method_details ">
|
|
658
|
+
<h3 class="signature " id="port-instance_method">
|
|
659
|
+
|
|
660
|
+
#<strong>port</strong> ⇒ <tt>Integer</tt>
|
|
661
|
+
|
|
662
|
+
|
|
663
|
+
|
|
664
|
+
|
|
665
|
+
|
|
666
|
+
</h3><div class="docstring">
|
|
667
|
+
<div class="discussion">
|
|
668
|
+
<p>Returns The port to connect ot this server on.</p>
|
|
669
|
+
|
|
670
|
+
|
|
671
|
+
</div>
|
|
672
|
+
</div>
|
|
673
|
+
<div class="tags">
|
|
674
|
+
|
|
675
|
+
<p class="tag_title">Returns:</p>
|
|
676
|
+
<ul class="return">
|
|
677
|
+
|
|
678
|
+
<li>
|
|
679
|
+
|
|
680
|
+
|
|
681
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
682
|
+
|
|
683
|
+
|
|
684
|
+
|
|
685
|
+
—
|
|
686
|
+
<div class='inline'><p>The port to connect ot this server on</p>
|
|
687
|
+
</div>
|
|
688
|
+
|
|
689
|
+
</li>
|
|
690
|
+
|
|
691
|
+
</ul>
|
|
692
|
+
|
|
693
|
+
</div><table class="source_code">
|
|
694
|
+
<tr>
|
|
695
|
+
<td>
|
|
696
|
+
<pre class="lines">
|
|
697
|
+
|
|
698
|
+
|
|
699
|
+
26
|
|
700
|
+
27
|
|
701
|
+
28</pre>
|
|
702
|
+
</td>
|
|
703
|
+
<td>
|
|
704
|
+
<pre class="code"><span class="info file"># File 'lib/mail_autoconfig/server.rb', line 26</span>
|
|
705
|
+
|
|
706
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_port'>port</span>
|
|
707
|
+
<span class='ivar'>@port</span> <span class='op'>||=</span> <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_xpath'>xpath</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>port</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_content'>content</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
|
|
708
|
+
<span class='kw'>end</span></pre>
|
|
709
|
+
</td>
|
|
710
|
+
</tr>
|
|
711
|
+
</table>
|
|
712
|
+
</div>
|
|
713
|
+
|
|
714
|
+
<div class="method_details ">
|
|
715
|
+
<h3 class="signature " id="protocol-instance_method">
|
|
716
|
+
|
|
717
|
+
#<strong>protocol</strong> ⇒ <tt>String</tt>
|
|
718
|
+
|
|
719
|
+
|
|
720
|
+
|
|
721
|
+
|
|
722
|
+
|
|
723
|
+
</h3><div class="docstring">
|
|
724
|
+
<div class="discussion">
|
|
725
|
+
<p>Returns the protocol of the mail server e.g. <code>smtp</code>, <code>pop3</code>, <code>imap</code></p>
|
|
726
|
+
|
|
727
|
+
|
|
728
|
+
</div>
|
|
729
|
+
</div>
|
|
730
|
+
<div class="tags">
|
|
731
|
+
|
|
732
|
+
<p class="tag_title">Returns:</p>
|
|
733
|
+
<ul class="return">
|
|
734
|
+
|
|
735
|
+
<li>
|
|
736
|
+
|
|
737
|
+
|
|
738
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
739
|
+
|
|
740
|
+
|
|
741
|
+
|
|
742
|
+
—
|
|
743
|
+
<div class='inline'><p>The protocol for the server</p>
|
|
744
|
+
</div>
|
|
745
|
+
|
|
746
|
+
</li>
|
|
747
|
+
|
|
748
|
+
</ul>
|
|
749
|
+
|
|
750
|
+
</div><table class="source_code">
|
|
751
|
+
<tr>
|
|
752
|
+
<td>
|
|
753
|
+
<pre class="lines">
|
|
754
|
+
|
|
755
|
+
|
|
756
|
+
16
|
|
757
|
+
17
|
|
758
|
+
18</pre>
|
|
759
|
+
</td>
|
|
760
|
+
<td>
|
|
761
|
+
<pre class="code"><span class="info file"># File 'lib/mail_autoconfig/server.rb', line 16</span>
|
|
762
|
+
|
|
763
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_protocol'>protocol</span>
|
|
764
|
+
<span class='ivar'>@protocol</span> <span class='op'>||=</span> <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_attr'>attr</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>type</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
765
|
+
<span class='kw'>end</span></pre>
|
|
766
|
+
</td>
|
|
767
|
+
</tr>
|
|
768
|
+
</table>
|
|
769
|
+
</div>
|
|
770
|
+
|
|
771
|
+
<div class="method_details ">
|
|
772
|
+
<h3 class="signature " id="socket_type-instance_method">
|
|
773
|
+
|
|
774
|
+
#<strong>socket_type</strong> ⇒ <tt>String</tt>
|
|
775
|
+
|
|
776
|
+
|
|
777
|
+
|
|
778
|
+
|
|
779
|
+
|
|
780
|
+
</h3><div class="docstring">
|
|
781
|
+
<div class="discussion">
|
|
782
|
+
<p>The connection type for this server. <code>plain</code>, <code>STARTTLS</code>, <code>SSL</code> are acceptable</p>
|
|
783
|
+
|
|
784
|
+
|
|
785
|
+
</div>
|
|
786
|
+
</div>
|
|
787
|
+
<div class="tags">
|
|
788
|
+
|
|
789
|
+
<p class="tag_title">Returns:</p>
|
|
790
|
+
<ul class="return">
|
|
791
|
+
|
|
792
|
+
<li>
|
|
793
|
+
|
|
794
|
+
|
|
795
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
796
|
+
|
|
797
|
+
|
|
798
|
+
|
|
799
|
+
—
|
|
800
|
+
<div class='inline'><p>The connection type</p>
|
|
801
|
+
</div>
|
|
802
|
+
|
|
803
|
+
</li>
|
|
804
|
+
|
|
805
|
+
</ul>
|
|
806
|
+
|
|
807
|
+
</div><table class="source_code">
|
|
808
|
+
<tr>
|
|
809
|
+
<td>
|
|
810
|
+
<pre class="lines">
|
|
811
|
+
|
|
812
|
+
|
|
813
|
+
32
|
|
814
|
+
33
|
|
815
|
+
34</pre>
|
|
816
|
+
</td>
|
|
817
|
+
<td>
|
|
818
|
+
<pre class="code"><span class="info file"># File 'lib/mail_autoconfig/server.rb', line 32</span>
|
|
819
|
+
|
|
820
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_socket_type'>socket_type</span>
|
|
821
|
+
<span class='ivar'>@socket_type</span> <span class='op'>||=</span> <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_xpath'>xpath</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>socketType</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_content'>content</span>
|
|
822
|
+
<span class='kw'>end</span></pre>
|
|
823
|
+
</td>
|
|
824
|
+
</tr>
|
|
825
|
+
</table>
|
|
826
|
+
</div>
|
|
827
|
+
|
|
828
|
+
<div class="method_details ">
|
|
829
|
+
<h3 class="signature " id="username-instance_method">
|
|
830
|
+
|
|
831
|
+
#<strong>username</strong> ⇒ <tt>String</tt>
|
|
832
|
+
|
|
833
|
+
|
|
834
|
+
|
|
835
|
+
|
|
836
|
+
|
|
837
|
+
</h3><div class="docstring">
|
|
838
|
+
<div class="discussion">
|
|
839
|
+
<p>The username for this mailbox, combines <span class='object_link'><a href="#username_format-instance_method" title="MailAutoconfig::Server#username_format (method)">#username_format</a></span> and [EmailAddress] details</p>
|
|
840
|
+
|
|
841
|
+
|
|
842
|
+
</div>
|
|
843
|
+
</div>
|
|
844
|
+
<div class="tags">
|
|
845
|
+
|
|
846
|
+
<p class="tag_title">Returns:</p>
|
|
847
|
+
<ul class="return">
|
|
848
|
+
|
|
849
|
+
<li>
|
|
850
|
+
|
|
851
|
+
|
|
852
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
853
|
+
|
|
854
|
+
|
|
855
|
+
|
|
856
|
+
—
|
|
857
|
+
<div class='inline'><p>The username</p>
|
|
858
|
+
</div>
|
|
859
|
+
|
|
860
|
+
</li>
|
|
861
|
+
|
|
862
|
+
</ul>
|
|
863
|
+
|
|
864
|
+
</div><table class="source_code">
|
|
865
|
+
<tr>
|
|
866
|
+
<td>
|
|
867
|
+
<pre class="lines">
|
|
868
|
+
|
|
869
|
+
|
|
870
|
+
38
|
|
871
|
+
39
|
|
872
|
+
40
|
|
873
|
+
41
|
|
874
|
+
42
|
|
875
|
+
43
|
|
876
|
+
44
|
|
877
|
+
45
|
|
878
|
+
46</pre>
|
|
879
|
+
</td>
|
|
880
|
+
<td>
|
|
881
|
+
<pre class="code"><span class="info file"># File 'lib/mail_autoconfig/server.rb', line 38</span>
|
|
882
|
+
|
|
883
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_username'>username</span>
|
|
884
|
+
<span class='ivar'>@username</span> <span class='op'>||=</span> <span class='kw'>begin</span>
|
|
885
|
+
<span class='id identifier rubyid_name'>name</span> <span class='op'>=</span> <span class='id identifier rubyid_username_format'>username_format</span>
|
|
886
|
+
<span class='id identifier rubyid_name'>name</span><span class='period'>.</span><span class='id identifier rubyid_gsub!'>gsub!</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>%EMAILADDRESS%</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_client_config'>client_config</span><span class='period'>.</span><span class='id identifier rubyid_email_address'>email_address</span><span class='period'>.</span><span class='id identifier rubyid_address'>address</span>
|
|
887
|
+
<span class='id identifier rubyid_name'>name</span><span class='period'>.</span><span class='id identifier rubyid_gsub!'>gsub!</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>%EMAILLOCALPART%</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_client_config'>client_config</span><span class='period'>.</span><span class='id identifier rubyid_email_address'>email_address</span><span class='period'>.</span><span class='id identifier rubyid_local_part'>local_part</span>
|
|
888
|
+
<span class='id identifier rubyid_name'>name</span><span class='period'>.</span><span class='id identifier rubyid_gsub!'>gsub!</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>%EMAILDOMAIN%</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_client_config'>client_config</span><span class='period'>.</span><span class='id identifier rubyid_email_address'>email_address</span><span class='period'>.</span><span class='id identifier rubyid_domain'>domain</span>
|
|
889
|
+
<span class='id identifier rubyid_name'>name</span>
|
|
890
|
+
<span class='kw'>end</span>
|
|
891
|
+
<span class='kw'>end</span></pre>
|
|
892
|
+
</td>
|
|
893
|
+
</tr>
|
|
894
|
+
</table>
|
|
895
|
+
</div>
|
|
896
|
+
|
|
897
|
+
<div class="method_details ">
|
|
898
|
+
<h3 class="signature " id="username_format-instance_method">
|
|
899
|
+
|
|
900
|
+
#<strong>username_format</strong> ⇒ <tt>String</tt>
|
|
901
|
+
|
|
902
|
+
|
|
903
|
+
|
|
904
|
+
|
|
905
|
+
|
|
906
|
+
</h3><div class="docstring">
|
|
907
|
+
<div class="discussion">
|
|
908
|
+
<p>Return the username format for this server. There are substitutions that can be made.</p>
|
|
909
|
+
|
|
910
|
+
<ul>
|
|
911
|
+
<li><code>%EMAILADDRESS%</code> - full email address of the user, usually entered by the user</li>
|
|
912
|
+
<li><code>%EMAILLOCALPART%</code> - email address, part before @</li>
|
|
913
|
+
<li><code>%EMAILDOMAIN%</code> - email address, part after @</li>
|
|
914
|
+
</ul>
|
|
915
|
+
|
|
916
|
+
|
|
917
|
+
</div>
|
|
918
|
+
</div>
|
|
919
|
+
<div class="tags">
|
|
920
|
+
|
|
921
|
+
<p class="tag_title">Returns:</p>
|
|
922
|
+
<ul class="return">
|
|
923
|
+
|
|
924
|
+
<li>
|
|
925
|
+
|
|
926
|
+
|
|
927
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
928
|
+
|
|
929
|
+
|
|
930
|
+
|
|
931
|
+
—
|
|
932
|
+
<div class='inline'><p>the username format</p>
|
|
933
|
+
</div>
|
|
934
|
+
|
|
935
|
+
</li>
|
|
936
|
+
|
|
937
|
+
</ul>
|
|
938
|
+
|
|
939
|
+
</div><table class="source_code">
|
|
940
|
+
<tr>
|
|
941
|
+
<td>
|
|
942
|
+
<pre class="lines">
|
|
943
|
+
|
|
944
|
+
|
|
945
|
+
55
|
|
946
|
+
56
|
|
947
|
+
57</pre>
|
|
948
|
+
</td>
|
|
949
|
+
<td>
|
|
950
|
+
<pre class="code"><span class="info file"># File 'lib/mail_autoconfig/server.rb', line 55</span>
|
|
951
|
+
|
|
952
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_username_format'>username_format</span>
|
|
953
|
+
<span class='ivar'>@username_format</span> <span class='op'>||=</span> <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_xpath'>xpath</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>username</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_content'>content</span>
|
|
954
|
+
<span class='kw'>end</span></pre>
|
|
955
|
+
</td>
|
|
956
|
+
</tr>
|
|
957
|
+
</table>
|
|
958
|
+
</div>
|
|
959
|
+
|
|
960
|
+
</div>
|
|
961
|
+
|
|
962
|
+
</div>
|
|
963
|
+
|
|
964
|
+
<div id="footer">
|
|
965
|
+
Generated on Wed Nov 15 16:38:27 2023 by
|
|
966
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
967
|
+
0.9.34 (ruby-3.2.2).
|
|
968
|
+
</div>
|
|
969
|
+
|
|
970
|
+
</div>
|
|
971
|
+
</body>
|
|
972
|
+
</html>
|