home *** CD-ROM | disk | FTP | other *** search
/ HAM Radio 1 / HamRadio.cdr / misc / rlimail / rlimail.doc < prev    next >
Encoding:
Text File  |  1990-05-15  |  7.5 KB  |  180 lines
  1. RLIMAIL Version 2.10                                                   05/15/90
  2. (C) 1990 R. J. Farrell, WB2COY - All Rights Reserved                Page 1 of 3
  3.  
  4.  
  5.    RLIMAIL is a program written in BASIC which will analyze the MAIL.MB
  6.    file from a W0RLI PBBS system (Version 6.05 and above), generate a
  7.    report, and send it to the display, printer, or save it to a file.
  8.  
  9.    Note: If you want to run the BASIC code under the BASIC interpreter,
  10.          you MUST specify the following when starting BASICA:
  11.          BASICA /S:512
  12.          Then LOAD"RLIMAIL and RUN
  13.  
  14.          The compiled program can be run by simply specifying RLIMAIL
  15.          at the DOS prompt.
  16.  
  17.    This program was born out of a desire to be able to get a printout of
  18.    the entire message header database for the purpose of doing some
  19.    housekeeping.  There is no provision in the W0RLI code to have the
  20.    message list sent to a file or to the printer.  RLIMAIL simulates the
  21.    BBS environment offline and provides this function.
  22.  
  23.    You should run the program offline using a backup copy of your MAIL.MB
  24.    file (you do make backups regularly, right?).  The program will prompt
  25.    for a Mail database filename.  The default is MAIL.MB, so just hitting
  26.    <Enter> will give you the default.  You may also specify a filename and
  27.    extension, if you save your backup copies using a different naming
  28.    convention.
  29.  
  30.    The program will support the listing of messages in the following ways:
  31.  
  32.     (A)ctive  ------- all active (unkilled) messages
  33.     (K)illed -------- killed messages only
  34.     (D)ate ---------- all active messages on a specified Date
  35.     (R)ead ---------- all messages that have been read (Status of Y)
  36.     (O)ld ----------- all messages flagged as OLD
  37.     (H)eld ---------- all messages flagged as HOLD (Status of H)
  38.     (F)orwarded ----- all messages flagged as Forwarded (F)
  39.     (B)ulletins ----- all messages marked as 'B' type messages
  40.     (T) NTS Traffic - NTS traffic messages only
  41.  
  42.     (>) TO ---------- Messages addressed TO Callsign
  43.     (<) FROM -------- Messages addressed FROM Callsign
  44.     (@) AT ---------- Messages addressed AT Callsign
  45.  
  46.     (?) Find Text --- Messages containing text string in Subject field.
  47.  
  48.    A secondary prompt for a Callsign will be made in the case of the (<),(>)
  49.    and (@) search types.  This may be a valid callsign, or a Mnemonic, such
  50.    as ALL, RLIBBS, etc.
  51.  
  52.    The (D)ate option will prompt for the date in the format MMDD.
  53.  
  54.    For the (?) Find Text search type, you will prompted to enter the text
  55.    to search for. This entry is case Insensitive.
  56.  
  57.    You will then be prompted to choose the output device type:
  58.    <H>ardcopy <F>ile or <D>isplay (H F or D) ?
  59.  
  60. RLIMAIL Version 2.10                                                   05/15/90
  61. (C) 1990 R. J. Farrell, WB2COY - All Rights Reserved                Page 2 of 3
  62.  
  63.    The default is Display, so just hitting <Enter> will provide a display
  64.    to the screen only. Answering H will result in a hardcopy printout only,
  65.    (make sure your printer is on), while answering F will save the output
  66.    into a filename using the following table:
  67.  
  68.      Active Messages    - RLI-ACT.RPT
  69.      Killed Messages    - RLI-KILL.RPT
  70.      Read Messages      - RLI-READ.RPT
  71.      Old Messages       - RLI-OLD.RPT
  72.      Held Messages      - RLI-HELD.RPT
  73.      Forwarded Messages - RLI-FWD.RPT
  74.      Bulletins          - RLI-BULL.RPT
  75.      NTS Messages       - RLI-NTS.RPT
  76.  
  77.      Messages TO, FROM or @ a callsign or mnemonic will be saved with a
  78.      filename matching what was entered at the Callsign prompt. For example,
  79.      if you answered the prompt with AMSAT, then the filename AMSAT.RPT will
  80.      contain the output report. Find Text will save into RLI-MAIL.RPT
  81.  
  82.    RLIMAIL will generate a report using the following header:
  83.  
  84.    Msg #  NR Stat  Size To     From   @ BBS  Date Subject
  85.  
  86.      Msg #   = message number
  87.      NR      = Number of times this message has been Read
  88.      Stat    = message statistics (see example)
  89.      Size    = size of the message file in bytes
  90.      To      = whom the message was addressed TO
  91.      From    = whom the message was FROM
  92.      @ BBS   = whom the message was addressed AT
  93.      Date    = date the message was left on the system (MMDD)
  94.      Subject = first 32 bytes of subject field
  95.  
  96.    Some typical output would look like the following: (This example shows
  97.    Killed messages)
  98.  
  99.    W0RLI Mail File Read Utility - WB2COY - 12-19-1988 - 14:18:30
  100.  
  101.    Msg #  NR Stat  Size To     From   @ BBS  Date Subject
  102.     8861   1 BKF    785 ALL    N1API  N1CUI  0211 ARRL SB 354
  103.     8849   3 BK    1138 ALL    W3IWI  MBLBBS 0210 It's a Girl
  104.     8767   2 BK    1740 ALL    W1AW   ARL    0206 ARRL Propagation Forecast
  105.     8542  15 BK     444 ALL    WA2MMX        0204 FOR SALE
  106.  
  107.    I find the 'NR' field very useful when determining if an old bulletin or
  108.    message should be deleted for cleanup purposes, and in determining how
  109.    much activity certain types of messages have.  If nobody is reading
  110.    bulletins addressed @FINOGA, then why continue to keep them around?
  111.  
  112.    The program BASIC source code is included. Feel free to modify it in
  113.    any way. I will make an attempt at keeping the program functional for
  114.    later releases of the W0RLI PBBS code. I would be interested in
  115.    receiving any major functional enhancements that are made by other
  116.    Sysops. I do not profess to be an expert in BASIC. Others may find
  117.    better or more efficient methods for accomplishing the same results.
  118.    To quote an old saying: "There's more than one way to skin a cat."
  119.  
  120. RLIMAIL Version 2.10                                                   05/15/90
  121. (C) 1990 R. J. Farrell, WB2COY - All Rights Reserved                Page 3 of 3
  122.  
  123.  
  124.    The following information may be useful to others who want to modify or
  125.    enhance this program. Most of this info was determined by trial and
  126.    error. There are no published functional specs for the database.
  127.    For purposes of this program, I am concerned with only the first 132
  128.    bytes of each record.  Additional information, such as BID, Distribution
  129.    list data, etc., will be found in the remainder of the record.
  130.  
  131. -
  132.      - The MAIL.MB database consists of 512 byte records
  133.  
  134.      - The database is structured such that the most recent entry is
  135.        at the end of the file.
  136.  
  137.      - The first record of the database does not contain any message
  138.        data.
  139.  
  140.      - For each valid record, the following structure is found:
  141.  
  142.        Byte(s)
  143.  
  144.         0,1    - database relative record number (*)
  145.         2,3    - # times message has been read (*)
  146.         4,5    - actual message number (*)
  147.         6,7    - message size in bytes (*)
  148.         8      - message type (B,T,P - plain text)
  149.         9      - message status (coded HEX) see table in source code
  150.         10-15  - TO field (plain text)
  151.         16     - null (00) separator
  152.         17-22  - FROM field (plain text)
  153.         23     - null (00) separator
  154.         24-29  - @BBS field (plain text)
  155.         30     - null (00) separator
  156.         31-36  - Date (YYMMDD)
  157.         37     - null (00) separator
  158.         38-41  - Time (HHMM)
  159.         42     - null (00) separator
  160.         43-48  - Originating BBS
  161.         49     - null (00) separator
  162.         50-51  - message number at Originating BBS (*)
  163.         52     - null (00) separator
  164.         53-132 - subject field (80 bytes)
  165.  
  166.  
  167.        (*) stored as a string variable
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.    73 - Bob, WB2COY @ WB2COY - Poughkeepsie, NY
  180.