diff options
Diffstat (limited to 'docs')
53 files changed, 668 insertions, 259 deletions
diff --git a/docs/Makefile.in b/docs/Makefile.in index 770bd07..008c441 100644 --- a/docs/Makefile.in +++ b/docs/Makefile.in @@ -1,4 +1,4 @@ -# Makefile.in generated by automake 1.11.3 from Makefile.am. +# Makefile.in generated by automake 1.11.6 from Makefile.am. # @configure_input@ # Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, @@ -15,6 +15,23 @@ @SET_MAKE@ VPATH = @srcdir@ +am__make_dryrun = \ + { \ + am__dry=no; \ + case $$MAKEFLAGS in \ + *\\[\ \ ]*) \ + echo 'am--echo: ; @echo "AM" OK' | $(MAKE) -f - 2>/dev/null \ + | grep '^AM OK$$' >/dev/null || am__dry=yes;; \ + *) \ + for am__flg in $$MAKEFLAGS; do \ + case $$am__flg in \ + *=*|--*) ;; \ + *n*) am__dry=yes; break;; \ + esac; \ + done;; \ + esac; \ + test $$am__dry = yes; \ + } pkgdatadir = $(datadir)/@PACKAGE@ pkgincludedir = $(includedir)/@PACKAGE@ pkglibdir = $(libdir)/@PACKAGE@ @@ -37,7 +54,11 @@ target_triplet = @target@ subdir = docs DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 -am__aclocal_m4_deps = $(top_srcdir)/acinclude.m4 \ +am__aclocal_m4_deps = $(top_srcdir)/m4/gtk-doc.m4 \ + $(top_srcdir)/m4/introspection.m4 $(top_srcdir)/m4/libtool.m4 \ + $(top_srcdir)/m4/ltoptions.m4 $(top_srcdir)/m4/ltsugar.m4 \ + $(top_srcdir)/m4/ltversion.m4 $(top_srcdir)/m4/lt~obsolete.m4 \ + $(top_srcdir)/m4/vapigen.m4 $(top_srcdir)/acinclude.m4 \ $(top_srcdir)/configure.ac am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ $(ACLOCAL_M4) @@ -45,6 +66,12 @@ mkinstalldirs = $(install_sh) -d CONFIG_HEADER = $(top_builddir)/config.h CONFIG_CLEAN_FILES = CONFIG_CLEAN_VPATH_FILES = +AM_V_GEN = $(am__v_GEN_@AM_V@) +am__v_GEN_ = $(am__v_GEN_@AM_DEFAULT_V@) +am__v_GEN_0 = @echo " GEN " $@; +AM_V_at = $(am__v_at_@AM_V@) +am__v_at_ = $(am__v_at_@AM_DEFAULT_V@) +am__v_at_0 = @ SOURCES = DIST_SOURCES = RECURSIVE_TARGETS = all-recursive check-recursive dvi-recursive \ @@ -54,6 +81,11 @@ RECURSIVE_TARGETS = all-recursive check-recursive dvi-recursive \ install-pdf-recursive install-ps-recursive install-recursive \ installcheck-recursive installdirs-recursive pdf-recursive \ ps-recursive uninstall-recursive +am__can_run_installinfo = \ + case $$AM_UPDATE_INFO_DIR in \ + n|no|NO) false;; \ + *) (install-info --version) >/dev/null 2>&1;; \ + esac RECURSIVE_CLEAN_TARGETS = mostlyclean-recursive clean-recursive \ distclean-recursive maintainer-clean-recursive AM_RECURSIVE_TARGETS = $(RECURSIVE_TARGETS:-recursive=) \ @@ -91,6 +123,7 @@ am__relativize = \ ACLOCAL = @ACLOCAL@ ACLOCAL_AMFLAGS = @ACLOCAL_AMFLAGS@ AMTAR = @AMTAR@ +AM_DEFAULT_VERBOSITY = @AM_DEFAULT_VERBOSITY@ API_VERSION = @API_VERSION@ AR = @AR@ AUTOCONF = @AUTOCONF@ @@ -158,6 +191,14 @@ INSTALL_DATA = @INSTALL_DATA@ INSTALL_PROGRAM = @INSTALL_PROGRAM@ INSTALL_SCRIPT = @INSTALL_SCRIPT@ INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ +INTROSPECTION_CFLAGS = @INTROSPECTION_CFLAGS@ +INTROSPECTION_COMPILER = @INTROSPECTION_COMPILER@ +INTROSPECTION_GENERATE = @INTROSPECTION_GENERATE@ +INTROSPECTION_GIRDIR = @INTROSPECTION_GIRDIR@ +INTROSPECTION_LIBS = @INTROSPECTION_LIBS@ +INTROSPECTION_MAKEFILE = @INTROSPECTION_MAKEFILE@ +INTROSPECTION_SCANNER = @INTROSPECTION_SCANNER@ +INTROSPECTION_TYPELIBDIR = @INTROSPECTION_TYPELIBDIR@ LD = @LD@ LDFLAGS = @LDFLAGS@ LIBICONV = @LIBICONV@ @@ -205,6 +246,9 @@ SET_MAKE = @SET_MAKE@ SHELL = @SHELL@ STRIP = @STRIP@ TAR = @TAR@ +VAPIGEN = @VAPIGEN@ +VAPIGEN_MAKEFILE = @VAPIGEN_MAKEFILE@ +VAPIGEN_VAPIDIR = @VAPIGEN_VAPIDIR@ VERSION = @VERSION@ WINDRES = @WINDRES@ abs_builddir = @abs_builddir@ @@ -474,13 +518,10 @@ distdir: $(DISTFILES) done @list='$(DIST_SUBDIRS)'; for subdir in $$list; do \ if test "$$subdir" = .; then :; else \ - test -d "$(distdir)/$$subdir" \ - || $(MKDIR_P) "$(distdir)/$$subdir" \ - || exit 1; \ - fi; \ - done - @list='$(DIST_SUBDIRS)'; for subdir in $$list; do \ - if test "$$subdir" = .; then :; else \ + $(am__make_dryrun) \ + || test -d "$(distdir)/$$subdir" \ + || $(MKDIR_P) "$(distdir)/$$subdir" \ + || exit 1; \ dir1=$$subdir; dir2="$(distdir)/$$subdir"; \ $(am__relativize); \ new_distdir=$$reldir; \ diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am index 2d7e0c4..48485d4 100644 --- a/docs/reference/Makefile.am +++ b/docs/reference/Makefile.am @@ -33,7 +33,7 @@ INCLUDES = \ $(GLIB_CFLAGS) GTKDOC_LIBS = \ - $(top_builddir)/util/libgmime-util.la \ + $(top_builddir)/util/libutil.la \ $(top_builddir)/gmime/libgmime-$(GMIME_API_VERSION).la \ $(GLIB_LIBS) diff --git a/docs/reference/Makefile.in b/docs/reference/Makefile.in index c50a170..ce49967 100644 --- a/docs/reference/Makefile.in +++ b/docs/reference/Makefile.in @@ -1,4 +1,4 @@ -# Makefile.in generated by automake 1.11.3 from Makefile.am. +# Makefile.in generated by automake 1.11.6 from Makefile.am. # @configure_input@ # Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, @@ -21,6 +21,23 @@ # Everything below here is generic # #################################### VPATH = @srcdir@ +am__make_dryrun = \ + { \ + am__dry=no; \ + case $$MAKEFLAGS in \ + *\\[\ \ ]*) \ + echo 'am--echo: ; @echo "AM" OK' | $(MAKE) -f - 2>/dev/null \ + | grep '^AM OK$$' >/dev/null || am__dry=yes;; \ + *) \ + for am__flg in $$MAKEFLAGS; do \ + case $$am__flg in \ + *=*|--*) ;; \ + *n*) am__dry=yes; break;; \ + esac; \ + done;; \ + esac; \ + test $$am__dry = yes; \ + } pkgdatadir = $(datadir)/@PACKAGE@ pkgincludedir = $(includedir)/@PACKAGE@ pkglibdir = $(libdir)/@PACKAGE@ @@ -44,7 +61,11 @@ DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in \ $(top_srcdir)/gtk-doc.make subdir = docs/reference ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 -am__aclocal_m4_deps = $(top_srcdir)/acinclude.m4 \ +am__aclocal_m4_deps = $(top_srcdir)/m4/gtk-doc.m4 \ + $(top_srcdir)/m4/introspection.m4 $(top_srcdir)/m4/libtool.m4 \ + $(top_srcdir)/m4/ltoptions.m4 $(top_srcdir)/m4/ltsugar.m4 \ + $(top_srcdir)/m4/ltversion.m4 $(top_srcdir)/m4/lt~obsolete.m4 \ + $(top_srcdir)/m4/vapigen.m4 $(top_srcdir)/acinclude.m4 \ $(top_srcdir)/configure.ac am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ $(ACLOCAL_M4) @@ -52,12 +73,24 @@ mkinstalldirs = $(install_sh) -d CONFIG_HEADER = $(top_builddir)/config.h CONFIG_CLEAN_FILES = CONFIG_CLEAN_VPATH_FILES = +AM_V_GEN = $(am__v_GEN_@AM_V@) +am__v_GEN_ = $(am__v_GEN_@AM_DEFAULT_V@) +am__v_GEN_0 = @echo " GEN " $@; +AM_V_at = $(am__v_at_@AM_V@) +am__v_at_ = $(am__v_at_@AM_DEFAULT_V@) +am__v_at_0 = @ SOURCES = DIST_SOURCES = +am__can_run_installinfo = \ + case $$AM_UPDATE_INFO_DIR in \ + n|no|NO) false;; \ + *) (install-info --version) >/dev/null 2>&1;; \ + esac DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) ACLOCAL = @ACLOCAL@ ACLOCAL_AMFLAGS = @ACLOCAL_AMFLAGS@ AMTAR = @AMTAR@ +AM_DEFAULT_VERBOSITY = @AM_DEFAULT_VERBOSITY@ API_VERSION = @API_VERSION@ AR = @AR@ AUTOCONF = @AUTOCONF@ @@ -125,6 +158,14 @@ INSTALL_DATA = @INSTALL_DATA@ INSTALL_PROGRAM = @INSTALL_PROGRAM@ INSTALL_SCRIPT = @INSTALL_SCRIPT@ INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ +INTROSPECTION_CFLAGS = @INTROSPECTION_CFLAGS@ +INTROSPECTION_COMPILER = @INTROSPECTION_COMPILER@ +INTROSPECTION_GENERATE = @INTROSPECTION_GENERATE@ +INTROSPECTION_GIRDIR = @INTROSPECTION_GIRDIR@ +INTROSPECTION_LIBS = @INTROSPECTION_LIBS@ +INTROSPECTION_MAKEFILE = @INTROSPECTION_MAKEFILE@ +INTROSPECTION_SCANNER = @INTROSPECTION_SCANNER@ +INTROSPECTION_TYPELIBDIR = @INTROSPECTION_TYPELIBDIR@ LD = @LD@ LDFLAGS = @LDFLAGS@ LIBICONV = @LIBICONV@ @@ -172,6 +213,9 @@ SET_MAKE = @SET_MAKE@ SHELL = @SHELL@ STRIP = @STRIP@ TAR = @TAR@ +VAPIGEN = @VAPIGEN@ +VAPIGEN_MAKEFILE = @VAPIGEN_MAKEFILE@ +VAPIGEN_VAPIDIR = @VAPIGEN_VAPIDIR@ VERSION = @VERSION@ WINDRES = @WINDRES@ abs_builddir = @abs_builddir@ @@ -264,7 +308,7 @@ INCLUDES = \ $(GLIB_CFLAGS) GTKDOC_LIBS = \ - $(top_builddir)/util/libgmime-util.la \ + $(top_builddir)/util/libutil.la \ $(top_builddir)/gmime/libgmime-$(GMIME_API_VERSION).la \ $(GLIB_LIBS) diff --git a/docs/reference/gmime-sections.txt b/docs/reference/gmime-sections.txt index c771bdd..875bce2 100644 --- a/docs/reference/gmime-sections.txt +++ b/docs/reference/gmime-sections.txt @@ -7,6 +7,7 @@ GMIME_BINARY_AGE GMIME_INTERFACE_AGE GMIME_CHECK_VERSION GMIME_ENABLE_RFC2047_WORKAROUNDS +GMIME_ENABLE_USE_ONLY_USER_CHARSETS g_mime_init g_mime_shutdown gmime_major_version @@ -103,6 +104,7 @@ GMIME_STREAM_CAT_GET_CLASS GMimeStreamFile g_mime_stream_file_new g_mime_stream_file_new_with_bounds +g_mime_stream_file_new_for_path g_mime_stream_file_get_owner g_mime_stream_file_set_owner @@ -124,6 +126,7 @@ GMIME_STREAM_FILE_GET_CLASS GMimeStreamFs g_mime_stream_fs_new g_mime_stream_fs_new_with_bounds +g_mime_stream_fs_new_for_path g_mime_stream_fs_get_owner g_mime_stream_fs_set_owner diff --git a/docs/reference/html/GMimeCertificate.html b/docs/reference/html/GMimeCertificate.html index 07fab4f..0e72b0c 100644 --- a/docs/reference/html/GMimeCertificate.html +++ b/docs/reference/html/GMimeCertificate.html @@ -1115,8 +1115,9 @@ Gets the <a class="link" href="GMimeCertificate.html" title="GMimeCertificate">< </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> at the specified index or <code class="literal">NULL</code> if -the index is out of range.</td> +<td>the <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> at the specified +index or <code class="literal">NULL</code> if the index is out of range. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span> +</td> </tr> </tbody> </table></div> diff --git a/docs/reference/html/GMimeContentDisposition.html b/docs/reference/html/GMimeContentDisposition.html index 9f92b6d..865c2bb 100644 --- a/docs/reference/html/GMimeContentDisposition.html +++ b/docs/reference/html/GMimeContentDisposition.html @@ -256,6 +256,10 @@ Sets the Content-Disposition's parameter list. <p> Sets a parameter on the Content-Disposition. </p> +<p> +Note: The <em class="parameter"><code>name</code></em> should be in US-ASCII while the <em class="parameter"><code>value</code></em> should be in +UTF-8. +</p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> @@ -264,10 +268,6 @@ Sets a parameter on the Content-Disposition. <td>a <a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> object</td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>attribute</code></em> :</span></p></td> -<td>parameter name</td> -</tr> -<tr> <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> <td>parameter value</td> </tr> @@ -281,7 +281,7 @@ Sets a parameter on the Content-Disposition. (<em class="parameter"><code><a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> *disposition</code></em>, <em class="parameter"><code>const <span class="type">char</span> *attribute</code></em>);</pre> <p> -Gets the value of the parameter <em class="parameter"><code>attribute</code></em>, or <code class="literal">NULL</code> on fail. +Gets the parameter value specified by <em class="parameter"><code>name</code></em> if it's available. </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> @@ -291,12 +291,10 @@ Gets the value of the parameter <em class="parameter"><code>attribute</code></em <td>a <a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> object</td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>attribute</code></em> :</span></p></td> -<td>parameter name</td> -</tr> -<tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the value of the parameter of name <em class="parameter"><code>attribute</code></em>.</td> +<td>the value of the requested parameter or <code class="literal">NULL</code> if the +parameter is not set. If the parameter is set, the returned string +will be in UTF-8.</td> </tr> </tbody> </table></div> diff --git a/docs/reference/html/GMimeContentType.html b/docs/reference/html/GMimeContentType.html index a1c47c9..f8b385f 100644 --- a/docs/reference/html/GMimeContentType.html +++ b/docs/reference/html/GMimeContentType.html @@ -332,7 +332,7 @@ Sets the Content-Type's parameter list. <pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_content_type_get_parameter (<em class="parameter"><code><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> *mime_type</code></em>, <em class="parameter"><code>const <span class="type">char</span> *attribute</code></em>);</pre> <p> -Gets the parameter value specified by <em class="parameter"><code>attribute</code></em> if it's available. +Gets the parameter value specified by <em class="parameter"><code>name</code></em> if it's available. </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> @@ -342,13 +342,10 @@ Gets the parameter value specified by <em class="parameter"><code>attribute</cod <td>a <a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> object</td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>attribute</code></em> :</span></p></td> -<td>parameter name (aka attribute)</td> -</tr> -<tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a const pointer to the paramer value specified by -<em class="parameter"><code>attribute</code></em> or <code class="literal">NULL</code> on fail.</td> +<td>the value of the requested parameter or <code class="literal">NULL</code> if the +parameter is not set. If the parameter is set, the returned string +will be in UTF-8.</td> </tr> </tbody> </table></div> @@ -362,6 +359,10 @@ Gets the parameter value specified by <em class="parameter"><code>attribute</cod <p> Sets a parameter on the Content-Type. </p> +<p> +Note: The <em class="parameter"><code>name</code></em> should be in US-ASCII while the <em class="parameter"><code>value</code></em> should be in +UTF-8. +</p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> @@ -370,10 +371,6 @@ Sets a parameter on the Content-Type. <td>MIME Content-Type</td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>attribute</code></em> :</span></p></td> -<td>parameter name (aka attribute)</td> -</tr> -<tr> <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> <td>parameter value</td> </tr> diff --git a/docs/reference/html/GMimeCryptoContext.html b/docs/reference/html/GMimeCryptoContext.html index e247f67..d414fa4 100644 --- a/docs/reference/html/GMimeCryptoContext.html +++ b/docs/reference/html/GMimeCryptoContext.html @@ -427,8 +427,9 @@ verify the integirity of the <em class="parameter"><code>istream</code></em>. </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> object containing the status of each -signature or <code class="literal">NULL</code> on error.</td> +<td>a <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> object containing +the status of each signature or <code class="literal">NULL</code> on error. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span> +</td> </tr> </tbody> </table></div> @@ -470,7 +471,9 @@ writes the resulting ciphertext to the output stream. </tr> <tr> <td><p><span class="term"><em class="parameter"><code>recipients</code></em> :</span></p></td> -<td>an array of recipient key ids and/or email addresses</td> +<td>an array of recipient key ids +and/or email addresses. <span class="annotation">[<a href="http://foldoc.org/element-type"><span class="acronym">element-type</span></a> utf8]</span> +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>istream</code></em> :</span></p></td> @@ -514,6 +517,11 @@ On success, the returned <a class="link" href="GMimeCryptoContext.html#GMimeDecr certificates, one for each recipient, that the original encrypted stream was encrypted to. </p> +<p> +Note: It *may* be possible to maliciously design an encrypted stream such +that recursively decrypting it will result in ane endless loop, causing +a denial of service attack on your application. +</p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> @@ -537,7 +545,9 @@ was encrypted to. </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a <a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> on success or <code class="literal">NULL</code> on error.</td> +<td>a <a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> on success or <code class="literal">NULL</code> +on error. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span> +</td> </tr> </tbody> </table></div> @@ -598,7 +608,8 @@ the key/certificate database controlled by <em class="parameter"><code>ctx</code </tr> <tr> <td><p><span class="term"><em class="parameter"><code>keys</code></em> :</span></p></td> -<td>an array of key ids</td> +<td>an array of key ids. <span class="annotation">[<a href="http://foldoc.org/element-type"><span class="acronym">element-type</span></a> utf8]</span> +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>ostream</code></em> :</span></p></td> @@ -780,7 +791,8 @@ Gets the list of certificates that the stream had been encrypted to. </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a <a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a>.</td> +<td>a <a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a>. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span> +</td> </tr> </tbody> </table></div> @@ -828,7 +840,9 @@ Gets a list of signatures if the encrypted stream had also been signed. </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> or <code class="literal">NULL</code> if the stream was not signed.</td> +<td>a <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> or <code class="literal">NULL</code> if the +stream was not signed. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span> +</td> </tr> </tbody> </table></div> diff --git a/docs/reference/html/GMimeDataWrapper.html b/docs/reference/html/GMimeDataWrapper.html index 16333a5..a82b985 100644 --- a/docs/reference/html/GMimeDataWrapper.html +++ b/docs/reference/html/GMimeDataWrapper.html @@ -173,7 +173,8 @@ Gets a reference to the stream wrapped by <em class="parameter"><code>wrapper</c </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a reference to the internal stream.</td> +<td>a reference to the internal stream. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span> +</td> </tr> </tbody> </table></div> diff --git a/docs/reference/html/GMimeFilter.html b/docs/reference/html/GMimeFilter.html index be4be39..ca530a7 100644 --- a/docs/reference/html/GMimeFilter.html +++ b/docs/reference/html/GMimeFilter.html @@ -119,7 +119,8 @@ Copies <em class="parameter"><code>filter</code></em> into a new GMimeFilter obj </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a duplicate of <em class="parameter"><code>filter</code></em>.</td> +<td>a duplicate of <em class="parameter"><code>filter</code></em>. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span> +</td> </tr> </tbody> </table></div> @@ -146,7 +147,8 @@ Filters the input data and writes it to <em class="parameter"><code>out</code></ </tr> <tr> <td><p><span class="term"><em class="parameter"><code>inbuf</code></em> :</span></p></td> -<td>input buffer</td> +<td>input buffer. <span class="annotation">[<a href="http://foldoc.org/array"><span class="acronym">array</span></a> length=inlen][<a href="http://foldoc.org/element-type"><span class="acronym">element-type</span></a> guint8]</span> +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>inlen</code></em> :</span></p></td> @@ -158,15 +160,18 @@ Filters the input data and writes it to <em class="parameter"><code>out</code></ </tr> <tr> <td><p><span class="term"><em class="parameter"><code>outbuf</code></em> :</span></p></td> -<td>pointer to output buffer</td> +<td>pointer to output buffer. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>][<a href="http://foldoc.org/array"><span class="acronym">array</span></a> length=outlen][<a href="http://foldoc.org/element-type"><span class="acronym">element-type</span></a> guint8][<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span> +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>outlen</code></em> :</span></p></td> -<td>pointer to output length</td> +<td>pointer to output length. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span> +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>outprespace</code></em> :</span></p></td> -<td>pointer to output prespace buffer length</td> +<td>pointer to output prespace buffer length. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span> +</td> </tr> </tbody> </table></div> @@ -193,7 +198,8 @@ Completes the filtering. </tr> <tr> <td><p><span class="term"><em class="parameter"><code>inbuf</code></em> :</span></p></td> -<td>input buffer</td> +<td>input buffer. <span class="annotation">[<a href="http://foldoc.org/array"><span class="acronym">array</span></a> length=inlen][<a href="http://foldoc.org/element-type"><span class="acronym">element-type</span></a> guint8]</span> +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>inlen</code></em> :</span></p></td> @@ -205,15 +211,18 @@ Completes the filtering. </tr> <tr> <td><p><span class="term"><em class="parameter"><code>outbuf</code></em> :</span></p></td> -<td>pointer to output buffer</td> +<td>pointer to output buffer. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>][<a href="http://foldoc.org/array"><span class="acronym">array</span></a> length=outlen][<a href="http://foldoc.org/element-type"><span class="acronym">element-type</span></a> guint8][<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span> +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>outlen</code></em> :</span></p></td> -<td>pointer to output length</td> +<td>pointer to output length. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span> +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>outprespace</code></em> :</span></p></td> -<td>pointer to output prespace buffer length</td> +<td>pointer to output prespace buffer length. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span> +</td> </tr> </tbody> </table></div> @@ -252,7 +261,8 @@ previous ones </tr> <tr> <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> -<td>data to backup</td> +<td>data to backup. <span class="annotation">[<a href="http://foldoc.org/array"><span class="acronym">array</span></a> length=length][<a href="http://foldoc.org/element-type"><span class="acronym">element-type</span></a> guint8]</span> +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td> diff --git a/docs/reference/html/GMimeGpgContext.html b/docs/reference/html/GMimeGpgContext.html index 2df5eca..840e873 100644 --- a/docs/reference/html/GMimeGpgContext.html +++ b/docs/reference/html/GMimeGpgContext.html @@ -105,7 +105,8 @@ Creates a new gpg crypto context object. </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a new gpg crypto context object.</td> +<td>a new gpg crypto context object. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span> +</td> </tr> </tbody> </table></div> diff --git a/docs/reference/html/GMimeMessage.html b/docs/reference/html/GMimeMessage.html index 225e4e4..0ac61b8 100644 --- a/docs/reference/html/GMimeMessage.html +++ b/docs/reference/html/GMimeMessage.html @@ -172,12 +172,18 @@ no (<code class="literal">FALSE</code>). Set the sender's name and address on the MIME Message. (ex: "\"Joe Sixpack\" <joe<em class="parameter"><code>sixpack.org</code></em>>") </p> +<p> +Note: The <em class="parameter"><code>sender</code></em> string should be the raw encoded email +address. It is probably best to use an <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> to +construct and encode this value. +</p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td> -<td>MIME Message to change</td> +<td>A <a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>sender</code></em> :</span></p></td> @@ -198,11 +204,14 @@ Gets the email address of the sender from <em class="parameter"><code>message</c <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td> -<td>MIME Message</td> +<td>A <a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> +</td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the sender's name and address of the MIME Message.</td> +<td>the sender's name and address of the <em class="parameter"><code>message</code></em> in a form +suitable for display or <code class="literal">NULL</code> if no sender is set. If not <code class="literal">NULL</code>, +the returned string will be in UTF-8.</td> </tr> </tbody> </table></div> @@ -213,14 +222,20 @@ Gets the email address of the sender from <em class="parameter"><code>message</c <pre class="programlisting"><span class="returnvalue">void</span> g_mime_message_set_reply_to (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>, <em class="parameter"><code>const <span class="type">char</span> *reply_to</code></em>);</pre> <p> -Set the sender's Reply-To address on the MIME Message. +Set the sender's Reply-To address on the <em class="parameter"><code>message</code></em>. +</p> +<p> +Note: The <em class="parameter"><code>reply_to</code></em> string should be the raw encoded email +address. It is probably best to use an <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> to +construct and encode this value. </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td> -<td>MIME Message to change</td> +<td>A <a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>reply_to</code></em> :</span></p></td> @@ -241,11 +256,14 @@ Gets the Reply-To address from <em class="parameter"><code>message</code></em>. <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td> -<td>MIME Message</td> +<td>A <a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> +</td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the sender's Reply-To address from the MIME Message.</td> +<td>the sender's Reply-To address in a form suitable for +display or <code class="literal">NULL</code> if no Reply-To address is set. If not <code class="literal">NULL</code>, the +returned string will be in UTF-8.</td> </tr> </tbody> </table></div> @@ -258,14 +276,18 @@ Gets the Reply-To address from <em class="parameter"><code>message</code></em>. <em class="parameter"><code>const <span class="type">char</span> *name</code></em>, <em class="parameter"><code>const <span class="type">char</span> *addr</code></em>);</pre> <p> -Add a recipient of a chosen type to the MIME Message. +Add a recipient of a chosen type to the MIME message. +</p> +<p> +Note: The <em class="parameter"><code>name</code></em> (and <em class="parameter"><code>addr</code></em>) strings should be in UTF-8. </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td> -<td>MIME Message to change</td> +<td>A <a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td> @@ -289,14 +311,15 @@ Add a recipient of a chosen type to the MIME Message. <pre class="programlisting"><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="returnvalue">InternetAddressList</span></a> * g_mime_message_get_recipients (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>, <em class="parameter"><code><a class="link" href="GMimeMessage.html#GMimeRecipientType" title="enum GMimeRecipientType"><span class="type">GMimeRecipientType</span></a> type</code></em>);</pre> <p> -Gets a list of recipients of type <em class="parameter"><code>type</code></em> from <em class="parameter"><code>message</code></em>. +Gets a list of recipients of the specified <em class="parameter"><code>type</code></em> from the <em class="parameter"><code>message</code></em>. </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td> -<td>MIME Message</td> +<td>A <a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td> @@ -305,8 +328,9 @@ Gets a list of recipients of type <em class="parameter"><code>type</code></em> f </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a list of recipients of a chosen type from the MIME -Message.</td> +<td>a list of recipients of the specified +<em class="parameter"><code>type</code></em> from the <em class="parameter"><code>message</code></em>. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span> +</td> </tr> </tbody> </table></div> @@ -323,12 +347,15 @@ Gets the complete list of recipients for <em class="parameter"><code>message</co <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td> -<td>MIME Message</td> +<td>A <a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> +</td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a newly allocated <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> containing all -recipients of the message or <code class="literal">NULL</code> if no recipients are set.</td> +<td>a newly allocated <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> +containing all recipients of the message or <code class="literal">NULL</code> if no recipients +are set. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span> +</td> </tr> </tbody> </table></div> @@ -339,14 +366,18 @@ recipients of the message or <code class="literal">NULL</code> if no recipients <pre class="programlisting"><span class="returnvalue">void</span> g_mime_message_set_subject (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>, <em class="parameter"><code>const <span class="type">char</span> *subject</code></em>);</pre> <p> -Set the unencoded UTF-8 Subject field on a MIME Message. +Set the subject of a <em class="parameter"><code>message</code></em>. +</p> +<p> +Note: The <em class="parameter"><code>subject</code></em> string should be in UTF-8. </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td> -<td>MIME Message</td> +<td>A <a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>subject</code></em> :</span></p></td> @@ -360,18 +391,21 @@ Set the unencoded UTF-8 Subject field on a MIME Message. <a name="g-mime-message-get-subject"></a><h3>g_mime_message_get_subject ()</h3> <pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_message_get_subject (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>);</pre> <p> -Gets the message's subject. +Gets the subject of the <em class="parameter"><code>message</code></em>. </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td> -<td>MIME Message</td> +<td>A <a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> +</td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the unencoded UTF-8 Subject field on a MIME Message.</td> +<td>the subject of the <em class="parameter"><code>message</code></em> in a form suitable for display +or <code class="literal">NULL</code> if no subject is set. If not <code class="literal">NULL</code>, the returned string +will be in UTF-8.</td> </tr> </tbody> </table></div> @@ -390,7 +424,8 @@ Sets the Date header on a MIME Message. <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td> -<td>MIME Message</td> +<td>A <a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>date</code></em> :</span></p></td> @@ -419,15 +454,18 @@ non-<code class="literal">NULL</code>, then the timezone offset in will be store <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td> -<td>MIME Message</td> +<td>A <a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>date</code></em> :</span></p></td> -<td>pointer to a date in time_t</td> +<td>pointer to a date in time_t. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span> +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>tz_offset</code></em> :</span></p></td> -<td>pointer to timezone offset (in +/- hours)</td> +<td>pointer to timezone offset (in +/- hours). <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span> +</td> </tr> </tbody> </table></div> @@ -445,7 +483,8 @@ Sets the sent-date of the message. <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td> -<td>MIME Message</td> +<td>A <a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td> @@ -466,7 +505,8 @@ Gets the message's sent-date in string format. <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td> -<td>MIME Message</td> +<td>A <a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> +</td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> @@ -488,7 +528,8 @@ Set the Message-Id on a message. <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td> -<td>MIME Message</td> +<td>A <a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>message_id</code></em> :</span></p></td> @@ -509,7 +550,8 @@ Gets the Message-Id header of <em class="parameter"><code>message</code></em>. <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td> -<td>MIME Message</td> +<td>A <a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> +</td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> @@ -531,7 +573,8 @@ Set the root-level MIME part of the message. <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td> -<td>MIME Message</td> +<td>A <a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>mime_part</code></em> :</span></p></td> @@ -552,11 +595,13 @@ Gets the toplevel MIME part contained within <em class="parameter"><code>message <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td> -<td>MIME Message</td> +<td>A <a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> +</td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the toplevel MIME part of <em class="parameter"><code>message</code></em>.</td> +<td>the toplevel MIME part of <em class="parameter"><code>message</code></em>. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span> +</td> </tr> </tbody> </table></div> @@ -575,12 +620,14 @@ Recursively calls <em class="parameter"><code>callback</code></em> on each of th <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td> -<td>a <a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> +<td>A <a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td> -<td>function to call on each of the mime parts contained by the mime message</td> +<td>function to call on each of the mime parts +contained by the mime message. <span class="annotation">[<a href="http://foldoc.org/scope%20call"><span class="acronym">scope call</span></a>]</span> +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> @@ -602,15 +649,17 @@ message. <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td> -<td>MIME Message</td> +<td>A <a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> +</td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> containing the textual content that appears -to be the main body of the message. +<td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> containing the textual +content that appears to be the main body of the message. Note: This function is NOT guarenteed to always work as it makes some assumptions that are not necessarily true. It is -recommended that you traverse the MIME structure yourself.</td> +recommended that you traverse the MIME structure yourself. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span> +</td> </tr> </tbody> </table></div> diff --git a/docs/reference/html/GMimeMessagePart.html b/docs/reference/html/GMimeMessagePart.html index e4e41d5..c6fcaca 100644 --- a/docs/reference/html/GMimeMessagePart.html +++ b/docs/reference/html/GMimeMessagePart.html @@ -145,7 +145,8 @@ Gets the message object on the message part object <em class="parameter"><code>p </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the message part contained within <em class="parameter"><code>part</code></em>.</td> +<td>the message part contained within <em class="parameter"><code>part</code></em>. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span> +</td> </tr> </tbody> </table></div> diff --git a/docs/reference/html/GMimeMessagePartial.html b/docs/reference/html/GMimeMessagePartial.html index 6bd6790..4da001c 100644 --- a/docs/reference/html/GMimeMessagePartial.html +++ b/docs/reference/html/GMimeMessagePartial.html @@ -203,7 +203,9 @@ in <em class="parameter"><code>partials</code></em>. </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a GMimeMessage object on success or <code class="literal">NULL</code> on fail.</td> +<td>a GMimeMessage object on success or <code class="literal">NULL</code> +on fail. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span> +</td> </tr> </tbody> </table></div> @@ -238,8 +240,9 @@ containing a single <a class="link" href="GMimeMessagePartial.html" title="GMime </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>an array of <a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> objects and sets <em class="parameter"><code>nparts</code></em> to th -number of messages returned or <code class="literal">NULL</code> on fail.</td> +<td>an array of <a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> objects and +sets <em class="parameter"><code>nparts</code></em> to the number of messages returned or <code class="literal">NULL</code> on fail. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span> +</td> </tr> </tbody> </table></div> diff --git a/docs/reference/html/GMimeMultipart.html b/docs/reference/html/GMimeMultipart.html index ca2a23f..6e3d381 100644 --- a/docs/reference/html/GMimeMultipart.html +++ b/docs/reference/html/GMimeMultipart.html @@ -469,8 +469,9 @@ Removes the mime part at position <em class="parameter"><code>index</code></em> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the mime part that was removed or <code class="literal">NULL</code> if the part was -not contained within the multipart.</td> +<td>the mime part that was removed or <code class="literal">NULL</code> +if the part was not contained within the multipart. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span> +</td> </tr> </tbody> </table></div> @@ -502,8 +503,9 @@ Replaces the mime part at position <em class="parameter"><code>index</code></em> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the mime part that was replaced or <code class="literal">NULL</code> if the part was -not contained within the multipart.</td> +<td>the mime part that was replaced or <code class="literal">NULL</code> +if the part was not contained within the multipart. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span> +</td> </tr> </tbody> </table></div> @@ -529,7 +531,8 @@ Gets the mime part at position <em class="parameter"><code>index</code></em> wit </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the mime part at position <em class="parameter"><code>index</code></em>.</td> +<td>the mime part at position <em class="parameter"><code>index</code></em>. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span> +</td> </tr> </tbody> </table></div> @@ -553,7 +556,9 @@ Recursively calls <em class="parameter"><code>callback</code></em> on each of <e </tr> <tr> <td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td> -<td>function to call for each of <em class="parameter"><code>multipart</code></em>'s subparts.</td> +<td>function to call for each of <em class="parameter"><code>multipart</code></em>'s +subparts. <span class="annotation">[<a href="http://foldoc.org/scope%20call"><span class="acronym">scope call</span></a>]</span> +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> @@ -585,8 +590,9 @@ multipart <em class="parameter"><code>multipart</code></em>. </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> whose content-id matches the search string, -or <code class="literal">NULL</code> if a match cannot be found.</td> +<td>the <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> whose content-id matches +the search string, or <code class="literal">NULL</code> if a match cannot be found. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span> +</td> </tr> </tbody> </table></div> diff --git a/docs/reference/html/GMimeMultipartEncrypted.html b/docs/reference/html/GMimeMultipartEncrypted.html index 5fab7c6..5512587 100644 --- a/docs/reference/html/GMimeMultipartEncrypted.html +++ b/docs/reference/html/GMimeMultipartEncrypted.html @@ -149,7 +149,8 @@ encrypted part of the multipart/encrypted object <em class="parameter"><code>mpe </tr> <tr> <td><p><span class="term"><em class="parameter"><code>recipients</code></em> :</span></p></td> -<td>an array of recipients to encrypt to</td> +<td>an array of recipients to encrypt to. <span class="annotation">[<a href="http://foldoc.org/element-type"><span class="acronym">element-type</span></a> utf8]</span> +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td> @@ -206,9 +207,10 @@ encrypted to. </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the decrypted MIME part on success or <code class="literal">NULL</code> on fail. If the -decryption fails, an exception will be set on <em class="parameter"><code>err</code></em> to provide -information as to why the failure occured.</td> +<td>the decrypted MIME part on success or +<code class="literal">NULL</code> on fail. If the decryption fails, an exception will be set on +<em class="parameter"><code>err</code></em> to provide information as to why the failure occured. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span> +</td> </tr> </tbody> </table></div> diff --git a/docs/reference/html/GMimeMultipartSigned.html b/docs/reference/html/GMimeMultipartSigned.html index 391158a..3afb44f 100644 --- a/docs/reference/html/GMimeMultipartSigned.html +++ b/docs/reference/html/GMimeMultipartSigned.html @@ -176,9 +176,11 @@ multipart/signed object <em class="parameter"><code>mps</code></em> using the <e </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a new <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> object on success or <code class="literal">NULL</code> on fail. If -the verification fails, an exception will be set on <em class="parameter"><code>err</code></em> to provide -information as to why the failure occured.</td> +<td>a new <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> object on +success or <code class="literal">NULL</code> on fail. If the verification fails, an exception +will be set on <em class="parameter"><code>err</code></em> to provide information as to why the failure +occured. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span> +</td> </tr> </tbody> </table></div> diff --git a/docs/reference/html/GMimeObject.html b/docs/reference/html/GMimeObject.html index fdf9850..07d55c3 100644 --- a/docs/reference/html/GMimeObject.html +++ b/docs/reference/html/GMimeObject.html @@ -294,7 +294,9 @@ Gets the <a class="link" href="GMimeContentType.html" title="GMimeContentType">< </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the content-type object for the specified MIME object.</td> +<td>the content-type object for the specified +MIME object. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span> +</td> </tr> </tbody> </table></div> @@ -309,6 +311,10 @@ Gets the <a class="link" href="GMimeContentType.html" title="GMimeContentType">< <p> Sets the content-type param <em class="parameter"><code>name</code></em> to the value <em class="parameter"><code>value</code></em>. </p> +<p> +Note: The <em class="parameter"><code>name</code></em> string should be in US-ASCII while the <em class="parameter"><code>value</code></em> +string should be in UTF-8. +</p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> @@ -352,8 +358,9 @@ Gets the value of the content-type param <em class="parameter"><code>name</code> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the value of the requested content-type param or <code class="literal">NULL</code> on -if the param doesn't exist.</td> +<td>the value of the requested content-type param or <code class="literal">NULL</code> if +the param doesn't exist. If the param is set, the returned string +will be in UTF-8.</td> </tr> </tbody> </table></div> @@ -450,7 +457,9 @@ Gets the <a class="link" href="GMimeContentDisposition.html" title="GMimeContent </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the <a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> set on the MIME object.</td> +<td>the <a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> set on the +MIME object. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span> +</td> </tr> </tbody> </table></div> @@ -465,6 +474,10 @@ Gets the <a class="link" href="GMimeContentDisposition.html" title="GMimeContent <p> Add a content-disposition parameter to the specified mime part. </p> +<p> +Note: The <em class="parameter"><code>name</code></em> string should be in US-ASCII while the <em class="parameter"><code>value</code></em> +string should be in UTF-8. +</p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> @@ -474,10 +487,6 @@ Add a content-disposition parameter to the specified mime part. </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>attribute</code></em> :</span></p></td> -<td>parameter name</td> -</tr> -<tr> <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> <td>parameter value</td> </tr> @@ -492,7 +501,7 @@ Add a content-disposition parameter to the specified mime part. <em class="parameter"><code>const <span class="type">char</span> *attribute</code></em>);</pre> <p> Gets the value of the Content-Disposition parameter specified by -<em class="parameter"><code>attribute</code></em>, or <code class="literal">NULL</code> if the parameter does not exist. +<em class="parameter"><code>name</code></em>, or <code class="literal">NULL</code> if the parameter does not exist. </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> @@ -503,13 +512,10 @@ Gets the value of the Content-Disposition parameter specified by </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>attribute</code></em> :</span></p></td> -<td>parameter name</td> -</tr> -<tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the value of a previously defined content-disposition -parameter specified by <em class="parameter"><code>attribute</code></em>.</td> +<td>the value of the requested content-disposition param or +<code class="literal">NULL</code> if the param doesn't exist. If the param is set, the returned +string will be in UTF-8.</td> </tr> </tbody> </table></div> @@ -568,6 +574,10 @@ Gets the Content-Id of the MIME object or NULL if one is not set. <p> Prepends a raw, unprocessed header to the MIME object. </p> +<p> +Note: <em class="parameter"><code>value</code></em> should be encoded with a function such as +<a class="link" href="gmime-gmime-utils.html#g-mime-utils-header-encode-text" title="g_mime_utils_header_encode_text ()"><code class="function">g_mime_utils_header_encode_text()</code></a>. +</p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> @@ -596,6 +606,10 @@ Prepends a raw, unprocessed header to the MIME object. <p> Appends a raw, unprocessed header to the MIME object. </p> +<p> +Note: <em class="parameter"><code>value</code></em> should be encoded with a function such as +<a class="link" href="gmime-gmime-utils.html#g-mime-utils-header-encode-text" title="g_mime_utils_header_encode_text ()"><code class="function">g_mime_utils_header_encode_text()</code></a>. +</p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> @@ -653,6 +667,10 @@ be found.</td> <p> Sets an arbitrary raw, unprocessed header on the MIME object. </p> +<p> +Note: <em class="parameter"><code>value</code></em> should be encoded with a function such as +<a class="link" href="gmime-gmime-utils.html#g-mime-utils-header-encode-text" title="g_mime_utils_header_encode_text ()"><code class="function">g_mime_utils_header_encode_text()</code></a>. +</p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> @@ -695,7 +713,9 @@ Gets the raw, unprocessed value of the requested header. <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td>the raw, unprocessed value of the requested header if it -exists or <code class="literal">NULL</code> otherwise.</td> +exists or <code class="literal">NULL</code> otherwise. +Note: The returned value should be decoded with a function such as +<a class="link" href="gmime-gmime-utils.html#g-mime-utils-header-decode-text" title="g_mime_utils_header_decode_text ()"><code class="function">g_mime_utils_header_decode_text()</code></a> before displaying to the user.</td> </tr> </tbody> </table></div> @@ -718,7 +738,8 @@ headers. </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>an allocated string containing all of the raw MIME headers.</td> +<td>an allocated string containing all of the raw MIME headers. +Note: The returned string will not be suitable for display.</td> </tr> </tbody> </table></div> @@ -740,8 +761,9 @@ Get the header list for <em class="parameter"><code>object</code></em>. </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> for <em class="parameter"><code>object</code></em>. Do not free this pointer -when you are done with it.</td> +<td>the <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> for <em class="parameter"><code>object</code></em>. Do not +free this pointer when you are done with it. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span> +</td> </tr> </tbody> </table></div> diff --git a/docs/reference/html/GMimeParser.html b/docs/reference/html/GMimeParser.html index e3f5692..7984808 100644 --- a/docs/reference/html/GMimeParser.html +++ b/docs/reference/html/GMimeParser.html @@ -470,7 +470,9 @@ Constructs a MIME part from <em class="parameter"><code>parser</code></em>. </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a MIME part based on <em class="parameter"><code>parser</code></em> or <code class="literal">NULL</code> on fail.</td> +<td>a MIME part based on <em class="parameter"><code>parser</code></em> or <code class="literal">NULL</code> on +fail. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span> +</td> </tr> </tbody> </table></div> @@ -491,7 +493,8 @@ Constructs a MIME message from <em class="parameter"><code>parser</code></em>. </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a MIME message or <code class="literal">NULL</code> on fail.</td> +<td>a MIME message or <code class="literal">NULL</code> on fail. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span> +</td> </tr> </tbody> </table></div> diff --git a/docs/reference/html/GMimePart.html b/docs/reference/html/GMimePart.html index 1d6b778..23e5a07 100644 --- a/docs/reference/html/GMimePart.html +++ b/docs/reference/html/GMimePart.html @@ -423,6 +423,9 @@ given the <em class="parameter"><code>constraint</code></em>. Sets the "filename" parameter on the Content-Disposition and also sets the "name" parameter on the Content-Type. </p> +<p> +Note: The <em class="parameter"><code>filename</code></em> string should be in UTF-8. +</p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> @@ -432,7 +435,7 @@ Sets the "filename" parameter on the Content-Disposition and also sets the </tr> <tr> <td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td> -<td>the filename of the Mime Part's content</td> +<td>the file name</td> </tr> </tbody> </table></div> @@ -442,8 +445,8 @@ Sets the "filename" parameter on the Content-Disposition and also sets the <a name="g-mime-part-get-filename"></a><h3>g_mime_part_get_filename ()</h3> <pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_part_get_filename (<em class="parameter"><code><a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> *mime_part</code></em>);</pre> <p> -Gets the filename of the specificed mime part, or <code class="literal">NULL</code> if the mime -part does not have the filename or name parameter set. +Gets the filename of the specificed mime part, or <code class="literal">NULL</code> if the +<em class="parameter"><code>mime_part</code></em> does not have the filename or name parameter set. </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> @@ -454,9 +457,9 @@ part does not have the filename or name parameter set. </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the filename of the specified MIME Part. It first checks to -see if the "filename" parameter was set on the Content-Disposition -and if not then checks the "name" parameter in the Content-Type.</td> +<td>the filename of the specified <em class="parameter"><code>mime_part</code></em> or <code class="literal">NULL</code> if +neither of the parameters is set. If a file name is set, the +returned string will be in UTF-8.</td> </tr> </tbody> </table></div> @@ -478,7 +481,9 @@ on error. </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the data-wrapper for the mime part's contents.</td> +<td>the data-wrapper for the mime part's +contents. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span> +</td> </tr> </tbody> </table></div> diff --git a/docs/reference/html/GMimePkcs7Context.html b/docs/reference/html/GMimePkcs7Context.html index ab12a55..f3e60eb 100644 --- a/docs/reference/html/GMimePkcs7Context.html +++ b/docs/reference/html/GMimePkcs7Context.html @@ -92,7 +92,8 @@ Creates a new pkcs7 crypto context object. </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a new pkcs7 crypto context object.</td> +<td>a new pkcs7 crypto context object. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span> +</td> </tr> </tbody> </table></div> diff --git a/docs/reference/html/GMimeSignature.html b/docs/reference/html/GMimeSignature.html index 5a18b45..041fccc 100644 --- a/docs/reference/html/GMimeSignature.html +++ b/docs/reference/html/GMimeSignature.html @@ -231,7 +231,8 @@ Get the signature's certificate. </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the signature's certificate.</td> +<td>the signature's certificate. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span> +</td> </tr> </tbody> </table></div> @@ -710,8 +711,9 @@ Gets the <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> at the specified index or <code class="literal">NULL</code> if -the index is out of range.</td> +<td>the <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> at the specified +index or <code class="literal">NULL</code> if the index is out of range. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span> +</td> </tr> </tbody> </table></div> diff --git a/docs/reference/html/GMimeStream.html b/docs/reference/html/GMimeStream.html index 3666047..18d8ade 100644 --- a/docs/reference/html/GMimeStream.html +++ b/docs/reference/html/GMimeStream.html @@ -221,7 +221,8 @@ Attempts to read up to <em class="parameter"><code>len</code></em> bytes from <e </tr> <tr> <td><p><span class="term"><em class="parameter"><code>buf</code></em> :</span></p></td> -<td>buffer</td> +<td>buffer. <span class="annotation">[<a href="http://foldoc.org/array"><span class="acronym">array</span></a> length=len][<a href="http://foldoc.org/element-type"><span class="acronym">element-type</span></a> guint8]</span> +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>len</code></em> :</span></p></td> @@ -475,7 +476,9 @@ Creates a new substream of <em class="parameter"><code>stream</code></em> with b </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a substream of <em class="parameter"><code>stream</code></em> with bounds <em class="parameter"><code>start</code></em> and <em class="parameter"><code>end</code></em>.</td> +<td>a substream of <em class="parameter"><code>stream</code></em> with bounds <em class="parameter"><code>start</code></em> +and <em class="parameter"><code>end</code></em>. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span> +</td> </tr> </tbody> </table></div> diff --git a/docs/reference/html/GMimeStreamFile.html b/docs/reference/html/GMimeStreamFile.html index 2e2ee47..ed73828 100644 --- a/docs/reference/html/GMimeStreamFile.html +++ b/docs/reference/html/GMimeStreamFile.html @@ -44,6 +44,8 @@ <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> * <a class="link" href="GMimeStreamFile.html#g-mime-stream-file-new-with-bounds" title="g_mime_stream_file_new_with_bounds ()">g_mime_stream_file_new_with_bounds</a> (<em class="parameter"><code><span class="type">FILE</span> *fp</code></em>, <em class="parameter"><code><span class="type">gint64</span> start</code></em>, <em class="parameter"><code><span class="type">gint64</span> end</code></em>); +<a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> * <a class="link" href="GMimeStreamFile.html#g-mime-stream-file-new-for-path" title="g_mime_stream_file_new_for_path ()">g_mime_stream_file_new_for_path</a> (<em class="parameter"><code>const <span class="type">char</span> *path</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *mode</code></em>); <span class="returnvalue">gboolean</span> <a class="link" href="GMimeStreamFile.html#g-mime-stream-file-get-owner" title="g_mime_stream_file_get_owner ()">g_mime_stream_file_get_owner</a> (<em class="parameter"><code><a class="link" href="GMimeStreamFile.html" title="GMimeStreamFile"><span class="type">GMimeStreamFile</span></a> *stream</code></em>); <span class="returnvalue">void</span> <a class="link" href="GMimeStreamFile.html#g-mime-stream-file-set-owner" title="g_mime_stream_file_set_owner ()">g_mime_stream_file_set_owner</a> (<em class="parameter"><code><a class="link" href="GMimeStreamFile.html" title="GMimeStreamFile"><span class="type">GMimeStreamFile</span></a> *stream</code></em>, <em class="parameter"><code><span class="type">gboolean</span> owner</code></em>); @@ -143,6 +145,34 @@ passed in. </div> <hr> <div class="refsect2"> +<a name="g-mime-stream-file-new-for-path"></a><h3>g_mime_stream_file_new_for_path ()</h3> +<pre class="programlisting"><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> * g_mime_stream_file_new_for_path (<em class="parameter"><code>const <span class="type">char</span> *path</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *mode</code></em>);</pre> +<p> +Creates a new <a class="link" href="GMimeStreamFile.html" title="GMimeStreamFile"><span class="type">GMimeStreamFile</span></a> object for the specified <em class="parameter"><code>path</code></em>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td> +<td>the path to a file</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>mode</code></em> :</span></p></td> +<td>as in fopen(3)</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a stream using for reading and/or writing to the specified +file path or <code class="literal">NULL</code> on error.</td> +</tr> +</tbody> +</table></div> +<p class="since">Since 2.6.18</p> +</div> +<hr> +<div class="refsect2"> <a name="g-mime-stream-file-get-owner"></a><h3>g_mime_stream_file_get_owner ()</h3> <pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_stream_file_get_owner (<em class="parameter"><code><a class="link" href="GMimeStreamFile.html" title="GMimeStreamFile"><span class="type">GMimeStreamFile</span></a> *stream</code></em>);</pre> <p> diff --git a/docs/reference/html/GMimeStreamFs.html b/docs/reference/html/GMimeStreamFs.html index c2d88ca..eb49539 100644 --- a/docs/reference/html/GMimeStreamFs.html +++ b/docs/reference/html/GMimeStreamFs.html @@ -44,6 +44,9 @@ <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> * <a class="link" href="GMimeStreamFs.html#g-mime-stream-fs-new-with-bounds" title="g_mime_stream_fs_new_with_bounds ()">g_mime_stream_fs_new_with_bounds</a> (<em class="parameter"><code><span class="type">int</span> fd</code></em>, <em class="parameter"><code><span class="type">gint64</span> start</code></em>, <em class="parameter"><code><span class="type">gint64</span> end</code></em>); +<a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> * <a class="link" href="GMimeStreamFs.html#g-mime-stream-fs-new-for-path" title="g_mime_stream_fs_new_for_path ()">g_mime_stream_fs_new_for_path</a> (<em class="parameter"><code>const <span class="type">char</span> *path</code></em>, + <em class="parameter"><code><span class="type">int</span> flags</code></em>, + <em class="parameter"><code><span class="type">int</span> mode</code></em>); <span class="returnvalue">gboolean</span> <a class="link" href="GMimeStreamFs.html#g-mime-stream-fs-get-owner" title="g_mime_stream_fs_get_owner ()">g_mime_stream_fs_get_owner</a> (<em class="parameter"><code><a class="link" href="GMimeStreamFs.html" title="GMimeStreamFs"><span class="type">GMimeStreamFs</span></a> *stream</code></em>); <span class="returnvalue">void</span> <a class="link" href="GMimeStreamFs.html#g-mime-stream-fs-set-owner" title="g_mime_stream_fs_set_owner ()">g_mime_stream_fs_set_owner</a> (<em class="parameter"><code><a class="link" href="GMimeStreamFs.html" title="GMimeStreamFs"><span class="type">GMimeStreamFs</span></a> *stream</code></em>, <em class="parameter"><code><span class="type">gboolean</span> owner</code></em>); @@ -132,6 +135,39 @@ and <em class="parameter"><code>end</code></em>. </div> <hr> <div class="refsect2"> +<a name="g-mime-stream-fs-new-for-path"></a><h3>g_mime_stream_fs_new_for_path ()</h3> +<pre class="programlisting"><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> * g_mime_stream_fs_new_for_path (<em class="parameter"><code>const <span class="type">char</span> *path</code></em>, + <em class="parameter"><code><span class="type">int</span> flags</code></em>, + <em class="parameter"><code><span class="type">int</span> mode</code></em>);</pre> +<p> +Creates a new <a class="link" href="GMimeStreamFs.html" title="GMimeStreamFs"><span class="type">GMimeStreamFs</span></a> object for the specified <em class="parameter"><code>path</code></em>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td> +<td>the path to a file</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td> +<td>as in open(2)</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>mode</code></em> :</span></p></td> +<td>as in open(2)</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a stream using for reading and/or writing to the specified +file path or <code class="literal">NULL</code> on error.</td> +</tr> +</tbody> +</table></div> +<p class="since">Since 2.6.18</p> +</div> +<hr> +<div class="refsect2"> <a name="g-mime-stream-fs-get-owner"></a><h3>g_mime_stream_fs_get_owner ()</h3> <pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_stream_fs_get_owner (<em class="parameter"><code><a class="link" href="GMimeStreamFs.html" title="GMimeStreamFs"><span class="type">GMimeStreamFs</span></a> *stream</code></em>);</pre> <p> diff --git a/docs/reference/html/GMimeStreamMem.html b/docs/reference/html/GMimeStreamMem.html index 6ffd166..f82ca0d 100644 --- a/docs/reference/html/GMimeStreamMem.html +++ b/docs/reference/html/GMimeStreamMem.html @@ -132,7 +132,8 @@ contents with the first <em class="parameter"><code>len</code></em> bytes of <em <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td> -<td>stream data</td> +<td>stream data. <span class="annotation">[<a href="http://foldoc.org/array"><span class="acronym">array</span></a> length=len][<a href="http://foldoc.org/element-type"><span class="acronym">element-type</span></a> guint8]</span> +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>len</code></em> :</span></p></td> @@ -162,7 +163,8 @@ Gets the byte array from the memory stream. </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the byte array from the memory stream.</td> +<td>the byte array from the memory stream. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span> +</td> </tr> </tbody> </table></div> diff --git a/docs/reference/html/InternetAddress.html b/docs/reference/html/InternetAddress.html index 4166549..767b340 100644 --- a/docs/reference/html/InternetAddress.html +++ b/docs/reference/html/InternetAddress.html @@ -93,7 +93,9 @@ Gets the display name of the <a class="link" href="InternetAddress.html" title=" </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the display name of <em class="parameter"><code>ia</code></em>.</td> +<td>the name of the mailbox or group in a form suitable for +display if available or <code class="literal">NULL</code> otherwise. If the name is available, +the returned string will be in UTF-8.</td> </tr> </tbody> </table></div> @@ -106,6 +108,9 @@ Gets the display name of the <a class="link" href="InternetAddress.html" title=" <p> Set the display name of the <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a>. </p> +<p> +Note: The <em class="parameter"><code>name</code></em> string should be in UTF-8. +</p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> diff --git a/docs/reference/html/InternetAddressGroup.html b/docs/reference/html/InternetAddressGroup.html index e18cea5..48a430c 100644 --- a/docs/reference/html/InternetAddressGroup.html +++ b/docs/reference/html/InternetAddressGroup.html @@ -81,7 +81,7 @@ An RFC 2822 Group address. <a name="internet-address-group-new"></a><h3>internet_address_group_new ()</h3> <pre class="programlisting"><a class="link" href="InternetAddress.html" title="InternetAddress"><span class="returnvalue">InternetAddress</span></a> * internet_address_group_new (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre> <p> -Creates a new <a class="link" href="InternetAddressGroup.html" title="InternetAddressGroup"><span class="type">InternetAddressGroup</span></a> object with a display name of +Creates a new <a class="link" href="InternetAddressGroup.html" title="InternetAddressGroup"><span class="type">InternetAddressGroup</span></a> object with the specified <em class="parameter"><code>name</code></em>. </p> <div class="variablelist"><table border="0"> @@ -93,7 +93,8 @@ Creates a new <a class="link" href="InternetAddressGroup.html" title="InternetAd </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a new <a class="link" href="InternetAddressGroup.html" title="InternetAddressGroup"><span class="type">InternetAddressGroup</span></a> object.</td> +<td>a new <a class="link" href="InternetAddressGroup.html" title="InternetAddressGroup"><span class="type">InternetAddressGroup</span></a> object. +Note: The <em class="parameter"><code>name</code></em> string should be in UTF-8.</td> </tr> </tbody> </table></div> @@ -117,7 +118,9 @@ rfc822 group address. </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> containing the members of <em class="parameter"><code>group</code></em>.</td> +<td>a <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> containing the +members of <em class="parameter"><code>group</code></em>. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span> +</td> </tr> </tbody> </table></div> diff --git a/docs/reference/html/InternetAddressList.html b/docs/reference/html/InternetAddressList.html index 442f7b7..2541bd5 100644 --- a/docs/reference/html/InternetAddressList.html +++ b/docs/reference/html/InternetAddressList.html @@ -355,8 +355,9 @@ Gets the <a class="link" href="InternetAddress.html" title="InternetAddress"><sp </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> at the specified index or <code class="literal">NULL</code> if -the index is out of range.</td> +<td>the <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> at the specified +index or <code class="literal">NULL</code> if the index is out of range. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span> +</td> </tr> </tbody> </table></div> @@ -484,8 +485,9 @@ Construct a list of internet addresses from the given string. </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> or <code class="literal">NULL</code> if the input string does -not contain any addresses.</td> +<td>a <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> or <code class="literal">NULL</code> if the +input string does not contain any addresses. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span> +</td> </tr> </tbody> </table></div> @@ -497,7 +499,7 @@ not contain any addresses.</td> <em class="parameter"><code><span class="type">GString</span> *str</code></em>);</pre> <p> Writes the rfc2047-encoded rfc822 formatted addresses in <em class="parameter"><code>list</code></em> to -<em class="parameter"><code>string</code></em>, folding appropriately. +<em class="parameter"><code>str</code></em>, folding appropriately. </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> diff --git a/docs/reference/html/InternetAddressMailbox.html b/docs/reference/html/InternetAddressMailbox.html index bce838c..20ec35d 100644 --- a/docs/reference/html/InternetAddressMailbox.html +++ b/docs/reference/html/InternetAddressMailbox.html @@ -81,7 +81,7 @@ An RFC 2822 Mailbox address. <pre class="programlisting"><a class="link" href="InternetAddress.html" title="InternetAddress"><span class="returnvalue">InternetAddress</span></a> * internet_address_mailbox_new (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>, <em class="parameter"><code>const <span class="type">char</span> *addr</code></em>);</pre> <p> -Creates a new <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> object with name <em class="parameter"><code>name</code></em> and address +Creates a new <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> object with the specified <em class="parameter"><code>name</code></em> and <em class="parameter"><code>addr</code></em>. </p> <div class="variablelist"><table border="0"> @@ -97,7 +97,8 @@ Creates a new <a class="link" href="InternetAddress.html" title="InternetAddress </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a new <a class="link" href="InternetAddressMailbox.html" title="InternetAddressMailbox"><span class="type">InternetAddressMailbox</span></a> object.</td> +<td>a new <a class="link" href="InternetAddressMailbox.html" title="InternetAddressMailbox"><span class="type">InternetAddressMailbox</span></a> object. +Note: The <em class="parameter"><code>name</code></em> string should be in UTF-8.</td> </tr> </tbody> </table></div> diff --git a/docs/reference/html/ch01.html b/docs/reference/html/ch01.html index b21fd60..45039d5 100644 --- a/docs/reference/html/ch01.html +++ b/docs/reference/html/ch01.html @@ -21,7 +21,7 @@ </tr></table> <div class="chapter"> <div class="titlepage"><div><div><h2 class="title"> -<a name="idp8457328"></a>Class hierarchy</h2></div></div></div> +<a name="idp8874128"></a>Class hierarchy</h2></div></div></div> <pre class="screen"> GMimeHeader <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam">GMimeParam</a> diff --git a/docs/reference/html/gmime-GMimeHeader.html b/docs/reference/html/gmime-GMimeHeader.html index 59d3424..dc18f86 100644 --- a/docs/reference/html/gmime-GMimeHeader.html +++ b/docs/reference/html/gmime-GMimeHeader.html @@ -460,7 +460,7 @@ Gets the current header's name. <a name="g-mime-header-iter-get-value"></a><h3>g_mime_header_iter_get_value ()</h3> <pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_header_iter_get_value (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter</code></em>);</pre> <p> -Gets the current header's name. +Gets the current header's value. </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> @@ -472,7 +472,9 @@ Gets the current header's name. </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the header name or <code class="literal">NULL</code> if invalid.</td> +<td>the header's raw, unprocessed value or <code class="literal">NULL</code> if invalid. +Note: The returned value should be decoded with a function such as +<a class="link" href="gmime-gmime-utils.html#g-mime-utils-header-decode-text" title="g_mime_utils_header_decode_text ()"><code class="function">g_mime_utils_header_decode_text()</code></a> before displaying to the user.</td> </tr> </tbody> </table></div> @@ -501,7 +503,9 @@ Sets the current header's value to the new value. <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td> <code class="literal">TRUE</code> if the value was set or <code class="literal">FALSE</code> otherwise (indicates -invalid iter).</td> +invalid iter). +Note: <em class="parameter"><code>value</code></em> should be encoded with a function such as +<a class="link" href="gmime-gmime-utils.html#g-mime-utils-header-encode-text" title="g_mime_utils_header_encode_text ()"><code class="function">g_mime_utils_header_encode_text()</code></a>.</td> </tr> </tbody> </table></div> @@ -619,6 +623,10 @@ Prepends a header. If <em class="parameter"><code>value</code></em> is <code cla for it (useful for setting the order of headers before values can be obtained for them) otherwise the header will be unset. </p> +<p> +Note: <em class="parameter"><code>value</code></em> should be encoded with a function such as +<a class="link" href="gmime-gmime-utils.html#g-mime-utils-header-encode-text" title="g_mime_utils_header_encode_text ()"><code class="function">g_mime_utils_header_encode_text()</code></a>. +</p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> @@ -649,6 +657,10 @@ Appends a header. If <em class="parameter"><code>value</code></em> is <code clas (useful for setting the order of headers before values can be obtained for them) otherwise the header will be unset. </p> +<p> +Note: <em class="parameter"><code>value</code></em> should be encoded with a function such as +<a class="link" href="gmime-gmime-utils.html#g-mime-utils-header-encode-text" title="g_mime_utils_header_encode_text ()"><code class="function">g_mime_utils_header_encode_text()</code></a>. +</p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> @@ -714,6 +726,10 @@ Note: If there are multiple headers with the specified field name, the first instance of the header will be replaced and further instances will be removed. </p> +<p> +Additionally, <em class="parameter"><code>value</code></em> should be encoded with a function such as +<a class="link" href="gmime-gmime-utils.html#g-mime-utils-header-encode-text" title="g_mime_utils_header_encode_text ()"><code class="function">g_mime_utils_header_encode_text()</code></a>. +</p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> @@ -755,7 +771,9 @@ Gets the value of the first header with the name requested. </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the value of the header requested.</td> +<td>the value of the header requested. +Note: The returned value should be decoded with a function such as +<a class="link" href="gmime-gmime-utils.html#g-mime-utils-header-decode-text" title="g_mime_utils_header_decode_text ()"><code class="function">g_mime_utils_header_decode_text()</code></a> before displaying to the user.</td> </tr> </tbody> </table></div> @@ -778,7 +796,7 @@ Initializes an iterator for traversing <em class="parameter"><code>headers</code </tr> <tr> <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td> -<td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> +<td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a>. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span> </td> </tr> <tr> @@ -808,7 +826,8 @@ Calls <em class="parameter"><code>func</code></em> for each header name/value pa </tr> <tr> <td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td> -<td>function to be called for each header.</td> +<td>function to be called for each header. <span class="annotation">[<a href="http://foldoc.org/scope%20call"><span class="acronym">scope call</span></a>]</span> +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> @@ -914,7 +933,8 @@ Gets the raw stream representing <em class="parameter"><code>headers</code></em> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> if set or <code class="literal">NULL</code> otherwise.</td> +<td>a <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> if set or <code class="literal">NULL</code> otherwise. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span> +</td> </tr> </tbody> </table></div> diff --git a/docs/reference/html/gmime-GMimePartIter.html b/docs/reference/html/gmime-GMimePartIter.html index 3e949c6..8499c1f 100644 --- a/docs/reference/html/gmime-GMimePartIter.html +++ b/docs/reference/html/gmime-GMimePartIter.html @@ -243,7 +243,8 @@ Gets the toplevel <a class="link" href="GMimeObject.html" title="GMimeObject"><s </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the toplevel <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a>.</td> +<td>the toplevel <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a>. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span> +</td> </tr> </tbody> </table></div> @@ -265,8 +266,9 @@ Gets the <a class="link" href="GMimeObject.html" title="GMimeObject"><span class </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the current <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> or <code class="literal">NULL</code> if the state of <em class="parameter"><code>iter</code></em> is -invalid.</td> +<td>the current <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> or <code class="literal">NULL</code> if the +state of <em class="parameter"><code>iter</code></em> is invalid. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span> +</td> </tr> </tbody> </table></div> @@ -289,8 +291,9 @@ position. </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the parent <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> or <code class="literal">NULL</code> if the state of <em class="parameter"><code>iter</code></em> is -invalid.</td> +<td>the parent <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> or <code class="literal">NULL</code> if the +state of <em class="parameter"><code>iter</code></em> is invalid. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span> +</td> </tr> </tbody> </table></div> diff --git a/docs/reference/html/gmime-changes-2-0.html b/docs/reference/html/gmime-changes-2-0.html index 7eea5ff..93dc209 100644 --- a/docs/reference/html/gmime-changes-2-0.html +++ b/docs/reference/html/gmime-changes-2-0.html @@ -31,7 +31,7 @@ Incompatible changes made between version 1.0 and version 2.0 <td valign="top" align="right"></td> </tr></table></div> <div class="refsect1"> -<a name="idp4962656"></a><h2>Incompatible changes from 1.0 to 2.0</h2> +<a name="idp5349024"></a><h2>Incompatible changes from 1.0 to 2.0</h2> <p> See also the PORTING document in the toplevel GMime source directory. </p> diff --git a/docs/reference/html/gmime-changes-2-2.html b/docs/reference/html/gmime-changes-2-2.html index b433704..ac31be4 100644 --- a/docs/reference/html/gmime-changes-2-2.html +++ b/docs/reference/html/gmime-changes-2-2.html @@ -29,7 +29,7 @@ <td valign="top" align="right"></td> </tr></table></div> <div class="refsect1"> -<a name="idp5050848"></a><h2>Incompatible changes from 2.0 to 2.2</h2> +<a name="idp5446096"></a><h2>Incompatible changes from 2.0 to 2.2</h2> <p>See also the PORTING document in the toplevel GMime source directory.</p> <p>There are no incompatible changes between 2.0 and 2.2.</p> <p>GMime 2.2 is both API and ABI compatible with GMime 2.0 meaning @@ -41,7 +41,7 @@ are a few API changes you should be aware of (as these interfaces will be deprecated in some future version, probably 3.0).</p> </div> <div class="refsect1"> -<a name="idp5088336"></a><h2>Replacement interfaces from 2.0 to 2.2</h2> +<a name="idp5491600"></a><h2>Replacement interfaces from 2.0 to 2.2</h2> <div class="itemizedlist"><ul class="itemizedlist" type="disc"> <li class="listitem"><p> <code class="function">g_mime_utils_8bit_header_decode()</code> has been split diff --git a/docs/reference/html/gmime-changes-2-4.html b/docs/reference/html/gmime-changes-2-4.html index 4ae5345..c48820f 100644 --- a/docs/reference/html/gmime-changes-2-4.html +++ b/docs/reference/html/gmime-changes-2-4.html @@ -29,7 +29,7 @@ <td valign="top" align="right"></td> </tr></table></div> <div class="refsect1"> -<a name="idp5083696"></a><h2>Changes from 2.2 to 2.4</h2> +<a name="idp5480720"></a><h2>Changes from 2.2 to 2.4</h2> <p>GMime 2.4 has had a number of API changes since GMime 2.2. To start, ALL public APIs that used to use off_t in GMime 2.2 now use gint64 so that the API and ABI do not change based on whether or diff --git a/docs/reference/html/gmime-changes-2-6.html b/docs/reference/html/gmime-changes-2-6.html index 6e65fb2..aec3b40 100644 --- a/docs/reference/html/gmime-changes-2-6.html +++ b/docs/reference/html/gmime-changes-2-6.html @@ -29,7 +29,7 @@ <td valign="top" align="right"></td> </tr></table></div> <div class="refsect1"> -<a name="idp5123568"></a><h2>Changes from 2.4 to 2.6</h2> +<a name="idp5549824"></a><h2>Changes from 2.4 to 2.6</h2> <p>After releasing GMime 2.4, it was discovered that g_mime_stream_length() still returned ssize_t which, on 32bit systems, meant that the function was useless if the actual stream was larger diff --git a/docs/reference/html/gmime-compiling.html b/docs/reference/html/gmime-compiling.html index e5aee65..efec06c 100644 --- a/docs/reference/html/gmime-compiling.html +++ b/docs/reference/html/gmime-compiling.html @@ -31,7 +31,7 @@ How to compile your GMime application <td valign="top" align="right"></td> </tr></table></div> <div class="refsect1"> -<a name="idp4948864"></a><h2>Compiling GMime Applications on UNIX</h2> +<a name="idp5343168"></a><h2>Compiling GMime Applications on UNIX</h2> <p> To compile a GMime application, you need to tell the compiler where to find the GMime header files and libraries. This is done with the diff --git a/docs/reference/html/gmime-gmime-charset.html b/docs/reference/html/gmime-gmime-charset.html index 918f546..66a620e 100644 --- a/docs/reference/html/gmime-gmime-charset.html +++ b/docs/reference/html/gmime-gmime-charset.html @@ -37,7 +37,7 @@ </tr></table></div> <div class="refsynopsisdiv"> <a name="gmime-gmime-charset.synopsis"></a><h2>Synopsis</h2> -<pre class="synopsis"> <a class="link" href="gmime-gmime-charset.html#GMimeCharset" title="GMimeCharset">GMimeCharset</a>; +<pre class="synopsis">struct <a class="link" href="gmime-gmime-charset.html#GMimeCharset" title="struct GMimeCharset">GMimeCharset</a>; <span class="returnvalue">void</span> <a class="link" href="gmime-gmime-charset.html#g-mime-charset-map-init" title="g_mime_charset_map_init ()">g_mime_charset_map_init</a> (<em class="parameter"><code><span class="type">void</span></code></em>); <span class="returnvalue">void</span> <a class="link" href="gmime-gmime-charset.html#g-mime-charset-map-shutdown" title="g_mime_charset_map_shutdown ()">g_mime_charset_map_shutdown</a> (<em class="parameter"><code><span class="type">void</span></code></em>); const <span class="returnvalue">char</span> * <a class="link" href="gmime-gmime-charset.html#g-mime-locale-charset" title="g_mime_locale_charset ()">g_mime_locale_charset</a> (<em class="parameter"><code><span class="type">void</span></code></em>); @@ -48,14 +48,14 @@ const <span class="returnvalue">char</span> * <a class="link" href="gmime const <span class="returnvalue">char</span> * <a class="link" href="gmime-gmime-charset.html#g-mime-charset-name" title="g_mime_charset_name ()">g_mime_charset_name</a> (<em class="parameter"><code>const <span class="type">char</span> *charset</code></em>); const <span class="returnvalue">char</span> * <a class="link" href="gmime-gmime-charset.html#g-mime-charset-locale-name" title="g_mime_charset_locale_name ()">g_mime_charset_locale_name</a> (<em class="parameter"><code><span class="type">void</span></code></em>); const <span class="returnvalue">char</span> * <a class="link" href="gmime-gmime-charset.html#g-mime-charset-iso-to-windows" title="g_mime_charset_iso_to_windows ()">g_mime_charset_iso_to_windows</a> (<em class="parameter"><code>const <span class="type">char</span> *isocharset</code></em>); -<span class="returnvalue">void</span> <a class="link" href="gmime-gmime-charset.html#g-mime-charset-init" title="g_mime_charset_init ()">g_mime_charset_init</a> (<em class="parameter"><code><a class="link" href="gmime-gmime-charset.html#GMimeCharset" title="GMimeCharset"><span class="type">GMimeCharset</span></a> *charset</code></em>); -<span class="returnvalue">void</span> <a class="link" href="gmime-gmime-charset.html#g-mime-charset-step" title="g_mime_charset_step ()">g_mime_charset_step</a> (<em class="parameter"><code><a class="link" href="gmime-gmime-charset.html#GMimeCharset" title="GMimeCharset"><span class="type">GMimeCharset</span></a> *charset</code></em>, +<span class="returnvalue">void</span> <a class="link" href="gmime-gmime-charset.html#g-mime-charset-init" title="g_mime_charset_init ()">g_mime_charset_init</a> (<em class="parameter"><code><a class="link" href="gmime-gmime-charset.html#GMimeCharset" title="struct GMimeCharset"><span class="type">GMimeCharset</span></a> *charset</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gmime-gmime-charset.html#g-mime-charset-step" title="g_mime_charset_step ()">g_mime_charset_step</a> (<em class="parameter"><code><a class="link" href="gmime-gmime-charset.html#GMimeCharset" title="struct GMimeCharset"><span class="type">GMimeCharset</span></a> *charset</code></em>, <em class="parameter"><code>const <span class="type">char</span> *inbuf</code></em>, <em class="parameter"><code><span class="type">size_t</span> inlen</code></em>); -const <span class="returnvalue">char</span> * <a class="link" href="gmime-gmime-charset.html#g-mime-charset-best-name" title="g_mime_charset_best_name ()">g_mime_charset_best_name</a> (<em class="parameter"><code><a class="link" href="gmime-gmime-charset.html#GMimeCharset" title="GMimeCharset"><span class="type">GMimeCharset</span></a> *charset</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="gmime-gmime-charset.html#g-mime-charset-best-name" title="g_mime_charset_best_name ()">g_mime_charset_best_name</a> (<em class="parameter"><code><a class="link" href="gmime-gmime-charset.html#GMimeCharset" title="struct GMimeCharset"><span class="type">GMimeCharset</span></a> *charset</code></em>); const <span class="returnvalue">char</span> * <a class="link" href="gmime-gmime-charset.html#g-mime-charset-best" title="g_mime_charset_best ()">g_mime_charset_best</a> (<em class="parameter"><code>const <span class="type">char</span> *inbuf</code></em>, <em class="parameter"><code><span class="type">size_t</span> inlen</code></em>); -<span class="returnvalue">gboolean</span> <a class="link" href="gmime-gmime-charset.html#g-mime-charset-can-encode" title="g_mime_charset_can_encode ()">g_mime_charset_can_encode</a> (<em class="parameter"><code><a class="link" href="gmime-gmime-charset.html#GMimeCharset" title="GMimeCharset"><span class="type">GMimeCharset</span></a> *mask</code></em>, +<span class="returnvalue">gboolean</span> <a class="link" href="gmime-gmime-charset.html#g-mime-charset-can-encode" title="g_mime_charset_can_encode ()">g_mime_charset_can_encode</a> (<em class="parameter"><code><a class="link" href="gmime-gmime-charset.html#GMimeCharset" title="struct GMimeCharset"><span class="type">GMimeCharset</span></a> *mask</code></em>, <em class="parameter"><code>const <span class="type">char</span> *charset</code></em>, <em class="parameter"><code>const <span class="type">char</span> *text</code></em>, <em class="parameter"><code><span class="type">size_t</span> len</code></em>); @@ -72,11 +72,11 @@ Charset utility functions. <div class="refsect1"> <a name="gmime-gmime-charset.details"></a><h2>Details</h2> <div class="refsect2"> -<a name="GMimeCharset"></a><h3>GMimeCharset</h3> -<pre class="programlisting">typedef struct { +<a name="GMimeCharset"></a><h3>struct GMimeCharset</h3> +<pre class="programlisting">struct GMimeCharset { unsigned int mask; unsigned int level; -} GMimeCharset; +}; </pre> <p> State used by <a class="link" href="gmime-gmime-charset.html#g-mime-charset-best" title="g_mime_charset_best ()"><code class="function">g_mime_charset_best()</code></a> and <a class="link" href="gmime-gmime-charset.html#g-mime-charset-best-name" title="g_mime_charset_best_name ()"><code class="function">g_mime_charset_best_name()</code></a>. @@ -293,7 +293,7 @@ charset. <hr> <div class="refsect2"> <a name="g-mime-charset-init"></a><h3>g_mime_charset_init ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> g_mime_charset_init (<em class="parameter"><code><a class="link" href="gmime-gmime-charset.html#GMimeCharset" title="GMimeCharset"><span class="type">GMimeCharset</span></a> *charset</code></em>);</pre> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_charset_init (<em class="parameter"><code><a class="link" href="gmime-gmime-charset.html#GMimeCharset" title="struct GMimeCharset"><span class="type">GMimeCharset</span></a> *charset</code></em>);</pre> <p> Initializes a charset mask structure. </p> @@ -308,7 +308,7 @@ Initializes a charset mask structure. <hr> <div class="refsect2"> <a name="g-mime-charset-step"></a><h3>g_mime_charset_step ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> g_mime_charset_step (<em class="parameter"><code><a class="link" href="gmime-gmime-charset.html#GMimeCharset" title="GMimeCharset"><span class="type">GMimeCharset</span></a> *charset</code></em>, +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_charset_step (<em class="parameter"><code><a class="link" href="gmime-gmime-charset.html#GMimeCharset" title="struct GMimeCharset"><span class="type">GMimeCharset</span></a> *charset</code></em>, <em class="parameter"><code>const <span class="type">char</span> *inbuf</code></em>, <em class="parameter"><code><span class="type">size_t</span> inlen</code></em>);</pre> <p> @@ -338,7 +338,7 @@ limiting what charsets our <em class="parameter"><code>charset->mask</code></ <hr> <div class="refsect2"> <a name="g-mime-charset-best-name"></a><h3>g_mime_charset_best_name ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_charset_best_name (<em class="parameter"><code><a class="link" href="gmime-gmime-charset.html#GMimeCharset" title="GMimeCharset"><span class="type">GMimeCharset</span></a> *charset</code></em>);</pre> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_charset_best_name (<em class="parameter"><code><a class="link" href="gmime-gmime-charset.html#GMimeCharset" title="struct GMimeCharset"><span class="type">GMimeCharset</span></a> *charset</code></em>);</pre> <p> Gets the best charset name based on the charset mask <em class="parameter"><code>charset</code></em>. </p> @@ -387,7 +387,7 @@ it is US-ASCII safe.</td> <hr> <div class="refsect2"> <a name="g-mime-charset-can-encode"></a><h3>g_mime_charset_can_encode ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_charset_can_encode (<em class="parameter"><code><a class="link" href="gmime-gmime-charset.html#GMimeCharset" title="GMimeCharset"><span class="type">GMimeCharset</span></a> *mask</code></em>, +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_charset_can_encode (<em class="parameter"><code><a class="link" href="gmime-gmime-charset.html#GMimeCharset" title="struct GMimeCharset"><span class="type">GMimeCharset</span></a> *mask</code></em>, <em class="parameter"><code>const <span class="type">char</span> *charset</code></em>, <em class="parameter"><code>const <span class="type">char</span> *text</code></em>, <em class="parameter"><code><span class="type">size_t</span> len</code></em>);</pre> @@ -399,7 +399,7 @@ Check to see if the UTF-8 <em class="parameter"><code>text</code></em> will fit <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>mask</code></em> :</span></p></td> -<td>a <a class="link" href="gmime-gmime-charset.html#GMimeCharset" title="GMimeCharset"><span class="type">GMimeCharset</span></a> mask</td> +<td>a <a class="link" href="gmime-gmime-charset.html#GMimeCharset" title="struct GMimeCharset"><span class="type">GMimeCharset</span></a> mask</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>charset</code></em> :</span></p></td> @@ -452,7 +452,9 @@ Get the list of user-preferred charsets set with <col align="left" valign="top"> <tbody><tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>an array of user-set charsets or <code class="literal">NULL</code> if none set.</td> +<td>an array of +user-set charsets or <code class="literal">NULL</code> if none set. <span class="annotation">[<a href="http://foldoc.org/array"><span class="acronym">array</span></a> zero-terminated=1][<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span> +</td> </tr></tbody> </table></div> </div> diff --git a/docs/reference/html/gmime-gmime-encodings.html b/docs/reference/html/gmime-gmime-encodings.html index 47c2475..b346442 100644 --- a/docs/reference/html/gmime-gmime-encodings.html +++ b/docs/reference/html/gmime-gmime-encodings.html @@ -42,19 +42,19 @@ (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>); const <span class="returnvalue">char</span> * <a class="link" href="gmime-gmime-encodings.html#g-mime-content-encoding-to-string" title="g_mime_content_encoding_to_string ()">g_mime_content_encoding_to_string</a> (<em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeContentEncoding" title="enum GMimeContentEncoding"><span class="type">GMimeContentEncoding</span></a> encoding</code></em>); enum <a class="link" href="gmime-gmime-encodings.html#GMimeEncodingConstraint" title="enum GMimeEncodingConstraint">GMimeEncodingConstraint</a>; - <a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="GMimeEncoding">GMimeEncoding</a>; -<span class="returnvalue">void</span> <a class="link" href="gmime-gmime-encodings.html#g-mime-encoding-init-encode" title="g_mime_encoding_init_encode ()">g_mime_encoding_init_encode</a> (<em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="GMimeEncoding"><span class="type">GMimeEncoding</span></a> *state</code></em>, +struct <a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="struct GMimeEncoding">GMimeEncoding</a>; +<span class="returnvalue">void</span> <a class="link" href="gmime-gmime-encodings.html#g-mime-encoding-init-encode" title="g_mime_encoding_init_encode ()">g_mime_encoding_init_encode</a> (<em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="struct GMimeEncoding"><span class="type">GMimeEncoding</span></a> *state</code></em>, <em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeContentEncoding" title="enum GMimeContentEncoding"><span class="type">GMimeContentEncoding</span></a> encoding</code></em>); -<span class="returnvalue">void</span> <a class="link" href="gmime-gmime-encodings.html#g-mime-encoding-init-decode" title="g_mime_encoding_init_decode ()">g_mime_encoding_init_decode</a> (<em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="GMimeEncoding"><span class="type">GMimeEncoding</span></a> *state</code></em>, +<span class="returnvalue">void</span> <a class="link" href="gmime-gmime-encodings.html#g-mime-encoding-init-decode" title="g_mime_encoding_init_decode ()">g_mime_encoding_init_decode</a> (<em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="struct GMimeEncoding"><span class="type">GMimeEncoding</span></a> *state</code></em>, <em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeContentEncoding" title="enum GMimeContentEncoding"><span class="type">GMimeContentEncoding</span></a> encoding</code></em>); -<span class="returnvalue">void</span> <a class="link" href="gmime-gmime-encodings.html#g-mime-encoding-reset" title="g_mime_encoding_reset ()">g_mime_encoding_reset</a> (<em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="GMimeEncoding"><span class="type">GMimeEncoding</span></a> *state</code></em>); -<span class="returnvalue">size_t</span> <a class="link" href="gmime-gmime-encodings.html#g-mime-encoding-outlen" title="g_mime_encoding_outlen ()">g_mime_encoding_outlen</a> (<em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="GMimeEncoding"><span class="type">GMimeEncoding</span></a> *state</code></em>, +<span class="returnvalue">void</span> <a class="link" href="gmime-gmime-encodings.html#g-mime-encoding-reset" title="g_mime_encoding_reset ()">g_mime_encoding_reset</a> (<em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="struct GMimeEncoding"><span class="type">GMimeEncoding</span></a> *state</code></em>); +<span class="returnvalue">size_t</span> <a class="link" href="gmime-gmime-encodings.html#g-mime-encoding-outlen" title="g_mime_encoding_outlen ()">g_mime_encoding_outlen</a> (<em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="struct GMimeEncoding"><span class="type">GMimeEncoding</span></a> *state</code></em>, <em class="parameter"><code><span class="type">size_t</span> inlen</code></em>); -<span class="returnvalue">size_t</span> <a class="link" href="gmime-gmime-encodings.html#g-mime-encoding-step" title="g_mime_encoding_step ()">g_mime_encoding_step</a> (<em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="GMimeEncoding"><span class="type">GMimeEncoding</span></a> *state</code></em>, +<span class="returnvalue">size_t</span> <a class="link" href="gmime-gmime-encodings.html#g-mime-encoding-step" title="g_mime_encoding_step ()">g_mime_encoding_step</a> (<em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="struct GMimeEncoding"><span class="type">GMimeEncoding</span></a> *state</code></em>, <em class="parameter"><code>const <span class="type">char</span> *inbuf</code></em>, <em class="parameter"><code><span class="type">size_t</span> inlen</code></em>, <em class="parameter"><code><span class="type">char</span> *outbuf</code></em>); -<span class="returnvalue">size_t</span> <a class="link" href="gmime-gmime-encodings.html#g-mime-encoding-flush" title="g_mime_encoding_flush ()">g_mime_encoding_flush</a> (<em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="GMimeEncoding"><span class="type">GMimeEncoding</span></a> *state</code></em>, +<span class="returnvalue">size_t</span> <a class="link" href="gmime-gmime-encodings.html#g-mime-encoding-flush" title="g_mime_encoding_flush ()">g_mime_encoding_flush</a> (<em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="struct GMimeEncoding"><span class="type">GMimeEncoding</span></a> *state</code></em>, <em class="parameter"><code>const <span class="type">char</span> *inbuf</code></em>, <em class="parameter"><code><span class="type">size_t</span> inlen</code></em>, <em class="parameter"><code><span class="type">char</span> *outbuf</code></em>); @@ -267,14 +267,14 @@ constraints are for the stream. </div> <hr> <div class="refsect2"> -<a name="GMimeEncoding"></a><h3>GMimeEncoding</h3> -<pre class="programlisting">typedef struct { +<a name="GMimeEncoding"></a><h3>struct GMimeEncoding</h3> +<pre class="programlisting">struct GMimeEncoding { GMimeContentEncoding encoding; unsigned char uubuf[60]; gboolean encode; guint32 save; int state; -} GMimeEncoding; +}; </pre> <p> A context used for encoding or decoding data. @@ -309,10 +309,10 @@ A context used for encoding or decoding data. <hr> <div class="refsect2"> <a name="g-mime-encoding-init-encode"></a><h3>g_mime_encoding_init_encode ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> g_mime_encoding_init_encode (<em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="GMimeEncoding"><span class="type">GMimeEncoding</span></a> *state</code></em>, +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_encoding_init_encode (<em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="struct GMimeEncoding"><span class="type">GMimeEncoding</span></a> *state</code></em>, <em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeContentEncoding" title="enum GMimeContentEncoding"><span class="type">GMimeContentEncoding</span></a> encoding</code></em>);</pre> <p> -Initializes a <a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="GMimeEncoding"><span class="type">GMimeEncoding</span></a> state machine for encoding to +Initializes a <a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="struct GMimeEncoding"><span class="type">GMimeEncoding</span></a> state machine for encoding to <em class="parameter"><code>encoding</code></em>. </p> <div class="variablelist"><table border="0"> @@ -320,7 +320,7 @@ Initializes a <a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" ti <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td> -<td>a <a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="GMimeEncoding"><span class="type">GMimeEncoding</span></a> to initialize</td> +<td>a <a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="struct GMimeEncoding"><span class="type">GMimeEncoding</span></a> to initialize</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>encoding</code></em> :</span></p></td> @@ -332,10 +332,10 @@ Initializes a <a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" ti <hr> <div class="refsect2"> <a name="g-mime-encoding-init-decode"></a><h3>g_mime_encoding_init_decode ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> g_mime_encoding_init_decode (<em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="GMimeEncoding"><span class="type">GMimeEncoding</span></a> *state</code></em>, +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_encoding_init_decode (<em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="struct GMimeEncoding"><span class="type">GMimeEncoding</span></a> *state</code></em>, <em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeContentEncoding" title="enum GMimeContentEncoding"><span class="type">GMimeContentEncoding</span></a> encoding</code></em>);</pre> <p> -Initializes a <a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="GMimeEncoding"><span class="type">GMimeEncoding</span></a> state machine for decoding from +Initializes a <a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="struct GMimeEncoding"><span class="type">GMimeEncoding</span></a> state machine for decoding from <em class="parameter"><code>encoding</code></em>. </p> <div class="variablelist"><table border="0"> @@ -343,7 +343,7 @@ Initializes a <a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" ti <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td> -<td>a <a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="GMimeEncoding"><span class="type">GMimeEncoding</span></a> to initialize</td> +<td>a <a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="struct GMimeEncoding"><span class="type">GMimeEncoding</span></a> to initialize</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>encoding</code></em> :</span></p></td> @@ -355,22 +355,22 @@ Initializes a <a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" ti <hr> <div class="refsect2"> <a name="g-mime-encoding-reset"></a><h3>g_mime_encoding_reset ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> g_mime_encoding_reset (<em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="GMimeEncoding"><span class="type">GMimeEncoding</span></a> *state</code></em>);</pre> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_encoding_reset (<em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="struct GMimeEncoding"><span class="type">GMimeEncoding</span></a> *state</code></em>);</pre> <p> -Resets the state of the <a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="GMimeEncoding"><span class="type">GMimeEncoding</span></a>. +Resets the state of the <a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="struct GMimeEncoding"><span class="type">GMimeEncoding</span></a>. </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody><tr> <td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td> -<td>a <a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="GMimeEncoding"><span class="type">GMimeEncoding</span></a> to reset</td> +<td>a <a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="struct GMimeEncoding"><span class="type">GMimeEncoding</span></a> to reset</td> </tr></tbody> </table></div> </div> <hr> <div class="refsect2"> <a name="g-mime-encoding-outlen"></a><h3>g_mime_encoding_outlen ()</h3> -<pre class="programlisting"><span class="returnvalue">size_t</span> g_mime_encoding_outlen (<em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="GMimeEncoding"><span class="type">GMimeEncoding</span></a> *state</code></em>, +<pre class="programlisting"><span class="returnvalue">size_t</span> g_mime_encoding_outlen (<em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="struct GMimeEncoding"><span class="type">GMimeEncoding</span></a> *state</code></em>, <em class="parameter"><code><span class="type">size_t</span> inlen</code></em>);</pre> <p> Given the input length, <em class="parameter"><code>inlen</code></em>, calculate the needed output length @@ -381,7 +381,7 @@ to perform an encoding or decoding step. <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td> -<td>a <a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="GMimeEncoding"><span class="type">GMimeEncoding</span></a> +<td>a <a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="struct GMimeEncoding"><span class="type">GMimeEncoding</span></a> </td> </tr> <tr> @@ -399,7 +399,7 @@ buffer of <em class="parameter"><code>inlen</code></em> bytes.</td> <hr> <div class="refsect2"> <a name="g-mime-encoding-step"></a><h3>g_mime_encoding_step ()</h3> -<pre class="programlisting"><span class="returnvalue">size_t</span> g_mime_encoding_step (<em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="GMimeEncoding"><span class="type">GMimeEncoding</span></a> *state</code></em>, +<pre class="programlisting"><span class="returnvalue">size_t</span> g_mime_encoding_step (<em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="struct GMimeEncoding"><span class="type">GMimeEncoding</span></a> *state</code></em>, <em class="parameter"><code>const <span class="type">char</span> *inbuf</code></em>, <em class="parameter"><code><span class="type">size_t</span> inlen</code></em>, <em class="parameter"><code><span class="type">char</span> *outbuf</code></em>);</pre> @@ -417,7 +417,7 @@ to be. <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td> -<td>a <a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="GMimeEncoding"><span class="type">GMimeEncoding</span></a> +<td>a <a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="struct GMimeEncoding"><span class="type">GMimeEncoding</span></a> </td> </tr> <tr> @@ -442,7 +442,7 @@ to be. <hr> <div class="refsect2"> <a name="g-mime-encoding-flush"></a><h3>g_mime_encoding_flush ()</h3> -<pre class="programlisting"><span class="returnvalue">size_t</span> g_mime_encoding_flush (<em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="GMimeEncoding"><span class="type">GMimeEncoding</span></a> *state</code></em>, +<pre class="programlisting"><span class="returnvalue">size_t</span> g_mime_encoding_flush (<em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="struct GMimeEncoding"><span class="type">GMimeEncoding</span></a> *state</code></em>, <em class="parameter"><code>const <span class="type">char</span> *inbuf</code></em>, <em class="parameter"><code><span class="type">size_t</span> inlen</code></em>, <em class="parameter"><code><span class="type">char</span> *outbuf</code></em>);</pre> @@ -455,7 +455,7 @@ Completes the incremental encode or decode of the input stream (see <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td> -<td>a <a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="GMimeEncoding"><span class="type">GMimeEncoding</span></a> +<td>a <a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="struct GMimeEncoding"><span class="type">GMimeEncoding</span></a> </td> </tr> <tr> diff --git a/docs/reference/html/gmime-gmime-utils.html b/docs/reference/html/gmime-gmime-utils.html index 30607e7..c7c978f 100644 --- a/docs/reference/html/gmime-gmime-utils.html +++ b/docs/reference/html/gmime-gmime-utils.html @@ -51,7 +51,7 @@ const <a class="link" href="gmime-gmime-utils.html#GMimeReferences" title="struc <em class="parameter"><code>const <span class="type">char</span> *msgid</code></em>); <span class="returnvalue">void</span> <a class="link" href="gmime-gmime-utils.html#g-mime-references-clear" title="g_mime_references_clear ()">g_mime_references_clear</a> (<em class="parameter"><code><a class="link" href="gmime-gmime-utils.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a> **refs</code></em>); <span class="returnvalue">void</span> <a class="link" href="gmime-gmime-utils.html#g-mime-references-free" title="g_mime_references_free ()">g_mime_references_free</a> (<em class="parameter"><code><a class="link" href="gmime-gmime-utils.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a> *refs</code></em>); -<span class="returnvalue">char</span> * <a class="link" href="gmime-gmime-utils.html#g-mime-utils-header-fold" title="g_mime_utils_header_fold ()">g_mime_utils_header_fold</a> (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>); +<span class="returnvalue">char</span> * <a class="link" href="gmime-gmime-utils.html#g-mime-utils-header-fold" title="g_mime_utils_header_fold ()">g_mime_utils_header_fold</a> (<em class="parameter"><code>const <span class="type">char</span> *header</code></em>); <span class="returnvalue">char</span> * <a class="link" href="gmime-gmime-utils.html#g-mime-utils-header-printf" title="g_mime_utils_header_printf ()">g_mime_utils_header_printf</a> (<em class="parameter"><code>const <span class="type">char</span> *format</code></em>, <em class="parameter"><code>...</code></em>); <span class="returnvalue">char</span> * <a class="link" href="gmime-gmime-utils.html#g-mime-utils-quote-string" title="g_mime_utils_quote_string ()">g_mime_utils_quote_string</a> (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>); @@ -66,9 +66,9 @@ const <a class="link" href="gmime-gmime-utils.html#GMimeReferences" title="struc <span class="returnvalue">char</span> * <a class="link" href="gmime-gmime-utils.html#g-mime-utils-header-encode-text" title="g_mime_utils_header_encode_text ()">g_mime_utils_header_encode_text</a> (<em class="parameter"><code>const <span class="type">char</span> *text</code></em>); <span class="returnvalue">char</span> * <a class="link" href="gmime-gmime-utils.html#g-mime-utils-header-decode-phrase" title="g_mime_utils_header_decode_phrase ()">g_mime_utils_header_decode_phrase</a> (<em class="parameter"><code>const <span class="type">char</span> *phrase</code></em>); <span class="returnvalue">char</span> * <a class="link" href="gmime-gmime-utils.html#g-mime-utils-header-encode-phrase" title="g_mime_utils_header_encode_phrase ()">g_mime_utils_header_encode_phrase</a> (<em class="parameter"><code>const <span class="type">char</span> *phrase</code></em>); -<span class="returnvalue">char</span> * <a class="link" href="gmime-gmime-utils.html#g-mime-utils-structured-header-fold" title="g_mime_utils_structured_header_fold ()">g_mime_utils_structured_header_fold</a> (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>); +<span class="returnvalue">char</span> * <a class="link" href="gmime-gmime-utils.html#g-mime-utils-structured-header-fold" title="g_mime_utils_structured_header_fold ()">g_mime_utils_structured_header_fold</a> (<em class="parameter"><code>const <span class="type">char</span> *header</code></em>); <span class="returnvalue">char</span> * <a class="link" href="gmime-gmime-utils.html#g-mime-utils-unstructured-header-fold" title="g_mime_utils_unstructured_header_fold ()">g_mime_utils_unstructured_header_fold</a> - (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>); + (<em class="parameter"><code>const <span class="type">char</span> *header</code></em>); </pre> </div> <div class="refsect1"> @@ -123,7 +123,8 @@ Decodes the rfc822 date string and saves the GMT offset into </tr> <tr> <td><p><span class="term"><em class="parameter"><code>tz_offset</code></em> :</span></p></td> -<td>timezone offset</td> +<td>timezone offset. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span> +</td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> @@ -323,7 +324,7 @@ Frees the <a class="link" href="gmime-gmime-utils.html#GMimeReferences" title="s <hr> <div class="refsect2"> <a name="g-mime-utils-header-fold"></a><h3>g_mime_utils_header_fold ()</h3> -<pre class="programlisting"><span class="returnvalue">char</span> * g_mime_utils_header_fold (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>);</pre> +<pre class="programlisting"><span class="returnvalue">char</span> * g_mime_utils_header_fold (<em class="parameter"><code>const <span class="type">char</span> *header</code></em>);</pre> <p> Folds a structured header according to the rules in rfc822. </p> @@ -331,12 +332,14 @@ Folds a structured header according to the rules in rfc822. <col align="left" valign="top"> <tbody> <tr> -<td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td> -<td>input string</td> +<td><p><span class="term"><em class="parameter"><code>header</code></em> :</span></p></td> +<td>header field and value string</td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>an allocated string containing the folded header.</td> +<td>an allocated string containing the folded header. +WARNING: This function is obsolete. Use +<a class="link" href="gmime-gmime-utils.html#g-mime-utils-structured-header-fold" title="g_mime_utils_structured_header_fold ()"><code class="function">g_mime_utils_structured_header_fold()</code></a> instead.</td> </tr> </tbody> </table></div> @@ -479,7 +482,9 @@ into question-marks (?) in the returned string buffer. <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td> -<td>input text in unknown 8bit/multibyte character set</td> +<td>input text in +unknown 8bit/multibyte character set. <span class="annotation">[<a href="http://foldoc.org/array"><span class="acronym">array</span></a> length=len][<a href="http://foldoc.org/element-type"><span class="acronym">element-type</span></a> guint8]</span> +</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>len</code></em> :</span></p></td> @@ -593,7 +598,7 @@ addresses.</td> <hr> <div class="refsect2"> <a name="g-mime-utils-structured-header-fold"></a><h3>g_mime_utils_structured_header_fold ()</h3> -<pre class="programlisting"><span class="returnvalue">char</span> * g_mime_utils_structured_header_fold (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>);</pre> +<pre class="programlisting"><span class="returnvalue">char</span> * g_mime_utils_structured_header_fold (<em class="parameter"><code>const <span class="type">char</span> *header</code></em>);</pre> <p> Folds a structured header according to the rules in rfc822. </p> @@ -601,8 +606,8 @@ Folds a structured header according to the rules in rfc822. <col align="left" valign="top"> <tbody> <tr> -<td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td> -<td>input string</td> +<td><p><span class="term"><em class="parameter"><code>header</code></em> :</span></p></td> +<td>header field and value string</td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> @@ -615,7 +620,7 @@ Folds a structured header according to the rules in rfc822. <div class="refsect2"> <a name="g-mime-utils-unstructured-header-fold"></a><h3>g_mime_utils_unstructured_header_fold ()</h3> <pre class="programlisting"><span class="returnvalue">char</span> * g_mime_utils_unstructured_header_fold - (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>);</pre> + (<em class="parameter"><code>const <span class="type">char</span> *header</code></em>);</pre> <p> Folds an unstructured header according to the rules in rfc822. </p> @@ -623,8 +628,8 @@ Folds an unstructured header according to the rules in rfc822. <col align="left" valign="top"> <tbody> <tr> -<td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td> -<td>input string</td> +<td><p><span class="term"><em class="parameter"><code>header</code></em> :</span></p></td> +<td>header field and value string</td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> diff --git a/docs/reference/html/gmime-gmime.html b/docs/reference/html/gmime-gmime.html index f354443..e620666 100644 --- a/docs/reference/html/gmime-gmime.html +++ b/docs/reference/html/gmime-gmime.html @@ -46,6 +46,7 @@ minor, micro) #define <a class="link" href="gmime-gmime.html#GMIME-ENABLE-RFC2047-WORKAROUNDS:CAPS" title="GMIME_ENABLE_RFC2047_WORKAROUNDS">GMIME_ENABLE_RFC2047_WORKAROUNDS</a> +#define <a class="link" href="gmime-gmime.html#GMIME-ENABLE-USE-ONLY-USER-CHARSETS:CAPS" title="GMIME_ENABLE_USE_ONLY_USER_CHARSETS">GMIME_ENABLE_USE_ONLY_USER_CHARSETS</a> <span class="returnvalue">void</span> <a class="link" href="gmime-gmime.html#g-mime-init" title="g_mime_init ()">g_mime_init</a> (<em class="parameter"><code><span class="type">guint32</span> flags</code></em>); <span class="returnvalue">void</span> <a class="link" href="gmime-gmime.html#g-mime-shutdown" title="g_mime_shutdown ()">g_mime_shutdown</a> (<em class="parameter"><code><span class="type">void</span></code></em>); extern const guint <a class="link" href="gmime-gmime.html#gmime-major-version" title="gmime_major_version">gmime_major_version</a>; @@ -77,7 +78,7 @@ GMime's major version. <hr> <div class="refsect2"> <a name="GMIME-MICRO-VERSION:CAPS"></a><h3>GMIME_MICRO_VERSION</h3> -<pre class="programlisting">#define GMIME_MICRO_VERSION (15) +<pre class="programlisting">#define GMIME_MICRO_VERSION (20) </pre> <p> GMime's micro version. @@ -95,7 +96,7 @@ GMime's minor version. <hr> <div class="refsect2"> <a name="GMIME-BINARY-AGE:CAPS"></a><h3>GMIME_BINARY_AGE</h3> -<pre class="programlisting">#define GMIME_BINARY_AGE (615) +<pre class="programlisting">#define GMIME_BINARY_AGE (620) </pre> <p> GMime's binary age. @@ -104,7 +105,7 @@ GMime's binary age. <hr> <div class="refsect2"> <a name="GMIME-INTERFACE-AGE:CAPS"></a><h3>GMIME_INTERFACE_AGE</h3> -<pre class="programlisting">#define GMIME_INTERFACE_AGE (15) +<pre class="programlisting">#define GMIME_INTERFACE_AGE (0) </pre> <p> GMime's interface age. @@ -139,7 +140,7 @@ Check whether a GMime version equal to or greater than <hr> <div class="refsect2"> <a name="GMIME-ENABLE-RFC2047-WORKAROUNDS:CAPS"></a><h3>GMIME_ENABLE_RFC2047_WORKAROUNDS</h3> -<pre class="programlisting">#define GMIME_ENABLE_RFC2047_WORKAROUNDS (1 << 0) +<pre class="programlisting">#define GMIME_ENABLE_RFC2047_WORKAROUNDS (1 << 0) </pre> <p> Initialization flag to enable workarounds for badly formed rfc2047 @@ -148,6 +149,18 @@ encoded-words. </div> <hr> <div class="refsect2"> +<a name="GMIME-ENABLE-USE-ONLY-USER-CHARSETS:CAPS"></a><h3>GMIME_ENABLE_USE_ONLY_USER_CHARSETS</h3> +<pre class="programlisting">#define GMIME_ENABLE_USE_ONLY_USER_CHARSETS (1 << 1) +</pre> +<p> +Initialization flag that hints to the rfc2047 encoder to use only +the configured user-charsets (set via <a class="link" href="gmime-gmime-charset.html#g-mime-set-user-charsets" title="g_mime_set_user_charsets ()"><code class="function">g_mime_set_user_charsets()</code></a>) +instead of trying to first use iso-8859-1. +</p> +<p class="since">Since 2.6.16</p> +</div> +<hr> +<div class="refsect2"> <a name="g-mime-init"></a><h3>g_mime_init ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> g_mime_init (<em class="parameter"><code><span class="type">guint32</span> flags</code></em>);</pre> <p> diff --git a/docs/reference/html/gmime-question-index.html b/docs/reference/html/gmime-question-index.html index 4c198ed..cb4e8cc 100644 --- a/docs/reference/html/gmime-question-index.html +++ b/docs/reference/html/gmime-question-index.html @@ -31,22 +31,22 @@ Find answers to common questions in the GMime manual <td valign="top" align="right"></td> </tr></table></div> <div class="refsect1"> -<a name="idp5189120"></a><h2>Questions and Answers</h2> +<a name="idp5607280"></a><h2>Questions and Answers</h2> <p>This is an "index" of the reference manual organized by common "How do I..." questions. If you aren't sure which documentation to read for the question you have, this list is a good place to start. </p> <div class="qandaset"> -<a name="idp5200944"></a><table border="0" width="100%" summary="Q and A Set"> +<a name="idp5584960"></a><table border="0" width="100%" summary="Q and A Set"> <col align="left" width="1%"> <col> <tbody> <tr class="qandadiv"><td align="left" valign="top" colspan="2"><h5 class="title"> -<a name="idp5201200"></a>1. General</h5></td></tr> +<a name="idp5585216"></a>1. General</h5></td></tr> <tr class="question"> <td align="left" valign="top"> -<a name="idp5201872"></a><a name="idp5202128"></a><p><b>1.1.</b></p> +<a name="idp5585888"></a><a name="idp5586144"></a><p><b>1.1.</b></p> </td> <td align="left" valign="top"><p>Where can I get help with GMime, submit a bug report, or make a feature request?</p></td> </tr> @@ -57,18 +57,18 @@ Find answers to common questions in the GMime manual </tr> <tr class="question"> <td align="left" valign="top"> -<a name="idp5204368"></a><a name="idp5204624"></a><p><b>1.2.</b></p> +<a name="idp5588592"></a><a name="idp5639200"></a><p><b>1.2.</b></p> </td> <td align="left" valign="top"><p>How do I port from one GMime version to another?</p></td> </tr> <tr class="answer"> <td align="left" valign="top"></td> -<td align="left" valign="top"><p>See the <a class="link" href="gmime-changes-2-4.html" title="Changes from 2.2 to 2.4">list of - incompatible changes from 2.2 to 2.4</a>.</p></td> +<td align="left" valign="top"><p>See the <a class="link" href="gmime-changes-2-6.html" title="Changes from 2.4 to 2.6">list of + incompatible changes from 2.4 to 2.6</a>.</p></td> </tr> <tr class="question"> <td align="left" valign="top"> -<a name="idp5237584"></a><a name="idp5237840"></a><p><b>1.3.</b></p> +<a name="idp5641232"></a><a name="idp5641488"></a><p><b>1.3.</b></p> </td> <td align="left" valign="top"><p>How does memory management work in GMime? Should I free data returned from functions?</p></td> </tr> @@ -88,7 +88,7 @@ Find answers to common questions in the GMime manual </tr> <tr class="question"> <td align="left" valign="top"> -<a name="idp5241536"></a><a name="idp5241792"></a><p><b>1.4.</b></p> +<a name="idp5645280"></a><a name="idp5645536"></a><p><b>1.4.</b></p> </td> <td align="left" valign="top"><p>How do I use GMime with threads?</p></td> </tr> @@ -110,7 +110,7 @@ Find answers to common questions in the GMime manual </tr> <tr class="question"> <td align="left" valign="top"> -<a name="idp5247232"></a><a name="idp5247488"></a><p><b>1.5.</b></p> +<a name="idp5650976"></a><a name="idp5651232"></a><p><b>1.5.</b></p> </td> <td align="left" valign="top"><p>How do I use GMime with C++?</p></td> </tr> diff --git a/docs/reference/html/gmime-resources.html b/docs/reference/html/gmime-resources.html index fe05221..87db47c 100644 --- a/docs/reference/html/gmime-resources.html +++ b/docs/reference/html/gmime-resources.html @@ -31,7 +31,7 @@ Getting help with GMime <td valign="top" align="right"></td> </tr></table></div> <div class="refsect1"> -<a name="idp5158880"></a><h2>Filing a bug report or feature request</h2> +<a name="idp5555872"></a><h2>Filing a bug report or feature request</h2> <p> If you encounter a bug, misfeature, or missing feature in GMime, please file a bug report at @@ -47,7 +47,7 @@ the way to be sure the GMime developers won't forget about an issue. </p> </div> <div class="refsect1"> -<a name="idp5161792"></a><h2>Submitting Patches</h2> +<a name="idp5608528"></a><h2>Submitting Patches</h2> <p> If you develop a bugfix or enhancement for GMime, please file that in Bugzilla as well. Bugzilla allows you to attach files; please attach a @@ -67,7 +67,7 @@ well, this way it's less likely to slip through the cracks. </p> </div> <div class="refsect1"> -<a name="idp5209360"></a><h2>Mailing lists</h2> +<a name="idp5613408"></a><h2>Mailing lists</h2> <p>There is currently only one mailing-list devoted to GMime itself which is for both the development of and development with GMime. You can subscribe to this list diff --git a/docs/reference/html/gmime.devhelp2 b/docs/reference/html/gmime.devhelp2 index 64e4687..267cd3b 100644 --- a/docs/reference/html/gmime.devhelp2 +++ b/docs/reference/html/gmime.devhelp2 @@ -100,6 +100,7 @@ <keyword type="macro" name="GMIME_INTERFACE_AGE" link="gmime-gmime.html#GMIME-INTERFACE-AGE:CAPS"/> <keyword type="macro" name="GMIME_CHECK_VERSION()" link="gmime-gmime.html#GMIME-CHECK-VERSION:CAPS"/> <keyword type="macro" name="GMIME_ENABLE_RFC2047_WORKAROUNDS" link="gmime-gmime.html#GMIME-ENABLE-RFC2047-WORKAROUNDS:CAPS"/> + <keyword type="macro" name="GMIME_ENABLE_USE_ONLY_USER_CHARSETS" link="gmime-gmime.html#GMIME-ENABLE-USE-ONLY-USER-CHARSETS:CAPS" since="2.6.16"/> <keyword type="function" name="g_mime_init ()" link="gmime-gmime.html#g-mime-init"/> <keyword type="function" name="g_mime_shutdown ()" link="gmime-gmime.html#g-mime-shutdown"/> <keyword type="variable" name="gmime_major_version" link="gmime-gmime.html#gmime-major-version"/> @@ -108,7 +109,7 @@ <keyword type="variable" name="gmime_binary_age" link="gmime-gmime.html#gmime-binary-age"/> <keyword type="variable" name="gmime_interface_age" link="gmime-gmime.html#gmime-interface-age"/> <keyword type="function" name="g_mime_check_version ()" link="gmime-gmime.html#g-mime-check-version"/> - <keyword type="struct" name="GMimeCharset" link="gmime-gmime-charset.html#GMimeCharset"/> + <keyword type="struct" name="struct GMimeCharset" link="gmime-gmime-charset.html#GMimeCharset"/> <keyword type="function" name="g_mime_charset_map_init ()" link="gmime-gmime-charset.html#g-mime-charset-map-init"/> <keyword type="function" name="g_mime_charset_map_shutdown ()" link="gmime-gmime-charset.html#g-mime-charset-map-shutdown"/> <keyword type="function" name="g_mime_locale_charset ()" link="gmime-gmime-charset.html#g-mime-locale-charset"/> @@ -141,7 +142,7 @@ <keyword type="function" name="g_mime_content_encoding_from_string ()" link="gmime-gmime-encodings.html#g-mime-content-encoding-from-string"/> <keyword type="function" name="g_mime_content_encoding_to_string ()" link="gmime-gmime-encodings.html#g-mime-content-encoding-to-string"/> <keyword type="enum" name="enum GMimeEncodingConstraint" link="gmime-gmime-encodings.html#GMimeEncodingConstraint"/> - <keyword type="struct" name="GMimeEncoding" link="gmime-gmime-encodings.html#GMimeEncoding"/> + <keyword type="struct" name="struct GMimeEncoding" link="gmime-gmime-encodings.html#GMimeEncoding"/> <keyword type="function" name="g_mime_encoding_init_encode ()" link="gmime-gmime-encodings.html#g-mime-encoding-init-encode"/> <keyword type="function" name="g_mime_encoding_init_decode ()" link="gmime-gmime-encodings.html#g-mime-encoding-init-decode"/> <keyword type="function" name="g_mime_encoding_reset ()" link="gmime-gmime-encodings.html#g-mime-encoding-reset"/> @@ -209,11 +210,13 @@ <keyword type="struct" name="struct GMimeStreamFile" link="GMimeStreamFile.html#GMimeStreamFile-struct"/> <keyword type="function" name="g_mime_stream_file_new ()" link="GMimeStreamFile.html#g-mime-stream-file-new"/> <keyword type="function" name="g_mime_stream_file_new_with_bounds ()" link="GMimeStreamFile.html#g-mime-stream-file-new-with-bounds"/> + <keyword type="function" name="g_mime_stream_file_new_for_path ()" link="GMimeStreamFile.html#g-mime-stream-file-new-for-path" since="2.6.18"/> <keyword type="function" name="g_mime_stream_file_get_owner ()" link="GMimeStreamFile.html#g-mime-stream-file-get-owner"/> <keyword type="function" name="g_mime_stream_file_set_owner ()" link="GMimeStreamFile.html#g-mime-stream-file-set-owner"/> <keyword type="struct" name="struct GMimeStreamFs" link="GMimeStreamFs.html#GMimeStreamFs-struct"/> <keyword type="function" name="g_mime_stream_fs_new ()" link="GMimeStreamFs.html#g-mime-stream-fs-new"/> <keyword type="function" name="g_mime_stream_fs_new_with_bounds ()" link="GMimeStreamFs.html#g-mime-stream-fs-new-with-bounds"/> + <keyword type="function" name="g_mime_stream_fs_new_for_path ()" link="GMimeStreamFs.html#g-mime-stream-fs-new-for-path" since="2.6.18"/> <keyword type="function" name="g_mime_stream_fs_get_owner ()" link="GMimeStreamFs.html#g-mime-stream-fs-get-owner"/> <keyword type="function" name="g_mime_stream_fs_set_owner ()" link="GMimeStreamFs.html#g-mime-stream-fs-set-owner"/> <keyword type="struct" name="struct GMimeStreamMem" link="GMimeStreamMem.html#GMimeStreamMem-struct"/> diff --git a/docs/reference/html/index.html b/docs/reference/html/index.html index c3da4ad..3b4b5b6 100644 --- a/docs/reference/html/index.html +++ b/docs/reference/html/index.html @@ -25,7 +25,7 @@ </div></div></div> <div><p class="copyright">Copyright © 2000-2011 Jeffrey Stedfast</p></div> <div><div class="legalnotice"> -<a name="idp251088"></a><p> +<a name="idp910144"></a><p> This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either diff --git a/docs/reference/html/index.sgml b/docs/reference/html/index.sgml index 1b70661..16a0bfd 100644 --- a/docs/reference/html/index.sgml +++ b/docs/reference/html/index.sgml @@ -27,6 +27,7 @@ <ANCHOR id="GMIME-INTERFACE-AGE:CAPS" href="gmime/gmime-gmime.html#GMIME-INTERFACE-AGE:CAPS"> <ANCHOR id="GMIME-CHECK-VERSION:CAPS" href="gmime/gmime-gmime.html#GMIME-CHECK-VERSION:CAPS"> <ANCHOR id="GMIME-ENABLE-RFC2047-WORKAROUNDS:CAPS" href="gmime/gmime-gmime.html#GMIME-ENABLE-RFC2047-WORKAROUNDS:CAPS"> +<ANCHOR id="GMIME-ENABLE-USE-ONLY-USER-CHARSETS:CAPS" href="gmime/gmime-gmime.html#GMIME-ENABLE-USE-ONLY-USER-CHARSETS:CAPS"> <ANCHOR id="g-mime-init" href="gmime/gmime-gmime.html#g-mime-init"> <ANCHOR id="g-mime-shutdown" href="gmime/gmime-gmime.html#g-mime-shutdown"> <ANCHOR id="gmime-major-version" href="gmime/gmime-gmime.html#gmime-major-version"> @@ -179,6 +180,7 @@ <ANCHOR id="GMimeStreamFile-struct" href="gmime/GMimeStreamFile.html#GMimeStreamFile-struct"> <ANCHOR id="g-mime-stream-file-new" href="gmime/GMimeStreamFile.html#g-mime-stream-file-new"> <ANCHOR id="g-mime-stream-file-new-with-bounds" href="gmime/GMimeStreamFile.html#g-mime-stream-file-new-with-bounds"> +<ANCHOR id="g-mime-stream-file-new-for-path" href="gmime/GMimeStreamFile.html#g-mime-stream-file-new-for-path"> <ANCHOR id="g-mime-stream-file-get-owner" href="gmime/GMimeStreamFile.html#g-mime-stream-file-get-owner"> <ANCHOR id="g-mime-stream-file-set-owner" href="gmime/GMimeStreamFile.html#g-mime-stream-file-set-owner"> <ANCHOR id="GMimeStreamFile.see-also" href="gmime/GMimeStreamFile.html#GMimeStreamFile.see-also"> @@ -190,6 +192,7 @@ <ANCHOR id="GMimeStreamFs-struct" href="gmime/GMimeStreamFs.html#GMimeStreamFs-struct"> <ANCHOR id="g-mime-stream-fs-new" href="gmime/GMimeStreamFs.html#g-mime-stream-fs-new"> <ANCHOR id="g-mime-stream-fs-new-with-bounds" href="gmime/GMimeStreamFs.html#g-mime-stream-fs-new-with-bounds"> +<ANCHOR id="g-mime-stream-fs-new-for-path" href="gmime/GMimeStreamFs.html#g-mime-stream-fs-new-for-path"> <ANCHOR id="g-mime-stream-fs-get-owner" href="gmime/GMimeStreamFs.html#g-mime-stream-fs-get-owner"> <ANCHOR id="g-mime-stream-fs-set-owner" href="gmime/GMimeStreamFs.html#g-mime-stream-fs-set-owner"> <ANCHOR id="GMimeStreamFs.see-also" href="gmime/GMimeStreamFs.html#GMimeStreamFs.see-also"> diff --git a/docs/reference/question_index.sgml b/docs/reference/question_index.sgml index 8372600..bd2a849 100644 --- a/docs/reference/question_index.sgml +++ b/docs/reference/question_index.sgml @@ -31,8 +31,8 @@ Find answers to common questions in the GMime manual <qandaentry> <question><para>How do I port from one GMime version to another?</para></question> <answer> - <para>See the <link linkend="gmime-changes-2-4">list of - incompatible changes from 2.2 to 2.4</link>.</para> + <para>See the <link linkend="gmime-changes-2-6">list of + incompatible changes from 2.4 to 2.6</link>.</para> </answer> </qandaentry> <qandaentry> diff --git a/docs/reference/tmpl/gmime-stream-file.sgml b/docs/reference/tmpl/gmime-stream-file.sgml index 0309a69..adc6ee3 100644 --- a/docs/reference/tmpl/gmime-stream-file.sgml +++ b/docs/reference/tmpl/gmime-stream-file.sgml @@ -46,6 +46,16 @@ gmime-stream-file @Returns: +<!-- ##### FUNCTION g_mime_stream_file_new_for_path ##### --> +<para> + +</para> + +@path: +@mode: +@Returns: + + <!-- ##### FUNCTION g_mime_stream_file_get_owner ##### --> <para> diff --git a/docs/reference/tmpl/gmime-stream-fs.sgml b/docs/reference/tmpl/gmime-stream-fs.sgml index fa14bb5..c77eca5 100644 --- a/docs/reference/tmpl/gmime-stream-fs.sgml +++ b/docs/reference/tmpl/gmime-stream-fs.sgml @@ -46,6 +46,17 @@ gmime-stream-fs @Returns: +<!-- ##### FUNCTION g_mime_stream_fs_new_for_path ##### --> +<para> + +</para> + +@path: +@flags: +@mode: +@Returns: + + <!-- ##### FUNCTION g_mime_stream_fs_get_owner ##### --> <para> diff --git a/docs/reference/tmpl/gmime-utils.sgml b/docs/reference/tmpl/gmime-utils.sgml index 42b01bf..ba1253d 100644 --- a/docs/reference/tmpl/gmime-utils.sgml +++ b/docs/reference/tmpl/gmime-utils.sgml @@ -123,7 +123,7 @@ gmime-utils </para> -@str: +@header: @Returns: @@ -225,7 +225,7 @@ gmime-utils </para> -@str: +@header: @Returns: @@ -234,7 +234,7 @@ gmime-utils </para> -@str: +@header: @Returns: diff --git a/docs/reference/tmpl/gmime.sgml b/docs/reference/tmpl/gmime.sgml index dbf4f2a..8701465 100644 --- a/docs/reference/tmpl/gmime.sgml +++ b/docs/reference/tmpl/gmime.sgml @@ -72,6 +72,13 @@ gmime +<!-- ##### MACRO GMIME_ENABLE_USE_ONLY_USER_CHARSETS ##### --> +<para> + +</para> + + + <!-- ##### FUNCTION g_mime_init ##### --> <para> diff --git a/docs/tutorial/Makefile.in b/docs/tutorial/Makefile.in index e8763f9..f41c987 100644 --- a/docs/tutorial/Makefile.in +++ b/docs/tutorial/Makefile.in @@ -1,4 +1,4 @@ -# Makefile.in generated by automake 1.11.3 from Makefile.am. +# Makefile.in generated by automake 1.11.6 from Makefile.am. # @configure_input@ # Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, @@ -15,6 +15,23 @@ @SET_MAKE@ VPATH = @srcdir@ +am__make_dryrun = \ + { \ + am__dry=no; \ + case $$MAKEFLAGS in \ + *\\[\ \ ]*) \ + echo 'am--echo: ; @echo "AM" OK' | $(MAKE) -f - 2>/dev/null \ + | grep '^AM OK$$' >/dev/null || am__dry=yes;; \ + *) \ + for am__flg in $$MAKEFLAGS; do \ + case $$am__flg in \ + *=*|--*) ;; \ + *n*) am__dry=yes; break;; \ + esac; \ + done;; \ + esac; \ + test $$am__dry = yes; \ + } pkgdatadir = $(datadir)/@PACKAGE@ pkgincludedir = $(includedir)/@PACKAGE@ pkglibdir = $(libdir)/@PACKAGE@ @@ -37,7 +54,11 @@ target_triplet = @target@ subdir = docs/tutorial DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 -am__aclocal_m4_deps = $(top_srcdir)/acinclude.m4 \ +am__aclocal_m4_deps = $(top_srcdir)/m4/gtk-doc.m4 \ + $(top_srcdir)/m4/introspection.m4 $(top_srcdir)/m4/libtool.m4 \ + $(top_srcdir)/m4/ltoptions.m4 $(top_srcdir)/m4/ltsugar.m4 \ + $(top_srcdir)/m4/ltversion.m4 $(top_srcdir)/m4/lt~obsolete.m4 \ + $(top_srcdir)/m4/vapigen.m4 $(top_srcdir)/acinclude.m4 \ $(top_srcdir)/configure.ac am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ $(ACLOCAL_M4) @@ -45,12 +66,24 @@ mkinstalldirs = $(install_sh) -d CONFIG_HEADER = $(top_builddir)/config.h CONFIG_CLEAN_FILES = CONFIG_CLEAN_VPATH_FILES = +AM_V_GEN = $(am__v_GEN_@AM_V@) +am__v_GEN_ = $(am__v_GEN_@AM_DEFAULT_V@) +am__v_GEN_0 = @echo " GEN " $@; +AM_V_at = $(am__v_at_@AM_V@) +am__v_at_ = $(am__v_at_@AM_DEFAULT_V@) +am__v_at_0 = @ SOURCES = DIST_SOURCES = +am__can_run_installinfo = \ + case $$AM_UPDATE_INFO_DIR in \ + n|no|NO) false;; \ + *) (install-info --version) >/dev/null 2>&1;; \ + esac DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) ACLOCAL = @ACLOCAL@ ACLOCAL_AMFLAGS = @ACLOCAL_AMFLAGS@ AMTAR = @AMTAR@ +AM_DEFAULT_VERBOSITY = @AM_DEFAULT_VERBOSITY@ API_VERSION = @API_VERSION@ AR = @AR@ AUTOCONF = @AUTOCONF@ @@ -118,6 +151,14 @@ INSTALL_DATA = @INSTALL_DATA@ INSTALL_PROGRAM = @INSTALL_PROGRAM@ INSTALL_SCRIPT = @INSTALL_SCRIPT@ INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ +INTROSPECTION_CFLAGS = @INTROSPECTION_CFLAGS@ +INTROSPECTION_COMPILER = @INTROSPECTION_COMPILER@ +INTROSPECTION_GENERATE = @INTROSPECTION_GENERATE@ +INTROSPECTION_GIRDIR = @INTROSPECTION_GIRDIR@ +INTROSPECTION_LIBS = @INTROSPECTION_LIBS@ +INTROSPECTION_MAKEFILE = @INTROSPECTION_MAKEFILE@ +INTROSPECTION_SCANNER = @INTROSPECTION_SCANNER@ +INTROSPECTION_TYPELIBDIR = @INTROSPECTION_TYPELIBDIR@ LD = @LD@ LDFLAGS = @LDFLAGS@ LIBICONV = @LIBICONV@ @@ -165,6 +206,9 @@ SET_MAKE = @SET_MAKE@ SHELL = @SHELL@ STRIP = @STRIP@ TAR = @TAR@ +VAPIGEN = @VAPIGEN@ +VAPIGEN_MAKEFILE = @VAPIGEN_MAKEFILE@ +VAPIGEN_VAPIDIR = @VAPIGEN_VAPIDIR@ VERSION = @VERSION@ WINDRES = @WINDRES@ abs_builddir = @abs_builddir@ |