This is an old revision of the document!
Table of Contents
Message Listing / Viewing
This module (msglist.js
) can be used as a full-screen scrolling user interface for listing messages (public posts and private email messages) and reading and replying to messages.
This module was first demonstrated in this video.
Install
Read Mail and List Msgs System Modules
Run jsexec msglist.js -install
.
This procedure this will configure the “Read Mail” and “List Msgs” modules in SCFG->System->Loadable Modules with command-lines that call this module to handle those system functions from all built-in menus and stock command shells.
Menu Command
If you wish to allow your BBS users to list sub-board messages directly from a command shell menu (e.g. using the 'L' command key from the main or message menu) add the following command key handler to the desired command shell source (.src
) file(s):
cmdkey L exec_bin "msglist" end_cmd
... and then recompile the source file with baja (e.g. baja default.src
).
Configure
The behavior of this module is sysop-configurable through the use of command-line arguments and the modopts.ini
file.
Command-Line Options
Option | Description |
---|---|
-preview | Enable the message preview pane by default |
-nospam | Don't load SPAM-tagged messages |
-spam | Only load SPAM-tagged messages |
-unread | Only load unread messages |
-reverse | Reverse the default message list order |
modopts.ini
The [msglist]
section of the modopts.ini
file may be created by the sysop to customize the look-and-feel of this module. If a [msglist:<code>]
section exists (e.g. [msglist:mail]
for the mail message base), then those settings will take precedence when the module is being used to list/view messages in the message base with the specified internal code.
Option | Default | Description |
---|---|---|
cache_msg_text | false | Cache message text in memory |
large_msg_threshold | 64 KBytes | Message text larger than this value will not be cached in memory |
preview_separator | '\xC4' | Character for Preview Pane separator |
preview_properties | date,attributes,subject | Properties to display in the Preview Pane separator |
preview_properties_fmt | “\xd9 %s \xc0” | Displayed string format |
preview_properties_maxlen | 10 | Maximum length of a previewed property value |
preview_properties_separator | “, ” | Separator to use between previewed property values |
hide_redundant_properties | true | Repeated property columns are automatically hidden |
date_fmt | %Y-%m-%d | Format of dates displayed in list |
date_time_fmt | system default | Format of date/time displayed in list |
beep | true | Console alerts/beeps are enabled |
view_lines_fmt | “%slines %u-%u” | Displayed string |
view_total_lines_fmt | “ of %u” | Displayed string |
view_line_range_fmt | “\x01n\x01h\x01k[%s]” | Displayed string |
preparing_preview_fmt | “%25s” | Displayed string |
reading_message_text | “\x01[Reading message text ...” | Displayed string |
preparing_hex_dump | “\x01[Preparing hex-dump ...” | Displayed string |
translating_charset | “\x01[Translating charset ...” | Displayed string |