OS/2 Shareware BBS: 2 BBS/02-BBS.zip/tmail100.zip/tmail.HLP

OS/2 Help File | 1997-01-24 | 21KB | 609 lines

ΓòÉΓòÉΓòÉ 1. Menu ΓòÉΓòÉΓòÉ

tMail is a Fidonet technology mailer. It uses ArcMailAttach type mail
management, version 7 nodelists and EMSI handshaking with WaZoo and Zmodem
transfers.

tMail is written for the OS/2 PM GUI. An HPFS formatted drive is required.

tMail is FreeWare. There is a lot that it can't do and it probably isn't
suitable for large 'super' systems. For one thing, it is single-line only. You
could probably fake out a multi-line set-up with the right .CMD files and flags
but I leave that to your imagination. If you need more than tMail offers then
you should look into a more powerful program.

However for a smaller system tMail contains lots of features (some of which
even the bigger packages don't have).

Beta
License
Main Window
Configuration Window #1
Configuration Window #2
Schedule Configuration
Button Configuration
Poll Window
Get/Send File Window
OutBound Management

Context sensitive help is available at any time by pressing F1.

Although tMail is FreeWare  I would like to know where it is being used and by
how many so feel free to send me a postcard or e-mail or nude pictures of your
wife. ;)

Simon Ewins
102 Cleveland Street
Toronto, Ontario
CANADA
M4S 2W5

[e-mail]
[e-mail]

Latest version at: www.241pizza.com/sje

Comments and suggestions welcome.


ΓòÉΓòÉΓòÉ 2. Main Window ΓòÉΓòÉΓòÉ

The Main Window contains a selection box which will contain all outbound
packets. This window is actually a summary of the files that are found in what
has been defined as the 'outbound' directory. The files in that directory are
named according to the following convention:

   <type>.<zone>.<net>.<node>.<point>.Q

   <type> can be C for Crash entries
              or H for Hold
              or P for Poll

   C.1.250.0.0.Q would be a:

     Crash packet for 1:250/0.0

Double clicking an entry in this box will force an immediate call (unless the
entry is a Hold type).

Each line in the Q file is the name of a file to send (P types are empty files)
to the system who's address comprises the name of the Q file. The first 'word'
in each line is a number that indicates some action that is associated with the
file name that follows. A 0 indicates that the file is to be left alone once
sent. A 1 indicates that the file is to be truncated to zero length once it has
been sent. A 2 indicates that the file is to be deleted after it has been sent.

Other values are as yet undefined but 3-9 are reserved for future use.

Under the outbound list window are two checkboxes, Answer and Call. If these
are checked then that action will be allowed. If they aren't checked then the
associated action will not be allowed. So, to stop tMail from answering calls
simply 'uncheck' the Answer box. To allow the system to answer incoming calls
make sure that the box is checked. The same applies to making outbound calls by
checking or unchecking the Call checkbox.

This can also be accomplished by external programs by creating a file in the
tMail home base directory called ANSWER.OFF, CALL.OFF, ANSWER.ON or CALL.ON as
required.

If tMail finds an ANSWER.OFF file it will uncheck the Answer checkbox, if it
finds a CALL.OFF file then it will uncheck the Call checkbox. These files are
deleted after the appropriate checkbox is cleared.

To have an external program check the checkboxes create a file in the tMail
home base directory called either ANSWER.ON or CALL.ON as required. These files
are also deleted once they have been dealt with.

The main window also contains a log that lists activity since the last inbound
call. All activity is also written to a disk-based log file. The current date
and time is displayed to the upper right of this list box.

The status line will indicate what the current status of the program is. It
also displays the current progress during a file transfer.

The last call line indicates what the last call was. If the last call was a BBS
call that will be so indicated. If it was a mailer call then as many AKAs as
will fit will be displayed.

Under the status line are nine buttons marked U1 through U9. These may be
defined as .CMD files that will be executed when the buttons are pressed. They
may also be activated via external programs by writing a Ux.BTN file (where the
'x' is the number of the button to be 'pressed') to the home base directory of
the running tMail program.

