home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 35 Internet / 35-Internet.zip / popbif11.zip / POPBiff.DOC < prev    next >
Text File  |  1995-04-24  |  13KB  |  256 lines
  1.                POPBiff V1.1 for OS/2 by Michele Marziani
  2.                =========================================
  3.  
  4.  
  5. Copyright:
  6.  
  7.     POPBiff V1.1 - Simple Unix-like Biff program for the POP3 TCP/IP
  8.     protocol. Copyright (c) March-April 1995, Michele Marziani.
  9.  
  10.  
  11. Warranty:
  12.  
  13.     This software comes with absolutely no warranty, expressed or
  14.     implied, including but not limited to fitness for a particular
  15.     purpose. You should realize that I am in no way responsible for
  16.     any loss or damage that may occur due to the use of this software.
  17.     The program is provided on an "as is" basis. Use at your own risk.
  18.  
  19.  
  20. Distribution:
  21.  
  22.     This program is distributed as 'emailware'.
  23.     If, after using this software for a reasonable time (15 days), you
  24.     feel that it is software that is useful to you and that you will
  25.     continue to use, you're kindly required to 'register' the software
  26.     with me.
  27.  
  28.     It will cost you *NOTHING*. Just send me an e-mail at the
  29.     address below, telling me your praise (!), your impressions, your
  30.     suggestions or whatever.
  31.     Please mention the fact you're registering explicitly. This will
  32.     help me keep a list of 'registered' users who will receive
  33.     notification of new releases and bug fixes when they become
  34.     available.
  35.  
  36.     There are very few restrictions on the distribution of this
  37.     software, as long as it is not altered in any way. The ZIP archive
  38.     file from which the program came from must be distributed in its
  39.     entirety and not altered in any way. This software can't be
  40.     distributed with or as part of any commercial program. However, it
  41.     may be freely distributed by commercial vendors, user groups, BBS
  42.     operators or individuals. No fee or payment may be charged or
  43.     accepted, other than a small distribution fee.
  44.  
  45.  
  46. Support:
  47.  
  48.     This software comes with absolutely no support.
  49.     If you have a problem with the software, I'd very much appreciate
  50.     receiving information about the problem and the circumstances under
  51.     which it occurred. Just e-mail me at the address below. This will
  52.     help me fix the problem (at least I'll try to) in a future release.
  53.     Do not expect an immediate reply or a prompt bug fix, however.
  54.  
  55.     Please keep in mind I wrote POPBiff in my spare time. OS/2
  56.     programming is not my job, it's only my hobby... So, be patient!
  57.  
  58.  
  59. Purpose:
  60.  
  61.     POPBiff is a Unix xbiff analogue. Only it has been designed to work
  62.     with a POP3 server i.e. it doesn't monitor a file on disk. Instead
  63.     it periodically checks your POP3 mailbox. It will raise its flag
  64.     and optionally beep on incoming mail. It will lower the flag if the
  65.     mail is read. An optional secondary window can show the total count
  66.     of new mail messages and their total size.
  67.  
  68.     Current features:
  69.       * compatibility with IBM TCP/IP 1.2.1, 2.0 and Warp IAK
  70.       * usual flag down/flag up stuff (a la Unix xbiff)
  71.       * display of new message count and total size
  72.       * optional beep in response to new mail
  73.       * mail checking every N minutes (N ranging from 1 to 120)
  74.       * saving of settings (host, user, password) to an INI file
  75.       * password encryption when saving to an INI file
  76.       * saving of window positions/size/color
  77.       * ability to turn off error messages for SLIP/PPP connections
  78.       * multithread design
  79.     Features planned for future releases:
  80.       * optional display of message headers
  81.       * launching of your favorite e-mail reader
  82.       * playing of a .WAV file in response to new mail
  83.       * no mail/new mail icons configurable via drag & drop
  84.       * optional reading of password from tcpos2.ini for Warp IAK users.
  85.  
  86.  
  87. Requirements:
  88.  
  89.     This software requires IBM TCP/IP 1.2.1 or 2.0 or Warp IAK with
  90.     the REXX Sockets (RxSock) interface. This was a separate package
  91.     distributed as EWS - 'Employee Written Software' - until the
  92.     August 1994 CSD for IBM TCP/IP. Then it has been included with
  93.     the corrective service disks. Since both IBM TCP/IP 1.2.1 and Warp
  94.     IAK do not include the RxSock interface, I'm hereby including two
  95.     copies of RxSock.DLL, one for the 16 bit TCP/IP stack (1.2.1) and
  96.     the other for usage with Warp IAK.
  97.  
  98.  
  99. Installation:
  100.  
  101.     Please follow these steps for manually installing POPBiff.
  102.  
  103.     - Unzip POPBif11.ZIP in a temporary directory. I'd like to suggest
  104.       using Info-ZIP's UnZip version 5.12 or later since it can preserve
  105.       OS/2 extended attributes.
  106.  
  107.     - Move POPBiff.EXE and POPBiff.ICO to a directory where you keep
  108.       your executable files, e.g. \OS2\APPS or \TCPIP\BIN or whatever.
  109.       It doesn't need to be a directory in your path, though, unless you
  110.       wish to run POPBiff from any OS/2 command line prompt.
  111.  
  112.     - Move POPBiff.DLL to a directory listed in LIBPATH, e.g. \OS2\DLL
  113.       or \TCPIP\DLL. The LIBPATH variable is defined in the OS/2 CONFIG.SYS
  114.       file. Note that you must shutdown your system and reboot OS/2 before
  115.       any changes to the LIBPATH will take effect.
  116.  
  117.     - If you are using IBM TCP/IP 2.0 with the August '94 CSD or later
  118.       already applied, you can safely delete both RXSOCK.DLL and
  119.       RXSOCK16.DLL. If your have either TCP/IP 2.0 without the CSD or Warp
  120.       Internet Access Kit (IAK) delete RXSOCK16.DLL and move RXSOCK.DLL to
  121.       the \TCPIP\DLL directory. Finally, if you have TCP/IP 1.2.1 delete
  122.       RXSOCK.DLL, rename RXSOCK16.DLL as RXSOCK.DLL and move it to the
  123.       \TCPIP\DLL subdirectory.
  124.  
  125.     - [Optional] Since POPBiff creates an OS/2 INI file (for storing its
  126.       settings) in the same directory as its EXE file, this directory
  127.       needs to reside on a writable disk. If you can't comply with this
  128.       request, e.g. when POPBiff.EXE resides on a network server disk or
  129.       on a CD-ROM, you can override the default path for the INI file by
  130.       putting a SET POPBIFF=D:\PATH\WHATEVER statement in your CONFIG.SYS
  131.       file. This will allow you to specify the drive and directory of
  132.       your choice for the purpose of storing the POPBiff.INI file.
  133.  
  134.     - [Optional] You could create a Workplace Shell (WPS) object by
  135.       dragging a Program template from the Templates folder and dropping it
  136.       on the WPS. An icon can be assigned to the POPBiff executable using
  137.       the General page of the program Settings notebook. You can use the
  138.       supplied POPBiff.ICO or any other icon of your choice.
  139.  
  140.     - [Optional] You could specify '/n' (without quotes) as a program
  141.       parameter. This will help SLIP/PPP users who wish to leave POPBiff
  142.       active when hanging up. This switch simply makes POPBiff bypass
  143.       error messages such as 'Host unreachable', 'Failed at resolve', etc.
  144.  
  145.     There is NO need to modify the \TCPIP\ETC\SERVICES file since POPBiff
  146.     addresses the POP3 TCP port (110) directly.
  147.  
  148.  
  149. Usage:
  150.  
  151.     POPBiff asks for configuration information the first time you start
  152.     the program. If need be, you can easily change the configuration
  153.     later. As a minimum you need to specify a POP3 server host name,
  154.     your POP3 server username and your password.
  155.  
  156.     As regards the password you have two options, either an "Enter
  157.     password" field or a "Read from plain text file" field. If you
  158.     choose to specify your password in the entry field under the "Enter
  159.     password" radio button you won't see your password as you type it.
  160.     Instead, a series of asterisks will be shown. Furthermore, your
  161.     password will be encrypted before saving it to POPBiff.INI for
  162.     obvious security reasons. Keep in mind that if you later move your
  163.     executable file to a different hard disk location you need to
  164.     re-enter your password.
  165.     Choosing the "Read from plain text file" option will allow you to
  166.     have a single system wide location for storing your POP3 password.
  167.     This could be useful for users of mail clients such as souper or
  168.     popclient who might have customized their Rexx scripts in order to
  169.     read their password from the same text file. Beware that it's an
  170.     intrinsically unsecure option, of course.
  171.  
  172.     The other two options in the POPBiff setup dialog will allow you
  173.     to specify the time interval between two consecutive mail checks
  174.     and whether you want a beep when the new mail counter increases.
  175.     Time intervals can range between 1 and 120 minutes. The default
  176.     is to have POPBiff check your mail every 2 minutes and beep when
  177.     there is more incoming mail.
  178.  
  179.     After a click on the "Save" pushbutton POPBiff will show its main
  180.     window consisting of a single flag down bitmap and the title bar.
  181.     Then it will try to contact your POP3 server for checking new mail.
  182.     This task is always done in a secondary thread in order to avoid
  183.     interfering with the user interface main thread.
  184.     You can move the main Biff window over your WPS. If you wish you
  185.     can drag a color from an OS/2 Color Palette and drop it on the
  186.     Biff window so as to change its background color. These settings
  187.     can be later saved to the POPBiff.INI file.
  188.     If there is new mail POPBiff will raise its flag. It will lower
  189.     the flag if the mail is read. POPBiff keeps a counter of all new
  190.     mail messages and it will beep (if you chose this option) when
  191.     new mail arrives.
  192.  
  193.     A double click on the flag (up or down) bitmap will open a secondary
  194.     status window which will show you the new mail counter and the
  195.     mail message total size in bytes. There is also a menu under the
  196.     title bar of this status window.
  197.  
  198.     The File menu only has an "Exit program" item with a fairly obvious
  199.     meaning. The Help menu only has an About menu item which opens a
  200.     dialog box with info on the author and the development environment
  201.     used for writing POPBiff. The Options menu has two items, "Settings"
  202.     and "Save Position/Size/Color". The former will reopen the POPBiff
  203.     Setup dialog thus allowing a change of the configuration information.
  204.     The latter is for saving various settings to the POPBiff.INI file.
  205.     Both the main POPBiff window position/background color and the POPBiff
  206.     status window position/size are saved to POPBiff.INI for later re-use.
  207.     You can leave POPBiff either by double clicking on the system menu
  208.     of the main window or via the File/Exit program menu item of the
  209.     status window.
  210.  
  211.  
  212. Known bugs and caveats:
  213.  
  214.     Keep in mind that POPBiff is written in REXX and I had to cope with
  215.     the limitations of the development environment I used and its tools.
  216.     For example I couldn't get rid of the title bar in the main window
  217.     without also preventing the user from moving the window itself. This
  218.     is a standard PM behaviour to which POPBiff adheres. I know there
  219.     are some tricks, allowed to C programmers, which can overcome these
  220.     limitations. At present they can't be implemented in REXX easily,
  221.     though. So don't blame me too much, please.
  222.  
  223.     A known bug is the following. If new mail arrives while you're still
  224.     moving the main window around, you'll hear a beep but POPBiff won't
  225.     raise its flag. This is due to the built-in REXX event dispatcher
  226.     which is still servicing an event while it should start servicing a
  227.     new notify event. Sorry people, I can't do anything to fix this. So,
  228.     again, don't blame me too much.
  229.  
  230.     Both reading from and saving to the INI file is a bit slow. This is
  231.     an intrinsic 'feature' of the SysIni Rexx utility function.
  232.     Finally I'd like to warn you that POPBiff has been tested only with
  233.     a VAX/VMS Multinet 3.0 POP3 server. I can't tell you its performances
  234.     while interacting with different POP3 servers. We don't have them.
  235.     POPBiff has been tested with the following configurations only: OS/2
  236.     2.11 with TCP/IP 2.0, and OS/2 Warp 3.0 with either TCP/IP 2.0 or
  237.     Warp IAK. It has been tested neither with OS/2 2.0 nor with TCP/IP
  238.     1.2.1 but it should work, though.
  239.  
  240.  
  241. Credits:
  242.  
  243.     POPBiff has been written using the DrDialog/DrRexx development
  244.     environment created by David C. Morrill. Version 3.27 was used.
  245.     Rexx routines for interacting with a POP3 server were 'borrowed'
  246.     from MADPOP.CMD, an "Ultra-simple REXX-based POP3 Client for
  247.     OS/2 2.X, Copyright 1994, Michael Alan Dorman".
  248.  
  249.  
  250. Author:
  251.  
  252.     Michele Marziani
  253.     Universita' di Ferrara       E-mail: marziani@vaxfe.fe.infn.it
  254.     Dipartimento di Fisica               Telephone: +39 532 781823
  255.     44100 Ferrara - ITALY                      Fax: +39 532 781810
  256.