Proxy#

Configures how Angie connects to the backend and relays the session to it. The authentication server chooses the backend (see How It Works); connections to backends do not use TLS.

Directives#

proxy_buffer#

Syntax

proxy_buffer size;

Default

proxy_buffer 4k|8k;

Context

mail, server

Sets the size of the buffer used for proxying. By default, the buffer size is equal to one memory page. Depending on a platform, it is either 4K or 8K.

proxy_pass_error_message#

Syntax

proxy_pass_error_message on | off;

Default

proxy_pass_error_message off;

Context

mail, server

Determines whether to pass the error message obtained during authentication on the backend to the client.

When the authentication server has already checked the password, an error from the backend means an internal problem, and its message may contain information that should not be shown to the client; with the directive disabled, the client gets an internal error instead. Enable the directive when the backend's error is meant for the client: when the authentication server leaves the password check to the backend, or with POP3 servers that respond with an error even to a correct password. In either case, Angie closes the connection after the error.

proxy_protocol#

Syntax

proxy_protocol on | off;

Default

proxy_protocol off;

Context

mail, server

Enables the PROXY protocol for connections to a backend.

proxy_smtp_auth#

Syntax

proxy_smtp_auth on | off;

Default

proxy_smtp_auth off;

Context

mail, server

Enables or disables user authentication on the SMTP backend using the AUTH command.

If XCLIENT is also enabled, then the XCLIENT command will not send the LOGIN parameter.

proxy_timeout#

Syntax

proxy_timeout time;

Default

proxy_timeout 24h;

Context

mail, server

Sets the timeout between two successive read or write operations on client or proxied server connections. If no data is transmitted within this time, the connection is closed.

xclient#

Syntax

xclient on | off;

Default

xclient on;

Context

mail, server

Enables or disables the passing of the XCLIENT command with client parameters when connecting to the SMTP backend.

With XCLIENT, the MTA is able to write client information to the log and apply various limitations based on this data.

If XCLIENT is enabled then Angie passes the following commands when connecting to the backend:

  • EHLO with the server name

  • XCLIENT

  • EHLO or HELO, as passed by the client

If the name found by the client IP address points to the same address, it is passed in the NAME parameter of the XCLIENT command. If the name could not be found, points to a different address, or resolver is not specified, then [UNAVAILABLE] is passed in the NAME parameter. If an error has occurred in the process of resolving, the [TEMPUNAVAIL] value is used.

If XCLIENT is disabled, Angie passes the EHLO command with the server name when connecting to the backend if the client has passed EHLO, or HELO with the server name, otherwise.