Below that are another nine buttons. The first three (Toss, Scan and NtScn) run
.CMD files that are user definable. These may also be 'pressed' by external
programs through the creation of a ?.BTN file where the '?' is replaced with
the name of the button (TOSS.BTN, SCAN.BTN or NTSCN.BTN). Toss is intended to
run your mail tosser and this is the same .CMD file as the one that is executed
after either an inbound or an outbound  call is dealt with. Scan is intended to
be a .CMD file that runs your message scanner/packer software and NtScn would
scan only your netmail area.

In addition to these external *.BTN files that can cause an action to take
place, you may also create a #.TMX file in the home base directory of the
running tMail program. If one of these files is found tMail will exit with an
errorlevel equal to the '#' part of the file name. If tMail is run from a .CMD
file (recommended) then this can be used to exit for certain events where it
may be necessary for tMail to release the COM port and exit before execution.

It is possible to schedule such exits by scheduling an execution of a small
.CMD file that simply creates an appropriate #.TMX file as required.

The remaining 6 buttons on the second row are:

[Sched]
Opens the schedule configuration window.

[Config]
Opens the configuration window(s).

[Poll]
Requests an address to poll and creates a P-type Q file.

[Send]
Requests an address and the name of a file to send.

[Get]
Requests an address and the name of a file (or 'magic'
name) to request from them with an optional password.

[OBM]
Allows for renaming outbound Q files (re-addressing and flavour
changes) or deleting them altogether.

The last button in the lower right corner is red and will say either Quit or
Cancel depending upon what the current state of tMail is. If it says Cancel
then the current activity will be cancelled and the button will change to Quit.
If it is pressed when it says Quit then tMail will exit with an errorlevel of
0.


ΓòÉΓòÉΓòÉ 3. Configuration Window #1 ΓòÉΓòÉΓòÉ

In this window you can enter the following data:

[Modem Data]

