home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 5 Edit / 05-Edit.zip / rconv112.zip / richconv / readme < prev    next >
Text File  |  1998-10-17  |  12KB  |  214 lines

  1. ----------------------------------------------------------------------------
  2. What is RichConv?
  3. ----------------------------------------------------------------------------
  4.  
  5. Some email programs (in particular Eudora) send emails in text/enriched format, which is a MIME (Multipurpose Internet Mail Extensions) type that has been defined in RFC 1896. This format allows the use of simple text formatting in emails, like the use of italic or bold fonts.
  6.  
  7. Note that text/enriched is neither related to rich text format (RTF) nor to any other "rich" or "enriched" text format.
  8.  
  9. There are several problems with text/enriched emails and PMMail:
  10.  
  11. (1) If PMMail receives such a text/enriched email, it puts the body of this email in an attachment and displays an empty Read Message Window.
  12.  
  13. (2) You need to open that attachment to read the actual message text. 
  14.  
  15. (3) Once you've opened the attached file, you will probably see the unmodified text/enriched source text, with oddly placed line breaks and with formatting commands like <italic> or <bold>.
  16.  
  17. Usually you will notice that the contents of most text/enriched emails does not really justify the usage of the text/enriched format, but that's a different problem... ;-)
  18.  
  19. RichConv is a converter for text/enriched emails. It converts a text/enriched email file into a multipart/alternative email file with a text/plain version of the original text/enriched email as its first part.
  20.  
  21. RichConv has been written to be used with the filter feature of PMMail for OS/2. However, it may also be used with any other email client that can run an external program to modify incoming emails.
  22.  
  23. RichConv may also be used as a command line tool if the input file contains only one single email that complies with RFC 822.
  24.  
  25. ----------------------------------------------------------------------------
  26. This is important!
  27. ----------------------------------------------------------------------------
  28.  
  29. RichConv is freeware. 
  30.  
  31. So, strictly speaking, you should not expect this program to do anything else than to decrease the amount of free memory in your computer. Since you don't pay anything for this program, this is actually already a bit of feature overkill... ;-)
  32.  
  33. Anyway, I appreciate any suggestions how to improve RichConv. If you find that RichConv doesn't work as you think it should, send me a note. If possible, please attach an example for an email file that causes the problem.
  34.  
  35. ----------------------------------------------------------------------------
  36. The most recent version of RichConv
  37. ----------------------------------------------------------------------------
  38.  
  39. I will upload the most recent version of RichConv to Hobbes (http://hobbes.nmsu.edu/ or ftp://hobbes.nmsu.edu/) only.
  40.  
  41. I have no particular preferences for Hobbes, except that it's one of the better known OS/2 software servers in that part of the world where I presently happen to live.
  42.  
  43. ----------------------------------------------------------------------------
  44. Files in this distribution
  45. ----------------------------------------------------------------------------
  46.  
  47. In the richconv directory:
  48.  
  49. filter.bmp   - Example for PMMail filter settings
  50. liesmich     - German read-me file
  51. mime.bmp     - Example for MIME Associations settings for text/html
  52. readme       - This file
  53. richconv.c   - The source code of RichConv
  54. richconv.exe - The RichConv executable for OS/2
  55. todo         - List of missing features, workarounds, restrictions, etc
  56.  
  57. In the richgconv\pgp directory:
  58.  
  59. filter.sig   - My PGP signature for filter.bmp
  60. liesmich.sig - My PGP signature for liesmich
  61. mime.sig     - My PGP signature for mime.bmp
  62. readme.sig   - My PGP signature for readme
  63. richconv.sig - My PGP signature for richconv.c
  64. todo.sig     - My PGP signature for todo
  65.  
  66. In the richconv\nt directory:
  67.  
  68. richconv.exe - RichConv executable for Windows NT (see below!)
  69.  
  70. If you want to use RichConv under Windows NT and want to be shure to run the most recent version of RichConv, you need to compile the program yourself. I don't have access to a C compiler for Windows NT. The executable in the richconv\nt directory is not up-to-date.
  71.  
  72. However, if you have problems compiling the source code for Windows NT, send me a note. I will try to help you by changing the source code of RichConv, if that should be necessary to solve your problems.
  73.  
  74. ----------------------------------------------------------------------------
  75. How RichConv works
  76. ----------------------------------------------------------------------------
  77.  
  78. With the proper PMMail filter set-up (see below), RichConv will convert any incoming text/enriched email to a multipart/alternative email, that consists of three parts:
  79.  
  80. (1) A text/plain part:
  81. This is a reduced-formatting version of the original text/enriched email. Most formatting commands are simply removed from the original text. Optionally, a few are interpreted. For example italic, bold, or underlined text can be converted to uppercase. The text/plain part will be automatically displayed in PMMail's Read Message Window.
  82.  
  83. (2) A text/html part:
  84. This is an HTML version of the original text/enriched email. Just to give an impression of how the original email was probably supposed to look like. However, be warned that RichConv's conversion from text/enriched to text/html is not perfect. And by definition, just like for text/enriched, there is no standard of how to interpret HTML elements anyway. The text/html part will appear as the first attachment of the email.
  85.  
  86. (3) A text/enriched part:
  87. This is the original email. It is not altered in any way, except that it is now embedded in a multipart/alternative MIME email. Thus, PGP signatures for example should still be valid. The text/enriched part will appear as the second attachment of the email.
  88.  
  89. Note: RichConv expects RFC-1896 compatible text/enriched emails. I couldn't verify statements, that some companies prefer to use their own, proprietary version of text/enriched. Any hints are welcome.
  90.  
  91. ----------------------------------------------------------------------------
  92. How to use RichConv
  93. ----------------------------------------------------------------------------
  94.  
  95. If you enter "richconv /h" in a command line window, the program will output some helpful informations to the screen. 
  96.  
  97. To use RichConv you first need to put richconv.exe in a directory of your choice. This directory doesn't have to be listed in your PATH environvent variable, and it also doesn't have to be any of the PMMail directories.
  98.  
  99. To use RichConv as a converter for incoming text/enriched emails in PMMail, you want to set up a filter in PMMail that calls RichConv. Here's how to do that:
  100.  
  101. (1) Go to "Account->Account Settings...->Filters"
  102.  
  103. In PMMail version prior to 1.96 you may have to go to "Account->Utilities Settings...->Filters". IN PMMail/2 2.0 and newer versions you can use the shortcut "Account->Filters..."
  104.  
  105. (2) Click on "New".
  106.  
  107. (3) Enter the following data in the "Edit Filter" window (see filter.bmp for an example):
  108.  
  109.   Description Any name you like
  110.   Enabled     [should be checked]
  111.   Simple
  112.     Search    <Header> 
  113.     For       Content-Type: text/enriched
  114.   Type        Incoming
  115.   Actions     REXX Exit (Background) x:\full\path\to\richconv.exe
  116.  
  117. You don't need to enter any arguments or %s after richconv.exe. 
  118.  
  119. However, you may enter command line switches, like the "-html" in the following example: "x:\full\path\to\richconv.exe -nohtml". PMMail will pass through all arguments to RichConv. 
  120.  
  121. To get more information about the possible command line options and about RichConv's default behavior, enter "richconv /h".
  122.  
  123. During the first time it's usually helpful to add the "Inform User" action after "REXX Exit", so you can know when this filter finds a matching email and calls RichConv.
  124.  
  125. (4) Click on "OK". 
  126.  
  127. (5) Make shure there is no filter that moves incoming text/enriched messages out of the Inbox, before RichConv had a chance to convert them. 
  128.  
  129. If necessary, use the "Up"/"Down" buttons to change the filter sequence.
  130.  
  131. (6) Make sure that there is no other conflict with another filter. That's the hardest part, and you're on your own... good luck ;-)
  132.  
  133. That's it.
  134.  
  135. ----------------------------------------------------------------------------
  136. How to view the text/plain part
  137. ----------------------------------------------------------------------------
  138.  
  139. The text/plain part should be displayed once you double-click on the message in PMMail's message list. (Actually that's the main purpose of RichConv.)
  140.  
  141. ----------------------------------------------------------------------------
  142. How to view the text/html part
  143. ----------------------------------------------------------------------------
  144.  
  145. There are two ways to view the text/html part:
  146.  
  147. (1) Just drag and drop the first attachment on your favorite WWW browser or its icon. 
  148.  
  149. (2) In case you haven't done this yet, go to "PMMail->Settings...->MIME" Associations, klick on Add and enter the following data (see mime.bmp for an example):
  150.  
  151.   Description           HTML
  152.   MIME Type             text / html
  153.   File Extension        html htm
  154.   Program To Execute:   x:\path\to\your\favorite\browser.exe
  155.   Arguments:            [other arguments if necessary] %s
  156.   Working Directory     [leave this field empty]
  157.   Program Type          [depends on your browser, e.g. "OS/2 PM" for Netscape]
  158.  
  159. Now a double click on the first attachment should load it into your WWW browser.
  160.  
  161. ----------------------------------------------------------------------------
  162. How to view the text/enriched part
  163. ----------------------------------------------------------------------------
  164.  
  165. You may still view the unaltered, original text/enriched part by double clicking on the second attachment. For example, with my MIME settings for PMMail, i.e. with no entry for text/enriched, the System Editor will start and load the attachment as a simple text file. Depending on your MIME settings, something different may happen.
  166.  
  167. ----------------------------------------------------------------------------
  168. How to test RichConv
  169. ----------------------------------------------------------------------------
  170.  
  171. RichConv reads a file, modifies it, and re-writes it. Hence you may test RichConv using any file that contains a text/enriched email. 
  172.  
  173. Warning: RichConv overwrites the original email file. So, you want to make a backup of the original file before testing RichConv.
  174.  
  175. However, make shure that the input email file also contains the header of the email. If you've configured PMMail not to display email headers by default, it will also not save the header to a file. To save the body and the header in this case, you need to open the email, click on "Toggle Display Of The Message Header" and then save it to a file.
  176.  
  177. ----------------------------------------------------------------------------
  178. Acknowledgements
  179. ----------------------------------------------------------------------------
  180.  
  181. Allen H Cogbill <ahc@lanl.gov> suggested the options to limit the input file size and to suppress any conversion to uppercase in the text/plain part.
  182.  
  183. Per Jessen <per@ibm.net> compiled the executable for Windows NT.
  184.  
  185. Paul Hodges <paul@qbss.co.uk> made him do it and sent me the executable.
  186.  
  187. Roger Lindmark <roger-li@algonet.se> helped as a beta tester.
  188.  
  189. Robb Selby <robbselby@earthlink.net> made me add support for colors and fonts, and helped me to debug the new program code.
  190.  
  191. ----------------------------------------------------------------------------
  192. The author
  193. ----------------------------------------------------------------------------
  194.  
  195. Enter "richconv /h" to get my email address.
  196.  
  197. You may request my PGP public key by sending me an empty email with "send pgp key" in the subject line.
  198.  
  199. ----------------------------------------------------------------------------
  200. Miscellaneous
  201. ----------------------------------------------------------------------------
  202.  
  203. I've written a similar program named HtmlConv that converts text/html just like RichConv converts text/enriched. Should be available on the same server as HtmlConv. (You don't need this for PMMail/2 2.0 and newer!)
  204.  
  205.  
  206.  
  207.  
  208.  
  209. Rolf Lochbuehler
  210. Vermont, USA
  211. --
  212. $Id: readme,v 1.10 1998-10-17 10:12:10-04 rl Exp $
  213.  
  214.