> For the complete documentation index, see [llms.txt](https://docshome.gitbook.io/nginx-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docshome.gitbook.io/nginx-docs/he-xin-gong-neng/mail/ngx_mail_imap_module.md).

# ngx\_mail\_imap\_module

* [示例配置](/nginx-docs/he-xin-gong-neng/mail/ngx_mail_imap_module.md#example_configuration)
* [指令](/nginx-docs/he-xin-gong-neng/mail/ngx_mail_imap_module.md#directives)
  * [imap\_auth](/nginx-docs/he-xin-gong-neng/mail/ngx_mail_imap_module.md#imap_auth)
  * [imap\_capabilities](/nginx-docs/he-xin-gong-neng/mail/ngx_mail_imap_module.md#imap_capabilities)
  * [imap\_client\_buffer](/nginx-docs/he-xin-gong-neng/mail/ngx_mail_imap_module.md#imap_client_buffer)

## 指令 <a href="#directives" id="directives"></a>

### imap\_auth

|       - | 说明                           |
| ------: | ---------------------------- |
|  **语法** | **imap\_auth** `method ...`; |
|  **默认** | imap\_auth plain;            |
| **上下文** | mail、server                  |

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

* `login`

  [AUTH=LOGIN](https://tools.ietf.org/html/draft-murchison-sasl-login-00)
* `plain`

  [AUTH=PLAIN](https://tools.ietf.org/html/rfc4616)
* `cram-md5`

  [AUTH=CRAM-MD5](https://tools.ietf.org/html/rfc2195)。为了使此方法正常工作，密码不能加密存储。
* `external`

  [AUTH EXTERNAL](https://tools.ietf.org/html/rfc4422)（1.11.6）。

### imap\_capabilities

|       - | 说明                                          |
| ------: | ------------------------------------------- |
|  **语法** | **imap\_capabilities** `extension ...`;     |
|  **默认** | imap\_capabilities IMAP4 IMAP4rev1 UIDPLUS; |
| **上下文** | mail、server                                 |

设置响应 `CAPABILITY` 命令传递给客户端的 [IMAP 协议](https://tools.ietf.org/html/rfc3501) 扩展列表。根据 [starttls](/nginx-docs/he-xin-gong-neng/mail/ngx_mail_ssl_module.md#starttls) 指令值，[imap\_auth](/nginx-docs/he-xin-gong-neng/mail/ngx_mail_imap_module.md#imap_auth) 指令和 [STARTTLS](https://tools.ietf.org/html/rfc2595) 中指定的认证方法将自动添加到此列表中。

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

目前的标准扩展名单已发布在 [www.iana.org](http://www.iana.org/assignments/imap4-capabilities)。

### imap\_client\_buffer

|       - | 说明                               |
| ------: | -------------------------------- |
|  **语法** | **imap\_client\_buffer** `size`; |
|  **默认** | imap\_client\_buffer 4k\|8k;     |
| **上下文** | mail、server                      |

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

## 原文档

<http://nginx.org/en/docs/mail/ngx_mail_imap_module.html>