Mercurial > hg > nginx-site
comparison xml/en/docs/mail/ngx_mail_auth_http_module.xml @ 1063:6a19aadc15b2
Updates and unification for mail_auth_http_module examples.
This includes:
- switch to documentation IP-addresses as per rfc5737
- language neutral comments
- addition of the "Client-Host" header field
author | Sergey Kandaurov <pluknet@nginx.com> |
---|---|
date | Sat, 08 Feb 2014 17:42:39 +0400 |
parents | b81ad8234f90 |
children | 3ee0ba5f4f08 |
comparison
equal
deleted
inserted
replaced
1062:4002f7a0bf35 | 1063:6a19aadc15b2 |
---|---|
76 <para> | 76 <para> |
77 Request: | 77 Request: |
78 <example> | 78 <example> |
79 GET /auth HTTP/1.0 | 79 GET /auth HTTP/1.0 |
80 Host: localhost | 80 Host: localhost |
81 Auth-Method: plain # plain or apop or cram-md5 | 81 Auth-Method: plain # plain/apop/cram-md5 |
82 Auth-User: user | 82 Auth-User: user |
83 Auth-Pass: password | 83 Auth-Pass: password |
84 Auth-Protocol: imap # imap, pop3 or smtp | 84 Auth-Protocol: imap # imap/pop3/smtp |
85 Auth-Login-Attempt: 1 # attempt count in a single session | 85 Auth-Login-Attempt: 1 |
86 Client-IP: 192.168.1.1 | 86 Client-IP: 192.0.2.42 |
87 Client-Host: client.example.org | |
87 </example> | 88 </example> |
88 Good response: | 89 Good response: |
89 <example> | 90 <example> |
90 HTTP/1.0 200 OK # this line is ignored | 91 HTTP/1.0 200 OK |
91 Auth-Status: OK | 92 Auth-Status: OK |
92 Auth-Server: 10.1.1.1 | 93 Auth-Server: 198.51.100.1 |
93 Auth-Port: 143 | 94 Auth-Port: 143 |
94 </example> | 95 </example> |
95 Bad response: | 96 Bad response: |
96 <example> | 97 <example> |
97 HTTP/1.0 200 OK # this line is ignored | 98 HTTP/1.0 200 OK |
98 Auth-Status: Invalid login or password | 99 Auth-Status: Invalid login or password |
99 Auth-Wait: 3 # wait for 3 seconds before returning an error to the client | 100 Auth-Wait: 3 |
100 </example> | 101 </example> |
101 </para> | 102 </para> |
102 | 103 |
103 <para> | 104 <para> |
104 If there is no <header>Auth-Wait</header> header, | 105 If there is no <header>Auth-Wait</header> header, |
120 Auth-Method: apop | 121 Auth-Method: apop |
121 Auth-User: user | 122 Auth-User: user |
122 Auth-Salt: <238188073.1163692009@mail.example.com> | 123 Auth-Salt: <238188073.1163692009@mail.example.com> |
123 Auth-Pass: auth_response | 124 Auth-Pass: auth_response |
124 Auth-Protocol: imap | 125 Auth-Protocol: imap |
125 Auth-Login-Attempt: 1 # attempt count in a single session | 126 Auth-Login-Attempt: 1 |
126 Client-IP: 192.168.1.1 | 127 Client-IP: 192.0.2.42 |
128 Client-Host: client.example.org | |
127 </example> | 129 </example> |
128 Good response: | 130 Good response: |
129 <example> | 131 <example> |
130 HTTP/1.0 200 OK # this line is ignored | 132 HTTP/1.0 200 OK |
131 Auth-Status: OK | 133 Auth-Status: OK |
132 Auth-Server: 10.1.1.1 | 134 Auth-Server: 198.51.100.1 |
133 Auth-Port: 143 | 135 Auth-Port: 143 |
134 Auth-Pass: plain-text-pass | 136 Auth-Pass: plain-text-pass |
135 </example> | 137 </example> |
136 </para> | 138 </para> |
137 | 139 |