[nginx-site] Documented limit_rate and limit_rate_after in mail ...

[Maxim Dounin]

details:   http://freenginx.org/hg/nginx-site/rev/1b81369bbf4f
branches:  
changeset: 3105:1b81369bbf4f
user:      Maxim Dounin <mdounin at mdounin.ru>
date:      Mon Jul 07 06:36:03 2025 +0300
description:
Documented limit_rate and limit_rate_after in mail proxy.

diffstat:

 xml/en/docs/mail/ngx_mail_core_module.xml |  44 +++++++++++++++++++++++++++++-
 xml/ru/docs/mail/ngx_mail_core_module.xml |  45 ++++++++++++++++++++++++++++++-
 2 files changed, 87 insertions(+), 2 deletions(-)

diffs (123 lines):

diff --git a/xml/en/docs/mail/ngx_mail_core_module.xml b/xml/en/docs/mail/ngx_mail_core_module.xml
--- a/xml/en/docs/mail/ngx_mail_core_module.xml
+++ b/xml/en/docs/mail/ngx_mail_core_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_mail_core_module"
         link="/en/docs/mail/ngx_mail_core_module.html"
         lang="en"
-        rev="24">
+        rev="25">
 
 <section id="summary">
 
@@ -74,6 +74,48 @@ mail {
 
 <section id="directives" name="Directives">
 
+<directive name="limit_rate">
+<syntax><value>rate</value></syntax>
+<default>0</default>
+<context>mail</context>
+<context>server</context>
+<appeared-in>1.29.0</appeared-in>
+
+<para>
+Limits the rate of transmission to the client.
+The <value>rate</value> is specified in bytes per second.
+The zero value disables rate limiting.
+The limit is set per a connection, and so if a client simultaneously opens
+two connections, the overall rate will be twice as much
+as the specified limit.
+</para>
+
+<para>
+Example:
+<example>
+limit_rate       10m;
+limit_rate_after 100m;
+</example>
+</para>
+
+</directive>
+
+
+<directive name="limit_rate_after">
+<syntax><value>size</value></syntax>
+<default>0</default>
+<context>mail</context>
+<context>server</context>
+<appeared-in>1.29.0</appeared-in>
+
+<para>
+Specifies the allowed size of data bursts
+after which further transmission to the client will be rate limited.
+</para>
+
+</directive>
+
+
 <directive name="listen">
 <syntax>
     <value>address</value>:<value>port</value>
diff --git a/xml/ru/docs/mail/ngx_mail_core_module.xml b/xml/ru/docs/mail/ngx_mail_core_module.xml
--- a/xml/ru/docs/mail/ngx_mail_core_module.xml
+++ b/xml/ru/docs/mail/ngx_mail_core_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_mail_core_module"
         link="/ru/docs/mail/ngx_mail_core_module.html"
         lang="ru"
-        rev="24">
+        rev="25">
 
 <section id="summary">
 
@@ -74,6 +74,49 @@ mail {
 
 <section id="directives" name="Директивы">
 
+<directive name="limit_rate">
+<syntax><value>скорость</value></syntax>
+<default>0</default>
+<context>mail</context>
+<context>server</context>
+<appeared-in>1.29.0</appeared-in>
+
+<para>
+Ограничивает скорость передачи данных клиенту.
+<value>Скорость</value> задаётся в байтах в секунду.
+Значение 0 отключает ограничение скорости.
+Ограничение устанавливается на соединение, поэтому, если клиент одновременно
+откроет два соединения, суммарная скорость будет вдвое выше
+заданного ограничения.
+</para>
+
+<para>
+Пример:
+<example>
+limit_rate       10m;
+limit_rate_after 100m;
+</example>
+</para>
+
+</directive>
+
+
+<directive name="limit_rate_after">
+<syntax><value>размер</value></syntax>
+<default>0</default>
+<context>mail</context>
+<context>server</context>
+<appeared-in>1.29.0</appeared-in>
+
+<para>
+Задаёт допустимый размер всплесков при передаче данных,
+при превышении которого начинает ограничиваться скорость
+передачи данных клиенту.
+</para>
+
+</directive>
+
+
 <directive name="listen">
 <syntax>
     <value>адрес</value>:<value>порт</value>