模块 ngx_mail_core_module

示例配置
指令
     listen
     mail
     max_errors
     protocol
     resolver
     resolver_timeout
     server
     server_name
     timeout

此模块默认情况下未构建,应使用--with-mail配置参数启用。

示例配置

worker_processes auto;

error_log /var/log/nginx/error.log info;

events {
    worker_connections  1024;
}

mail {
    server_name       mail.example.com;
    auth_http         localhost:9000/cgi-bin/nginxauth.cgi;

    imap_capabilities IMAP4rev1 UIDPLUS IDLE LITERAL+ QUOTA;

    pop3_auth         plain apop cram-md5;
    pop3_capabilities LAST TOP USER PIPELINING UIDL;

    smtp_auth         login plain cram-md5;
    smtp_capabilities "SIZE 10485760" ENHANCEDSTATUSCODES 8BITMIME DSN;
    xclient           off;

    server {
        listen   25;
        protocol smtp;
    }
    server {
        listen   110;
        protocol pop3;
        proxy_pass_error_message on;
    }
    server {
        listen   143;
        protocol imap;
    }
    server {
        listen   587;
        protocol smtp;
    }
}

指令

语法 listen 地址:端口 [ssl] [proxy_protocol] [backlog=数量] [rcvbuf=大小] [sndbuf=大小] [bind] [ipv6only=on|off] [so_keepalive=on|off|[保持空闲]:[保持间隔]:[保持次数]];
默认值
上下文 server

设置服务器将接受请求的套接字的地址端口。可以只指定端口。地址也可以是主机名,例如

listen 127.0.0.1:110;
listen *:110;
listen 110;     # same as *:110
listen localhost:110;

IPv6 地址 (0.7.58) 用方括号指定

listen [::1]:110;
listen [::]:110;

UNIX 域套接字 (1.3.5) 用“unix:”前缀指定

listen unix:/var/run/nginx.sock;

不同的服务器必须监听不同的地址:端口对。

ssl参数允许指定在此端口上接受的所有连接都应在 SSL 模式下工作。

proxy_protocol参数 (1.19.8) 允许指定在此端口上接受的所有连接都应使用PROXY 协议。获得的信息将传递给身份验证服务器,并可用于更改客户端地址

listen指令可以具有一些特定于套接字相关系统调用的其他参数。

backlog=数量
listen()调用中设置backlog参数,该参数限制挂起连接队列的最大长度 (1.9.2)。默认情况下,backlog在 FreeBSD、DragonFly BSD 和 macOS 上设置为 -1,在其他平台上设置为 511。
rcvbuf=大小
设置监听套接字的接收缓冲区大小 (SO_RCVBUF选项) (1.11.13)。
sndbuf=大小
设置监听套接字的发送缓冲区大小 (SO_SNDBUF选项) (1.11.13)。
bind
此参数指示对给定的地址:端口对进行单独的bind()调用。事实上,如果有多个listen指令具有相同的端口但地址不同,并且其中一个listen指令侦听给定端口的所有地址 (*:端口),则 nginx 将只绑定到*:端口。需要注意的是,在这种情况下将进行getsockname()系统调用以确定接受连接的地址。如果使用了backlogrcvbufsndbufipv6onlyso_keepalive参数,则对于给定的地址:端口对,将始终进行单独的bind()调用。
ipv6only=on|off
此参数确定 (通过IPV6_V6ONLY套接字选项) 侦听通配符地址[::]的 IPv6 套接字是否只接受 IPv6 连接或同时接受 IPv6 和 IPv4 连接。此参数默认开启。它只能在启动时设置一次。
so_keepalive=on|off|[保持空闲]:[保持间隔]:[保持次数]
此参数配置监听套接字的“TCP 保持活动”行为。如果省略此参数,则操作系统设置将对套接字生效。如果将其设置为“on”值,则为套接字打开SO_KEEPALIVE选项。如果将其设置为“off”值,则为套接字关闭SO_KEEPALIVE选项。某些操作系统支持使用TCP_KEEPIDLETCP_KEEPINTVLTCP_KEEPCNT套接字选项在每个套接字的基础上设置 TCP 保持活动参数。在这样的系统上 (目前,Linux 2.4+、NetBSD 5+ 和 FreeBSD 9.0-STABLE),可以使用保持空闲保持间隔保持次数参数配置它们。可以省略一个或两个参数,在这种情况下,系统默认设置将对相应的套接字选项生效。例如,
so_keepalive=30m::10
将空闲超时 (TCP_KEEPIDLE) 设置为 30 分钟,将探测间隔 (TCP_KEEPINTVL) 保留为其系统默认值,并将探测次数 (TCP_KEEPCNT) 设置为 10 次探测。

语法 mail { ... }
默认值
上下文 main

提供指定邮件服务器指令的配置文件上下文。

语法 max_errors 数量;
默认值
max_errors 5;
上下文 mailserver

此指令出现在 1.21.0 版本中。

设置连接关闭之前的协议错误数。

语法 protocol imap | pop3 | smtp;
默认值
上下文 server

设置代理服务器的协议。支持的协议为IMAPPOP3SMTP

如果未设置指令,则可以根据listen指令中指定的众所周知的端口自动检测协议

可以使用配置参数--without-mail_imap_module--without-mail_pop3_module--without-mail_smtp_module禁用不必要的协议。

语法 resolver 地址 ... [valid=时间] [ipv4=on|off] [ipv6=on|off] [status_zone=区域];
resolver off;
默认值
resolver off;
上下文 mailserver

配置用于查找客户端主机名的名称服务器,以将其传递给身份验证服务器,以及在代理 SMTP 时使用XCLIENT命令。例如

resolver 127.0.0.1 [::1]:5353;

地址可以指定为域名或 IP 地址,并带有一个可选端口 (1.3.1、1.2.2)。如果未指定端口,则使用端口 53。名称服务器将以轮询方式查询。

在 1.1.7 版本之前,只能配置单个名称服务器。从 1.3.1 和 1.2.2 版本开始,支持使用 IPv6 地址指定名称服务器。

默认情况下,nginx 将在解析时查找 IPv4 和 IPv6 地址。如果不需要查找 IPv4 或 IPv6 地址,则可以指定ipv4=off (1.23.1) 或ipv6=off参数。

从 1.5.8 版本开始支持将名称解析为 IPv6 地址。

默认情况下,nginx 使用响应的 TTL 值缓存答案。可选的valid参数允许覆盖它

resolver 127.0.0.1 [::1]:5353 valid=30s;

在 1.1.9 版本之前,无法调整缓存时间,nginx 始终缓存 5 分钟的答案。

为了防止 DNS 欺骗,建议在安全可靠的本地网络中配置 DNS 服务器。

可选的status_zone参数 (1.17.1) 启用在指定的区域收集请求和响应的 DNS 服务器统计信息。此参数作为我们商业订阅的一部分提供。

特殊值off禁用解析。

语法 resolver_timeout 时间;
默认值
resolver_timeout 30s;
上下文 mailserver

设置 DNS 操作的超时,例如

resolver_timeout 5s;

语法 server { ... }
默认值
上下文 mail

设置服务器的配置。

语法 server_name 名称;
默认值
server_name hostname;
上下文 mailserver

设置使用的服务器名称

如果未指定指令,则使用机器的主机名。

语法 timeout 时间;
默认值
timeout 60s;
上下文 mailserver

设置在代理到后端开始之前使用的超时。