diff options
| author | Vsevolod Stakhov <vsevolod@highsecure.ru> | 2020-08-18 13:27:45 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-08-18 13:27:45 +0100 |
| commit | 81b73be9aa4d9892423afa9e39959fc44f001167 (patch) | |
| tree | afce25d5edb4128fe5c0b8ab30787132c78f03c9 | |
| parent | 749baf462ac7659c832e6f337e52fb7c75695166 (diff) | |
| parent | 72f0f0ddd3017f5be7bfe19fe5d2abe2dcf95629 (diff) | |
| download | rspamd-81b73be9aa4d9892423afa9e39959fc44f001167.tar.gz rspamd-81b73be9aa4d9892423afa9e39959fc44f001167.zip | |
Merge pull request #3472 from citrin/api-doc
[Doc] Improve task:get_message_id() description
| -rw-r--r-- | src/lua/lua_task.c | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/src/lua/lua_task.c b/src/lua/lua_task.c index e850f1d7e..27fee395d 100644 --- a/src/lua/lua_task.c +++ b/src/lua/lua_task.c @@ -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); /*** |