README

   1                             GMime, version 2.6.15
   2                    by Jeffrey Stedfast <fejj@gnome.org>
   3
   4
   5 WHAT IS GMIME
   6 -------------
   7
   8 GMime is a C/C++ library for parsing and creating messages using
   9 the Multipurpose Internet Mail Extension (MIME) as defined by the
  10 following RFCs:
  11
  12  * 0822: Standard for the Format of Arpa Internet Text Messages
  13  * 1521: MIME (Multipurpose Internet Mail Extensions) Part One:
  14          Mechanisms for Specifying and Describing the Format of
  15          Internet Message Bodies
  16  * 1847: Security Multiparts for MIME: Multipart/Signed and
  17          Multipart/Encrypted
  18  * 1864: The Content-MD5 Header Field (Obsoletes rfc1544)
  19  * 2015: MIME Security with Pretty Good Privacy (PGP)
  20  * 2045: Multipurpose Internet Mail Extensions (MIME) Part One:
  21          Format of Internet Message Bodies
  22  * 2046: Multipurpose Internet Mail Extensions (MIME) Part Two:
  23          Media Types
  24  * 2047: Multipurpose Internet Mail Extensions (MIME) Part Three:
  25          Message Header Extensions for Non-ASCII Text
  26  * 2048: Multipurpose Internet Mail Extensions (MIME) Part Four:
  27          Registration Procedures
  28  * 2049: Multipurpose Internet Mail Extensions (MIME) Part Five:
  29          Conformance Criteria and Examples
  30  * 2183: Communicating Presentation Information in Internet Messages:
  31          The Content-Disposition Header Field
  32  * 2184: MIME Parameter Value and Encoded Word Extensions: Character
  33          Sets, Languages, and Continuations
  34  * 2231: MIME Parameter Value and Encoded Word Extensions: Character
  35          Sets, Languages, and Continuations (Obsoletes rfc2184)
  36  * 2822: Internet Message Format (Obsoletes rfc822)
  37  * 3156: MIME Security with OpenPGP (Updates rfc2015)
  38  * 5322: Internet Message Format (Obsoletes rfc2822)
  39
  40 Other RFCs of interest:
  41
  42  * 1872: The MIME Multipart/Related Content-type
  43  * 1927: Suggested Additional MIME Types for Associating Documents
  44  * 2111: Content-ID and Message-ID Uniform Resource Locators
  45  * 2311: S/MIME Version 2 Message Specification
  46  * 2312: S/MIME Version 2 Certificate Handling
  47  * 2387: The Multipart/Related Content-Type.
  48  * 2424: Content Duration MIME Header Definition
  49  * 2630: Cryptographic Message Syntax
  50  * 2632: S/MIME Version 3 Certificate Handling
  51  * 2633: S/MIME Version 3 Message Specification
  52  * 2634: Enhanced Security Services for S/MIME
  53  * 3280: Internet X.509 Public Key Infrastructure certificate and
  54          Certificate Revocation List (CRL) Profile
  55
  56 Cryptography related RFCs:
  57
  58  * 2268: A Description of the RC2(r) Encryption Algorithm
  59  * 2313: PKCS #1: RSA Encryption
  60  * 2314: PKCS #10: Certification Request Syntax
  61  * 2315: PKCS #7: Cryptographic Message Syntax
  62  * 2631: Diffie-Hellman Key Agreement Method
  63
  64
  65 LICENSE INFORMATION
  66 -------------------
  67
  68 The GMime library is Copyright (C) 2000-2011 Jeffrey Stedfast.
  69
  70 This library is free software; you can redistribute it and/or
  71 modify it under the terms of the GNU Lesser General Public
  72 License as published by the Free Software Foundation; either
  73 version 2.1 of the License, or (at your option) any later version.
  74
  75 This library is distributed in the hope that it will be useful,
  76 but WITHOUT ANY WARRANTY; without even the implied warranty of
  77 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  78 Lesser General Public License for more details.
  79
  80 You should have received a copy of the GNU Lesser General Public
  81 License along with this library; if not, write to the Free Software
  82 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  83
  84
  85 HISTORY
  86 -------
  87
  88 As a developer and user of Electronic Mail clients, I had come to
  89 realize that the vast majority of E-Mail client (and server) software
  90 had less-than-satisfactory MIME implementations. More often than not
  91 these E-Mail clients created broken MIME messages and/or would
  92 incorrectly try to parse a MIME message thus subtracting from the full
  93 benefits that MIME was meant to provide. GMime is meant to address
  94 this issue by following the MIME specification as closely as possible
  95 while also providing programmers with an extremely easy to use
  96 high-level application programming interface (API).
  97
  98
  99 OBTAINING GMIME
 100 ---------------
 101
 102 Sources to GMime may be obtained from:
 103   http://download.gnome.org/pub/GNOME/sources/gmime/
 104 or
 105   ftp://ftp.gnome.org/pub/GNOME/sources/gmime/
 106
 107 Information regarding GMime may be obtained from the Spruce home page:
 108   http://spruce.sourceforge.net/gmime/
 109
 110 Experimental versions of GMime may be obtained by following the
 111 directions at http://developer.gnome.org/tools/svn.html
 112
 113   git clone git://git.gnome.org/gmime
 114
 115
 116 REQUIREMENTS
 117 ------------
 118
 119 For proper compilation and functionality of GMime, the following packages
 120 are REQUIRED:
 121
 122   - Glib version >= 2.18.0
 123
 124     Glib provides a number of portability-enhancing functions and types.
 125     Glib is included in most GMime-supported operating system
 126     distributions.  Glib sources may be obtained from:
 127       ftp://ftp.gtk.org/pub/glib
 128
 129
 130 DOCUMENTATION
 131 -------------
 132
 133 This is the README file for GMime.  Additional documentation related to
 134 development using GMime has been included within the source release
 135 of GMime.
 136
 137   docs/reference/       Contains SGML and HTML versions of the GMime
 138                         reference manual
 139
 140   docs/tutorial/        Contains SGML and HTML versions of the GMime
 141                         tutorial
 142
 143   AUTHORS               List of primary authors (source code developers)
 144
 145   COPYING               The GNU Lesser General Public License, version 2
 146
 147   ChangeLog             Log of changes made to the source code
 148
 149   INSTALL               In-depth installation instructions
 150
 151   NEWS                  Release notes (Overview of changes)
 152
 153   TODO                  Description of planned GMime development
 154
 155   PORTING               Guide for developers porting their application
 156                         from an older version of GMime
 157
 158
 159 You can find online developer documentation at
 160 http://library.gnome.org/devel/gmime/stable/
 161
 162
 163 MAILING-LIST
 164 ------------
 165
 166 For discussion of GMime development (either of GMime itself or using
 167 GMime in your own application), you may find the GMime-Devel
 168 mailing-list helpful. To subscribe, please see
 169 http://mail.gnome.org/mailman/listinfo/gmime-devel-list
 170
 171
 172 BINDINGS
 173 --------
 174
 175 Other developers have been working to make GMime available to
 176 programmers in other languages. The current list of known bindings
 177 are:
 178
 179 - Perl: http://search.cpan.org/dist/MIME-Fast/
 180
 181 - .NET (Mono): Included in this distribution.
 182
 183
 184 REPORTING BUGS
 185 --------------
 186
 187 Bugs may be reported to the GMime development team by submitting a bug
 188 report for the gmime module at http://bugzilla.gnome.org/