Skip to content
Snippets Groups Projects
Commit 2ff3edc0 authored by rswindell's avatar rswindell
Browse files

Updated documentation for new(ish) arguments to the get_msg_body() method.

parent 8bb298fe
No related branches found
No related tags found
No related merge requests found
...@@ -1650,8 +1650,12 @@ static jsSyncMethodSpec js_msgbase_functions[] = { ...@@ -1650,8 +1650,12 @@ static jsSyncMethodSpec js_msgbase_functions[] = {
,JSDOCSTR("write a message header") ,JSDOCSTR("write a message header")
,310 ,310
}, },
{"get_msg_body", js_get_msg_body, 2, JSTYPE_STRING, JSDOCSTR("[boolean by_offset,] number_or_id [,boolean strip_ctrl_a]") {"get_msg_body", js_get_msg_body, 2, JSTYPE_STRING, JSDOCSTR("[boolean by_offset,] number_or_id [,boolean strip_ctrl_a] "
,JSDOCSTR("returns the body text of a specific message, <i>null</i> on failure") "[,boolean rfc822_encoded] [,boolean include_tails]")
,JSDOCSTR("returns the body text of a specific message, <i>null</i> on failure. "
"The default behavior is to leave Ctrl-A codes intact, perform no RFC-822 encoding, and to include tails (if any) in the "
"returned body text."
)
,310 ,310
}, },
{"get_msg_tail", js_get_msg_tail, 2, JSTYPE_STRING, JSDOCSTR("[boolean by_offset,] number_or_id [,boolean strip_ctrl_a]") {"get_msg_tail", js_get_msg_tail, 2, JSTYPE_STRING, JSDOCSTR("[boolean by_offset,] number_or_id [,boolean strip_ctrl_a]")
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment