docs/reference/changes-2.2.sgml

   1 <refentry id="gmime-changes-2-2" revision="6 June 2004">
   2   <refmeta>
   3     <refentrytitle>Changes from 2.0 to 2.2</refentrytitle>
   4     <manvolnum>3</manvolnum>
   5     <refmiscinfo>Changes from 2.0 to 2.2</refmiscinfo>
   6   </refmeta>
   7   <refnamediv>
   8     <refname>Changes from 2.0 to 2.2</refname>
   9     <refpurpose>Incompatible changes made between version 2.0 and version 2.2</refpurpose>
  10   </refnamediv>
  11   <refsect1>
  12     <title>Incompatible changes from 2.0 to 2.2</title>
  13     <para>See also the PORTING document in the toplevel GMime source directory.</para>
  14     <para>There are no incompatible changes between 2.0 and 2.2.</para>
  15     <para>GMime 2.2 is both API and ABI compatible with GMime 2.0 meaning
  16 that any program written for GMime 2.0 will compile fine with GMime
  17 2.2 and any program linked against GMime 2.0's libraries will also
  18 work with GMime 2.2's libraries.</para>
  19     <para>Most of the changes made between 2.0 and 2.2 were internal but there
  20 are a few API changes you should be aware of (as these interfaces will
  21 be deprecated in some future version, probably 3.0).</para>
  22   </refsect1>
  23   <refsect1>
  24     <title>Replacement interfaces from 2.0 to 2.2</title>
  25     <itemizedlist>
  26       <listitem>
  27         <para>
  28 <function>g_mime_utils_8bit_header_decode()</function> has been split
  29 into 2 functions. We now have
  30 <function>g_mime_utils_header_decode_text()</function> and
  31 <function>g_mime_utils_header_decode_phrase()</function>.
  32 <function>g_mime_utils_header_decode_text()</function> no longer
  33 requires encoded-words to be rfc822 atoms.
  34 <function>g_mime_utils_header_decode_phrase()</function> is
  35 still strict in that encoded-words MUST be valid rfc822 atoms.</para>
  36       </listitem>
  37       <listitem>
  38         <para>
  39 <function>g_mime_utils_8bit_header_encode()</function> has been
  40 renamed to <function>g_mime_utils_header_encode_text()</function> to
  41 be more clear as to what type of header this is supposed to encode. If
  42 you haven't guessed, this function is for encoding rfc822 'text'
  43 headers (such as Subject).</para>
  44       </listitem>
  45       <listitem>
  46         <para>
  47 <function>g_mime_utils_8bit_header_encode_phrase()</function> has been
  48 renamed to <function>g_mime_utils_header_encode_phrase()</function>
  49 mostly for consistancy with the previous 2 changes.</para>
  50       </listitem>
  51       <listitem>
  52         <para>
  53 <function>g_mime_charset_name()</function> has been renamed to
  54 <function>g_mime_charset_iconv_name()</function> for clarity.</para>
  55       </listitem>
  56       <listitem>
  57         <para>
  58 <function>g_mime_charset_locale_name()</function> has been renamed to
  59 <function>g_mime_locale_charset()</function>.</para>
  60       </listitem>
  61       <listitem>
  62         <para>
  63 <function>g_mime_cipher_context_verify()</function> no longer returns
  64 a <structname>GMimeCipherValidity</structname>, instead it returns a
  65 <structname>GMimeSignatureValidity</structname> which is far more
  66 useful. Never fear, you may still use the
  67 <structname>GMimeCipherValidity</structname> APIs for the time being -
  68 they work fine given a <structname>GMimeSignatureValidity</structname>
  69 structure.</para>
  70       </listitem>
  71       <listitem>
  72         <para>
  73 <function>g_mime_multipart_signed_verify()</function> also now returns
  74 a <structname>GMimeSignatureValidity</structname> structure rather than
  75 a <structname>GMimeCipherValidity</structname> structure. See changes to
  76 <function>g_mime_cipher_context_verify()</function> for details.</para>
  77       </listitem>
  78     </itemizedlist>
  79   </refsect1>
  80 </refentry>