comparison xml/en/docs/mail/ngx_mail_core_module.xml @ 1068:0c5f8630fe40

Documented the mail "resolver" directive.
author Sergey Kandaurov <pluknet@nginx.com>
date Sat, 08 Feb 2014 17:42:41 +0400
parents b81ad8234f90
children 71e6daffa4dc
comparison
equal deleted inserted replaced
1067:8d9578f8523b 1068:0c5f8630fe40
181 </para> 181 </para>
182 182
183 </directive> 183 </directive>
184 184
185 185
186 <directive name="resolver">
187 <syntax>
188 <value>address</value> ...
189 [<literal>valid</literal>=<value>time</value>]</syntax>
190 <syntax><literal>off</literal></syntax>
191 <default>off</default>
192 <context>mail</context>
193 <context>server</context>
194
195 <para>
196 Configures name servers used to find the client’s hostname
197 to pass it to the
198 <link doc="ngx_mail_auth_http_module.xml">authentication server</link>,
199 and in the
200 <link doc="ngx_mail_proxy_module.xml" id="xclient">XCLIENT</link>
201 command when proxying SMTP.
202 For example:
203 <example>
204 resolver 127.0.0.1 [::1]:5353;
205 </example>
206 An address can be specified as a domain name or IP address,
207 and an optional port (1.3.1, 1.2.2).
208 If port is not specified, the port 53 is used.
209 Name servers are queried in a round-robin fashion.
210 <note>
211 Before version 1.1.7, only a single name server could be configured.
212 Specifying name servers using IPv6 addresses is supported
213 starting from versions 1.3.1 and 1.2.2.
214 </note>
215 By default, nginx caches answers using the TTL value of a response.
216 An optional <literal>valid</literal> parameter allows overriding it:
217 <example>
218 resolver 127.0.0.1 [::1]:5353 valid=30s;
219 </example>
220 <note>
221 Before version 1.1.9, tuning of caching time was not possible,
222 and nginx always cached answers for the duration of 5 minutes.
223 </note>
224 </para>
225
226 <para>
227 The special value <literal>off</literal> disables resolving.
228 </para>
229
230 </directive>
231
232
233 <directive name="resolver_timeout">
234 <syntax><value>time</value></syntax>
235 <default>30s</default>
236 <context>mail</context>
237 <context>server</context>
238
239 <para>
240 Sets a timeout for DNS operations, for example:
241 <example>
242 resolver_timeout 5s;
243 </example>
244 </para>
245
246 </directive>
247
248
186 <directive name="server"> 249 <directive name="server">
187 <syntax block="yes"/> 250 <syntax block="yes"/>
188 <default/> 251 <default/>
189 <context>mail</context> 252 <context>mail</context>
190 253