]> source.dussan.org Git - rspamd.git/commitdiff
[Doc] Improve task:get_message_id() description 3472/head
authorAnton Yuzhaninov <citrin+git@citrin.ru>
Tue, 18 Aug 2020 12:21:27 +0000 (13:21 +0100)
committerAnton Yuzhaninov <citrin+git@citrin.ru>
Tue, 18 Aug 2020 12:21:27 +0000 (13:21 +0100)
src/lua/lua_task.c

index e850f1d7e411a2ccac0445916032dd97a26dbbe7..27fee395d8d34000913935f906f04fcd8029fbcf 100644 (file)
@@ -774,8 +774,10 @@ end
 LUA_FUNCTION_DEF (task, get_date);
 /***
  * @method task:get_message_id()
- * Returns message id of the specified task
- * @return {string} if of a message
+ * Returns message identifier from the `Message-ID` header.  Angle brackets (`<>`)
+ * are stripped off if present.  If a Message-ID header is missing `undef` is
+ * returned.
+ * @return {string} ID of the message
  */
 LUA_FUNCTION_DEF (task, get_message_id);
 /***