Init, PreDial, PostDial and Answer strings for your modem. Beyond regular ASCII
characters the following characters have special signifigance in one of these
strings:

  v  Lowers DTR
  ^  Raises DTR
  ~  Delays 1/2 second
  `  Delays 1/20 second
  |  Sends a carriage-return

  The Init string:  v~~^~~AT&F1W2M0L0|

  Lowers DTR, waits 1 second, raises DTR, waits 1 second,
  sends AT&F1W2M0L0, and then sends a carriage return

You can also select the initialization baudrate using the Baudrate spin-button.
The available rate range is from 300 to 115200 bps.

The Port to use can be selected from the choices 1-4 and the port may be locked
at the baudrate selected by checking the Locked checkbox. This is always the
desirable case with a high-speed modem.

The CallDelay spin button allows you to enter the number of seconds that tMail
will wait between rescanning the netmail area, outbound area and calling any
systems that are pending and then initializing the modem and waiting again.
During this period of time tMail watches the modem to see if a RING occurs and,
if so, it will answer any incoming calls.  The red button in the main window
will say Cancel while this waiting is going on.

If you click Cancel this will end the delay/wait period, check the netmail
area, outbound directory and make a call.  The start of each delay period is
when the modem is initialized.

[Directories]

The Known directory is where inbound mail/files are received from systems that
are not in your password section but are in the nodelist.

The Unknown directory is where inbound mail/files are placed when the connected
system is not listed in the nodelist and is not listed in the password section
of your tMail configuration.

The Secure directory is where inbound mail/files are placed when the system
sending them is listed in the password section of the first configuration
window.

The OutBound directory is where tMail builds its Q files and stores temporary
netmail packets that are waiting to be sent out.

The NetMail directory is a Fido *.MSG type netmail message directory.  The
messages in this area should include any ArcMailAttach messages created by your
scanner/packer.

The Log directory is where the tMail.Log file will be written.

The NodeList directory is the location where a Version7 compilation of a St.
Louis nodelist is stored.  There are many programs available to create this
type of list from a raw nodelist.

[Passwords]

This list is the list of up to 100 passwords for specified systems. To remove a
passworded system from the list highlight it and then click Remove.  To add a
new one you can enter the address, password, phone number and name of the
system in the entry field above the list and then click on Add.

The list can also be used for phone number overrides by just entering the
system address and the phone number.  However any of the three possible entries
for an address may be left out but a dash '-' must be used as a place holder
for any missing data.

The address may be entered as a partial address and the missing parts will be
filled in for you.  If your main address is 1:250/664 then entering:

  601 password

Will expand to '1:250/601.0 password' in the list when Add is clicked.

To enter a phone number override but not set up a password with a system enter:

  601 - 416-555-5555

Notice that data may be left out from the end of the entered string but not
from any field before the end of the entered string.

To enter a name only for an address but leave out the password and phone number
enter:

  1:250/0.0 - - Net250_Host

Note that no spaces are allowed in the name or any other fields.

To change an entry in this list you must Remove it and then Add a new one to
replace it.

All entries in this list that are not in the nodelist are assumed to be CM type
systems.

tMail assumes that the first AKA presented by another system is the primary
address for that system.  It also assumes that your password entries are for
primary addresses of other systems.  If you find that the password entered is
not recognized or that Secure inbounds are only Known or Unknown then you will
need to look in the tMail.Log file and set a password for the address that is
the first one in the AKA list presented by the other system.

For example:  My feed for some local areas is 250/501 but the AKAs that that
system presents start with his 250/99 address.  All my connections were seen as
Known and not as Secure.  By adding a password for 250/99 this problem is
resolved.

[Export and Import Buttons]

If you are entering a lot of passworded systems or you prefer to work with an
ASCII text file for your configuration you can Export the current configuration
to a text file called tMCfg.Txt in the home base directory used by tMail.  This
text file is of the form key=data on each line.  You should export a current
configuration and examine the resulting file carefully before attempting to
import data.

The same file can be imported into your configuration by clicking the Import
button.  After importing it is strongly suggested that you exit tMail and then
run it again to save the configuration in the tMail.Dat config file.  In fact,
if changes are made to the communication parameters you MUST do this exit and
re-run routine.

A description of the syntax for each key follows.  Everything to the left of
the = must be as indicated and the = MUST be present with no intervening
spaces. The key MUST start in column one.

 port=<port number 1-4>

 baud=<baudrate must be one of
       300, 1200, 2400, 4800, 9600, 14400,
       19200, 38400, 57600, 115200>

 calldelay=<seconds from 60 to 3600>

 locked=<a Y or an N>

 mdminit=<init string>

 mdmpredial=<predial string>

 mdmpostdial=<postdial string>

 mdmanswer=<answer string>

 known=<directories MUST have a trailing backslash (\)>
 unknown=
 secure=
 outbound=
 netmail=
 log=
 nodelist=

 pw1=<full 4D address> <password> <phone number> <name>
 pw2=
 ...
 pw99=
 pw100=
 (use a dash (-) to replace any unused fields in password entries)

 systemname=<name string>
 systemlocation=<location string>
 sysopname=<sysop string>
 systemphone=<phone number string>

 adr1=<full 4D Fido address> (this is the primary address)
 adr2=
 adr3=                       (2 ,3, 4 & 5 are secondary)
 adr4=
 adr5=

 scan=<type> <command line>
 toss=
 netscan=
 u1=
 u2=
 ...
 u8=
 u9=
 (type may be one of OS2TEXT, DOSTEXT or OS2PM)
 (if the command is a .CMD file you will need to
  start the command line with 'cmd.exe /c")

 u1name=
 ...
 u9name=
 (the above are the optional names for each of the
  nine user buttons. The default for an empty name
  string is U#, where # is the number 1-9. The name
  can be up to 8 characters including a tilde (~)
  that can be placed before an Alt- type hotkey
  define)

 scd00:01=<type> <frequency> <data>
 scd00:02=
 ...
 scd00:09=
 scd00:10=
 ...
 scd23:01=
 scd23:02=
 ...
 scd23:09=
 scd23:10=
 (the number immediately after the scd is the hour that the
  schedule entry is for from 00 to 23. The number after the
  colon is the item number for that hour's events. This may
  be from 01 to 10. Each hourly event can have up to ten
  separate actions.

  type is one of the digits:
      NONE   = 0
      BUTTON = 1
      RUN    = 2
      POLL   = 3
      EXIT   = 4
      SEND   = 5
      GET    = 6
  frequency is one of the digits:
      All    = 0
      Sun    = 1
      Mon    = 2
      Tue    = 3
      Wed    = 4
      Thu    = 5
      Fri    = 6
      Sat    = 7
  data is a string that depends upon the type:
      BUTTON = the name of the .BTN file without the .BTN part
      RUN    = the command line to execute
      POLL   = the full 4D address to poll
      EXIT   = the errorlevel number to exit with
      SEND   = the full 4D address to send to followed by the name
               of the file to send
      GET    = the full 4D address to get the file from followed by
               the file name to request and then an optional
               password to include with the request
 )

 zmhstart=<digit 0 to 23>
 zmhend=<digit 0 to 23>

 bbs=<key sequence to activate the call to your BBS>
 (An empty entry defaults to EscapeEscape. The BBS is called
  via the execution of a RUNBBS.CMD file with two arguments.
  Argument one is the port handle and two is the current
  connect baudrate (DCE not DTE).)


ΓòÉΓòÉΓòÉ 4. Configuration Window #2 ΓòÉΓòÉΓòÉ

In this window you can enter the following data:

[Local Data]

System Name is the name of your BBS or Fido system.

SysOp Name is your name.

Location is where you are located (city, province/state).

Phone is your system's phone number.

[ZMH]

Start is the starting hour for ZMH in your zone.

End is the ending hour (first non-ZMH hour following ZMH) in your zone.

[BBS]

This is the key sequence that must be entered to gain access to a BBS.  If this
string is detected while tMail is trying to establish an EMSI handshake with an
incoming caller then the file RUNBBS.CMD is executed.  Two arguments are passed
to this batch file.  Argument one is the port handle and argument two is the
current connected baudrate.

If this field is left blank then the default is used which is two escape
characters in a row.

[Fidonet Address(es)]

You can enter up to five full 4D Fidonet addresses in the five entry fields
provided.  The first one will be used for any default purposes as required.
Addresses 2 through 5 are considered to be secondary addresses.

[Commands]

The commands to be executed for buttons U1 through U9 as well as the Toss, Scan
and NtScn buttons can be entered by selecting the desired button and filling in
the subsequent dialog. The nine user buttons (U1-U9) can also have the name
displayed on the button set by the user in the commands dialogue box. Toss,
Scan and NtScan names are fixed and cannot be altered.


ΓòÉΓòÉΓòÉ 5. Schedule Configuration ΓòÉΓòÉΓòÉ

tMail uses a very simple scheduler.  There is one event available each hour (at
the top of the hour).  Each event can have up to ten actions take place when
its time arrives.

The Hour spin button will cycle through the hours 0 to 23 and the display to
the right of it will show the ten actions defined for that hour.

The actions are carried out in the order that they appear in the list.

To change an action highlight it in the list and then enter the data in the
Detail box below the list.  You can choose one of the radio buttons in the
Detail box for the type of action that you are entering. These actions are:

  BUTTON .. Write a .BTN file
  RUN    .. Run a program
  POLL   .. Poll a system
  EXIT   .. Write a .TMX file
  SEND   .. Send a file to a system
  GET    .. Get a file from a system

You can select the day of the week to execute this event's action on or All to
have it run every day.

The Data is a string that depends upon the type of action being defined.

  BUTTON = the name of the .BTN file without the .BTN part
  RUN    = the command line to execute
  POLL   = the full 4D address to poll
  EXIT   = the errorlevel number to exit with
  SEND   = the full 4D address to send to followed by the name
           of the file to send
  GET    = the full 4D address to get the file from followed by
           the file name to request and then an optional
           password to include with the request

For the format of command lines using the RUN command see the Button
Configuration section.


ΓòÉΓòÉΓòÉ 6. Button Configuration ΓòÉΓòÉΓòÉ

This dialogue allows you to define a command that will be executed when the
selected button is clicked.  The command may be an OS/2 PM program, a DOS
program (or batch file) or an OS/2 text session (or cmd file).

The only requirement for executing a .EXE program is that the program that you
are executing be in your PATH.

If you are entering an OS/2 batch file name you must preface the file name with
'cmd.exe /c'.

 cmd.exe /c myprog.cmd

If you are running a DOS batch file (.BAT) then you only need to select the
correct radio button and then enter the name of the bat file (with the .BAT
extension).


ΓòÉΓòÉΓòÉ 7. Poll Window ΓòÉΓòÉΓòÉ

Enter the address of the system to poll here.  You may enter a partial address
and let tMail fill in the missing bits using your primary address as a source
for the default data.

If your main address is 1:250/664 then entering just 601 as the address to poll
will result in '1:250/601.0' as the expanded address.


ΓòÉΓòÉΓòÉ 8. Get/Send File Window ΓòÉΓòÉΓòÉ

This window is used for both Get and Send.  If you have selected Get then the
Password field will be available.  If you have selected Send then the password
field will be disabled.

Simply enter the Fido system address for the Get or Send and the name of the
file involved.  If you are doing a Get and a password is needed for that file
or 'magic' name then you can enter it in the field provided.


ΓòÉΓòÉΓòÉ 9. OutBound Management ΓòÉΓòÉΓòÉ

This will allow you to rename the packet (just change the address or the type).
Note that the address entered here canot be a partial address. It must be a
full 4D address.

You can also delete the Q file but bear in mind that when you delete a Q file
this way all of the internals of the Q file will be dealt with as though it had
been sent.

This means that the content files will be truncated or deleted according to the
internal flags for those files.

See the description of tMail Q file contents in the Main Window section.


ΓòÉΓòÉΓòÉ 10. Beta ΓòÉΓòÉΓòÉ

tMail v1.00 through 1.99 are beta versions of the program. As such there may be
bugs, things that don't work, things that don't work as expected and things
that will surprise me when I am made aware of them. Reports of any and all such
anomalies as well as any discovered work-arounds may be sent to the author at
the addresses indicated elsewhere in this help file.


ΓòÉΓòÉΓòÉ 11. License ΓòÉΓòÉΓòÉ

tMail is FreeWare *NOT* Public Domain.

The documentation and accompanying program are copyrighted material designed,
produced and tested by the author of the software.

Although every care and attention has been taken to write and test the program
to make sure that it does what the documentation states, the program is
provided as it is, without warranty or guarantee of any kind, either expressed
or implied, as to the quality or performance of this program, except that it
will occupy disk space.

The author shall not be held liable to you or anyone else for any direct,
indirect, incidental or consequential damages, including any lost profits, lost
savings or lost business, which may result from the use of (or inability to
use) this program.

Your use of this program constitutes your agreement to this disclaimer and your
release of the author from any form of liability or litigation.

You are actively encouraged to copy and distribute it in an unmodified way as
much as you want, as long as you still abide by the conditions mentioned here
and that no money or monies or any other form of compensation is asked for or
accepted.

 InterNet:  [e-mail]
            [e-mail]

    Snail:  c/o 102 Cleveland Street,
            Toronto, Ontario, CANADA
            M4S 2W5   [phone]

tMail, as distributed here, is FreeWare only for private individual use.
Governments and Corporate users must contact the author at the above address to
arrange for licensing.