LAKOTA Mail System
This transcription preserves the original wording, commands, examples, and text diagrams. Only DOS end-of-file markers, form-feed breaks, and repeated printed page furniture have been removed for continuous reading.
LAKOTA
SPITFIRE MAIL SYSTEM
Version 2.0
Copyright (C) by Mike Woltz, 1993-1999
Buffalo Creek Software
INTRODUCTION
------------
LAKOTA is a companion utility designed to work with the SPITFIRE
Bulletin Board System. SPITFIRE Version 3.3 or greater offers an
option from the Message Menu called LAKOTA (QWK Mail System). When
a caller selects this option, SPITFIRE shells to LAKOTA.COM. LAKOTA
allows the caller to extract messages for download and to upload
reply packets, inserting the caller's messages into the SPITFIRE
message base. LAKOTA is written in Assembler which contributes to
its speed and compact file size.
USAGE
-----
LAKOTA.COM must reside in the SPITFIRE home directory. LAKOTA
uses Phil Katz's PKZIP, PKUNZIP and Chuck Forsberg's DSZ. These
files must reside in a directory that is located in your path statement
or in your SPITFIRE home directory. For more information on defining
file paths refer to your DOS documentation. Versions of PKZIP newer
than version 1.10 require a tremendous amount more memory than did
PKZIP version 1.10. In the event you discover that there is not
enough memory available to utilize a version of PKZIP newer than version
1.10 then simply place a copy of PKZIP.EXE (v1.10) in your SPITFIRE
HOME directory. LAKOTA will then use the copy of PKZIP in the SPITFIRE
HOME directory before looking through your PATH to find it.
Upon selecting <L>.... LAKOTA (QWK Mail System) option from the
Message Menu of SPITFIRE, SPITFIRE shells to LAKOTA and the following
menu is displayed:
╔═════[ WELCOME TO SPITFIRE'S MAIL SYSTEM]════╗
║ LAKOTA Version 2.0 ║
║ Buffalo Creek Software ║
║ Copyright (C) by Mike Woltz, 1993-1999 ║
║ Utilizing QWK Message Packet Format ║
╚═════════════════════════════════════════════╝
<D>............. Download Messages (QWK Format)
<U>............... Upload Messages (QWK Format)
<S>............. Set Last Read Message Pointers
<Q>....................................... Quit
LAKOTA MAIN MENU - [D U S Q]?
CONFIGURATION
-------------
When LAKOTA is first installed on your BBS, it must be configured
for your system. To configure LAKOTA, log on to the BBS locally and
select <L>...LAKOTA (QWK Mail System) from the Message Menu. LAKOTA
will provide a series of prompts. The information you enter in
response to these prompts is used to create the configuration file.
The configuration prompts Lakota will present include:
Enter the name of your BBS:
Simply respond by entering the name of your BBS.
Enter your city & state/province:
Respond with the city and state/province where your BBS is located.
Enter your BBS phone number:
Key in the phone number to your BBS, including area code.
Enter the name of the Sysop of your BBS:
Normally you will want to respond by entering your name, followed
by a comma and then the word Sysop. (See example below.)
Enter QWK BBS identification name:
Respond with the name which will be used to identify your BBS. This
is a single word of up to eight characters and is used to identify
your BBS in QWK mail exchanges.
A sample configuration for Buffalo Creek's BBS would look like this:
Enter the name of your BBS: Buffalo Creek's BBS
Enter your city & state/province: West Des Moines, Iowa
Enter your BBS phone number: 515-225-8496
Enter the name of the Sysop of your BBS: Mike Woltz, Sysop
Enter QWK BBS identification name: BUFFALO
UNDOCUMENTED SPITFIRE FEATURE
-----------------------------
SPITFIRE supports an undocumented feature related to LAKOTA.
Immediately before SPITFIRE shells to LAKOTA, a display named
LAKOTA.BBS/CLR will be displayed if SPITFIRE finds such file in
your DISPLAY directory. The purpose of this display file is to
provide your callers with information regarding LAKOTA which you
may feel is important. You will find both LAKOTA.BBS and LAKOTA.CLR
included in this package. In the event you wish to use these
display files, you will simply have to copy them into your DISPLAY
directory.
DOWNLOADING MESSAGES
--------------------
When a caller elects to download messages using the LAKOTA (QWK
Mail System) option, a check is made to determine if the available disk
space is sufficient. (The disk space available on the BBS must be equal
to or greater than that which the Sysop has configured using SPITFIRE's
(ALT+Z) Upload Disk Space Requirement.) In the event the amount of
available disk space is inadequate, LAKOTA displays the message:
"Sorry but there is not enough disk space!"
Otherwise the following menu is displayed:
>>>> Download Message Menu <<<<
<N>................New Messages
<T>......................To You
<Q>........................Quit
DOWNLOAD MENU - [N T Q]?
"New Messages" are messages newer than the message pointed to by
the last read message pointer for each Message Conference.
"To You" are messages specifically addressed to the caller.
"Quit" will return the caller to LAKOTA's Main Menu.
Once the caller has selected the option of New Messages or To You,
a second menu is presented. The Message Conference Menu allows the
caller to further define which messages will be extracted by selecting
which conferences are to be included in the download packet.
>>>> Message Conference Menu <<<<
<A>...............All Conferences
<B>...........Select A Conference
<C>.......Your Queued Conferences
<Q>..........................Quit
CONFERENCE MENU - [A S Y Q]?
All Conferences - Will extract messages from all available message
conferences (those to which the caller has security to access) according
to the previously selected criteria (New Messages/To You).
Select A Conference - Will prompt the caller to enter the number
of the message conference from which messages will be extracted
according to the previously selected criteria (New Messages/To You).
Your Queued Conferences - Will extract messages according to the
previously selected criteria (New Messages/To You) from all message
conferences in the caller's queue.
Quit - Returns the caller to LAKOTA's Main Menu.
If the caller has Sysop Security, LAKOTA will then prompt the
caller with:
"Update last read message pointers? [y/N] ".
In the event the caller selects "No", LAKOTA will not mark the caller's
messages as received and will not update the caller's last read message
pointers. When the caller selects "Yes", then the messages are marked
as received and the last read message pointers are updated just as if
the caller did not have Sysop Security.
During the message extraction process, LAKOTA will display
the following messages for each conference processed:
You last read message number #<X> of <X>
(where the first <X> represents the last message number
read in this Message Conference and the second <X>
represents the total number of messages available in
the Message Conference being processed.)
Processing Message Conference #<X> <Message Conference Description>
(where <X> represents the number of the Message Conference
and <Message Conference Description> is the configured
description of the Message Conference being processed).
As the messages are processed, a sliding graph is used to
illustrate the progress of the message extraction process. The
graph is divided into increments of 20 percent; showing 0, 20, 40
60, 80, and 100 percent completion of the message extraction.
Once the message(s) have been extracted from the SPITFIRE message
base, the extracted messages will be archived in ZIP format and the
following message will display to the caller:
Creating (zipping) <BBS QWK Identification>.QWK ... please stand by!
(the BBS QWK Identification will correspond to the BBS QWK
Identification defined during LAKOTA's configuration.)
If the caller has logged on locally, the <BBS QWK Identification>.QWK
packet will be created in the SPITFIRE home directory. If this file
(<BBS QWK Identification>.QWK) already exists, it will be overwritten
when the new mail packet is created.
If the caller has called the BBS from a remote location (via modem)
the filename is displayed along with the total number of bytes the
file contains. For example:
<BBS QWK Identification>.QWK : 117,341 Bytes
Next, the File Transfer Protocol Menu is displayed to the remote
caller:
File Transfer Protocols
<X>..............Xmodem
<Y>..............Ymodem
<Z>..............Zmodem
<Q>................Quit
PROTOCOL MENU - [X Y Z Q]:
The caller may then select the download protocol of their choice
from XModem, YModem or ZModem. The caller may also opt to Quit and
return to LAKOTA's Main Menu. Once a protocol is selected, the caller
should initiate the download process from within their communications
program to begin the file transfer.
LAKOTA includes display files in the created QWK packet. These
display files are WELCOME1.CLR and GOODBYE.CLR from your DISPLAY
directory (when found). LAKOTA also includes a display named
NEWSFILE.CLR when this file is found in the SPITFIRE HOME directory.
This file can be used to provide the caller with whatever information
you believe is important, however, the default NEWSFILE.CLR which is
included in the LAKOTA distribution package is used to explain the
features of LAKOTA.
LAKOTA creates and includes a <QWK BBS identification name>.LMR file
in the QWK packet. This file contains a record of the 'last message
read pointers' for the messages conferences which are included in the
downloaded QWK packet. In the event this file is placed in a .REP file
and then uploaded to LAKOTA, the caller's last message read pointers
will be reset using the information contained in the .LMR file.
UPLOADING MESSAGES
------------------
When logged on locally and a caller selects to Upload Messages in
QWK Format, the following prompt is displayed provided the required
amount of upload disk space exists per the amount configured by the
Sysop in SPITFIRE (ALT+Z). In the event there is inadequate disk space,
then LAKOTA displays the message "Sorry but there is not enough disk
space!" otherwise the following prompt is displayed::
File must be in .ZIP format!
Enter name of the file to import:
The first character you enter should be the drive letter where the
file to be uploaded is located. LAKOTA will automatically insert the
semi-colon and the backslash after this letter is entered. (In other
words, if you input the letter C, LAKOTA will then place the :\ after
this character to make it "C:\".) Next enter the path and file name
of the file you will import. LAKOTA will import messages from this
file directly into SPITFIRE's message base.
If a caller logs on to the BBS from a remote location (via modem)
and selects LAKOTA's option to Upload Messages, the caller is presented
a menu of File Transfer Protocols:
File Transfer Protocols
<X>..............XModem
<Y>..............YModem
<Z>..............ZModem
<Q>................Quit
PROTOCOL MENU - [X Y Z Q]:
from which a protocol will be selected to perform the file transfer
of the message mail packet or the caller may quit and be returned
to LAKOTA's Main Menu. Once a protocol is selected, the caller
should initiate the upload process from within their communications
program.
LAKOTA adds the number of messages uploaded to the caller's record
in SPITFIRE. In other words, if the caller had entered 197 messages
and then uploaded 7 messages, SPITFIRE would then credit the caller
with 204 messages entered. LAKOTA also adds the number of messages
uploaded to SPITFIRE's total number of messages entered for the day.
SET LAST MESSAGE READ POINTERS
------------------------------
Selecting this option from Lakota's Main Menu allows the caller
to update their last message read pointers. The Message Conference
menu is displayed to allow the caller to specify which conference(s)
should be included when setting the last message read pointers.
>>>> Message Conference Menu <<<<
<A>...............All Conferences
<B>...........Select A Conference
<C>.......Your Queued Conferences
<Q>..........................Quit
CONFERENCE MENU - [A S Y Q]?
All Conferences - will display the following prompt for each
Message Conference available to the caller:
Message Conference #<X>
(where <X> is the number corresponding the Message
Conference number)
You last read msg #<X> of <X>
(where the first <X> represents the last message number
read in this Message Conference and where the second <X>
represents the total number of messages available in
this Message Conference.)
Enter message number:
The number entered here will reset the caller's last message read
pointer to the corresponding message number in this conference.
Pressing enter, without entering a number, allows the caller to
continue without updating the last message read pointer for this
conference.
This process will continue until the caller has been prompted to set
their last read message pointer for each conference available to them
on the BBS.
Select A Conference - allows the caller to select a specific conference
in which to set the last message read pointer. LAKOTA will prompt the
caller with:
Change last message read for which conference?
After the caller enters the number of the conference, the following
prompt is displayed:
You last read msg #<X> of <X>
(where the first <X> represents the last message number
read in this Message Conference and where the second <X>
represents the total number of messages available in
this Message Conference.)
Enter message number:
The number entered here will reset the caller's last message read
pointer to the corresponding message number for this conference.
Pressing enter, without entering a number, allows the caller to
continue without updating the last message read pointer for this
conference.
Your Queued Conferences - will display the following prompt for each
Message Conference in the caller's message queue:
Message Conference #<X>
(where <X> is the number corresponding the the Message
Conference number)
You last read msg #<X> of <X>
(where the first <X> represents the last message number
read in this Message Conference and where the second <X>
represents the total number of messages available in
this Message Conference.)
Enter message number:
The number entered here will reset the caller's last message read
pointer to the corresponding message number in this conference.
Pressing enter, without entering a number, allows the caller to
continue without updating the last message read pointer for this
conference.
This process will continue until the caller has been prompted to set
their last read message pointer for each conference within their
message queue.
Quit - Returns the caller to LAKOTA's Main Menu.
MESSAGE ROUTING SUPPORT
-----------------------
LAKOTA supports SPITFIRE's message routing feature provided the
message conference has been configured as a netmail conference.
Routing a message will prevent the message from going out to every
participant on the net. However, even when routed, the message must
still travel the logical path to arrive at its routed destination.
In other words, it must go from the end node to the local hub, regional
hub, and the destination's local hub before arriving at the final
routing destination.
To route a message through Lakota using an offline mail reader, the
body of the message is used to indicate where the message will be routed
to. The routing information must start on the first line of the message
and it is must start on the first space of the message body. (In other
words, it must begin at column 1, row 1). There can be no blank lines
and no blank spaces at the beginning of the message if you want your
message routing attempts to be successful.
The routing information (which is placed one the first line, first
character of the message body) should consist of a dash, directly
followed by a greater than sign and then followed with the Node ID of
the BBS to where the message will be routed. For example:
FROM:Mike Woltz
TO:Jacque Shipley
SUBJECT:LAKOTA Routing
->A0515000
Notice there are no blank spaces in the routing information that is
placed on the first line of the message body. Also, there should be
no trailing spaces after the routing information which is entered on
the first line of the message body. In addition, there should be no
other text entered on the first line of the message where the routing
information is entered.
When the steps outlined above are used and the message is uploaded
through LAKOTA, LAKOTA will update the message routing information as it
imports the message into the SPITFIRE message base.
MAINTAINING CONFERENCE QUEUE IN LAKOTA
--------------------------------------
LAKOTA also includes a feature which allows the caller to maintain
their SPITFIRE Message Conference queue. There are two methods by
which the caller can add or delete Message Conferences in their
queue.
In the first method, the caller uses the message subject header
to pass the information to Lakota for maintaining their message
queue. The message entered through the offline reader must be
addressed to Lakota and then the message subject is simply ADD
if you wish to add the conference to the message conference queue
or DROP if you wish to remove the conference from the message
conference queue. Below are examples of each:
FROM:Mike Woltz FROM:Mike Woltz
TO:Lakota TO:Lakota
SUBJECT:ADD SUBJECT:DROP
Notice, there are no blank spaces in the subject field, only the word
ADD or DROP. When the message is uploaded through Lakota, the conference
where the message was entered will either be added or deleted from the
callers message queue.
The other method Lakota uses to maintain a callers conference queue
is the message body. The word ADD or the word DROP must be placed
on the first line and in the first space of the message body. There
should be no other text in the body of the message. For example:
FROM:Mike Woltz FROM:Mike Woltz
TO:Lakota TO:Lakota
SUBJECT:Anything You Like SUBJECT:Anything You Like
ADD DROP
The word ADD or DROP must appear in the first line of of the message
body. The word ADD or DROP must begin on the first space of the
message line. (Column 1, Row 1). In other words, there can be no
leading blank spaces preceding the word ADD or DROP. The body of the
message should contain no other text.
When this message is uploaded through Lakota, the conference in
which the message was entered will either be added or deleted from
the callers message queue. In addition, the message will automatically
be marked for deletion.
DISTRIBUTION PACKAGE
--------------------
When decompressed, the distribution package, LAKOTA.ZIP, should
contain the following files:
FILE_ID.DIZ - Text file containing short program description
LAKOTA.BBS - ASCII display file
LAKOTA.CLR - ANSI display file
LAKOTA.COM - Executable message packer file
LAKOTA.DOC - This documentation file
NEWSFILE.CLR - Optional display file
You are free to distribute the LAKOTA program as long as it remains
unmodified and no fee is charged. Sysops are free to post this and
subsequent versions of LAKOTA on public Bulletin Board Systems as
long as no fee is charged to obtain the file.
SPECIAL THANKS
--------------
Mike Woltz and Buffalo Creek Software would like to extend a
special thank you to Tom Lehner for his participation in the
beta-testing of LAKOTA during its development stages. There are
quite a number of people who participated in the development of
LAKOTA whose assistance was appreciated as well. Thanks!
Further, special thanks goes to the native Americans for
the word LAKOTA.
REGISTRATION
------------
LAKOTA is distributed under the shareware concept. You may use
the files included within LAKOTA.ZIP for a trial period of thirty
days. If you continue to use these programs beyond the thirty day
trial period a $1.00 registration fee is required. Registration
should be sent to:
Buffalo Creek Software
ATTN: Mike Woltz
913 39th Street
West Des Moines, Iowa 50265
DISCLAIMER
----------
Mike Woltz and/or Buffalo Creek Software shall in no way be
held responsible for any damage incurred while operating LAKOTA.
All responsibility lies with the user of the software.
The documentation for LAKOTA is contributed by Jacque
Shipley. The shareware version of SPITFIRE and other SPITFIRE
utilities are available for download from:
Buffalo Creek's BBS
Mike Woltz, Sysop
(515) 225-8496
57600 - 1200 Baud
REVISION HISTORY
----------------
Version 1.4 Released September 3, 1994
Some general clean up of LAKOTA v1.3.
Mail routing capability feature added.
Conference queue maintenance feature added.
Version 1.5 Released December 22, 1995 along with
SPITFIRE v3.51.
Version 2.0 Released August 17, 1999.
LAKOTA v2.0 was revised to be Y2K in addition to changes so LAKOTA
will work properly on HUGE disk drives.