Nginx官方文档(四十四)【ngx_mail_imap_module|ngx_mail_pop3_module|ngx_mail_smtp_module】

曾经终败给现在 2021-07-05 01:44 240阅读 0赞

# ngx\_mail\_imap\_module #

*  示例配置
 *  指令
    
     *  imap\_auth
     *  imap\_capabilities
     *  imap\_client\_buffer

## 指令 ##

### imap\_auth ###

<table> 
 <thead> 
  <tr> 
   <th align="right">-</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="right"><strong>语法</strong></td> 
   <td><strong>imap_auth</strong> <code>method ...</code>;</td> 
  </tr> 
  <tr> 
   <td align="right"><strong>默认</strong></td> 
   <td>imap_auth plain;</td> 
  </tr> 
  <tr> 
   <td align="right"><strong>上下文</strong></td> 
   <td>mail、server</td> 
  </tr> 
 </tbody> 
</table>

为 IMAP 客户端设置允许的认证方法。支持的方法有：

*  `login`
    
    [AUTH=LOGIN][AUTH_LOGIN]
 *  `plain`
    
    [AUTH=PLAIN][AUTH_PLAIN]
 *  `cram-md5`
    
    [AUTH=CRAM-MD5][AUTH_CRAM-MD5]。为了使此方法正常工作，密码不能加密存储。
 *  `external`
    
    [AUTH EXTERNAL][]（1.11.6）。

### imap\_capabilities ###

<table> 
 <thead> 
  <tr> 
   <th align="right">-</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="right"><strong>语法</strong></td> 
   <td><strong>imap_capabilities</strong> <code>extension ...</code>;</td> 
  </tr> 
  <tr> 
   <td align="right"><strong>默认</strong></td> 
   <td>imap_capabilities IMAP4 IMAP4rev1 UIDPLUS;</td> 
  </tr> 
  <tr> 
   <td align="right"><strong>上下文</strong></td> 
   <td>mail、server</td> 
  </tr> 
 </tbody> 
</table>

设置响应 `CAPABILITY` 命令传递给客户端的 [IMAP 协议][IMAP] 扩展列表。根据 starttls 指令值，imap\_auth 指令和 [STARTTLS][] 中指定的认证方法将自动添加到此列表中。

指定被代理客户端的 IMAP 后端支持的扩展（当 nginx 透明地代理到后端的客户端连接，如果这些扩展与认证后使用的命令相关），则是有意义的。

目前的标准扩展名单已发布在 [www.iana.org][]。

### imap\_client\_buffer ###

<table> 
 <thead> 
  <tr> 
   <th align="right">-</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="right"><strong>语法</strong></td> 
   <td><strong>imap_client_buffer</strong> <code>size</code>;</td> 
  </tr> 
  <tr> 
   <td align="right"><strong>默认</strong></td> 
   <td>imap_client_buffer 4k|8k;</td> 
  </tr> 
  <tr> 
   <td align="right"><strong>上下文</strong></td> 
   <td>mail、server</td> 
  </tr> 
 </tbody> 
</table>

设置 IMAP 命令读取缓冲区大小。默认情况下，缓冲区大小等于一个内存页面。4K 或 8K，取决于平台。

## 原文档 ##

