From 5e7475e24a4ea0707b9d0b2fc7c24ba117259580 Mon Sep 17 00:00:00 2001 From: Vsevolod Stakhov Date: Sat, 13 Feb 2016 14:43:19 +0000 Subject: [PATCH] Add some documentation for once_received module --- doc/markdown/modules/once_received.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/doc/markdown/modules/once_received.md b/doc/markdown/modules/once_received.md index e69de29bb..398ce1cb1 100644 --- a/doc/markdown/modules/once_received.md +++ b/doc/markdown/modules/once_received.md @@ -0,0 +1,22 @@ +# Once received module + +This module is intended to do simple checks for mail with one `Received` header. The idea behind these checks is that legitimate mail likely has more than one received and some bad patterns, such as `dynamic` or `broadband` are common for spam from hacked users' machines. + +## Configuration + +The configuration of this module is pretty straightforward: specify `symbol` for generic one received mail, specify `symbol_strict` for emails with bad patterns or with unresolvable hostnames and add **good** and **bad** patterns. Patterns can contain [lua patterns](http://lua-users.org/wiki/PatternsTutorial). `good_host` lines are used to negate this module for certain hosts, `bad_host` lines are used to specify certain bad patterns. It is also possible to specify `whitelist` to define a list of networks for which `once_received` checks should be excluded. + +## Example + +~~~nginx +once_received { + good_host = "^mail"; + bad_host = "static"; + bad_host = "dynamic"; + symbol_strict = "ONCE_RECEIVED_STRICT"; + symbol = "ONCE_RECEIVED"; + whitelist = "/tmp/ip.map"; +} +~~~ + +IP map can contain, as usually, IP's (both v4 and v6), networks (in CIDR notation) and optional comments starting from `#` symbol. -- 2.39.5