diff options
| author | Vsevolod Stakhov <vsevolod@highsecure.ru> | 2016-01-04 09:59:08 +0000 |
|---|---|---|
| committer | Vsevolod Stakhov <vsevolod@highsecure.ru> | 2016-01-04 10:00:20 +0000 |
| commit | adbdec46f87684b2638fad7cc42f66dc04346260 (patch) | |
| tree | 69c83415df603853482b4a45e994e0acbf4a55ff /src/plugins | |
| parent | 260b55ccf152e62204e7db9f5163c1016f8605e2 (diff) | |
| download | rspamd-adbdec46f87684b2638fad7cc42f66dc04346260.tar.gz rspamd-adbdec46f87684b2638fad7cc42f66dc04346260.zip | |
Add docstrings for spf module
Diffstat (limited to 'src/plugins')
| -rw-r--r-- | src/plugins/spf.c | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/src/plugins/spf.c b/src/plugins/spf.c index ac2f1ddb4..200270b11 100644 --- a/src/plugins/spf.c +++ b/src/plugins/spf.c @@ -97,6 +97,40 @@ spf_module_init (struct rspamd_config *cfg, struct module_ctx **ctx) *ctx = (struct module_ctx *)spf_module_ctx; + rspamd_rcl_add_doc_by_path (cfg, NULL, + "SPF check plugin", + "spf", UCL_OBJECT, NULL, 0); + + rspamd_rcl_add_doc_by_path (cfg, "spf", + "Map of IP addresses that should be excluded from SPF checks (in addition to `local_networks`)", + "whitelist", UCL_STRING, NULL, 0); + rspamd_rcl_add_doc_by_path (cfg, "spf", + "Symbol that is added if SPF check is successful", + "symbol_allow", UCL_STRING, NULL, 0); + rspamd_rcl_add_doc_by_path (cfg, "spf", + "Symbol that is added if SPF policy is set to 'deny'", + "symbol_fail", UCL_STRING, NULL, 0); + rspamd_rcl_add_doc_by_path (cfg, + "spf", + "Symbol that is added if SPF policy is set to 'undefined'", + "symbol_softfail", + UCL_STRING, + NULL, + 0); + rspamd_rcl_add_doc_by_path (cfg, + "spf", + "Symbol that is added if SPF policy is set to 'neutral'", + "symbol_neutral", + UCL_STRING, + NULL, + 0); + rspamd_rcl_add_doc_by_path (cfg, "spf", + "Size of SPF parsed records cache", + "spf_cache_size", UCL_INT, NULL, 0); + rspamd_rcl_add_doc_by_path (cfg, "spf", + "Maximum lifetime for the elements in the SPF cache", + "spf_cache_expire", UCL_TIME, NULL, 0); + return 0; } |