home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 35 Internet / 35-Internet.zip / icetag26.zip / icetag26.doc < prev    next >
Text File  |  1997-02-21  |  8KB  |  225 lines
  1. DISCLAIMER:
  2. ----------
  3. IceTag/2 is  supplied as is without any warranties, expressed or implied.
  4. The author assumes no liability for damages which may result from the use
  5. of IceTag/2.
  6.  
  7. Package Contents:
  8. ----------------
  9.  
  10.     icetag25.cmd    The main IceTag/2 (v2.5) REXX script.
  11.     iceidx25.cmd    Indexing utility required for producing index file.
  12.     pqf4.quo    This is the Pratchett Quotes file with several additions 
  13.             by me.
  14.     icetag25.doc    This is the file you're reading now.
  15.  
  16. Description:
  17. ------------
  18.  
  19.     IceTag/2 is a REXX script that gives you the ability of adding random
  20.     tags or quotes to the end of any e-mail you send using PMMail. This ability
  21.     is enhanced further by giving you the freedom of adding quotes of
  22.     any length (you're not limited to a certain number of lines).
  23.  
  24.  
  25. Requirements:
  26. ------------
  27.  
  28.     This program requires the following:
  29.     
  30.         1. OS/2 Warp 4.0 (Version 3.0 can also be used).
  31.         2. REXX must be installed (comes included with OS/2 Warp).
  32.         3. SouthSoft's PMMail 1.5 or above.
  33.                                                    
  34.  
  35. New Features in this Release:
  36. ----------------------------
  37.  
  38.     - Improved Speed: this release is almost 50% faster than the previous releases.
  39.     - You can see the quote before it gets added to the e-mail and if you don't like
  40.       it, you ask IceTag/2 to pull another one from the quote file.
  41.     - Can remove the X-Mailer line or replace it with any string.
  42.     - More control over the way the quote is added at the end.
  43.         
  44.  
  45. Installation:
  46. ------------
  47.  
  48. 1. Unzip the archive containing the program into a temporary directory.
  49. 2. Copy icetag25.cmd, iceidx25.cmd & pqf4.quo to you PMMail directory.
  50. 3. Change to the PMMail directory and edit the iceidx25.cmd file as required
  51.    if you want to use a different quote file than the one included.
  52. 4. Run iceidx25.cmd to produce an index file (pqf4.idx)
  53. 5. From inside PMMail, pull down the "Account" menu and choose "Utilities
  54.    Settings".
  55. 6. When the settings window appears, press on the "REXX" tab.
  56. 7. When there, turn on the "Message Send Exit" checkbox and enter the name
  57.    of the script "icetag2.cmd" in the entry field below it.
  58.  
  59. Now you're done installing IceTag/2 with the basic configuration.
  60.  
  61. To test it, send an e-mail to yourself and you'll see that there's a quote
  62. added at the end of the e-mail (if you want to read the quote, open your
  63. e-mail in the "Sent Mail" folder).
  64.  
  65.  
  66. Enabling new Features:
  67. ---------------------
  68.  
  69.     To enable the new features you have to set some flags inside the script
  70.     itself (icetag25.cmd). Changes can be performed using your favorite
  71.     text editor like E or EPM or any other editor.
  72.  
  73. Here's what the configuration section looks like:
  74.  
  75. /*               _   _               ___      _                 */
  76. /*              | | | |___ ___ _ _  / __| ___| |_ _  _ _ __     */
  77. /*              | |_| (_-</ -_) '_| \__ \/ -_)  _| || | '_ \    */
  78. /*               \___//__/\___|_|   |___/\___|\__|\_,_| .__/    */
  79. /*                                                    |_|       */
  80.  
  81.  
  82. /* 1. Do you want to confirm each quote before it is applied to an
  83.    outgoing e-mail? (0=NO - 1=Yes)                              */
  84.  
  85. Confirm=0
  86.  
  87. /* 2. Do you want a string inserted before each quote?          */
  88. /* (0=NO - 1=Yes)                                               */
  89.  
  90. insert_prefix=0
  91.  
  92. /* 3. If you want a prefix other than the one below, change the
  93.    value between the quotes.                                    */
  94.  
  95. prefix="... "
  96.  
  97. /* 4. Do you want a newline inserted before the quote?          */
  98. /* (0=NO - 1=Yes)                                               */
  99.  
  100. insert_newline=0
  101.  
  102. /* 5. Do you want to replace the X-Mailer line in your header?  */
  103. /* (0=NO - 1=Yes)                                               */
  104.  
  105. replace_xmailer=0
  106.  
  107. /* If answered YES to the above question then you can change the
  108.    change the value below to something you prefer to replace the
  109.    X-Mailer line with. Leaving nothing between the quotes removes
  110.    the X-Mailer line completely.                                */
  111.  
  112. new_XMailer=""
  113.  
  114. /*--------------------------------------------------------------*/
  115. /* End of User Setup section                                    */
  116.  
  117.  
  118. These are the default values for the flags which will achieve the
  119. following results:
  120.  
  121.     1. It's working in Silent Mode (it won't ask for confirmation
  122.        for the quote pulled from the file).
  123.     2. It won't add anything before the quote.
  124.     3. It won't insert a blank line before the quote starts.
  125.     4. It won't replace the X-Mailer line.
  126.  
  127.  
  128. Changing Mode to Interactive:
  129. ----------------------------
  130.  
  131.     To gain a bit of control over the quotes added, let the value of Confirm
  132.     equal 1. And in the Account -> Utilities Settings -> REXX dialog, check the box
  133.     under "Message Send Exit" entry field marked "Execute Script in Foreground".
  134.  
  135.     Now whenever you send a message a command window will popup and will look something
  136.     like this:
  137.  
  138. ________________________
  139.  
  140. "Research is what I'm doing when I don't know what I'm doing."
  141.         -- Wernher von Braun
  142.  
  143. Do you feel that this quote is appropriate (Y/N) ?
  144. ________________________
  145.  
  146.     If you answer with a "y" then the window will disappear and your 
  147.     message will be processed after the quote gets appended to it. 
  148.     But if you answer with a "n" a new quote will be pulled from the 
  149.     file and you will be asked again to confirm adding it to your e-mail.
  150.  
  151.  
  152. Adding a Prefix before the Quote:
  153. --------------------------------
  154.  
  155.     Some people prefer to precede any quote added to their e-mails with 
  156.     some characters like dots or dashes. To enable this feature, change
  157.     the value of "insert_quote" to 1 and also change the prefix itself 
  158.     (by changing the value of the variable "prefix" under the next question) 
  159.     if you have a specific preference.
  160.  
  161.  
  162. Inserting a Blank Line Before the Quote:
  163. ---------------------------------------
  164.  
  165.     If you prefer to have some space between your sig and the quote,
  166.     change the value of "insert_newline" to 1.
  167.  
  168.  
  169. Replacing the X-Mailer Line:
  170. ---------------------------
  171.  
  172.     Many people prefer to maintain their anonymity if their desire it
  173.     but the X-Mailer line added to the header of every message they send 
  174.     prevents that. For example, every e-mail I send has the following line 
  175.     in the header:
  176.  
  177.     X-Mailer: Ahmad Al-Nusif's Registered PMMail 1.9 For OS/2
  178.  
  179.     So even if my name doesn't appear anywhere in the message body, all that 
  180.     someone who wants to know the origin of the e-mail has to do is look at 
  181.     the header and it won't be a secret anymore.
  182.  
  183.     So, if you want to remove this line completely, change the value of 
  184.     "replace_xmailer" to 1. But if you want to replace it with something else 
  185.     change "replace_xmailer" to 1 AND change "new_XMailer" to a different
  186.     value. Leaving "new_XMailer" as an empty string    will only remove the 
  187.     X-Mailer line.
  188.  
  189.     _NOTE_: I've seen some REXX scripts that do just that, so this is not
  190.         the only program that can do this.
  191.  
  192. Adding More Quote to the File:
  193. -----------------------------
  194.  
  195.     Adding more quotes to the quote file is simplicity itself. Just open
  196.     the quote file (pqf4.quo) in E and add whatever quotes you like and 
  197.     appending a "#" at the end of each one. Save the file and run iceidx25.cmd
  198.     again to refresh the index file (pqf4.idx). Next time you send an e-mail, 
  199.     there's a chance that one of your new quotes will get picked from the file.
  200.  
  201. Status:
  202. -------
  203.        This program is E-mailware, i.e. send me an e-mail if you like/use it.
  204.        But it's copyrighted to Ahmad Al-Nusif (morpheus@moc.kw) so you're
  205.        not allowed to put your own name to it or use portions of it in your
  206.        program without consulting me.
  207.  
  208.  
  209. Note:
  210.  
  211.       If you have an attachment in your e-mail the quote will be appended
  212.       after it. So if you send an e-mail with an attachment and then go
  213.       to the sent mail folder to check the quote, you won't see it unless
  214.       you press alt-v (which displays the attachment as text).
  215.  
  216.  
  217. Contact:
  218. -------
  219.  
  220.     Please e-mail me if you like this little program or if you have any
  221.     suggestions at:
  222.  
  223.     Ahmad Al-Nusif
  224.     morpheus@moc.kw
  225.