Skip to content
Snippets Groups Projects
Commit 7837084f authored by rswindell's avatar rswindell
Browse files

Updated embedded JS docs. 

Created msgbase.cfg.index (as 'undefined').
parent 23a47182
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 59 additions and 57 deletions
src/sbbs3/js_msgbase.c
+ 59
− 57
View file @ 7837084f
...@@ -1666,75 +1666,75 @@ static jsSyncMethodSpec js_msgbase_functions[] = { ...@@ -1666,75 +1666,75 @@ static jsSyncMethodSpec js_msgbase_functions[] = {
,JSDOCSTR("returns a specific message index, <i>null</i> on failure. " ,JSDOCSTR("returns a specific message index, <i>null</i> on failure. "
"The index object will contain the following properties:<br>" "The index object will contain the following properties:<br>"
"<table>" "<table>"
"<tr><td><tt>subject</tt><td>CRC-16 of lowercase message subject" "<tr><td align=top><tt>subject</tt><td>CRC-16 of lowercase message subject"
"<tr><td><tt>to</tt><td>CRC-16 of lowercase recipient's name (or user number if e-mail)" "<tr><td align=top><tt>to</tt><td>CRC-16 of lowercase recipient's name (or user number if e-mail)"
"<tr><td><tt>from</tt><td>CRC-16 of lowercase sender's name (or user number if e-mail)" "<tr><td align=top><tt>from</tt><td>CRC-16 of lowercase sender's name (or user number if e-mail)"
"<tr><td><tt>attr</tt><td>Attribute bitfield" "<tr><td align=top><tt>attr</tt><td>Attribute bitfield"
"<tr><td><tt>time</tt><td>Date/time (in time_t format)" "<tr><td align=top><tt>time</tt><td>Date/time imported (in time_t format)"
"<tr><td><tt>number</tt><td>Message number" "<tr><td align=top><tt>number</tt><td>Message number"
"<tr><td><tt>offset</tt><td>Record number in index file" "<tr><td align=top><tt>offset</tt><td>Record number in index file"
"</table>") "</table>")
,311 ,311
}, },
{"remove_msg", js_remove_msg, 2, JSTYPE_BOOLEAN, JSDOCSTR("[boolean by_offset,] number_or_id") {"remove_msg", js_remove_msg, 2, JSTYPE_BOOLEAN, JSDOCSTR("[boolean by_offset,] number_or_id")
,JSDOCSTR("mark message as deleted") ,JSDOCSTR("mark message for deletion")
,311 ,311
}, },
{"save_msg", js_save_msg, 2, JSTYPE_BOOLEAN, JSDOCSTR("object header [,client] [,body_text] [,array rcpt_list]") {"save_msg", js_save_msg, 2, JSTYPE_BOOLEAN, JSDOCSTR("object header [,client] [,body_text] [,array rcpt_list]")
,JSDOCSTR("create a new message in message base, the <i>header</i> object may contain the following properties:<br>" ,JSDOCSTR("create a new message in message base, the <i>header</i> object may contain the following properties:<br>"
"<table>" "<table>"
"<tr><td><tt>subject</tt><td>Message subject <i>(required)</i>" "<tr><td align=top><tt>subject</tt><td>Message subject <i>(required)</i>"
"<tr><td><tt>to</tt><td>Recipient's name <i>(required)</i>" "<tr><td align=top><tt>to</tt><td>Recipient's name <i>(required)</i>"
"<tr><td><tt>to_ext</tt><td>Recipient's user number (for local e-mail)" "<tr><td align=top><tt>to_ext</tt><td>Recipient's user number (for local e-mail)"
"<tr><td><tt>to_org</tt><td>Recipient's organization" "<tr><td align=top><tt>to_org</tt><td>Recipient's organization"
"<tr><td><tt>to_net_type</tt><td>Recipient's network type (default: 0 for local)" "<tr><td align=top><tt>to_net_type</tt><td>Recipient's network type (default: 0 for local)"
"<tr><td><tt>to_net_addr</tt><td>Recipient's network address" "<tr><td align=top><tt>to_net_addr</tt><td>Recipient's network address"
"<tr><td><tt>to_agent</tt><td>Recipient's agent type" "<tr><td align=top><tt>to_agent</tt><td>Recipient's agent type"
"<tr><td><tt>from</tt><td>Sender's name <i>(required)</i>" "<tr><td align=top><tt>from</tt><td>Sender's name <i>(required)</i>"
"<tr><td><tt>from_ext</tt><td>Sender's user number" "<tr><td align=top><tt>from_ext</tt><td>Sender's user number"
"<tr><td><tt>from_org</tt><td>Sender's organization" "<tr><td align=top><tt>from_org</tt><td>Sender's organization"
"<tr><td><tt>from_net_type</tt><td>Sender's network type (default: 0 for local)" "<tr><td align=top><tt>from_net_type</tt><td>Sender's network type (default: 0 for local)"
"<tr><td><tt>from_net_addr</tt><td>Sender's network address" "<tr><td align=top><tt>from_net_addr</tt><td>Sender's network address"
"<tr><td><tt>from_agent</tt><td>Sender's agent type" "<tr><td align=top><tt>from_agent</tt><td>Sender's agent type"
"<tr><td><tt>from_ip_addr</tt><td>Sender's IP address (if available, for security tracking)" "<tr><td align=top><tt>from_ip_addr</tt><td>Sender's IP address (if available, for security tracking)"
"<tr><td><tt>from_host_name</tt><td>Sender's host name (if available, for security tracking)" "<tr><td align=top><tt>from_host_name</tt><td>Sender's host name (if available, for security tracking)"
"<tr><td><tt>from_protocol</tt><td>TCP/IP protocol used by sender (if available, for security tracking)" "<tr><td align=top><tt>from_protocol</tt><td>TCP/IP protocol used by sender (if available, for security tracking)"
"<tr><td><tt>from_port</tt><td>TCP/UDP port number used by sender (if available, for security tracking)" "<tr><td align=top><tt>from_port</tt><td>TCP/UDP port number used by sender (if available, for security tracking)"
"<tr><td><tt>replyto</tt><td>Replies should be sent to this name" "<tr><td align=top><tt>replyto</tt><td>Replies should be sent to this name"
"<tr><td><tt>replyto_ext</tt><td>Replies should be sent to this user number" "<tr><td align=top><tt>replyto_ext</tt><td>Replies should be sent to this user number"
"<tr><td><tt>replyto_org</tt><td>Replies should be sent to organization" "<tr><td align=top><tt>replyto_org</tt><td>Replies should be sent to organization"
"<tr><td><tt>replyto_net_type</tt><td>Replies should be sent to this network type" "<tr><td align=top><tt>replyto_net_type</tt><td>Replies should be sent to this network type"
"<tr><td><tt>replyto_net_addr</tt><td>Replies should be sent to this network address" "<tr><td align=top><tt>replyto_net_addr</tt><td>Replies should be sent to this network address"
"<tr><td><tt>replyto_agent</tt><td>Replies should be sent to this agent type" "<tr><td align=top><tt>replyto_agent</tt><td>Replies should be sent to this agent type"
"<tr><td><tt>id</tt><td>Message's RFC-822 compliant Message-ID" "<tr><td align=top><tt>id</tt><td>Message's RFC-822 compliant Message-ID"
"<tr><td><tt>reply_id</tt><td>Message's RFC-822 compliant Reply-ID" "<tr><td align=top><tt>reply_id</tt><td>Message's RFC-822 compliant Reply-ID"
"<tr><td><tt>reverse_path</tt><td>Message's SMTP sender address" "<tr><td align=top><tt>reverse_path</tt><td>Message's SMTP sender address"
"<tr><td><tt>path</tt><td>Messages's NNTP path" "<tr><td align=top><tt>path</tt><td>Messages's NNTP path"
"<tr><td><tt>newsgroups</tt><td>Message's NNTP newsgroups header" "<tr><td align=top><tt>newsgroups</tt><td>Message's NNTP newsgroups header"
"<tr><td><tt>ftn_msgid</tt><td>FidoNet FTS-9 Message-ID" "<tr><td align=top><tt>ftn_msgid</tt><td>FidoNet FTS-9 Message-ID"
"<tr><td><tt>ftn_reply</tt><td>FidoNet FTS-9 Reply-ID" "<tr><td align=top><tt>ftn_reply</tt><td>FidoNet FTS-9 Reply-ID"
"<tr><td><tt>ftn_area</tt><td>FidoNet FTS-4 echomail AREA tag" "<tr><td align=top><tt>ftn_area</tt><td>FidoNet FTS-4 echomail AREA tag"
"<tr><td><tt>ftn_flags</tt><td>FidoNet FSC-53 FLAGS" "<tr><td align=top><tt>ftn_flags</tt><td>FidoNet FSC-53 FLAGS"
"<tr><td><tt>ftn_pid</tt><td>FidoNet FSC-46 Program Identifier" "<tr><td align=top><tt>ftn_pid</tt><td>FidoNet FSC-46 Program Identifier"
"<tr><td><tt>ftn_tid</tt><td>FidoNet FSC-46 Tosser Identifier" "<tr><td align=top><tt>ftn_tid</tt><td>FidoNet FSC-46 Tosser Identifier"
"<tr><td><tt>date</tt><td>RFC-822 formatted date/time" "<tr><td align=top><tt>date</tt><td>RFC-822 formatted date/time"
"<tr><td><tt>attr</tt><td>Attribute bitfield" "<tr><td align=top><tt>attr</tt><td>Attribute bitfield"
"<tr><td><tt>auxattr</tt><td>Auxillary attribute bitfield" "<tr><td align=top><tt>auxattr</tt><td>Auxillary attribute bitfield"
"<tr><td><tt>netattr</tt><td>Network attribute bitfield" "<tr><td align=top><tt>netattr</tt><td>Network attribute bitfield"
"<tr><td><tt>when_written_time</tt><td>Date/time (in time_t format)" "<tr><td align=top><tt>when_written_time</tt><td>Date/time (in time_t format)"
"<tr><td><tt>when_written_zone</tt><td>Time zone" "<tr><td align=top><tt>when_written_zone</tt><td>Time zone"
"<tr><td><tt>when_imported_time</tt><td>Date/time message was imported" "<tr><td align=top><tt>when_imported_time</tt><td>Date/time message was imported"
"<tr><td><tt>when_imported_zone</tt><td>Time zone" "<tr><td align=top><tt>when_imported_zone</tt><td>Time zone"
"<tr><td><tt>thread_back</tt><td>Message number that this message is a reply to" "<tr><td align=top><tt>thread_back</tt><td>Message number that this message is a reply to"
"<tr><td><tt>thread_next</tt><td>Message number of the next reply to the original message in this thread" "<tr><td align=top><tt>thread_next</tt><td>Message number of the next reply to the original message in this thread"
"<tr><td><tt>thread_first</tt><td>Message number of the first reply to this message" "<tr><td align=top><tt>thread_first</tt><td>Message number of the first reply to this message"
"<tr><td><tt>field_list[].type</tt><td>Other SMB header fields (type)" "<tr><td align=top><tt>field_list[].type</tt><td>Other SMB header fields (type)"
"<tr><td><tt>field_list[].data</tt><td>Other SMB header fields (data)" "<tr><td align=top><tt>field_list[].data</tt><td>Other SMB header fields (data)"
"</table>" "</table>"
"<br>" "<br>"
"The optional <i>client</i> argument is an instance of the <i>Client</i> class to be used for the " "The optional <i>client</i> argument is an instance of the <i>Client</i> class to be used for the "
"security log header fields (e.g. sender IP addres, hostname, protocol, and port). " "security log header fields (e.g. sender IP address, hostname, protocol, and port). "
"<br>" "<br><br>"
"The optional <i>rcpt_list</i> is an array of objects that specifies multiple recipients " "The optional <i>rcpt_list</i> is an array of objects that specifies multiple recipients "
"for a single message (e.g. bulk e-mail). Each object in the array may include the following header properties " "for a single message (e.g. bulk e-mail). Each object in the array may include the following header properties "
"(described above): <br>" "(described above): <br>"
...@@ -1797,6 +1797,8 @@ js_msgbase_constructor(JSContext *cx, JSObject *obj, uintN argc, jsval *argv, js ...@@ -1797,6 +1797,8 @@ js_msgbase_constructor(JSContext *cx, JSObject *obj, uintN argc, jsval *argv, js
} }
if(p->smb.subnum<scfg->total_subs) { if(p->smb.subnum<scfg->total_subs) {
cfgobj=JS_NewObject(cx,NULL,NULL,obj); cfgobj=JS_NewObject(cx,NULL,NULL,obj);
JS_DefineProperty(cx,cfgobj,"index",JSVAL_VOID
,NULL,NULL,JSPROP_ENUMERATE|JSPROP_READONLY);
js_CreateMsgAreaProperties(cx, scfg, cfgobj, p->smb.subnum); js_CreateMsgAreaProperties(cx, scfg, cfgobj, p->smb.subnum);
#ifdef _DEBUG #ifdef _DEBUG
js_DescribeSyncObject(cx,cfgobj js_DescribeSyncObject(cx,cfgobj
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment