home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 35 Internet / 35-Internet.zip / mail.zip / MAIL.DOC < prev   
Text File  |  1995-09-10  |  15KB  |  349 lines
  1.                   MAIL.CMD version 1.1 documentation
  2.  
  3.                         Written by Ruud Senden
  4.  
  5.  
  6. Contents:
  7.    General Information
  8.    Description
  9.    Necessary external files
  10.    Installation
  11.    Configuration
  12.    Time-outs
  13.    Usage
  14.    Known bugs
  15.    Trouble-shooting
  16.    Support
  17.  
  18.  
  19.  
  20. General information:
  21.  
  22. THERE ARE NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING THE IMPLIED
  23. WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  24.  
  25. You may distribute the program in it's original form, however, you
  26. must distribute it with this documentation included.
  27. You may also distribute a modified version of this program or include
  28. (parts of) this program into your own program, however, you have to
  29. credit the original author in both the program and in the
  30. documentation.
  31.  
  32. Under no circumstances am I liable for any of the following:
  33.  
  34.   1. third-party claims against you for losses or damages;
  35.   2. loss of, or damage to, your records or data; or
  36.   3. economic consequential damages (including lost profits or
  37.      savings) or incidental damages, even if I am informed of
  38.      their possibility.
  39.  
  40.  
  41.  
  42. Description:
  43.  
  44. The REXX-script will automatically log on to the Internet, exchange
  45. mail and news and optionally hang up afterwards.
  46.  
  47.  
  48.  
  49. Necessary external files:
  50.  
  51. Before you can use the REXX-script, you will need some other software,
  52. which can be found at most OS/2 BBSes/FTP-sites. This software
  53. includes the following:
  54.  
  55. RXSOCK.ZIP    The REXX-script uses some function from this package, so
  56.               it is really required.
  57.  
  58. SOUPERxx.ZIP  This is a program to exchange mail and news with the
  59.               Internet in SOUP-format.  You can use any other program
  60.               which can exchange mail and news with the Internet,
  61.               however, check the installation-section if you don't use
  62.               the SOUP-format.
  63.  
  64. SOUP2SQ.ZIP   This program exports and imports mail and news from a
  65.               Squish message-base to the SOUP-format.  If you have a
  66.               mail-reader which supports the SOUP-format, you don't
  67.               need this.  If you use another message-base format, you
  68.               will have to find a similar program for your format.
  69.  
  70. PPPKILL.ZIP   This is used to terminate a PPP-connection.  If you use
  71.               SLIP, you can use the SLIPKILL.EXE program supplied with
  72.               the OS/2 Warp Internet Connection.  You can also use a
  73.               standard process-killer to kill PPP.EXE.
  74.  
  75. Note: xx indicates a version number.
  76.  
  77.  
  78. Installation:
  79.  
  80. Before you can start using MAIL.CMD, you will first have to install
  81. and configure the programs mentioned above.  I suggest you first try
  82. to exchange your mail and news manually, before you start using the
  83. REXX-script.  This way you can first test the setup of the other
  84. programs, if they are set up correctly, you can start using MAIL.CMD.
  85.  
  86. Before you can use MAIL.CMD, you will probably have to change some of
  87. the variables which can be found at the top of the REXX-script.
  88. Please see the configuration-section in this document.
  89.  
  90. Also, if you don't use the SOUP-format to exchange your mail and news,
  91. you will have to change or delete some checks, which are somewhere
  92. down the script.  These checks are used to display informational
  93. messages and to determine whether a given program must be started (for
  94. example, if no new mail and news is available to send to the Internet,
  95. the program to send mail and news doesn't need to be started).  The
  96. checks can be changed to support your own format, or they can be
  97. deleted without any harm (the script just gets a little bit less
  98. intelligent).  To find these checks, search for "End of SOUP-part" or
  99. "SOUP-packets".  They are in lines (approximatically) 83, 174, 206 and
  100. 264.
  101.  
  102.  
  103.  
  104. Configuration:
  105.  
  106. This section describes the variables which can be found at the top of
  107. the REXX-script.
  108.  
  109. logFile      This variable specifies a file in which informational
  110.              messages and the output of external programs is recorded.
  111.              This has to be a valid filename, else the program will
  112.              display an error message.
  113.  
  114. newsServer   This variable specifies the name of your news-server.  It
  115.              is used to determine when the news-server becomes
  116.              available, so the exchange of mail and news can begin.
  117.  
  118. timeout1     This variable specifies the maximum number of seconds the
  119.              program will wait while waiting for the news-server to
  120.              become available.  This timer will start almost
  121.              immediatly after the connection is initialised (eg after
  122.              PPP or SLIP is started). If the timer reaches the
  123.              time-out value, the REXX-script will be terminated. A
  124.              value of 0 will disable the timer.
  125.  
  126. timeout2     This variable is the same as the timeout1-variable,
  127.              except that this timer will start after a connect-message
  128.              is given by the modem.  This feature only works if you
  129.              use a REXX login-script, and requires a change to this
  130.              login-script.  See the time-outs section for more
  131.              information.
  132.  
  133. triggerFile  This variable is used to specify a file which is used by
  134.              the second time-out.  See the time-outs section for more
  135.              information.
  136.  
  137. prgKill      This variable specifies the program which is used to
  138.              terminate the connection with the internet.  Normally,
  139.              this will be a program which kills PPP.EXE or SLIP.EXE.
  140.  
  141.  
  142. The following variables have one thing in common.  If a prg-variable
  143. is empty or not specified, the function will not be performed.  For
  144. example, if you use an editor which directly supports the SOUP-format,
  145. you probably won't need the import and export-functions.  This means
  146. the prgImport and prgExport-variables can be deleted or can be set to
  147. an empty string.  If a dir-variable is empty or not specified, the
  148. directory won't be changed during that operation.  For example, if
  149. both the prgRecv and prgImport-programs has to execute from the same
  150. directory, you won't have to set the dirImport-variable (however, it
  151. is safer ofcourse to do set it).  Here are the variables:
  152.  
  153. prgConnect   This variable specifies the program which is used to
  154.              connect to the Internet.  When used with the OS/2
  155.              Internet Connection, this will normally be a command
  156.              which starts PPP.EXE or SLIP.EXE with it's necessary
  157.              parameters in the background (if you don't know the
  158.              parameters, because you normally start PPP or SLIP from
  159.              the PM Dialer, there exists a program which fetches these
  160.              variables for you, called PPPFK101.ZIP on most OS/2
  161.              BBSes).
  162.  
  163. prgExport    This variable specifies the program which is used to put
  164.              new mail and news ready for sending to the Internet.  In
  165.              a SOUPER/SOUP2SQ-configuration, this should be
  166.              'SOUP2SQ -s'.
  167.  
  168. prgSend      This variable specifies the program which is used to send
  169.              available mail and news to the Internet.  In a
  170.              SOUPER/SOUP2SQ-configuration, this should be 'SOUPER -s'.
  171.  
  172. prgRecv      This variable specifies the program which is used to
  173.              receive new mail and news from the Internet. In a
  174.              SOUPER/SOUP2SQ-configuration, this should be 'SOUPER'.
  175.  
  176. prgImport    This variable specifies the program which imports
  177.              received mail and news into your message-base.  In a
  178.              SOUPER/SOUP2SQ- configuration, this should be
  179.              'SOUP2SQ -r'.
  180.  
  181. dirExport    This variable specifies the directory from which the
  182.              prgExport-program is executed.  In a SOUPER/SOUP2SQ-
  183.              configuration, this should be the directory where
  184.              SOUP2SQ.CFG resides.
  185.  
  186. dirSend      This variable specifies the directory from which the
  187.              prgSend-program is executed.  In a SOUPER/SOUP2SQ-
  188.              configuration, this should be the directory where the
  189.              SOUP reply-packets reside.
  190.  
  191. dirRecv      This variable specifies the directory from which the
  192.              prgRecv-program is executed.  In a SOUPER/SOUP2SQ-
  193.              configuration, this should be the directory where SOUP2SQ
  194.              looks for SOUP-packets which have to be imported into a
  195.              squish message-base.
  196.  
  197. dirImport    This variable specifies the directory from which the
  198.              prgImport-program is executed.  In a SOUPER/SOUP2SQ-
  199.              configuration, this should be the directory where
  200.              SOUP2SQ.CFG resides.
  201.  
  202.  
  203. If you have configured all variables correctly and changed the
  204. REXX-script as indicated under the installation-section if you don't
  205. use SOUP-packets, you should be ready to automatically fetch your mail
  206. and news from the Internet.  For example, if you have a program which
  207. can start other programs at specified times, you can fetch your mail
  208. and news at night when the lines of your provider aren't busy and
  209. while you are asleep.
  210.  
  211. With all error-checking and the two timers, it is almost impossible
  212. that the connection isn't terminated if something goes wrong, so you
  213. won't get high phone-bills because the connection wasn't terminated
  214. because of an error.  However, I don't take any responsibility for
  215. this (I said almost impossible, not totally impossible).
  216.  
  217.  
  218.  
  219. time-outs:
  220.  
  221. As you can see in the configuration-sections, there are two timers
  222. build into the REXX-script. The first one can always be used, and
  223. requires no special changes. Normally you will want to set this
  224. time-out to a high value, especially if you use a login-script which
  225. features redialing when your provider is busy or something.
  226.  
  227. Normally, if something goes wrong during the login-fase, this will be
  228. handled by the second timer (since the second timer only starts after
  229. a CONNECT-message is received from the modem). However, to use the
  230. second timer, you need to have a REXX login-script (as far as I know
  231. you can't trigger the second timer from a login response-file or
  232. something like that) and you will have to make a change to your REXX
  233. login-script.
  234.  
  235. The second timer is started when the file specified by the
  236. triggerFile-variable is found (note that during initialisation of
  237. MAIL.CMD this trigger-file, if found, is deleted). So to initialise
  238. the second timer you have to change your REXX login-script to create
  239. the trigger-file after a CONNECT-message is received. It won't be
  240. very difficult to find the right spot, especially if you know REXX a
  241. little bit. Just putting the following line at the right place will
  242. do it:
  243.  
  244. "ECHO. > <name>"
  245.  
  246. (fill in the name you specified in the triggerFile-variable instead of
  247. <name>). The quotes have to be included. When you've done this, you
  248. will be able to use the second timer.
  249.  
  250.  
  251.  
  252. Usage:
  253.  
  254. Normally you can just execute MAIL.CMD from an OS/2 command prompt (if
  255. the directory where you placed MAIL.CMD isn't contained in your PATH,
  256. you have to go to that directory first ofcourse). If you don't give
  257. any parameters, it will export new mail and news from your
  258. message-base, connect to the Internet, send and receive new mail,
  259. terminate the connection and import the received mail and news.
  260.  
  261. You can also give a parameter on the command-line.  The program
  262. doesn't look at this parameter, but if a parameter is found, the
  263. REXX-script won't terminate the connection after receiving mail and
  264. news. You can use this feature if you want to use other services on
  265. the Internet, like FTP, WWW etc. This way you won't be interupted
  266. after MAIL.CMD has received new mail and news.
  267.  
  268.  
  269.  
  270. Known bugs:
  271.  
  272. I'm only aware of one bug. The output of all external programs and
  273. some informational messages are written to a logfile. But I couldn't
  274. find a way to redirect the output from the DETACH or START commands,
  275. without also redirecting the output from the started or detached
  276. program (when the output of a started program is redirected to the
  277. logfile, the logfile can't be used by my own program anymore, because
  278. only one process is allowed to use it).
  279.  
  280. Because of this I don't redirect the output of the program specified
  281. in the prgConnect-variable, since this is normally a program which
  282. has to be started in the background using START or DETACH.
  283. This means that if you use DETACH to start PPP or SLIP, you will see
  284. a message on your screen saying "The process identification number
  285. is 87" or something like that.
  286.  
  287. If anybody knows a solution to this problem, please let me know (see
  288. the addresses at the bottom of this document).
  289.  
  290.  
  291.  
  292. Trouble-shooting:
  293.  
  294. If you can't get MAIL.CMD to work, first try to do all the actions
  295. manually.  This means you have to execute all the commands you have
  296. given in the prg-variables from the directory specified in the
  297. corresponding dir-variable.
  298. If something goes wrong, you have to check the configuration of the
  299. other programs.  If everything works all right, something is probably
  300. wrong with the REXX-script. Please check the documentation once more
  301. to see whether you skipped something important.
  302.  
  303. If you still can't find the error, and you know REXX, you can try to
  304. fix the program yourself. If you fix a problem, please let me know,
  305. so I can incorporate it into newer version of this program.
  306.  
  307. If you can't fix the problem yourself, please send a message to me
  308. (see the bottom of this document for my addresses) containing
  309. information about the problem, the version of MAIL.CMD you are using
  310. and other information of which you think it can be usefull. I will
  311. try to fix the problem as time permits.
  312.  
  313.  
  314.  
  315. Support:
  316.  
  317. If you like this program, I would like to hear from you.  You can
  318. either send me an email or netmail, a postcard would also be nice (my
  319. mother likes the stamps). If you appreciate this program so much that
  320. you want to send me (a poor student) some money, I would appreciate it
  321. even more.
  322. I will support this program on an as-time-permits basis, if you have
  323. any problems, suggestions, tips etc about the program itself or this
  324. documentation, I would like to hear from you. Also, if you create a
  325. modified version of this program, I would like to hear this from you.
  326.  
  327.  
  328.  
  329. Addresses:
  330.  
  331. E-Mail:  rsenden@cs.ruu.nl
  332.  
  333. Fidonet: 2:280/804.2054
  334.  
  335. Home:    Ruud Senden
  336.          Nieuwendijk 72
  337.          3443 BN Woerden
  338.          The Netherlands
  339.          Europe
  340.  
  341. Giro-account:
  342.  
  343.    Postbank NV
  344.    Amsterdam
  345.    The Netherlands
  346.    Account:  #    : 6281120
  347.              name : Ruud Senden
  348.              city : Woerden
  349.