From 72f0f0ddd3017f5be7bfe19fe5d2abe2dcf95629 Mon Sep 17 00:00:00 2001 From: Anton Yuzhaninov Date: Tue, 18 Aug 2020 13:21:27 +0100 Subject: [PATCH] [Doc] Improve task:get_message_id() description --- src/lua/lua_task.c | 6 ++++-- 1 file 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); /*** -- 2.39.5