]> source.dussan.org Git - rspamd.git/commitdiff
[Minor] API docs: try explain real_ip / from_ip better
authorAndrew Lewis <nerf@judo.za.org>
Mon, 11 Oct 2021 13:36:52 +0000 (15:36 +0200)
committerAndrew Lewis <nerf@judo.za.org>
Mon, 11 Oct 2021 13:36:52 +0000 (15:36 +0200)
src/lua/lua_task.c

index 1eb67a4309ae5ba1cd5feaf07ea02ed3a7ef18a3..42cdd22f0be38bbc55c43f7c4cbc8a02d1df8181 100644 (file)
@@ -446,9 +446,9 @@ LUA_FUNCTION_DEF (task, modify_header);
  * the following structure:
  *
  * - `from_hostname` - string that represents hostname provided by a peer
- * - `from_ip` - string representation of IP address as provided by a peer
+ * - `from_ip` - string representation of sending IP address
  * - `real_hostname` - hostname as resolved by MTA
- * - `real_ip` - string representation of IP as resolved by PTR request of MTA
+ * - `real_ip` - rspamd_ip object representing sending IP address
  * - `by_hostname` - MTA hostname
  * - `proto` - protocol, e.g. ESMTP or ESMTPS
  * - `timestamp` - received timestamp