home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 35 Internet / 35-Internet.zip / wpbif094.zip / readme < prev    next >
Text File  |  1997-07-02  |  5KB  |  105 lines

  1.                                WPBiff v 0.94
  2.                  Copyright (c) Virtual Objects Software 1997
  3.  
  4.  
  5. 0. Introduction
  6.  
  7. This simple program changes the icon and the title of the WPS object you
  8. specified according to the state of your mail box on POP3 server. Thepackage includes source code for those suffering from paranoya --
  9. nobody should not get know your POP3 password!;-)  Moreover this
  10. allows you to change the program for your need. However you are
  11. not granted to use this code for developing of commercial software.
  12. This 0.92 version fixes little bug concerning closing of the socket.
  13.  
  14. 1. Packaging
  15.  
  16. readme         Obviously this readme file:))
  17. runBiff.cmd    Sample REXX script to start wpbiff
  18. strtBiff.cmd   Yet another sample REXX prog
  19. biff.cpp       biff sources C++ file
  20. TCPSOCK.CPP    small helpful C++ class used by biff.cpp
  21. SOCK.DEF       hmm, i don't really remember what's that:)
  22. file_id.diz    for those using PCBoard & Co
  23. biff.exe       refer to note bellow -- you'd run it directly from
  24.                command line
  25. tcpsock.hpp    C++ header file
  26. mail_0.ico     this icon used by sample REXX scripts
  27. mail_1.ico     this icon used by sample REXX scripts
  28. biff.MAK       IBM VAC++ make file (run nmake ``biff.MAK'' :-)
  29. tcpsock.obj    trash -- you can delete this file
  30. wpbif091.txt   description
  31.  
  32.  
  33. 2. Usage
  34.  
  35. OK, let's talk about its usage. WPBiff is configured very simple via
  36. OS/2 environment variables. The package includes some sample REXX
  37. scripts used to start WPBiff. To try WPBiff you have to edit one of
  38. this sample scripts and run it. The env variables need to be assigned
  39. follow:
  40.  
  41. POP3_USER          -- your user name on POP3 server
  42. POP3_PASS          -- your password on POP3 server
  43. POP3_INTERVAL      -- interval between mail check
  44. POP3_WPS_OBJECT    -- WPS ID of the object whose icon and title will be
  45.                       changed
  46.  
  47. POP3_NO_MAIL_ICON  -- full path to the icon which will be assigned
  48.                       to the above WPS object when there are no mail
  49.                       for you on POP3 server
  50.  
  51. POP3_MAIL_ICON     -- full path to the icon which will be assigned
  52.                       to the above WPS object when mail for you is
  53.                       found on your POP3 server
  54.  
  55. POP3_ERROR_ICON    -- full path to the icon which will be assigned 
  56.                       to the above WPS object when the connection to 
  57.                       your POP3 server is failed for some reason;
  58.                       this is useful for eg. when dial-up connection 
  59.                       is not established
  60.  
  61. POP3_NO_MSGS_TITLE -- title of the mentioned WPS object when there are
  62.                       no messages
  63.  
  64. POP3_1_MSG_TITLE   -- title of the WPS object when there is only 1
  65.                       message on the POP3 server
  66.  
  67. POP3_MSGS_TITLE    -- title of the WPS object when there are more then
  68.                       1 messages on the server. This line should
  69.                       include ``%d'' C-style format specifier which
  70.                       will be replaced with the actual number of
  71.                       messages. For example look at sample starting
  72.                       REXX scripts.
  73.  
  74. POP3_ERROR_TITLE   -- title of the WPS object which will be shown
  75.                       when the connection to your POP3 server is 
  76.                       failed for some reason;
  77.                       this is useful for eg. when dial-up connection 
  78.                       is not established
  79.  
  80.  
  81. Note: YOU SHOULD NOT START BIFF.EXE DIRECTLY FROM THE COMMAND LINE. Of
  82. course this does not refer to those advanced users knowing what are
  83. they doing:)
  84.  
  85.  
  86. 3. Acknowledgements
  87.  
  88. Actualy that was Peter Noskov (noskov@main.comcen-1.nsk.su) who forced
  89. me to write this program. Some time ago I was developing a real WPS
  90. class whose objects can check mail on POP3 server. But the project was
  91. delayed because... well, you know how it used to be happened:) Once
  92. Peter has came to me and said that he's quite bored by the biff program
  93. he using. It was mbiff -- REXX script without source using rxsock lib.
  94. This is shareware and requires registration after some evaluation
  95. period. I'd be a pig  if I say that shareware idea is a bullshit. And
  96. US$5 is not so big cost for such good prog as MailBiff. But if you'd
  97. know what should you do to send this money somewhere in US from Russia
  98. you'll rather sit down and spend one evening to write the similar
  99. program.
  100.  
  101. I would also thank David Lawless for the idea of displaying 'error 
  102. connecting to POP3' state as a special icon and title.
  103.  
  104.  
  105.