home *** CD-ROM | disk | FTP | other *** search
/ Crawly Crypt Collection 1 / crawlyvol1.bin / bbs / mailscan / mailscan.doc next >
Text File  |  1993-09-04  |  6KB  |  165 lines
  1. Licence
  2. ~~~~~~~
  3.  
  4. The author specifically disclaims all warranties, expressed or
  5. implied, to the fullest extent that the law allows, including, but not
  6. limited to, implied warranties of merchantability and fitness for any
  7. particular purpose with respect to defects in the program or
  8. documentation. In no event shall the author be liable for any loss of
  9. profit or any other form of commercial damage.
  10.  
  11. MailScan
  12. ~~~~~~~~
  13.  
  14. MailScan is a program which makes use of the feature of QuickBBS-ST
  15. versions from 1.08, which have the capability whereby a search for
  16. mail can be carried out by an external program when no user is online,
  17. and the information retrieved when the user logs in, much more quickly
  18. than a regular mail scan can be done. This means that the user does
  19. not have to spend a lot of time waiting for the BBS to find any
  20. waiting mail, and consequently will incur smaller phone charges.
  21.  
  22. Updating from previous edition
  23. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  24.  
  25. V1.01:    As soon as you have unpacked the new version of MailScan,
  26.           run it again. The files produced by this version are
  27.           slightly incompatible with the previous version, and if you
  28.           use the previous versions' files then any users without any
  29.           mail will have all the mail that is waiting for the sysop
  30.           (i.e. yourself) marked.
  31.  
  32. Installation
  33. ~~~~~~~~~~~~
  34.  
  35. The installation process is fairly easy, although I recommend that you
  36. either have this part of the documentation to hand when setting up
  37. MailScan, or jot down the important details. You must be using a
  38. command line interpreter, and be using a batch file to execute
  39. QuickBBS-ST.
  40.  
  41. 1. Unpack the program. It can be placed in any directory, as long as
  42.    you are using the QBBS environment variable. Otherwise, place it in
  43.    the directory that QuickBBS-ST itself resides in. All directories
  44.    will be found from QuickBBS-ST's configuration files.
  45.  
  46. 2. Scanning for mail. You need to set MailScan scanning for mail
  47.    immediately after the numbers of existing messages, or users,
  48.    change. Common causes are the use of FastPack, MPack, one of the
  49.    mail scanners that deletes old messages, or a user packer. Before
  50.    any user is allowed onto your system, you should run MailScan with
  51.    the parameter /s. (A full list of parameters is available by typing
  52.    "mailscan /?".)
  53.  
  54.    On my system, this batch file is part of one which is run every
  55.    morning at 0800 hours:
  56.  
  57.    jetmail maint    ;# deletes old messages
  58.    mailscan /s      ;# scans for users' mail
  59.  
  60. 3. Showing mail waiting for a user. A .DOR file must be executed,
  61.    which may be WELCOME.DOR if desired. A basic implementation of a
  62.    compatible .DOR file is as follows:
  63.  
  64.    write dorinfo1.def
  65.    send Marking waiting mail
  66.    exec mailscan.ttp
  67.    if *C<0 then goto newuser
  68.    if *C>500 then goto newuser
  69.    send You have *C messages waiting.
  70.    readmarked
  71.  
  72.    Here is an example of a more complex .DOR file, which is similar to
  73.    the one I use:
  74.  
  75.    write dorinfo1.def
  76.    send Marking your waiting mail
  77.    exec mailscan.ttp
  78.    if *C<0 then goto newuser
  79.    if *C>500 then goto newuser
  80.    if *C=0 then goto nomail
  81.    :rpt
  82.    send
  83.    if *C=1 then prompt You have 1 message waiting. Do you want to read
  84.                        it now [Y/n]?  ^H
  85.    if *C>1 then prompt You have *C messages waiting. Do you want to
  86.                        read them now [Y/n]?  ^H
  87.    key
  88.    if *CHR ~ Y then goto readmail
  89.    if *CHR ~ N then goto dont
  90.    if *ASC = 13 then goto readmail
  91.    goto rpt
  92.    :readmail
  93.    send Yes
  94.    readmarked
  95.    exit
  96.    :dont
  97.    send No
  98.    exit
  99.    :nomail
  100.    send You have no mail waiting.
  101.    exit
  102.    :newuser
  103.    send Since you are new here, your mail has not yet been searched
  104.    send for. Any mail waiting for you will be marked ready for you to
  105.    send read upon your next call after 08:00 tomorrow.
  106.    exit
  107.  
  108.    If you wish, dig the .DOR file segment out of this documentation
  109.    and use it. The ^H signifies a backspace character.
  110.  
  111. 4. Making sure MailScan works initially. Type mailscan /s during or
  112.    after installation, to make the message index files for each user
  113.    ready.
  114.  
  115. Use and Notes
  116. ~~~~~~~~~~~~~
  117.  
  118. The indices of messages that have the Received and/or Deleted flags
  119. set are not stored in the files produced (USERMSGS.PTR and
  120. USERMSGS.DAT). Therefore, these messages will not be shown to the
  121. user.
  122.  
  123. The names of bases, and numbers of waiting messages, will be shown to
  124. the user exactly as if QuickBBS-ST's own mail scanner is being used.
  125. However, access levels are not checked at present. Presumably
  126. QuickBBS-ST will check that the user has access to the base, but the
  127. message will appear as waiting.
  128.  
  129. If a message has been deleted, or marked as read, after the mail scan,
  130. it will still not be shown to the user as each message is checked by
  131. MailScan for these flags at use time.
  132.  
  133. What's new in v1.01?
  134. ~~~~~~~~~~~~~~~~~~~~
  135.  
  136.  o Copyright line is no longer shown to the user. The version number
  137.    replaces this information;
  138.  o Security level checks: each user must have the correct flags set,
  139.    and at least enough security, to read mail in a base, otherwise
  140.    mail will not be marked;
  141.  o Mail bases not used by QBBS (without a name in the message base
  142.    configuration) are no longer scanned;
  143.  o A speed indication is shown at the end of a scan.
  144.  o Messages can now be read which are waiting for the sysop. (Actually
  145.    this problem affected the first user to have any messages, this is
  146.    of course usually the sysop.)
  147.  
  148. Programming
  149. ~~~~~~~~~~~
  150.  
  151. This program was written using GfA Basic v3.5.
  152.  
  153. Distribution
  154. ~~~~~~~~~~~~
  155.  
  156. This program may be freely distributed, and used, without making any
  157. donation to me. This original documentation must accompany the program
  158. or archive.
  159.  
  160. Contact and Support
  161. ~~~~~~~~~~~~~~~~~~~
  162.  
  163. The author is David J. Thomas, and can be contacted at 2:442/600,
  164. 90:103/103, or 100:104/0. Happy MailScanning!
  165.