Both sides previous revisionPrevious revisionNext revision | Previous revision |
module:msglist [2020/03/02 23:54] – [Read Mail and List Msgs System Modules] rename this sub-section digital man | module:msglist [2025/01/06 12:44] (current) – [Command-Line Options] Document more command-line options digital man |
---|
For full/proper function of this module, you'll need a recent v3.17c dev-build (as of March, 2020) of Synchronet, or later. | For full/proper function of this module, you'll need a recent v3.17c dev-build (as of March, 2020) of Synchronet, or later. |
| |
This module may require a [[dev:cvs]]-update of your Synchronet ''exec/[[dir:load]]'' directory to get the latest ''.js'' load-libraries, including the newly added ''age.js''. | This module may require an update of your Synchronet ''exec/[[dir:load]]'' directory to get the latest ''.js'' load-libraries, including the newly added ''age.js''. |
| |
The following menu files are used by this module: | The following menu files are used by this module: |
==== Menu Command ==== | ==== 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): | If you wish to allow your BBS users to list sub-board messages directly from a Baja 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): |
| |
| for Synchronet v3.18 or later: |
| |
| <code> |
| cmdkey L |
| msg_list |
| end_cmd |
| |
| </code> |
| |
| for Synchronet v3.17 or older: |
| |
<code> | <code> |
| |
... and then recompile the source file with [[util:baja]] (e.g. ''baja default.src''). | ... and then recompile the source file with [[util:baja]] (e.g. ''baja default.src''). |
| |
| In Synchronet v3.20, the default command shell (''default.js'') already has main menu ''L'' command key mapped to the BBS message list function. |
| |
===== Configure ===== | ===== Configure ===== |
| ''-spam'' | Only load SPAM-tagged messages | | | ''-spam'' | Only load SPAM-tagged messages | |
| ''-unread'' | Only load unread messages | | | ''-unread'' | Only load unread messages | |
| | ''-send'' | List sent mail | |
| | ''-all'' | List all mail | |
| ''-reverse'' | Reverse the default message list order | | | ''-reverse'' | Reverse the default message list order | |
| | ''-sort=//property//'' | Specify a property name to sort list by | |
| | ''-new=//days//'' | List only messages added/imported in last number of days | |
| | ''-fmt=//format//'' | Specify list format string | |
| | ''-p=//prop-list//'' | Specify comma-separated list of property names for columns | |
| | ''-hdr'' | Include a header when executed offline (e.g. via''[[util:jsexec]]''). | |
| | ''-count'' | Display only total number of messages | |
| | ''-all_subs'' | List all sub-boards | |
| | ''-hide_zero'' | Don't list subs with no (new) messages | |
==== modopts.ini ==== | ==== modopts.ini ==== |
| |
| |
^ Option ^ Default ^ Description ^ | ^ Option ^ Default ^ Description ^ |
| | ''reverse_mail'' | true | List mail messages in reverse chronological order (newest first) by default | |
| | ''reverse_msgs'' | true | List sub-board messages in reverse chronological order (newest first) by default | |
| ''cache_msg_text'' | false | Cache message text in memory | | | ''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 | | | ''large_msg_threshold'' | 64 KBytes | Message text larger than this value will not be cached in memory | |
| ''date_fmt'' | %Y-%m-%d | Format of dates displayed in list | | | ''date_fmt'' | %Y-%m-%d | Format of dates displayed in list | |
| ''date_time_fmt'' | system default | Format of date/time displayed in list | | | ''date_time_fmt'' | system default | Format of date/time displayed in list | |
| | ''pause'' | true | Pause for a key-press after posting a message, or set to a duration (in seconds), or ''false'' | |
| ''beep'' | true | Console alerts/beeps are enabled | | | ''beep'' | true | Console alerts/beeps are enabled | |
| ''view_lines_fmt'' | "%slines %u-%u" | Displayed string | | | ''view_lines_fmt'' | "%slines %u-%u" | Displayed string | |