[http://nginx.org/en/docs/mail/ngx\_mail\_imap\_module.html][http_nginx.org_en_docs_mail_ngx_mail_imap_module.html]

--------------------

# ngx\_mail\_pop3\_module #

*  示例配置
 *  指令
    
     *  pop3\_auth
     *  pop3\_capabilities

## 指令 ##

### pop3\_auth ###

<table> 
 <thead> 
  <tr> 
   <th align="right">-</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="right"><strong>语法</strong></td> 
   <td><strong>pop3_auth</strong> <code>method ...</code>;</td> 
  </tr> 
  <tr> 
   <td align="right"><strong>默认</strong></td> 
   <td>pop3_auth plain;</td> 
  </tr> 
  <tr> 
   <td align="right"><strong>上下文</strong></td> 
   <td>mail、server</td> 
  </tr> 
 </tbody> 
</table>

为 POP3 客户端设置允许的认证方法。支持的方法有：

*  `plain`
    
    [USER/PASS][USER_PASS]、[AUTH PLAIN][AUTH_PLAIN]、[AUTH LOGIN][AUTH_LOGIN]。不可能禁用这些方法。
 *  `apop`
    
    [APOP][USER_PASS]。为了使此方法正常工作，密码不能加密存储。
 *  `cram-md5`
    
    [AUTH CRAM-MD5][AUTH_CRAM-MD5]。为了使此方法正常工作，密码不能加密存储。
 *  `external`
    
    [AUTH EXTERNAL][]（1.11.6）。

### pop3\_capabilities ###

<table> 
 <thead> 
  <tr> 
   <th align="right">-</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="right"><strong>语法</strong></td> 
   <td><strong>pop3_capabilities</strong> <code>extension ...</code>;</td> 
  </tr> 
  <tr> 
   <td align="right"><strong>默认</strong></td> 
   <td>pop3_capabilities TOP USER UIDL;</td> 
  </tr> 
  <tr> 
   <td align="right"><strong>上下文</strong></td> 
   <td>mail、server</td> 
  </tr> 
 </tbody> 
</table>

设置响应 `CAPA` 命令传送给客户端的 [POP3 协议][POP3] 扩展列表。根据 starttls 指令值，pop3\_auth 指令（[SASL][POP3] 扩展）和 [STLS][STARTTLS] 中指定的认证方法将自动添加到此列表。

指定客户端代理的 POP3 后端支持的扩展（当 nginx 透明地代理到后端的客户端连接，如果这些扩展与认证后使用的命令相关），则是有意义的。

## 原文档 ##

[http://nginx.org/en/docs/mail/ngx\_mail\_pop3\_module.html][http_nginx.org_en_docs_mail_ngx_mail_pop3_module.html]

--------------------

# ngx\_mail\_smtp\_module #

*  示例配置
 *  指令
    
     *  ngx\_mail\_smtp\_module
     *  smtp\_capabilities

## 指令 ##

### smtp\_auth ###

<table> 
 <thead> 
  <tr> 
   <th align="right">-</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="right"><strong>语法</strong></td> 
   <td><strong>smtp_auth</strong> <code>method ...</code>;</td> 
  </tr> 
  <tr> 
   <td align="right"><strong>默认</strong></td> 
   <td>smtp_auth login plain;</td> 
  </tr> 
  <tr> 
   <td align="right"><strong>上下文</strong></td> 
   <td>mail、server</td> 
  </tr> 
 </tbody> 
</table>

为 SMTP 客户端设置 [SASL 认证][SASL] 的允许方法。支持的方法有：

*  `login`
    
    [AUTH LOGIN][AUTH_LOGIN]
 *  `plain`
    
    [AUTH PLAIN][AUTH_PLAIN]
 *  `cram-md5`
    
    [AUTH CRAM-MD5][AUTH_CRAM-MD5]。为了使此方法正常工作，密码不加密存储。
 *  `external`
    
    [AUTH EXTERNAL][]（1.11.6）。
 *  `none`
    
    不需要验证

### smtp\_capabilities ###

<table> 
 <thead> 
  <tr> 
   <th align="right">-</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="right"><strong>语法</strong></td> 
   <td><strong>smtp_capabilities</strong> <code>extension ...</code>;</td> 
  </tr> 
  <tr> 
   <td align="right"><strong>默认</strong></td> 
   <td>——</td> 
  </tr> 
  <tr> 
   <td align="right"><strong>上下文</strong></td> 
   <td>mail、server</td> 
  </tr> 
 </tbody> 
</table>

设置传送给客户端响应 `EHLO` 命令的 SMTP 协议扩展列表。根据 starttls 指令值，smtp\_auth 指令和 [STARTTLS][STARTTLS 1] 中指定的认证方法将自动添加到此列表中。

指定被代理客户端的 MTA 支持扩展是有意义的（当 nginx 透明地将客户端连接代理到后端，如果这些扩展与认证后使用的命令相关）。

目前的标准扩展名单已发布在 [www.iana.org][www.iana.org 1]。

## 原文档 ##

[http://nginx.org/en/docs/mail/ngx\_mail\_smtp\_module.html][http_nginx.org_en_docs_mail_ngx_mail_smtp_module.html]

[AUTH_LOGIN]: https://tools.ietf.org/html/draft-murchison-sasl-login-00
[AUTH_PLAIN]: https://tools.ietf.org/html/rfc4616
[AUTH_CRAM-MD5]: https://tools.ietf.org/html/rfc2195
[AUTH EXTERNAL]: https://tools.ietf.org/html/rfc4422
[IMAP]: https://tools.ietf.org/html/rfc3501
[STARTTLS]: https://tools.ietf.org/html/rfc2595
[www.iana.org]: http://www.iana.org/assignments/imap4-capabilities
[http_nginx.org_en_docs_mail_ngx_mail_imap_module.html]: http://nginx.org/en/docs/mail/ngx_mail_imap_module.html
[USER_PASS]: https://tools.ietf.org/html/rfc1939
[POP3]: https://tools.ietf.org/html/rfc2449
[http_nginx.org_en_docs_mail_ngx_mail_pop3_module.html]: http://nginx.org/en/docs/mail/ngx_mail_pop3_module.html
[SASL]: https://tools.ietf.org/html/rfc2554
[STARTTLS 1]: https://tools.ietf.org/html/rfc3207
[www.iana.org 1]: http://www.iana.org/assignments/mail-parameters
[http_nginx.org_en_docs_mail_ngx_mail_smtp_module.html]: http://nginx.org/en/docs/mail/ngx_mail_smtp_module.html