aboutsummaryrefslogtreecommitdiffstats
path: root/src/lua
diff options
context:
space:
mode:
authorJan Smutny <js@excello.cz>2020-04-17 11:23:22 +0200
committerJan Smutny <js@excello.cz>2020-04-17 14:32:31 +0200
commit51a7730b1cca039b40aeacf6355f1a9b911b6d24 (patch)
tree105f362023b70469ef856282cf0f16f72ef02921 /src/lua
parentacc9a3ceaa4c7f4eccf7d81de87935d814dc3fd5 (diff)
downloadrspamd-51a7730b1cca039b40aeacf6355f1a9b911b6d24.tar.gz
rspamd-51a7730b1cca039b40aeacf6355f1a9b911b6d24.zip
[Minor] complete doc part of task:get_from method
Diffstat (limited to 'src/lua')
-rw-r--r--src/lua/lua_task.c8
1 files changed, 8 insertions, 0 deletions
diff --git a/src/lua/lua_task.c b/src/lua/lua_task.c
index 4f92bdb06..4ac819c9d 100644
--- a/src/lua/lua_task.c
+++ b/src/lua/lua_task.c
@@ -519,6 +519,14 @@ LUA_FUNCTION_DEF (task, has_from);
* - `addr` - address part of the address
* - `user` - user part (if present) of the address, e.g. `blah`
* - `domain` - domain part (if present), e.g. `foo.com`
+ * - `flags` - table with following keys set to true if given condition fulfilled:
+ * - [valid] - valid SMTP address in conformity with https://tools.ietf.org/html/rfc5321#section-4.1.
+ * - [ip] - domain is IPv4/IPv6 address
+ * - [braced] - angled `<blah@foo.com>` address
+ * - [quoted] - quoted user part
+ * - [empty] - empty address
+ * - [backslash] - user part contains backslash
+ * - [8bit] - contains 8bit characters
* @param {integer|string} type if specified has the following meaning: `0` or `any` means try SMTP sender and fallback to MIME if failed, `1` or `smtp` means checking merely SMTP sender and `2` or `mime` means MIME `From:` only
* @return {address} sender or `nil`
*/