mimelib/README.mimepp

   1 This is the README file for the MIME++ library.
   2
   3 **** Important: Please read the file LICENSE for information about using
   4 mime++. mime++ may be used for non-commercial use without paying a license
   5 fee; however, by downloading or using the software, you agree to abide by
   6 the terms of the Non-Commercial License. ****
   7
   8 MIME++ is a C++ class library for creating, parsing, and modifying messages
   9 in MIME format.
  10
  11 See the file INSTALL for information about how to compile the library.
  12
  13 The library classes themselves are somewhat low-level.  The example programs
  14 use wrapper classes.  This technique of using wrapper classes is the
  15 recommended way to use MIME++ for two reasons.  First, it will isolate your
  16 application from the low-level, implementation details of the library.
  17 Second, it will help to isolate your application from future changes in
  18 the library classes.  If you are familiar with the idea of design patterns,
  19 the wrapper classes implement the facade pattern.
  20
  21 To learn the library, I suggest you first take a look at the text file
  22 "Tutorial", which contains a tutorial.  Then, I suggest browsing the HTML
  23 man pages, which can all be referenced from doc/mimepp.html.  If you do
  24 not have an HTML browser available, use your favorite editor to view the
  25 .h files.  All the text of the man pages is embedded as comments in the .h
  26 files.  Look especially at the man pages for DwString and
  27 DwMessageComponent, the base class of nearly all MIME components.  Also,
  28 look at the example programs.  As a starting point for your own
  29 application, I suggest you start with the source code for one or more of
  30 the wrapper classes (BasicMessage, declared and defined in basicmsg.*;
  31 MultipartMessage, declared and defined in multipar.*; and
  32 MessageWithAttachments, declared and defined in attach.*) and modify it
  33 for your own use.
  34
  35 Please send me any comments, questions, bug reports, or whatever.
  36
  37 Doug Sauder
  38 dwsauder@fwb.gulf.net