diff options
Diffstat (limited to 'docs')
168 files changed, 36318 insertions, 0 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am new file mode 100644 index 0000000..5f75174 --- /dev/null +++ b/docs/Makefile.am @@ -0,0 +1,5 @@ +## Process this file with automake to produce Makefile.in + +SUBDIRS = reference tutorial + +EXTRA_DIST = gtkdocs_fix diff --git a/docs/Makefile.in b/docs/Makefile.in new file mode 100644 index 0000000..770bd07 --- /dev/null +++ b/docs/Makefile.in @@ -0,0 +1,624 @@ +# Makefile.in generated by automake 1.11.3 from Makefile.am. +# @configure_input@ + +# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, +# 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software +# Foundation, Inc. +# This Makefile.in is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY, to the extent permitted by law; without +# even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. + +@SET_MAKE@ +VPATH = @srcdir@ +pkgdatadir = $(datadir)/@PACKAGE@ +pkgincludedir = $(includedir)/@PACKAGE@ +pkglibdir = $(libdir)/@PACKAGE@ +pkglibexecdir = $(libexecdir)/@PACKAGE@ +am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd +install_sh_DATA = $(install_sh) -c -m 644 +install_sh_PROGRAM = $(install_sh) -c +install_sh_SCRIPT = $(install_sh) -c +INSTALL_HEADER = $(INSTALL_DATA) +transform = $(program_transform_name) +NORMAL_INSTALL = : +PRE_INSTALL = : +POST_INSTALL = : +NORMAL_UNINSTALL = : +PRE_UNINSTALL = : +POST_UNINSTALL = : +build_triplet = @build@ +host_triplet = @host@ +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 \ + $(top_srcdir)/configure.ac +am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ + $(ACLOCAL_M4) +mkinstalldirs = $(install_sh) -d +CONFIG_HEADER = $(top_builddir)/config.h +CONFIG_CLEAN_FILES = +CONFIG_CLEAN_VPATH_FILES = +SOURCES = +DIST_SOURCES = +RECURSIVE_TARGETS = all-recursive check-recursive dvi-recursive \ + html-recursive info-recursive install-data-recursive \ + install-dvi-recursive install-exec-recursive \ + install-html-recursive install-info-recursive \ + install-pdf-recursive install-ps-recursive install-recursive \ + installcheck-recursive installdirs-recursive pdf-recursive \ + ps-recursive uninstall-recursive +RECURSIVE_CLEAN_TARGETS = mostlyclean-recursive clean-recursive \ + distclean-recursive maintainer-clean-recursive +AM_RECURSIVE_TARGETS = $(RECURSIVE_TARGETS:-recursive=) \ + $(RECURSIVE_CLEAN_TARGETS:-recursive=) tags TAGS ctags CTAGS \ + distdir +ETAGS = etags +CTAGS = ctags +DIST_SUBDIRS = $(SUBDIRS) +DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) +am__relativize = \ + dir0=`pwd`; \ + sed_first='s,^\([^/]*\)/.*$$,\1,'; \ + sed_rest='s,^[^/]*/*,,'; \ + sed_last='s,^.*/\([^/]*\)$$,\1,'; \ + sed_butlast='s,/*[^/]*$$,,'; \ + while test -n "$$dir1"; do \ + first=`echo "$$dir1" | sed -e "$$sed_first"`; \ + if test "$$first" != "."; then \ + if test "$$first" = ".."; then \ + dir2=`echo "$$dir0" | sed -e "$$sed_last"`/"$$dir2"; \ + dir0=`echo "$$dir0" | sed -e "$$sed_butlast"`; \ + else \ + first2=`echo "$$dir2" | sed -e "$$sed_first"`; \ + if test "$$first2" = "$$first"; then \ + dir2=`echo "$$dir2" | sed -e "$$sed_rest"`; \ + else \ + dir2="../$$dir2"; \ + fi; \ + dir0="$$dir0"/"$$first"; \ + fi; \ + fi; \ + dir1=`echo "$$dir1" | sed -e "$$sed_rest"`; \ + done; \ + reldir="$$dir2" +ACLOCAL = @ACLOCAL@ +ACLOCAL_AMFLAGS = @ACLOCAL_AMFLAGS@ +AMTAR = @AMTAR@ +API_VERSION = @API_VERSION@ +AR = @AR@ +AUTOCONF = @AUTOCONF@ +AUTOHEADER = @AUTOHEADER@ +AUTOMAKE = @AUTOMAKE@ +AWK = @AWK@ +CC = @CC@ +CCDEPMODE = @CCDEPMODE@ +CFLAGS = @CFLAGS@ +CPP = @CPP@ +CPPFLAGS = @CPPFLAGS@ +CSC = @CSC@ +CYGPATH_W = @CYGPATH_W@ +DB2HTML = @DB2HTML@ +DEFS = @DEFS@ +DEPDIR = @DEPDIR@ +DLLTOOL = @DLLTOOL@ +DOLT_BASH = @DOLT_BASH@ +DSYMUTIL = @DSYMUTIL@ +DUMPBIN = @DUMPBIN@ +ECHO_C = @ECHO_C@ +ECHO_N = @ECHO_N@ +ECHO_T = @ECHO_T@ +EGREP = @EGREP@ +EXEEXT = @EXEEXT@ +FGREP = @FGREP@ +GACUTIL = @GACUTIL@ +GAPI_CODEGEN = @GAPI_CODEGEN@ +GAPI_FIXUP = @GAPI_FIXUP@ +GAPI_PARSER = @GAPI_PARSER@ +GAPI_TOOLS_CFLAGS = @GAPI_TOOLS_CFLAGS@ +GAPI_TOOLS_LIBS = @GAPI_TOOLS_LIBS@ +GLIB_CFLAGS = @GLIB_CFLAGS@ +GLIB_COMPILE_RESOURCES = @GLIB_COMPILE_RESOURCES@ +GLIB_GENMARSHAL = @GLIB_GENMARSHAL@ +GLIB_LIBS = @GLIB_LIBS@ +GLIB_MKENUMS = @GLIB_MKENUMS@ +GLIB_SHARP_CFLAGS = @GLIB_SHARP_CFLAGS@ +GLIB_SHARP_LIBS = @GLIB_SHARP_LIBS@ +GMIME_API_VERSION = @GMIME_API_VERSION@ +GMIME_BINARY_AGE = @GMIME_BINARY_AGE@ +GMIME_CFLAGS = @GMIME_CFLAGS@ +GMIME_INCLUDEDIR = @GMIME_INCLUDEDIR@ +GMIME_INTERFACE_AGE = @GMIME_INTERFACE_AGE@ +GMIME_LIBDIR = @GMIME_LIBDIR@ +GMIME_LIBS = @GMIME_LIBS@ +GMIME_LIBS_PRIVATE = @GMIME_LIBS_PRIVATE@ +GMIME_MAJOR_VERSION = @GMIME_MAJOR_VERSION@ +GMIME_MICRO_VERSION = @GMIME_MICRO_VERSION@ +GMIME_MINOR_VERSION = @GMIME_MINOR_VERSION@ +GMIME_VERSION = @GMIME_VERSION@ +GOBJECT_QUERY = @GOBJECT_QUERY@ +GPGME_CONFIG = @GPGME_CONFIG@ +GPGME_PTHREAD_CFLAGS = @GPGME_PTHREAD_CFLAGS@ +GPGME_PTHREAD_LIBS = @GPGME_PTHREAD_LIBS@ +GREP = @GREP@ +GTKDOC_CHECK = @GTKDOC_CHECK@ +GTKDOC_DEPS_CFLAGS = @GTKDOC_DEPS_CFLAGS@ +GTKDOC_DEPS_LIBS = @GTKDOC_DEPS_LIBS@ +GTKDOC_MKPDF = @GTKDOC_MKPDF@ +GTKDOC_REBASE = @GTKDOC_REBASE@ +HTML_DIR = @HTML_DIR@ +INSTALL = @INSTALL@ +INSTALL_DATA = @INSTALL_DATA@ +INSTALL_PROGRAM = @INSTALL_PROGRAM@ +INSTALL_SCRIPT = @INSTALL_SCRIPT@ +INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ +LD = @LD@ +LDFLAGS = @LDFLAGS@ +LIBICONV = @LIBICONV@ +LIBOBJS = @LIBOBJS@ +LIBS = @LIBS@ +LIBTOOL = @LIBTOOL@ +LIB_EXE_MACHINE_FLAG = @LIB_EXE_MACHINE_FLAG@ +LIPO = @LIPO@ +LN_S = @LN_S@ +LTCOMPILE = @LTCOMPILE@ +LTCXXCOMPILE = @LTCXXCOMPILE@ +LTLIBICONV = @LTLIBICONV@ +LTLIBOBJS = @LTLIBOBJS@ +LT_AGE = @LT_AGE@ +LT_CURRENT = @LT_CURRENT@ +LT_CURRENT_MINUS_AGE = @LT_CURRENT_MINUS_AGE@ +LT_RELEASE = @LT_RELEASE@ +LT_REVISION = @LT_REVISION@ +MAINT = @MAINT@ +MAKEINFO = @MAKEINFO@ +MANIFEST_TOOL = @MANIFEST_TOOL@ +MKDIR_P = @MKDIR_P@ +MV = @MV@ +NM = @NM@ +NMEDIT = @NMEDIT@ +OBJDUMP = @OBJDUMP@ +OBJEXT = @OBJEXT@ +OTOOL = @OTOOL@ +OTOOL64 = @OTOOL64@ +PACKAGE = @PACKAGE@ +PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ +PACKAGE_NAME = @PACKAGE_NAME@ +PACKAGE_STRING = @PACKAGE_STRING@ +PACKAGE_TARNAME = @PACKAGE_TARNAME@ +PACKAGE_URL = @PACKAGE_URL@ +PACKAGE_VERSION = @PACKAGE_VERSION@ +PATH_SEPARATOR = @PATH_SEPARATOR@ +PKG_CONFIG = @PKG_CONFIG@ +PKG_CONFIG_LIBDIR = @PKG_CONFIG_LIBDIR@ +PKG_CONFIG_PATH = @PKG_CONFIG_PATH@ +RANLIB = @RANLIB@ +RM = @RM@ +SED = @SED@ +SET_MAKE = @SET_MAKE@ +SHELL = @SHELL@ +STRIP = @STRIP@ +TAR = @TAR@ +VERSION = @VERSION@ +WINDRES = @WINDRES@ +abs_builddir = @abs_builddir@ +abs_srcdir = @abs_srcdir@ +abs_top_builddir = @abs_top_builddir@ +abs_top_srcdir = @abs_top_srcdir@ +ac_ct_AR = @ac_ct_AR@ +ac_ct_CC = @ac_ct_CC@ +ac_ct_DUMPBIN = @ac_ct_DUMPBIN@ +am__include = @am__include@ +am__leading_dot = @am__leading_dot@ +am__quote = @am__quote@ +am__tar = @am__tar@ +am__untar = @am__untar@ +bindir = @bindir@ +build = @build@ +build_alias = @build_alias@ +build_cpu = @build_cpu@ +build_os = @build_os@ +build_vendor = @build_vendor@ +builddir = @builddir@ +datadir = @datadir@ +datarootdir = @datarootdir@ +docdir = @docdir@ +dvidir = @dvidir@ +exec_prefix = @exec_prefix@ +gacdir = @gacdir@ +host = @host@ +host_alias = @host_alias@ +host_cpu = @host_cpu@ +host_os = @host_os@ +host_vendor = @host_vendor@ +htmldir = @htmldir@ +includedir = @includedir@ +infodir = @infodir@ +install_sh = @install_sh@ +libdir = @libdir@ +libexecdir = @libexecdir@ +localedir = @localedir@ +localstatedir = @localstatedir@ +mandir = @mandir@ +mkdir_p = @mkdir_p@ +ms_librarian = @ms_librarian@ +oldincludedir = @oldincludedir@ +pdfdir = @pdfdir@ +prefix = @prefix@ +program_transform_name = @program_transform_name@ +psdir = @psdir@ +sbindir = @sbindir@ +sharedstatedir = @sharedstatedir@ +srcdir = @srcdir@ +sysconfdir = @sysconfdir@ +target = @target@ +target_alias = @target_alias@ +target_cpu = @target_cpu@ +target_os = @target_os@ +target_vendor = @target_vendor@ +top_build_prefix = @top_build_prefix@ +top_builddir = @top_builddir@ +top_srcdir = @top_srcdir@ +SUBDIRS = reference tutorial +EXTRA_DIST = gtkdocs_fix +all: all-recursive + +.SUFFIXES: +$(srcdir)/Makefile.in: @MAINTAINER_MODE_TRUE@ $(srcdir)/Makefile.am $(am__configure_deps) + @for dep in $?; do \ + case '$(am__configure_deps)' in \ + *$$dep*) \ + ( cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh ) \ + && { if test -f $@; then exit 0; else break; fi; }; \ + exit 1;; \ + esac; \ + done; \ + echo ' cd $(top_srcdir) && $(AUTOMAKE) --foreign docs/Makefile'; \ + $(am__cd) $(top_srcdir) && \ + $(AUTOMAKE) --foreign docs/Makefile +.PRECIOUS: Makefile +Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status + @case '$?' in \ + *config.status*) \ + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh;; \ + *) \ + echo ' cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe)'; \ + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe);; \ + esac; + +$(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh + +$(top_srcdir)/configure: @MAINTAINER_MODE_TRUE@ $(am__configure_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(ACLOCAL_M4): @MAINTAINER_MODE_TRUE@ $(am__aclocal_m4_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(am__aclocal_m4_deps): + +mostlyclean-libtool: + -rm -f *.lo + +clean-libtool: + -rm -rf .libs _libs + +# This directory's subdirectories are mostly independent; you can cd +# into them and run `make' without going through this Makefile. +# To change the values of `make' variables: instead of editing Makefiles, +# (1) if the variable is set in `config.status', edit `config.status' +# (which will cause the Makefiles to be regenerated when you run `make'); +# (2) otherwise, pass the desired values on the `make' command line. +$(RECURSIVE_TARGETS): + @fail= failcom='exit 1'; \ + for f in x $$MAKEFLAGS; do \ + case $$f in \ + *=* | --[!k]*);; \ + *k*) failcom='fail=yes';; \ + esac; \ + done; \ + dot_seen=no; \ + target=`echo $@ | sed s/-recursive//`; \ + list='$(SUBDIRS)'; for subdir in $$list; do \ + echo "Making $$target in $$subdir"; \ + if test "$$subdir" = "."; then \ + dot_seen=yes; \ + local_target="$$target-am"; \ + else \ + local_target="$$target"; \ + fi; \ + ($(am__cd) $$subdir && $(MAKE) $(AM_MAKEFLAGS) $$local_target) \ + || eval $$failcom; \ + done; \ + if test "$$dot_seen" = "no"; then \ + $(MAKE) $(AM_MAKEFLAGS) "$$target-am" || exit 1; \ + fi; test -z "$$fail" + +$(RECURSIVE_CLEAN_TARGETS): + @fail= failcom='exit 1'; \ + for f in x $$MAKEFLAGS; do \ + case $$f in \ + *=* | --[!k]*);; \ + *k*) failcom='fail=yes';; \ + esac; \ + done; \ + dot_seen=no; \ + case "$@" in \ + distclean-* | maintainer-clean-*) list='$(DIST_SUBDIRS)' ;; \ + *) list='$(SUBDIRS)' ;; \ + esac; \ + rev=''; for subdir in $$list; do \ + if test "$$subdir" = "."; then :; else \ + rev="$$subdir $$rev"; \ + fi; \ + done; \ + rev="$$rev ."; \ + target=`echo $@ | sed s/-recursive//`; \ + for subdir in $$rev; do \ + echo "Making $$target in $$subdir"; \ + if test "$$subdir" = "."; then \ + local_target="$$target-am"; \ + else \ + local_target="$$target"; \ + fi; \ + ($(am__cd) $$subdir && $(MAKE) $(AM_MAKEFLAGS) $$local_target) \ + || eval $$failcom; \ + done && test -z "$$fail" +tags-recursive: + list='$(SUBDIRS)'; for subdir in $$list; do \ + test "$$subdir" = . || ($(am__cd) $$subdir && $(MAKE) $(AM_MAKEFLAGS) tags); \ + done +ctags-recursive: + list='$(SUBDIRS)'; for subdir in $$list; do \ + test "$$subdir" = . || ($(am__cd) $$subdir && $(MAKE) $(AM_MAKEFLAGS) ctags); \ + done + +ID: $(HEADERS) $(SOURCES) $(LISP) $(TAGS_FILES) + list='$(SOURCES) $(HEADERS) $(LISP) $(TAGS_FILES)'; \ + unique=`for i in $$list; do \ + if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \ + done | \ + $(AWK) '{ files[$$0] = 1; nonempty = 1; } \ + END { if (nonempty) { for (i in files) print i; }; }'`; \ + mkid -fID $$unique +tags: TAGS + +TAGS: tags-recursive $(HEADERS) $(SOURCES) $(TAGS_DEPENDENCIES) \ + $(TAGS_FILES) $(LISP) + set x; \ + here=`pwd`; \ + if ($(ETAGS) --etags-include --version) >/dev/null 2>&1; then \ + include_option=--etags-include; \ + empty_fix=.; \ + else \ + include_option=--include; \ + empty_fix=; \ + fi; \ + list='$(SUBDIRS)'; for subdir in $$list; do \ + if test "$$subdir" = .; then :; else \ + test ! -f $$subdir/TAGS || \ + set "$$@" "$$include_option=$$here/$$subdir/TAGS"; \ + fi; \ + done; \ + list='$(SOURCES) $(HEADERS) $(LISP) $(TAGS_FILES)'; \ + unique=`for i in $$list; do \ + if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \ + done | \ + $(AWK) '{ files[$$0] = 1; nonempty = 1; } \ + END { if (nonempty) { for (i in files) print i; }; }'`; \ + shift; \ + if test -z "$(ETAGS_ARGS)$$*$$unique"; then :; else \ + test -n "$$unique" || unique=$$empty_fix; \ + if test $$# -gt 0; then \ + $(ETAGS) $(ETAGSFLAGS) $(AM_ETAGSFLAGS) $(ETAGS_ARGS) \ + "$$@" $$unique; \ + else \ + $(ETAGS) $(ETAGSFLAGS) $(AM_ETAGSFLAGS) $(ETAGS_ARGS) \ + $$unique; \ + fi; \ + fi +ctags: CTAGS +CTAGS: ctags-recursive $(HEADERS) $(SOURCES) $(TAGS_DEPENDENCIES) \ + $(TAGS_FILES) $(LISP) + list='$(SOURCES) $(HEADERS) $(LISP) $(TAGS_FILES)'; \ + unique=`for i in $$list; do \ + if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \ + done | \ + $(AWK) '{ files[$$0] = 1; nonempty = 1; } \ + END { if (nonempty) { for (i in files) print i; }; }'`; \ + test -z "$(CTAGS_ARGS)$$unique" \ + || $(CTAGS) $(CTAGSFLAGS) $(AM_CTAGSFLAGS) $(CTAGS_ARGS) \ + $$unique + +GTAGS: + here=`$(am__cd) $(top_builddir) && pwd` \ + && $(am__cd) $(top_srcdir) \ + && gtags -i $(GTAGS_ARGS) "$$here" + +distclean-tags: + -rm -f TAGS ID GTAGS GRTAGS GSYMS GPATH tags + +distdir: $(DISTFILES) + @srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + topsrcdirstrip=`echo "$(top_srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + list='$(DISTFILES)'; \ + dist_files=`for file in $$list; do echo $$file; done | \ + sed -e "s|^$$srcdirstrip/||;t" \ + -e "s|^$$topsrcdirstrip/|$(top_builddir)/|;t"`; \ + case $$dist_files in \ + */*) $(MKDIR_P) `echo "$$dist_files" | \ + sed '/\//!d;s|^|$(distdir)/|;s,/[^/]*$$,,' | \ + sort -u` ;; \ + esac; \ + for file in $$dist_files; do \ + if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \ + if test -d $$d/$$file; then \ + dir=`echo "/$$file" | sed -e 's,/[^/]*$$,,'`; \ + if test -d "$(distdir)/$$file"; then \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \ + cp -fpR $(srcdir)/$$file "$(distdir)$$dir" || exit 1; \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + cp -fpR $$d/$$file "$(distdir)$$dir" || exit 1; \ + else \ + test -f "$(distdir)/$$file" \ + || cp -p $$d/$$file "$(distdir)/$$file" \ + || exit 1; \ + fi; \ + 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 \ + dir1=$$subdir; dir2="$(distdir)/$$subdir"; \ + $(am__relativize); \ + new_distdir=$$reldir; \ + dir1=$$subdir; dir2="$(top_distdir)"; \ + $(am__relativize); \ + new_top_distdir=$$reldir; \ + echo " (cd $$subdir && $(MAKE) $(AM_MAKEFLAGS) top_distdir="$$new_top_distdir" distdir="$$new_distdir" \\"; \ + echo " am__remove_distdir=: am__skip_length_check=: am__skip_mode_fix=: distdir)"; \ + ($(am__cd) $$subdir && \ + $(MAKE) $(AM_MAKEFLAGS) \ + top_distdir="$$new_top_distdir" \ + distdir="$$new_distdir" \ + am__remove_distdir=: \ + am__skip_length_check=: \ + am__skip_mode_fix=: \ + distdir) \ + || exit 1; \ + fi; \ + done +check-am: all-am +check: check-recursive +all-am: Makefile +installdirs: installdirs-recursive +installdirs-am: +install: install-recursive +install-exec: install-exec-recursive +install-data: install-data-recursive +uninstall: uninstall-recursive + +install-am: all-am + @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am + +installcheck: installcheck-recursive +install-strip: + if test -z '$(STRIP)'; then \ + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + install; \ + else \ + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'" install; \ + fi +mostlyclean-generic: + +clean-generic: + +distclean-generic: + -test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES) + -test . = "$(srcdir)" || test -z "$(CONFIG_CLEAN_VPATH_FILES)" || rm -f $(CONFIG_CLEAN_VPATH_FILES) + +maintainer-clean-generic: + @echo "This command is intended for maintainers to use" + @echo "it deletes files that may require special tools to rebuild." +clean: clean-recursive + +clean-am: clean-generic clean-libtool mostlyclean-am + +distclean: distclean-recursive + -rm -f Makefile +distclean-am: clean-am distclean-generic distclean-tags + +dvi: dvi-recursive + +dvi-am: + +html: html-recursive + +html-am: + +info: info-recursive + +info-am: + +install-data-am: + +install-dvi: install-dvi-recursive + +install-dvi-am: + +install-exec-am: + +install-html: install-html-recursive + +install-html-am: + +install-info: install-info-recursive + +install-info-am: + +install-man: + +install-pdf: install-pdf-recursive + +install-pdf-am: + +install-ps: install-ps-recursive + +install-ps-am: + +installcheck-am: + +maintainer-clean: maintainer-clean-recursive + -rm -f Makefile +maintainer-clean-am: distclean-am maintainer-clean-generic + +mostlyclean: mostlyclean-recursive + +mostlyclean-am: mostlyclean-generic mostlyclean-libtool + +pdf: pdf-recursive + +pdf-am: + +ps: ps-recursive + +ps-am: + +uninstall-am: + +.MAKE: $(RECURSIVE_CLEAN_TARGETS) $(RECURSIVE_TARGETS) ctags-recursive \ + install-am install-strip tags-recursive + +.PHONY: $(RECURSIVE_CLEAN_TARGETS) $(RECURSIVE_TARGETS) CTAGS GTAGS \ + all all-am check check-am clean clean-generic clean-libtool \ + ctags ctags-recursive distclean distclean-generic \ + distclean-libtool distclean-tags distdir dvi dvi-am html \ + html-am info info-am install install-am install-data \ + install-data-am install-dvi install-dvi-am install-exec \ + install-exec-am install-html install-html-am install-info \ + install-info-am install-man install-pdf install-pdf-am \ + install-ps install-ps-am install-strip installcheck \ + installcheck-am installdirs installdirs-am maintainer-clean \ + maintainer-clean-generic mostlyclean mostlyclean-generic \ + mostlyclean-libtool pdf pdf-am ps ps-am tags tags-recursive \ + uninstall uninstall-am + + +# Tell versions [3.59,3.63) of GNU make to not export all variables. +# Otherwise a system limit (for SysV at least) may be exceeded. +.NOEXPORT: diff --git a/docs/gtkdocs_fix b/docs/gtkdocs_fix new file mode 100755 index 0000000..d13daa6 --- /dev/null +++ b/docs/gtkdocs_fix @@ -0,0 +1,11 @@ +#!/usr/bin/perl + +# Stupid script to fix look of html files created with sgml2html... + +foreach (@ARGV) { + print "Fixing... $_\n"; + system("mv $_ $_.orig"); + system("sed -e 's/<BODY>/<BODY BGCOLOR=\"#FFFFFF\">/g' -e 's/<HR>/<HR NOSHADE>/g' $_.orig > $_"); + unlink("$_.orig"); +} + diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am new file mode 100644 index 0000000..2d7e0c4 --- /dev/null +++ b/docs/reference/Makefile.am @@ -0,0 +1,83 @@ +## Process this file with automake to produce Makefile.in + +# The name of the module. +DOC_MODULE_VERSION = $(GMIME_MAJOR_VERSION).$(GMIME_MINOR_VERSION) +DOC_MODULE = gmime + +# The top-level SGML file. +DOC_MAIN_SGML_FILE = gmime-docs.sgml + +# The directory containing the source code (if it contains documentation). +DOC_SOURCE_DIR = $(top_srcdir)/gmime + +HTML_DIR = $(datadir)/gtk-doc/html + +# Images to copy into HTML directory +HTML_IMAGES = + +# Extra options to supply to gtkdoc-scan +SCAN_OPTIONS = --deprecated-guards="GMIME_DISABLE_DEPRECATED" + +# Extra options to pass to gtkdoc-scangobj +SCANGOBJ_OPTIONS=--type-init-func="g_mime_init (0)" + +# Extra options to supply to gtkdoc-mkdb +MKDB_OPTIONS = --sgml-mode --output-format=xml --ignore-files=trio + +# CFLAGS and LDFLAGS for compiling scan program. Only needed +# if $(DOC_MODULE).types is non-empty. +INCLUDES = \ + -I$(top_srcdir) \ + -I$(top_builddir) \ + -I$(top_builddir)/gmime \ + $(GLIB_CFLAGS) + +GTKDOC_LIBS = \ + $(top_builddir)/util/libgmime-util.la \ + $(top_builddir)/gmime/libgmime-$(GMIME_API_VERSION).la \ + $(GLIB_LIBS) + +# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE) +content_files = \ + building.sgml \ + changes-2.0.sgml \ + changes-2.2.sgml \ + changes-2.4.sgml \ + changes-2.6.sgml \ + compiling.sgml \ + data-wrappers.sgml \ + filters.sgml \ + question_index.sgml \ + resources.sgml \ + streams.sgml \ + tree_index.sgml + +# Used for dependencies +HFILE_GLOB=$(top_srcdir)/gmime/*.h +CFILE_GLOB=$(top_srcdir)/gmime/*.c + +# Header files to ignore when scanning +IGNORE_HFILES = \ + gmime-charset-map-private.h \ + gmime-table-private.h \ + gmime-parse-utils.h \ + gmime-common.h \ + gmime-events.h + +# Extra options to supply to gtkdoc-fixref +FIXXREF_OPTIONS = + +include $(top_srcdir)/gtk-doc.make + +# Other files to distribute +EXTRA_DIST += \ + $(DOC_MODULE)-docs.sgml \ + gmime.hierarchy + +BUILT_EXTRA_DIST = + +dist-hook-local: $(BUILT_EXTRA_DIST) + files='$(BUILT_EXTRA_DIST)'; \ + for f in $$files; do \ + if test -f $$f; then d=.; else d=$(srcdir); fi; \ + cp $$d/$$f $(distdir) || exit 1; done diff --git a/docs/reference/Makefile.in b/docs/reference/Makefile.in new file mode 100644 index 0000000..c50a170 --- /dev/null +++ b/docs/reference/Makefile.in @@ -0,0 +1,767 @@ +# Makefile.in generated by automake 1.11.3 from Makefile.am. +# @configure_input@ + +# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, +# 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software +# Foundation, Inc. +# This Makefile.in is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY, to the extent permitted by law; without +# even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. + +@SET_MAKE@ + +# -*- mode: makefile -*- + +#################################### +# Everything below here is generic # +#################################### +VPATH = @srcdir@ +pkgdatadir = $(datadir)/@PACKAGE@ +pkgincludedir = $(includedir)/@PACKAGE@ +pkglibdir = $(libdir)/@PACKAGE@ +pkglibexecdir = $(libexecdir)/@PACKAGE@ +am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd +install_sh_DATA = $(install_sh) -c -m 644 +install_sh_PROGRAM = $(install_sh) -c +install_sh_SCRIPT = $(install_sh) -c +INSTALL_HEADER = $(INSTALL_DATA) +transform = $(program_transform_name) +NORMAL_INSTALL = : +PRE_INSTALL = : +POST_INSTALL = : +NORMAL_UNINSTALL = : +PRE_UNINSTALL = : +POST_UNINSTALL = : +build_triplet = @build@ +host_triplet = @host@ +target_triplet = @target@ +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 \ + $(top_srcdir)/configure.ac +am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ + $(ACLOCAL_M4) +mkinstalldirs = $(install_sh) -d +CONFIG_HEADER = $(top_builddir)/config.h +CONFIG_CLEAN_FILES = +CONFIG_CLEAN_VPATH_FILES = +SOURCES = +DIST_SOURCES = +DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) +ACLOCAL = @ACLOCAL@ +ACLOCAL_AMFLAGS = @ACLOCAL_AMFLAGS@ +AMTAR = @AMTAR@ +API_VERSION = @API_VERSION@ +AR = @AR@ +AUTOCONF = @AUTOCONF@ +AUTOHEADER = @AUTOHEADER@ +AUTOMAKE = @AUTOMAKE@ +AWK = @AWK@ +CC = @CC@ +CCDEPMODE = @CCDEPMODE@ +CFLAGS = @CFLAGS@ +CPP = @CPP@ +CPPFLAGS = @CPPFLAGS@ +CSC = @CSC@ +CYGPATH_W = @CYGPATH_W@ +DB2HTML = @DB2HTML@ +DEFS = @DEFS@ +DEPDIR = @DEPDIR@ +DLLTOOL = @DLLTOOL@ +DOLT_BASH = @DOLT_BASH@ +DSYMUTIL = @DSYMUTIL@ +DUMPBIN = @DUMPBIN@ +ECHO_C = @ECHO_C@ +ECHO_N = @ECHO_N@ +ECHO_T = @ECHO_T@ +EGREP = @EGREP@ +EXEEXT = @EXEEXT@ +FGREP = @FGREP@ +GACUTIL = @GACUTIL@ +GAPI_CODEGEN = @GAPI_CODEGEN@ +GAPI_FIXUP = @GAPI_FIXUP@ +GAPI_PARSER = @GAPI_PARSER@ +GAPI_TOOLS_CFLAGS = @GAPI_TOOLS_CFLAGS@ +GAPI_TOOLS_LIBS = @GAPI_TOOLS_LIBS@ +GLIB_CFLAGS = @GLIB_CFLAGS@ +GLIB_COMPILE_RESOURCES = @GLIB_COMPILE_RESOURCES@ +GLIB_GENMARSHAL = @GLIB_GENMARSHAL@ +GLIB_LIBS = @GLIB_LIBS@ +GLIB_MKENUMS = @GLIB_MKENUMS@ +GLIB_SHARP_CFLAGS = @GLIB_SHARP_CFLAGS@ +GLIB_SHARP_LIBS = @GLIB_SHARP_LIBS@ +GMIME_API_VERSION = @GMIME_API_VERSION@ +GMIME_BINARY_AGE = @GMIME_BINARY_AGE@ +GMIME_CFLAGS = @GMIME_CFLAGS@ +GMIME_INCLUDEDIR = @GMIME_INCLUDEDIR@ +GMIME_INTERFACE_AGE = @GMIME_INTERFACE_AGE@ +GMIME_LIBDIR = @GMIME_LIBDIR@ +GMIME_LIBS = @GMIME_LIBS@ +GMIME_LIBS_PRIVATE = @GMIME_LIBS_PRIVATE@ +GMIME_MAJOR_VERSION = @GMIME_MAJOR_VERSION@ +GMIME_MICRO_VERSION = @GMIME_MICRO_VERSION@ +GMIME_MINOR_VERSION = @GMIME_MINOR_VERSION@ +GMIME_VERSION = @GMIME_VERSION@ +GOBJECT_QUERY = @GOBJECT_QUERY@ +GPGME_CONFIG = @GPGME_CONFIG@ +GPGME_PTHREAD_CFLAGS = @GPGME_PTHREAD_CFLAGS@ +GPGME_PTHREAD_LIBS = @GPGME_PTHREAD_LIBS@ +GREP = @GREP@ +GTKDOC_CHECK = @GTKDOC_CHECK@ +GTKDOC_DEPS_CFLAGS = @GTKDOC_DEPS_CFLAGS@ +GTKDOC_DEPS_LIBS = @GTKDOC_DEPS_LIBS@ +GTKDOC_MKPDF = @GTKDOC_MKPDF@ +GTKDOC_REBASE = @GTKDOC_REBASE@ +HTML_DIR = $(datadir)/gtk-doc/html +INSTALL = @INSTALL@ +INSTALL_DATA = @INSTALL_DATA@ +INSTALL_PROGRAM = @INSTALL_PROGRAM@ +INSTALL_SCRIPT = @INSTALL_SCRIPT@ +INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ +LD = @LD@ +LDFLAGS = @LDFLAGS@ +LIBICONV = @LIBICONV@ +LIBOBJS = @LIBOBJS@ +LIBS = @LIBS@ +LIBTOOL = @LIBTOOL@ +LIB_EXE_MACHINE_FLAG = @LIB_EXE_MACHINE_FLAG@ +LIPO = @LIPO@ +LN_S = @LN_S@ +LTCOMPILE = @LTCOMPILE@ +LTCXXCOMPILE = @LTCXXCOMPILE@ +LTLIBICONV = @LTLIBICONV@ +LTLIBOBJS = @LTLIBOBJS@ +LT_AGE = @LT_AGE@ +LT_CURRENT = @LT_CURRENT@ +LT_CURRENT_MINUS_AGE = @LT_CURRENT_MINUS_AGE@ +LT_RELEASE = @LT_RELEASE@ +LT_REVISION = @LT_REVISION@ +MAINT = @MAINT@ +MAKEINFO = @MAKEINFO@ +MANIFEST_TOOL = @MANIFEST_TOOL@ +MKDIR_P = @MKDIR_P@ +MV = @MV@ +NM = @NM@ +NMEDIT = @NMEDIT@ +OBJDUMP = @OBJDUMP@ +OBJEXT = @OBJEXT@ +OTOOL = @OTOOL@ +OTOOL64 = @OTOOL64@ +PACKAGE = @PACKAGE@ +PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ +PACKAGE_NAME = @PACKAGE_NAME@ +PACKAGE_STRING = @PACKAGE_STRING@ +PACKAGE_TARNAME = @PACKAGE_TARNAME@ +PACKAGE_URL = @PACKAGE_URL@ +PACKAGE_VERSION = @PACKAGE_VERSION@ +PATH_SEPARATOR = @PATH_SEPARATOR@ +PKG_CONFIG = @PKG_CONFIG@ +PKG_CONFIG_LIBDIR = @PKG_CONFIG_LIBDIR@ +PKG_CONFIG_PATH = @PKG_CONFIG_PATH@ +RANLIB = @RANLIB@ +RM = @RM@ +SED = @SED@ +SET_MAKE = @SET_MAKE@ +SHELL = @SHELL@ +STRIP = @STRIP@ +TAR = @TAR@ +VERSION = @VERSION@ +WINDRES = @WINDRES@ +abs_builddir = @abs_builddir@ +abs_srcdir = @abs_srcdir@ +abs_top_builddir = @abs_top_builddir@ +abs_top_srcdir = @abs_top_srcdir@ +ac_ct_AR = @ac_ct_AR@ +ac_ct_CC = @ac_ct_CC@ +ac_ct_DUMPBIN = @ac_ct_DUMPBIN@ +am__include = @am__include@ +am__leading_dot = @am__leading_dot@ +am__quote = @am__quote@ +am__tar = @am__tar@ +am__untar = @am__untar@ +bindir = @bindir@ +build = @build@ +build_alias = @build_alias@ +build_cpu = @build_cpu@ +build_os = @build_os@ +build_vendor = @build_vendor@ +builddir = @builddir@ +datadir = @datadir@ +datarootdir = @datarootdir@ +docdir = @docdir@ +dvidir = @dvidir@ +exec_prefix = @exec_prefix@ +gacdir = @gacdir@ +host = @host@ +host_alias = @host_alias@ +host_cpu = @host_cpu@ +host_os = @host_os@ +host_vendor = @host_vendor@ +htmldir = @htmldir@ +includedir = @includedir@ +infodir = @infodir@ +install_sh = @install_sh@ +libdir = @libdir@ +libexecdir = @libexecdir@ +localedir = @localedir@ +localstatedir = @localstatedir@ +mandir = @mandir@ +mkdir_p = @mkdir_p@ +ms_librarian = @ms_librarian@ +oldincludedir = @oldincludedir@ +pdfdir = @pdfdir@ +prefix = @prefix@ +program_transform_name = @program_transform_name@ +psdir = @psdir@ +sbindir = @sbindir@ +sharedstatedir = @sharedstatedir@ +srcdir = @srcdir@ +sysconfdir = @sysconfdir@ +target = @target@ +target_alias = @target_alias@ +target_cpu = @target_cpu@ +target_os = @target_os@ +target_vendor = @target_vendor@ +top_build_prefix = @top_build_prefix@ +top_builddir = @top_builddir@ +top_srcdir = @top_srcdir@ + +# The name of the module. +DOC_MODULE_VERSION = $(GMIME_MAJOR_VERSION).$(GMIME_MINOR_VERSION) +DOC_MODULE = gmime + +# The top-level SGML file. +DOC_MAIN_SGML_FILE = gmime-docs.sgml + +# The directory containing the source code (if it contains documentation). +DOC_SOURCE_DIR = $(top_srcdir)/gmime + +# Images to copy into HTML directory +HTML_IMAGES = + +# Extra options to supply to gtkdoc-scan +SCAN_OPTIONS = --deprecated-guards="GMIME_DISABLE_DEPRECATED" + +# Extra options to pass to gtkdoc-scangobj +SCANGOBJ_OPTIONS = --type-init-func="g_mime_init (0)" + +# Extra options to supply to gtkdoc-mkdb +MKDB_OPTIONS = --sgml-mode --output-format=xml --ignore-files=trio + +# CFLAGS and LDFLAGS for compiling scan program. Only needed +# if $(DOC_MODULE).types is non-empty. +INCLUDES = \ + -I$(top_srcdir) \ + -I$(top_builddir) \ + -I$(top_builddir)/gmime \ + $(GLIB_CFLAGS) + +GTKDOC_LIBS = \ + $(top_builddir)/util/libgmime-util.la \ + $(top_builddir)/gmime/libgmime-$(GMIME_API_VERSION).la \ + $(GLIB_LIBS) + + +# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE) +content_files = \ + building.sgml \ + changes-2.0.sgml \ + changes-2.2.sgml \ + changes-2.4.sgml \ + changes-2.6.sgml \ + compiling.sgml \ + data-wrappers.sgml \ + filters.sgml \ + question_index.sgml \ + resources.sgml \ + streams.sgml \ + tree_index.sgml + + +# Used for dependencies +HFILE_GLOB = $(top_srcdir)/gmime/*.h +CFILE_GLOB = $(top_srcdir)/gmime/*.c + +# Header files to ignore when scanning +IGNORE_HFILES = \ + gmime-charset-map-private.h \ + gmime-table-private.h \ + gmime-parse-utils.h \ + gmime-common.h \ + gmime-events.h + + +# Extra options to supply to gtkdoc-fixref +FIXXREF_OPTIONS = +@GTK_DOC_USE_LIBTOOL_FALSE@GTKDOC_CC = $(CC) $(INCLUDES) $(GTKDOC_DEPS_CFLAGS) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS) +@GTK_DOC_USE_LIBTOOL_TRUE@GTKDOC_CC = $(LIBTOOL) --tag=CC --mode=compile $(CC) $(INCLUDES) $(GTKDOC_DEPS_CFLAGS) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS) +@GTK_DOC_USE_LIBTOOL_FALSE@GTKDOC_LD = $(CC) $(GTKDOC_DEPS_LIBS) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS) +@GTK_DOC_USE_LIBTOOL_TRUE@GTKDOC_LD = $(LIBTOOL) --tag=CC --mode=link $(CC) $(GTKDOC_DEPS_LIBS) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS) +@GTK_DOC_USE_LIBTOOL_FALSE@GTKDOC_RUN = +@GTK_DOC_USE_LIBTOOL_TRUE@GTKDOC_RUN = $(LIBTOOL) --mode=execute + +# We set GPATH here; this gives us semantics for GNU make +# which are more like other make's VPATH, when it comes to +# whether a source that is a target of one rule is then +# searched for in VPATH/GPATH. +# +GPATH = $(srcdir) +TARGET_DIR = $(HTML_DIR)/$(DOC_MODULE) +SETUP_FILES = \ + $(content_files) \ + $(DOC_MAIN_SGML_FILE) \ + $(DOC_MODULE)-sections.txt \ + $(DOC_MODULE)-overrides.txt + + +# Other files to distribute +EXTRA_DIST = $(HTML_IMAGES) $(SETUP_FILES) $(DOC_MODULE)-docs.sgml \ + gmime.hierarchy +DOC_STAMPS = setup-build.stamp scan-build.stamp tmpl-build.stamp sgml-build.stamp \ + html-build.stamp pdf-build.stamp \ + tmpl.stamp sgml.stamp html.stamp pdf.stamp + +SCANOBJ_FILES = \ + $(DOC_MODULE).args \ + $(DOC_MODULE).hierarchy \ + $(DOC_MODULE).interfaces \ + $(DOC_MODULE).prerequisites \ + $(DOC_MODULE).signals + +REPORT_FILES = \ + $(DOC_MODULE)-undocumented.txt \ + $(DOC_MODULE)-undeclared.txt \ + $(DOC_MODULE)-unused.txt + +CLEANFILES = $(SCANOBJ_FILES) $(REPORT_FILES) $(DOC_STAMPS) +@ENABLE_GTK_DOC_TRUE@@GTK_DOC_BUILD_HTML_FALSE@HTML_BUILD_STAMP = +@ENABLE_GTK_DOC_TRUE@@GTK_DOC_BUILD_HTML_TRUE@HTML_BUILD_STAMP = html-build.stamp +@ENABLE_GTK_DOC_TRUE@@GTK_DOC_BUILD_PDF_FALSE@PDF_BUILD_STAMP = +@ENABLE_GTK_DOC_TRUE@@GTK_DOC_BUILD_PDF_TRUE@PDF_BUILD_STAMP = pdf-build.stamp +BUILT_EXTRA_DIST = +all: all-am + +.SUFFIXES: +$(srcdir)/Makefile.in: @MAINTAINER_MODE_TRUE@ $(srcdir)/Makefile.am $(top_srcdir)/gtk-doc.make $(am__configure_deps) + @for dep in $?; do \ + case '$(am__configure_deps)' in \ + *$$dep*) \ + ( cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh ) \ + && { if test -f $@; then exit 0; else break; fi; }; \ + exit 1;; \ + esac; \ + done; \ + echo ' cd $(top_srcdir) && $(AUTOMAKE) --foreign docs/reference/Makefile'; \ + $(am__cd) $(top_srcdir) && \ + $(AUTOMAKE) --foreign docs/reference/Makefile +.PRECIOUS: Makefile +Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status + @case '$?' in \ + *config.status*) \ + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh;; \ + *) \ + echo ' cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe)'; \ + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe);; \ + esac; +$(top_srcdir)/gtk-doc.make: + +$(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh + +$(top_srcdir)/configure: @MAINTAINER_MODE_TRUE@ $(am__configure_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(ACLOCAL_M4): @MAINTAINER_MODE_TRUE@ $(am__aclocal_m4_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(am__aclocal_m4_deps): + +mostlyclean-libtool: + -rm -f *.lo + +clean-libtool: + -rm -rf .libs _libs +tags: TAGS +TAGS: + +ctags: CTAGS +CTAGS: + + +distdir: $(DISTFILES) + @srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + topsrcdirstrip=`echo "$(top_srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + list='$(DISTFILES)'; \ + dist_files=`for file in $$list; do echo $$file; done | \ + sed -e "s|^$$srcdirstrip/||;t" \ + -e "s|^$$topsrcdirstrip/|$(top_builddir)/|;t"`; \ + case $$dist_files in \ + */*) $(MKDIR_P) `echo "$$dist_files" | \ + sed '/\//!d;s|^|$(distdir)/|;s,/[^/]*$$,,' | \ + sort -u` ;; \ + esac; \ + for file in $$dist_files; do \ + if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \ + if test -d $$d/$$file; then \ + dir=`echo "/$$file" | sed -e 's,/[^/]*$$,,'`; \ + if test -d "$(distdir)/$$file"; then \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \ + cp -fpR $(srcdir)/$$file "$(distdir)$$dir" || exit 1; \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + cp -fpR $$d/$$file "$(distdir)$$dir" || exit 1; \ + else \ + test -f "$(distdir)/$$file" \ + || cp -p $$d/$$file "$(distdir)/$$file" \ + || exit 1; \ + fi; \ + done + $(MAKE) $(AM_MAKEFLAGS) \ + top_distdir="$(top_distdir)" distdir="$(distdir)" \ + dist-hook +check-am: all-am +check: check-am +all-am: Makefile all-local +installdirs: +install: install-am +install-exec: install-exec-am +install-data: install-data-am +uninstall: uninstall-am + +install-am: all-am + @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am + +installcheck: installcheck-am +install-strip: + if test -z '$(STRIP)'; then \ + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + install; \ + else \ + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'" install; \ + fi +mostlyclean-generic: + +clean-generic: + -test -z "$(CLEANFILES)" || rm -f $(CLEANFILES) + +distclean-generic: + -test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES) + -test . = "$(srcdir)" || test -z "$(CONFIG_CLEAN_VPATH_FILES)" || rm -f $(CONFIG_CLEAN_VPATH_FILES) + +maintainer-clean-generic: + @echo "This command is intended for maintainers to use" + @echo "it deletes files that may require special tools to rebuild." +clean: clean-am + +clean-am: clean-generic clean-libtool clean-local mostlyclean-am + +distclean: distclean-am + -rm -f Makefile +distclean-am: clean-am distclean-generic distclean-local + +dvi: dvi-am + +dvi-am: + +html: html-am + +html-am: + +info: info-am + +info-am: + +install-data-am: install-data-local + +install-dvi: install-dvi-am + +install-dvi-am: + +install-exec-am: + +install-html: install-html-am + +install-html-am: + +install-info: install-info-am + +install-info-am: + +install-man: + +install-pdf: install-pdf-am + +install-pdf-am: + +install-ps: install-ps-am + +install-ps-am: + +installcheck-am: + +maintainer-clean: maintainer-clean-am + -rm -f Makefile +maintainer-clean-am: distclean-am maintainer-clean-generic \ + maintainer-clean-local + +mostlyclean: mostlyclean-am + +mostlyclean-am: mostlyclean-generic mostlyclean-libtool + +pdf: pdf-am + +pdf-am: + +ps: ps-am + +ps-am: + +uninstall-am: uninstall-local + +.MAKE: install-am install-strip + +.PHONY: all all-am all-local check check-am clean clean-generic \ + clean-libtool clean-local dist-hook distclean \ + distclean-generic distclean-libtool distclean-local distdir \ + dvi dvi-am html html-am info info-am install install-am \ + install-data install-data-am install-data-local install-dvi \ + install-dvi-am install-exec install-exec-am install-html \ + install-html-am install-info install-info-am install-man \ + install-pdf install-pdf-am install-ps install-ps-am \ + install-strip installcheck installcheck-am installdirs \ + maintainer-clean maintainer-clean-generic \ + maintainer-clean-local mostlyclean mostlyclean-generic \ + mostlyclean-libtool pdf pdf-am ps ps-am uninstall uninstall-am \ + uninstall-local + + +@ENABLE_GTK_DOC_TRUE@all-local: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP) +@ENABLE_GTK_DOC_FALSE@all-local: + +docs: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP) + +$(REPORT_FILES): sgml-build.stamp + +#### setup #### + +setup-build.stamp: + -@if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \ + echo ' DOC Preparing build'; \ + files=`echo $(SETUP_FILES) $(expand_content_files) $(DOC_MODULE).types`; \ + if test "x$$files" != "x" ; then \ + for file in $$files ; do \ + test -f $(abs_srcdir)/$$file && \ + cp -pu $(abs_srcdir)/$$file $(abs_builddir)/ || true; \ + done; \ + fi; \ + test -d $(abs_srcdir)/tmpl && \ + { cp -rp $(abs_srcdir)/tmpl $(abs_builddir)/; \ + chmod -R u+w $(abs_builddir)/tmpl; } \ + fi + @touch setup-build.stamp + +#### scan #### + +scan-build.stamp: $(HFILE_GLOB) $(CFILE_GLOB) + @echo ' DOC Scanning header files' + @_source_dir='' ; \ + for i in $(DOC_SOURCE_DIR) ; do \ + _source_dir="$${_source_dir} --source-dir=$$i" ; \ + done ; \ + gtkdoc-scan --module=$(DOC_MODULE) --ignore-headers="$(IGNORE_HFILES)" $${_source_dir} $(SCAN_OPTIONS) $(EXTRA_HFILES) + @if grep -l '^..*$$' $(DOC_MODULE).types > /dev/null 2>&1 ; then \ + echo " DOC Introspecting gobjects"; \ + scanobj_options=""; \ + gtkdoc-scangobj 2>&1 --help | grep >/dev/null "\-\-verbose"; \ + if test "$(?)" = "0"; then \ + if test "x$(V)" = "x1"; then \ + scanobj_options="--verbose"; \ + fi; \ + fi; \ + CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" RUN="$(GTKDOC_RUN)" CFLAGS="$(GTKDOC_CFLAGS) $(CFLAGS)" LDFLAGS="$(GTKDOC_LIBS) $(LDFLAGS)" \ + gtkdoc-scangobj $(SCANGOBJ_OPTIONS) $$scanobj_options --module=$(DOC_MODULE); \ + else \ + for i in $(SCANOBJ_FILES) ; do \ + test -f $$i || touch $$i ; \ + done \ + fi + @touch scan-build.stamp + +$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt: scan-build.stamp + @true + +#### templates #### + +tmpl-build.stamp: setup-build.stamp $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt + @echo ' DOC Rebuilding template files' + @gtkdoc-mktmpl --module=$(DOC_MODULE) $(MKTMPL_OPTIONS) + @if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \ + if test -w $(abs_srcdir) ; then \ + cp -rp $(abs_builddir)/tmpl $(abs_srcdir)/; \ + fi \ + fi + @touch tmpl-build.stamp + +tmpl.stamp: tmpl-build.stamp + @true + +$(srcdir)/tmpl/*.sgml: + @true + +#### xml #### + +sgml-build.stamp: tmpl.stamp $(DOC_MODULE)-sections.txt $(srcdir)/tmpl/*.sgml $(expand_content_files) + @echo ' DOC Building XML' + @-chmod -R u+w $(srcdir) + @_source_dir='' ; \ + for i in $(DOC_SOURCE_DIR) ; do \ + _source_dir="$${_source_dir} --source-dir=$$i" ; \ + done ; \ + gtkdoc-mkdb --module=$(DOC_MODULE) --output-format=xml --expand-content-files="$(expand_content_files)" --main-sgml-file=$(DOC_MAIN_SGML_FILE) $${_source_dir} $(MKDB_OPTIONS) + @touch sgml-build.stamp + +sgml.stamp: sgml-build.stamp + @true + +#### html #### + +html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) + @echo ' DOC Building HTML' + @rm -rf html + @mkdir html + @mkhtml_options=""; \ + gtkdoc-mkhtml 2>&1 --help | grep >/dev/null "\-\-verbose"; \ + if test "$(?)" = "0"; then \ + if test "x$(V)" = "x1"; then \ + mkhtml_options="$$mkhtml_options --verbose"; \ + fi; \ + fi; \ + gtkdoc-mkhtml 2>&1 --help | grep >/dev/null "\-\-path"; \ + if test "$(?)" = "0"; then \ + mkhtml_options="$$mkhtml_options --path=\"$(abs_srcdir)\""; \ + fi; \ + cd html && gtkdoc-mkhtml $$mkhtml_options $(MKHTML_OPTIONS) $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE) + -@test "x$(HTML_IMAGES)" = "x" || \ + for file in $(HTML_IMAGES) ; do \ + if test -f $(abs_srcdir)/$$file ; then \ + cp $(abs_srcdir)/$$file $(abs_builddir)/html; \ + fi; \ + if test -f $(abs_builddir)/$$file ; then \ + cp $(abs_builddir)/$$file $(abs_builddir)/html; \ + fi; \ + done; + @echo ' DOC Fixing cross-references' + @gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS) + @touch html-build.stamp + +#### pdf #### + +pdf-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) + @echo ' DOC Building PDF' + @rm -f $(DOC_MODULE).pdf + @mkpdf_options=""; \ + gtkdoc-mkpdf 2>&1 --help | grep >/dev/null "\-\-verbose"; \ + if test "$(?)" = "0"; then \ + if test "x$(V)" = "x1"; then \ + mkpdf_options="$$mkpdf_options --verbose"; \ + fi; \ + fi; \ + if test "x$(HTML_IMAGES)" != "x"; then \ + for img in $(HTML_IMAGES); do \ + part=`dirname $$img`; \ + echo $$mkpdf_options | grep >/dev/null "\-\-imgdir=$$part "; \ + if test $$? != 0; then \ + mkpdf_options="$$mkpdf_options --imgdir=$$part"; \ + fi; \ + done; \ + fi; \ + gtkdoc-mkpdf --path="$(abs_srcdir)" $$mkpdf_options $(DOC_MODULE) $(DOC_MAIN_SGML_FILE) $(MKPDF_OPTIONS) + @touch pdf-build.stamp + +############## + +clean-local: + @rm -f *~ *.bak + @rm -rf .libs + +distclean-local: + @rm -rf xml html $(REPORT_FILES) $(DOC_MODULE).pdf \ + $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt + @if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \ + rm -f $(SETUP_FILES) $(expand_content_files) $(DOC_MODULE).types; \ + rm -rf tmpl; \ + fi + +maintainer-clean-local: clean + @rm -rf xml html + +install-data-local: + @installfiles=`echo $(builddir)/html/*`; \ + if test "$$installfiles" = '$(builddir)/html/*'; \ + then echo 1>&2 'Nothing to install' ; \ + else \ + if test -n "$(DOC_MODULE_VERSION)"; then \ + installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \ + else \ + installdir="$(DESTDIR)$(TARGET_DIR)"; \ + fi; \ + $(mkinstalldirs) $${installdir} ; \ + for i in $$installfiles; do \ + echo ' $(INSTALL_DATA) '$$i ; \ + $(INSTALL_DATA) $$i $${installdir}; \ + done; \ + if test -n "$(DOC_MODULE_VERSION)"; then \ + mv -f $${installdir}/$(DOC_MODULE).devhelp2 \ + $${installdir}/$(DOC_MODULE)-$(DOC_MODULE_VERSION).devhelp2; \ + fi; \ + $(GTKDOC_REBASE) --relative --dest-dir=$(DESTDIR) --html-dir=$${installdir}; \ + fi + +uninstall-local: + @if test -n "$(DOC_MODULE_VERSION)"; then \ + installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \ + else \ + installdir="$(DESTDIR)$(TARGET_DIR)"; \ + fi; \ + rm -rf $${installdir} + +# +# Require gtk-doc when making dist +# +@ENABLE_GTK_DOC_TRUE@dist-check-gtkdoc: +@ENABLE_GTK_DOC_FALSE@dist-check-gtkdoc: +@ENABLE_GTK_DOC_FALSE@ @echo "*** gtk-doc must be installed and enabled in order to make dist" +@ENABLE_GTK_DOC_FALSE@ @false + +dist-hook: dist-check-gtkdoc dist-hook-local + @mkdir $(distdir)/tmpl + @mkdir $(distdir)/html + @-cp ./tmpl/*.sgml $(distdir)/tmpl + @cp ./html/* $(distdir)/html + @-cp ./$(DOC_MODULE).pdf $(distdir)/ + @-cp ./$(DOC_MODULE).types $(distdir)/ + @-cp ./$(DOC_MODULE)-sections.txt $(distdir)/ + @cd $(distdir) && rm -f $(DISTCLEANFILES) + @$(GTKDOC_REBASE) --online --relative --html-dir=$(distdir)/html + +.PHONY : dist-hook-local docs + +dist-hook-local: $(BUILT_EXTRA_DIST) + files='$(BUILT_EXTRA_DIST)'; \ + for f in $$files; do \ + if test -f $$f; then d=.; else d=$(srcdir); fi; \ + cp $$d/$$f $(distdir) || exit 1; done + +# Tell versions [3.59,3.63) of GNU make to not export all variables. +# Otherwise a system limit (for SysV at least) may be exceeded. +.NOEXPORT: diff --git a/docs/reference/building.sgml b/docs/reference/building.sgml new file mode 100644 index 0000000..a53b4e8 --- /dev/null +++ b/docs/reference/building.sgml @@ -0,0 +1,280 @@ +<refentry id="gmime-building" revision="11 Apr 2009"> + <refmeta> + <refentrytitle>Compiling the GMime libraries</refentrytitle> + <manvolnum>3</manvolnum> + <refmiscinfo>GMime Library</refmiscinfo> + </refmeta> + <refnamediv> + <refname>Compiling the GMime Libraries</refname> + <refpurpose>How to compile GMime itself</refpurpose> + </refnamediv> + <refsect1 id="overview"> + <title>Building GMime on UNIX-like systems</title> + <para> + This chapter covers building and installing GMime on UNIX and + UNIX-like systems such as Linux. Compiling GMime on Microsoft + Windows is not a goal of the project, however if you are able + build on a Microsoft Windows platform, do send me building and + installing instructions and I will add them to this document. + </para> + <para> + Before we get into the details of how to compile GMime, I should + mention that binary packages of GMime prebuilt for your operating + system may be available either from your operating system vendor + or from independent sources such as http://rpmfind.net. If you + can find them, it may be the easiest way of getting started + developing GMime. + </para> + <para> + On UNIX-like systems GMime uses the standard GNU build system, + using <application>autoconf</application> for package + configuration and resolving portability issues, + <application>automake</application> for building makefiles that + comply with the GNU Coding Standards, and + <application>libtool</application> for building shared libraries + on multiple platforms. + </para> + <para> + If you are building GMime from the distributed source packages, + then you won't need these tools installed; the necessary pieces + of the tools are already included in the source packages. But + it's useful to know a bit about how packages that use these + tools work. A source package is distributed as a + <literal>tar.gz</literal> file which you unpack into a + directory full of the source files as follows: + </para> + <programlisting> + tar -zxvf gmime-2.6.x.tar.gz + </programlisting> + <para> + In the toplevel of the directory that is created, there will be + a shell script called <filename>configure</filename> which + you then run to take the template makefiles called + <filename>Makefile.in</filename> in the package and create + makefiles customized for your operating system. The + <filename>configure</filename> script can be passed various + command line arguments to determine how the package is built and + installed. The most commonly useful argument is the + <systemitem>--prefix</systemitem> argument which specifies where + the package is installed. To install a package into + <filename>/opt/gmime</filename> you would run configure as: + </para> + <programlisting> + ./configure --prefix=/opt/gmime + </programlisting> + <para> + A full list of options can be found by running + <filename>configure</filename> with the + <systemitem>--help</systemitem> argument. In general, the defaults + are right and should be trusted. After you've run + <filename>configure</filename>, you then run the + <command>make</command> command to build the package and install + it. + </para> + <programlisting> + make + make install + </programlisting> + <para> + If you don't have permission to write to the directory you are + installing in, you may have to change to root temporarily before + running <literal>make install</literal>. A quick way to do this is + to use the <command>su</command> command with the + <systemitem>-c</systemitem> option + (ex. <literal>su -c "make install"</literal>). Also, if you are + installing in a system directory, on some systems (such as + Linux), you will need to run <command>ldconfig</command> after + <literal>make install</literal> so that the newly installed + libraries will be found. + </para> + <para> + Several environment variables are useful to pass to set before + running configure. <envar>CPPFLAGS</envar> contains options to + pass to the C compiler, and is used to tell the compiler where + to look for include files. The <envar>LDFLAGS</envar> variable + is used in a similar fashion for the linker. Finally the + <envar>PKG_CONFIG_PATH</envar> environment variable contains + a search path that <command>pkg-config</command> (see below) + uses when looking for a file describing how to compile + programs using different libraries. If you were installing GMime + and it's dependencies into <filename>/opt/gmime</filename>, you + might want to set these variables as: + </para> + <programlisting> + CPPFLAGS="-I/opt/gmime/include" + LDFLAGS="-L/opt/gmime/lib" + PKG_CONFIG_PATH="/opt/gmime/lib/pkgconfig" + export CPPFLAGS LDFLAGS PKG_CONFIG_PATH + </programlisting> + <para> + You may also need to set the <envar>LD_LIBRARY_PATH</envar> + environment variable so the systems dynamic linker can find + the newly installed libraries, and the <envar>PATH</envar> + environment program so that utility binaries installed by + the various libraries will be found. + </para> + <programlisting> + LD_LIBRARY_PATH="/opt/gmime/lib" + PATH="/opt/gmime/bin:$PATH" + export LD_LIBRARY_PATH PATH + </programlisting> + </refsect1> + <refsect1 id="dependencies"> + <title>Dependencies</title> + <para> + Before you can compile the GMime library, you need to have + various other tools and libraries installed on your + system. The two tools needed during the build process (as + differentiated from the tools used in when creating GMime + mentioned above such as <application>autoconf</application>) + are <command>pkg-config</command> and GNU make. + </para> + <itemizedlist> + <listitem> + <para><ulink url="http://www.freedesktop.org/software/pkgconfig/">pkg-config</ulink> + is a tool for tracking the compilation flags needed for + libraries that are used by the GMime libraries. (For each + library, a small <literal>.pc</literal> text file is installed in a standard + location that contains the compilation flags needed for that + library along with version number information.) The version + of <command>pkg-config</command> needed to build GMime is + mirrored in the <filename>dependencies</filename> directory + on the <ulink url="ftp://ftp.gtk.org/pub/gtk/v2.0/">GTK+ FTP + site.</ulink></para> + </listitem> + <listitem> + <para> + The GMime makefiles will mostly work with different versions + of <command>make</command>, however, there tends to be + a few incompatibilities, so the GMime team recommends + installing <ulink url="http://www.gnu.org/software/make">GNU + make</ulink> if you don't already have it on your system + and using it. (It may be called <command>gmake</command> + rather than <command>make</command>.) + </para> + </listitem> + </itemizedlist> + <para> + GMime depends on the existance of two (2) libraries: GLib and iconv. + </para> + <itemizedlist> + <listitem> + <para> + The GLib library provides core non-graphical functionality + such as high level data types, Unicode manipulation, and + a object and type system to C programs. It is available + from the <ulink url="ftp://ftp.gtk.org/pub/gtk/v2.0/">GTK+ + FTP site.</ulink> + </para> + </listitem> + <listitem> + <para> + The <ulink url="http://www.gnu.org/software/libiconv/">GNU + libiconv library</ulink> is needed to build GLib and GMime + if your system doesn't already have the + <function>iconv()</function> function for doing conversion + between character encodings. Most modern systems should have + <function>iconv()</function>. + </para> + </listitem> + </itemizedlist> + </refsect1> + <refsect1 id="building"> + <title>Building and testing GMime</title> + <para> + First make sure that you have the necessary external + dependencies installed: <command>pkg-config</command>, GNU make, + and, if necessary, libiconv. To get detailed information about + building these packages, see the documentation provided with the + individual packages. On a newer Linux system, it's quite likely + that you'll have all of these installed already. + </para> + <para> + Then build and install the GMime libraries in the order: + libiconv, GLib, then GMime. For each library, follow the + steps of <literal>configure</literal>, <literal>make</literal>, + <literal>make install</literal> mentioned above. If you're + lucky, this will all go smoothly, and you'll be ready to + <link linkend="gmime-compiling">start compiling your own GMime + applications</link>. You can test your GMime installation + by running <command>pkg-config --modversion gmime-2.6</command> + and making sure that it can both find GMime and reports the + correct version. + </para> + <para> + If one of the <filename>configure</filename> scripts fails or running + <command>make</command> fails, look closely at the error + messages printed; these will often provide useful information + as to what went wrong. When <filename>configure</filename> + fails, extra information, such as errors that a test compilation + ran into, is found in the file <filename>config.log</filename>. + Looking at the last couple of hundred lines in this file will + frequently make clear what went wrong. If all else fails, you + can ask for help by emailing me, fejj@gnome.org + </para> + </refsect1> + <refsect1 id="extra-configuration-options"> + <title>Extra Configuration Options</title> + <para> + In addition to the normal options, the + <command>configure</command> script for the GMime library + supports a number of additional arguments. (Command line + arguments for the other GMime libraries are described in + the documentation distributed with those libraries.) + + <cmdsynopsis><command>./configure</command><group><arg>--enable-profiling</arg><arg>--enable-warnings</arg><arg>--enable-mono</arg><arg>--enable-gtk-doc</arg><arg>--enable-largfile</arg></group></cmdsynopsis> + </para> + <formalpara> + <title> + <systemitem>--enable-profiling</systemitem> + </title> + <para> + Normally GMime will not pass the <literal>-pg</literal> flag to + <command>gcc</command> when building. This option will enable + the use of that flag thus building profiling information into + the GMime libraries for use with the GNU Profiler, gprof. Odds + are you do not care about this option unless you are either me + or desire to profile GMime and/or your program. + </para> + </formalpara> + <formalpara> + <title> + <systemitem>--enable-warnings</systemitem> + </title> + <para> + This option enables parser warnings about invalid MIME to be + logged to stderr at runtime. Again, it is unlikely you will + care to use this option. + </para> + </formalpara> + <formalpara> + <title> + <systemitem>--enable-mono</systemitem> + </title> + <para> + This option will include the Mono .NET bindings as part of + the build. + </para> + </formalpara> + <formalpara> + <title> + <systemitem>--enable-gtk-doc</systemitem> + </title> + <para> + This option will enable the building of the reference + documentation for GMime (e.g. the html pages you are + reading now). + </para> + </formalpara> + <formalpara> + <title> + <systemitem>--enable-largefile</systemitem> + </title> + <para> + This option will enable large file support (e.g. files larger + than 2GB) on 32bit systems. This flag is enabled by default + starting with GMime 2.4.5. + </para> + </formalpara> + </refsect1> +</refentry> diff --git a/docs/reference/changes-2.0.sgml b/docs/reference/changes-2.0.sgml new file mode 100644 index 0000000..ede457b --- /dev/null +++ b/docs/reference/changes-2.0.sgml @@ -0,0 +1,136 @@ +<refentry id="gmime-changes-2-0" revision="1 Feb 2003"> + <refmeta> + <refentrytitle>Changes from 1.0 to 2.0</refentrytitle> + <manvolnum>3</manvolnum> + <refmiscinfo>Changes from 1.0 to 2.0</refmiscinfo> + </refmeta> + <refnamediv> + <refname>Changes from 1.0 to 2.0</refname> + <refpurpose> +Incompatible changes made between version 1.0 and version 2.0 +</refpurpose> + </refnamediv> + <refsect1> + <title>Incompatible changes from 1.0 to 2.0</title> + <para> +See also the PORTING document in the toplevel GMime source directory. +</para> + <para> +The major change here is that I've dropped my own base object class +and have replaced it with GObject from glib-2.0. This should be a +pleasant change since you (the developer) will now be able to do many +more things such as setting arbitrary data on all GMime objects. For +additional information about GObject, please see the GObject Reference +Manual at http://developer.gnome.org/doc/API/2.0/gobject/ +</para> + <itemizedlist> + <listitem> + <para> +The first thing you need to know is that any function returning a +non-const pointer to any object /must/ be unref'd when you are done +with it. Since all objects in GMime now subclass GObject, you may +safely use <function>g_object_unref()</function> +(<structname>GMimeStream</structname>'s may also be unref'd using +<function>g_mime_stream_unref()</function>, but either way is fine). + +Don't forget that +<function>g_mime_part_get_content_object()</function> returns a +ref-counted <structname>GMimeDataWrapper</structname> object now, and +so you /must/ unref it when you have finished using it. You must also +remember to unref any GMimeDataWrapper object that you /set/ on a +GMimePart using <function>g_mime_part_set_content_object()</function> +as the GMimePart will now ref the content object that you set on it. +</para> + </listitem> + <listitem> + <para><structname>GMimeMultipart</structname> is a new class which is to be +used for all multipart MIME parts rather than GMimePart (as in +1.0). There are also some subclasses of GMimeMultipart for other +things. +</para> + </listitem> + <listitem> + <para><function>g_mime_part_[g,s]et_boundary()</function> have been removed +(see above). You must now create a GMimeMultipart object and use +<function>g_mime_multipart_[g,s]et_boundary()</function>. +</para> + </listitem> + <listitem> + <para><function>g_mime_part_add_subpart()</function> has been replaced with +<function>g_mime_multipart_add_part()</function>. +</para> + </listitem> + <listitem> + <para><function>g_mime_part_foreach()</function> has been replaced with +<function>g_mime_multipart_foreach()</function> and/or +<function>g_mime_message_foreach_part()</function>. +</para> + </listitem> + <listitem> + <para><function>g_mime_part_get_subpart_from_content_id()</function> has +been replaced with +<function>g_mime_multipart_get_subpart_from_content_id()</function>. +</para> + </listitem> + <listitem> + <para> +Another new class is <structname>GMimeMessagePart</structname> which +is to be used for all MIME parts containing an rfc822 message. All 1.0 +GMimePart's representing message/rfc822 parts (as well as message/news +parts?) need to be migrated over to be GMimeMessagePart objects. +</para> + </listitem> + <listitem> + <para><structname>GMimeMessagePartial</structname> is another class meant +for handling the message/partial MIME type. All 1.0 GMimePart's +holding data of this type should be replaced with GMimeMessagePartial +objects. +</para> + </listitem> + <listitem> + <para><function>g_mime_message_write_to_stream()</function> and +<function>g_mime_part_write_to_stream()</function> functions have been +consolidated into a virtual method. Replace calls to these functions +with <function>g_mime_object_write_to_stream()</function>. Note: while +<function>g_mime_part_write_to_stream()</function> and +<function>g_mime_message_write_to_stream()</function> still exist, it +is suggested you migrate to +<function>g_mime_object_write_to_stream()</function>. Same goes for +<function>g_mime_part_to_string()</function> and +<function>g_mime_message_to_string()</function>. +</para> + </listitem> + <listitem> + <para><structname>GMimeMessage</structname>'s structure has changed a +bit. You will not be able to do <literal>message->header</literal>, +instead you want to do <literal>((GMimeObject *) +message)->header</literal>. +</para> + </listitem> + <listitem> + <para><function>g_mime_message_set_message_id()</function> now takes a +message_id argument without the encapsulating < and >'s (it now +just takes the addr-spec portion of the msg-id). +</para> + </listitem> + <listitem> + <para><structname>GMimeFilterFrom</structname> has changed slightly, you +will want to replace all calls to +<function>g_mime_filter_from_new()</function> with +<function>g_mime_filter_from_new +(GMIME_FILTER_FROM_MODE_DEFAULT)</function> +(<literal>GMIME_FILTER_FROM_MODE_DEFAULT</literal> is equivalent to (<type>int</type>) 0). +</para> + </listitem> + <listitem> + <para><structname>GMimeParser</structname> is a brand new class and +<filename>gmime-parser.h</filename> has had a number of API additions. +<function>g_mime_parser_construct_part()</function> and +<function>g_mime_parser_construct_message()</function> still exist, +however they no longer take a GMimeStream argument. Instead, they take +a GMimeParser object. +</para> + </listitem> + </itemizedlist> + </refsect1> +</refentry> diff --git a/docs/reference/changes-2.2.sgml b/docs/reference/changes-2.2.sgml new file mode 100644 index 0000000..b09f308 --- /dev/null +++ b/docs/reference/changes-2.2.sgml @@ -0,0 +1,80 @@ +<refentry id="gmime-changes-2-2" revision="6 June 2004"> + <refmeta> + <refentrytitle>Changes from 2.0 to 2.2</refentrytitle> + <manvolnum>3</manvolnum> + <refmiscinfo>Changes from 2.0 to 2.2</refmiscinfo> + </refmeta> + <refnamediv> + <refname>Changes from 2.0 to 2.2</refname> + <refpurpose>Incompatible changes made between version 2.0 and version 2.2</refpurpose> + </refnamediv> + <refsect1> + <title>Incompatible changes from 2.0 to 2.2</title> + <para>See also the PORTING document in the toplevel GMime source directory.</para> + <para>There are no incompatible changes between 2.0 and 2.2.</para> + <para>GMime 2.2 is both API and ABI compatible with GMime 2.0 meaning +that any program written for GMime 2.0 will compile fine with GMime +2.2 and any program linked against GMime 2.0's libraries will also +work with GMime 2.2's libraries.</para> + <para>Most of the changes made between 2.0 and 2.2 were internal but there +are a few API changes you should be aware of (as these interfaces will +be deprecated in some future version, probably 3.0).</para> + </refsect1> + <refsect1> + <title>Replacement interfaces from 2.0 to 2.2</title> + <itemizedlist> + <listitem> + <para> +<function>g_mime_utils_8bit_header_decode()</function> has been split +into 2 functions. We now have +<function>g_mime_utils_header_decode_text()</function> and +<function>g_mime_utils_header_decode_phrase()</function>. +<function>g_mime_utils_header_decode_text()</function> no longer +requires encoded-words to be rfc822 atoms. +<function>g_mime_utils_header_decode_phrase()</function> is +still strict in that encoded-words MUST be valid rfc822 atoms.</para> + </listitem> + <listitem> + <para> +<function>g_mime_utils_8bit_header_encode()</function> has been +renamed to <function>g_mime_utils_header_encode_text()</function> to +be more clear as to what type of header this is supposed to encode. If +you haven't guessed, this function is for encoding rfc822 'text' +headers (such as Subject).</para> + </listitem> + <listitem> + <para> +<function>g_mime_utils_8bit_header_encode_phrase()</function> has been +renamed to <function>g_mime_utils_header_encode_phrase()</function> +mostly for consistancy with the previous 2 changes.</para> + </listitem> + <listitem> + <para> +<function>g_mime_charset_name()</function> has been renamed to +<function>g_mime_charset_iconv_name()</function> for clarity.</para> + </listitem> + <listitem> + <para> +<function>g_mime_charset_locale_name()</function> has been renamed to +<function>g_mime_locale_charset()</function>.</para> + </listitem> + <listitem> + <para> +<function>g_mime_cipher_context_verify()</function> no longer returns +a <structname>GMimeCipherValidity</structname>, instead it returns a +<structname>GMimeSignatureValidity</structname> which is far more +useful. Never fear, you may still use the +<structname>GMimeCipherValidity</structname> APIs for the time being - +they work fine given a <structname>GMimeSignatureValidity</structname> +structure.</para> + </listitem> + <listitem> + <para> +<function>g_mime_multipart_signed_verify()</function> also now returns +a <structname>GMimeSignatureValidity</structname> structure rather than +a <structname>GMimeCipherValidity</structname> structure. See changes to +<function>g_mime_cipher_context_verify()</function> for details.</para> + </listitem> + </itemizedlist> + </refsect1> +</refentry> diff --git a/docs/reference/changes-2.4.sgml b/docs/reference/changes-2.4.sgml new file mode 100644 index 0000000..dcb328d --- /dev/null +++ b/docs/reference/changes-2.4.sgml @@ -0,0 +1,57 @@ +<refentry id="gmime-changes-2-4" revision="23 May 2008"> + <refmeta> + <refentrytitle>Changes from 2.2 to 2.4</refentrytitle> + <manvolnum>3</manvolnum> + <refmiscinfo>Changes from 2.2 to 2.4</refmiscinfo> + </refmeta> + <refnamediv> + <refname>Changes from 2.2 to 2.4</refname> + <refpurpose>Changes made between version 2.2 and version 2.4</refpurpose> + </refnamediv> + <refsect1> + <title>Changes from 2.2 to 2.4</title> + <para>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 +not large file support is enabled.</para> + <para>In addition, all of the functions marked as deprecated in +2.0 and 2.2 were removed (usually they had equivalent functionality in +a parent class).</para> + <para>Many functions have also been renamed for better clarity +and/or consistency. For convenience, GMime 2.4 source packages include +a shell-script to aid in porting applications using GMime 2.2 (should +work for most GMime 2.0 applications as well) to the 2.4 API. You can +find this script under the tools/ directory, named +`gmime-port-2-2-to-2-4.sh'.</para> + <para>This script won't fix everything, but it should help quite a +bit.</para> + <para>Beyond that, a few methods have changed in other ways:</para> + <itemizedlist> + <listitem><para><function>g_mime_cipher_context_sign()</function> + still returns int, but if the value isn't -1 (failure), then it will + represent a GMimeCipherHash that it used for signing. This is + useful, for example, when the requested hash was + GMIME_CIPHER_HASH_DEFAULT.</para></listitem> + <listitem><para><function>g_mime_cipher_context_decrypt()</function> + now returns a GMimeSignatureValidty on success and NULL on + failure. This is needed in case the encrypted stream was also + signed.</para></listitem> + <listitem><para><function>g_mime_multipart_encrypted_encrypt()</function> + now takes a boolean 'sign' argument to allow the caller to request + encrypting and signing in a single pass.</para></listitem> + </itemizedlist> + <para>Several structs have also been rewritten to subclass GObject like +GMimeContentType and GMimeContentDisposition as well as +InternetAddress and InternetAddressList.</para> + <para>Not only have InternetAddress and InternetAddressList been ported to +GObject, but they have also undergone other design +changes. InternetAddress is now a base class for +InternetAddressMailbox and InternetAddressGroup, meaning that +InternetAddress no longer contains a union for group/addr fields.</para> + <para>All functions that return a GObject have been changed to not add a ref +to the object returned, meaning that it is no longer necessary to call +g_object_unref() on MIME parts returned from functions like +g_mime_message_get_mime_part() or g_mime_multipart_get_part(). This +was done to be more consistent with the Gtk+ API.</para> + </refsect1> +</refentry> diff --git a/docs/reference/changes-2.6.sgml b/docs/reference/changes-2.6.sgml new file mode 100644 index 0000000..4443e9e --- /dev/null +++ b/docs/reference/changes-2.6.sgml @@ -0,0 +1,65 @@ +<refentry id="gmime-changes-2-6" revision="06 Feb 2010"> + <refmeta> + <refentrytitle>Changes from 2.4 to 2.6</refentrytitle> + <manvolnum>3</manvolnum> + <refmiscinfo>Changes from 2.4 to 2.6</refmiscinfo> + </refmeta> + <refnamediv> + <refname>Changes from 2.4 to 2.6</refname> + <refpurpose>Changes made between version 2.4 and version 2.6</refpurpose> + </refnamediv> + <refsect1> + <title>Changes from 2.4 to 2.6</title> + <para>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 +than 2GB (which could happen if GMime was built with large file +support).</para> + <para>As I fixed this, I also found some API inconsistencies which I felt I +might as well fix up since I had to break API/ABI compatibility with +2.4 anyway.</para> + <para>Most notable in GMime 2.6 is the lack of GMimeSession which has been +dropped in favor of a much simpler callback +mechanism. GMimeCipherContexts constructors now take a +password_request callback function rather than forcing you to subclass +GMimeSession to get this functionality.</para> + <para>Other API changes include:</para> + <itemizedlist> + <listitem><para>GMimeBestEncoding has been renamed to + GMimeEncodingConstraint</para></listitem> + <listitem><para>GMimeSignatureValidity has been dropped in favor + of GMimeSignatureList which is simply a collection of + signatures. + </para></listitem> + <listitem><para>GMimeSigner has been replaced by GMimeSignature + and GMimeCertificate which added a number of new fields and + accessors making it much more complete. + </para></listitem> + <listitem><para>GMimeCipherContext has been renamed to + GMimeCryptoContext and the method names for this class have also + been renamed in a similar fashion. + </para></listitem> + <listitem><para><function>g_mime_crypto_context_encrypt()</function> + now takes a digest algorithm argument which is used when the + 'sign' argument is TRUE. + </para></listitem> + <listitem><para><function>g_mime_multipart_encrypted_encrypt()</function> + also now takes a digest algorithm argument which it passes along + to <function>g_mime_crypto_context_encrypt()</function>. + </para></listitem> + <listitem><para><function>g_mime_crypto_context_decrypt()</function> + now returns a GMimeDecryptResult which contains a list of + signatures (if signed), a list of recipients that the stream had + been encrypted to, and also the cipher and digest algorithms + used. + </para></listitem> + <listitem><para><function>g_mime_multipart_encrypted_decrypt()</function> + no longer caches the decrypted part and also now takes a + GMimeSignatureList** output argument which it sets in place of + having to call + <function>g_mime_multipart_encrypted_get_signature_validity()</function> + afterward. + </para></listitem> + </itemizedlist> + </refsect1> +</refentry> diff --git a/docs/reference/compiling.sgml b/docs/reference/compiling.sgml new file mode 100644 index 0000000..0449b0a --- /dev/null +++ b/docs/reference/compiling.sgml @@ -0,0 +1,46 @@ +<refentry id="gmime-compiling" revision="23 May 2008"> +<refmeta> +<refentrytitle>Compiling GMime Applications</refentrytitle> +<manvolnum>3</manvolnum> +<refmiscinfo>GMime Library</refmiscinfo> +</refmeta> + +<refnamediv> +<refname>Compiling GMime Applications</refname> +<refpurpose> +How to compile your GMime application +</refpurpose> +</refnamediv> + +<refsect1> +<title>Compiling GMime Applications on UNIX</title> + +<para> +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 +<literal>pkg-config</literal> utility. +</para> +<para> +The following interactive shell session demonstrates how +<literal>pkg-config</literal> is used: +<programlisting> +$ pkg-config --cflags gmime-2.4 + -I/usr/include/gmime-2.4 -I/usr/include/glib-2.0 -I/usr/lib/glib-2.0/include +$ pkg-config --libs gmime-2.4 + -L/opt/gnome2/lib -lgmime-2.4 -lnsl -lgobject-2.0 -lglib-2.0 +</programlisting> +</para> +<para> +The simplest way to compile a program is to use the "backticks" +feature of the shell. If you enclose a command in backticks +(<emphasis>not single quotes</emphasis>), then its output will be +substituted into the command line before execution. So to compile +a GTK+ Hello, World, you would type the following: +<programlisting> +$ cc `pkg-config --cflags --libs gmime-2.4` hello.c -o hello +</programlisting> +</para> + +</refsect1> + +</refentry> diff --git a/docs/reference/data-wrappers.sgml b/docs/reference/data-wrappers.sgml new file mode 100644 index 0000000..103c65e --- /dev/null +++ b/docs/reference/data-wrappers.sgml @@ -0,0 +1,22 @@ +<refentry id="gmime-data-wrappers"> + <refmeta> + <refentrytitle>GMime Data Wrappers</refentrytitle> + <refmiscinfo>GMime Library</refmiscinfo> + </refmeta> + + <refnamediv> + <refname>GMime Data Wrappers</refname> + <refpurpose>How to use GMime Data Wrappers</refpurpose> + </refnamediv> + <refsect1 id="data-wrapper-overview"> + <title>Overview of Data Wrappers</title> + + <para>Data wrappers are very simple. A GMimeDataWrapper object + contains both a stream and an encoding-type. The encoding-type + (such as GMIME_PART_ENCODING_BASE64) is used by + g_mime_data_wrapper_write_to_stream() in order to decode the data + into its unencoded form. This means that you, the application + programmer, do not need to worry about decoding the content stream + yourself.</para> + </refsect1> +</refentry> diff --git a/docs/reference/filters.sgml b/docs/reference/filters.sgml new file mode 100644 index 0000000..4d3d2e8 --- /dev/null +++ b/docs/reference/filters.sgml @@ -0,0 +1,53 @@ +<refentry id="gmime-filters"> + <refmeta> + <refentrytitle>GMime Stream Filters</refentrytitle> + <refmiscinfo>GMime Library</refmiscinfo> + </refmeta> + + <refnamediv> + <refname>GMime Stream Filters</refname> + <refpurpose>How to use GMime Stream Filters</refpurpose> + </refnamediv> + <refsect1 id="filter-overview"> + <title>Overview of Filters</title> + <para>Stream filters are an efficient way of converting data from + one format to another. To use a stream filter, you must first + construct a GMimeStreamFilter stream and then add the desired + filters to it.</para> + + <para>GMime comes equipped with some basic filters such as + GMimeFilterBasic, GMimeFilterCharset, GMimeFilterCRLF, + GMimeFilterFrom and GMimeFilterHTML.</para> + + <para>The GMimeFilterBasic filter is actually a collection of + filters for common transfer encodings used by MIME. So far, it is + able to handle encoding and decoding of base64, quoted-printable + and (x-)uuencode.</para> + + <para>For internationalization support, GMime also includes a + filter for converting between any 2 charsets, + GMimeFilterCharset. With this filter, mail user agents can allow + the user to read the message content in his or her own + charset.</para> + + <para>A common conversion needed for text is CRLF -> LF and LF -> + CRLF which is needed for most (all?) internet protocols. Luckily, + GMime comes equipped with a filter to handle this for you, + GMimeFilterCRLF. You'll notice that GMimeFilterCRLF can also + handle dot-escaping, which is especially useful for SMTP + (rfc821).</para> + + <para>On Unix systems, mail often resides in spools in mbox + format. Mbox uses a line that starts with "From " to delimit + messages which means that message bodies are forbidden to contain + lines starting with "From ". The common way to escape these from + lines in message bodies is to prepend the line with a greater-than + character ('>') producing ">From ". You'll find GMimeFilterFrom + handy when dealing with this.</para> + + <para>The GMimeFilterHTML filter converts a normal text stream + into an html stream. This is especially useful if you are using a + widget such as GtkHTML to display the contents of an email + message.</para> + </refsect1> +</refentry> diff --git a/docs/reference/gmime-docs.sgml b/docs/reference/gmime-docs.sgml new file mode 100644 index 0000000..c60ee89 --- /dev/null +++ b/docs/reference/gmime-docs.sgml @@ -0,0 +1,261 @@ +<?xml version="1.0"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ +<!ENTITY gmime-Init SYSTEM "xml/gmime.xml"> +<!ENTITY GMimeParam SYSTEM "xml/gmime-param.xml"> +<!ENTITY GMimeHeader SYSTEM "xml/gmime-header.xml"> +<!ENTITY GMimeContentType SYSTEM "xml/gmime-content-type.xml"> +<!ENTITY GMimeDisposition SYSTEM "xml/gmime-disposition.xml"> +<!ENTITY GMimeObject SYSTEM "xml/gmime-object.xml"> +<!ENTITY GMimeDataWrapper SYSTEM "xml/gmime-data-wrapper.xml"> +<!ENTITY GMimeMultipart SYSTEM "xml/gmime-multipart.xml"> +<!ENTITY GMimeMultipartEncrypted SYSTEM "xml/gmime-multipart-encrypted.xml"> +<!ENTITY GMimeMultipartSigned SYSTEM "xml/gmime-multipart-signed.xml"> +<!ENTITY GMimePart SYSTEM "xml/gmime-part.xml"> +<!ENTITY GMimePartIter SYSTEM "xml/gmime-part-iter.xml"> +<!ENTITY GMimeMessage SYSTEM "xml/gmime-message.xml"> +<!ENTITY GMimeMessagePart SYSTEM "xml/gmime-message-part.xml"> +<!ENTITY GMimeMessagePartial SYSTEM "xml/gmime-message-partial.xml"> +<!ENTITY gmime-utils SYSTEM "xml/gmime-utils.xml"> +<!ENTITY gmime-encodings SYSTEM "xml/gmime-encodings.xml"> +<!ENTITY InternetAddress SYSTEM "xml/internet-address.xml"> +<!ENTITY InternetAddressGroup SYSTEM "xml/internet-address-group.xml"> +<!ENTITY InternetAddressMailbox SYSTEM "xml/internet-address-mailbox.xml"> +<!ENTITY InternetAddressList SYSTEM "xml/internet-address-list.xml"> +<!ENTITY GMimeParser SYSTEM "xml/gmime-parser.xml"> +<!ENTITY gmime-charset SYSTEM "xml/gmime-charset.xml"> +<!ENTITY gmime-iconv SYSTEM "xml/gmime-iconv.xml"> +<!ENTITY gmime-iconv-utils SYSTEM "xml/gmime-iconv-utils.xml"> +<!ENTITY GMimeStream SYSTEM "xml/gmime-stream.xml"> +<!ENTITY GMimeStreamBuffer SYSTEM "xml/gmime-stream-buffer.xml"> +<!ENTITY GMimeStreamCat SYSTEM "xml/gmime-stream-cat.xml"> +<!ENTITY GMimeStreamFile SYSTEM "xml/gmime-stream-file.xml"> +<!ENTITY GMimeStreamFs SYSTEM "xml/gmime-stream-fs.xml"> +<!ENTITY GMimeStreamGIO SYSTEM "xml/gmime-stream-gio.xml"> +<!ENTITY GMimeStreamMem SYSTEM "xml/gmime-stream-mem.xml"> +<!ENTITY GMimeStreamMmap SYSTEM "xml/gmime-stream-mmap.xml"> +<!ENTITY GMimeStreamNull SYSTEM "xml/gmime-stream-null.xml"> +<!ENTITY GMimeStreamPipe SYSTEM "xml/gmime-stream-pipe.xml"> +<!ENTITY GMimeStreamFilter SYSTEM "xml/gmime-stream-filter.xml"> +<!ENTITY GMimeFilter SYSTEM "xml/gmime-filter.xml"> +<!ENTITY GMimeFilterBasic SYSTEM "xml/gmime-filter-basic.xml"> +<!ENTITY GMimeFilterBest SYSTEM "xml/gmime-filter-best.xml"> +<!ENTITY GMimeFilterCharset SYSTEM "xml/gmime-filter-charset.xml"> +<!ENTITY GMimeFilterCRLF SYSTEM "xml/gmime-filter-crlf.xml"> +<!ENTITY GMimeFilterEnriched SYSTEM "xml/gmime-filter-enriched.xml"> +<!ENTITY GMimeFilterFrom SYSTEM "xml/gmime-filter-from.xml"> +<!ENTITY GMimeFilterGZip SYSTEM "xml/gmime-filter-gzip.xml"> +<!ENTITY GMimeFilterHTML SYSTEM "xml/gmime-filter-html.xml"> +<!ENTITY GMimeFilterMd5 SYSTEM "xml/gmime-filter-md5.xml"> +<!ENTITY GMimeFilterStrip SYSTEM "xml/gmime-filter-strip.xml"> +<!ENTITY GMimeFilterWindows SYSTEM "xml/gmime-filter-windows.xml"> +<!ENTITY GMimeFilterYenc SYSTEM "xml/gmime-filter-yenc.xml"> +<!ENTITY GMimeCertificate SYSTEM "xml/gmime-certificate.xml"> +<!ENTITY GMimeSignature SYSTEM "xml/gmime-signature.xml"> +<!ENTITY GMimeCryptoContext SYSTEM "xml/gmime-crypto-context.xml"> +<!ENTITY GMimeGpgContext SYSTEM "xml/gmime-gpg-context.xml"> +<!ENTITY GMimePkcs7Context SYSTEM "xml/gmime-pkcs7-context.xml"> + +<!ENTITY index-Class-Tree SYSTEM "tree_index.sgml"> + +<!ENTITY gmime-Building SYSTEM "building.sgml"> +<!ENTITY gmime-Compiling SYSTEM "compiling.sgml"> +<!ENTITY gmime-Resources SYSTEM "resources.sgml"> +<!ENTITY gmime-Questions SYSTEM "question_index.sgml"> +<!ENTITY gmime-Changes-2-0 SYSTEM "changes-2.0.sgml"> +<!ENTITY gmime-Changes-2-2 SYSTEM "changes-2.2.sgml"> +<!ENTITY gmime-Changes-2-4 SYSTEM "changes-2.4.sgml"> +<!ENTITY gmime-Changes-2-6 SYSTEM "changes-2.6.sgml"> + +<!ENTITY gmime-Streams SYSTEM "streams.sgml"> +<!ENTITY gmime-Filters SYSTEM "filters.sgml"> +<!ENTITY gmime-DataWrappers SYSTEM "data-wrappers.sgml"> +]> + +<book id="index"> + <bookinfo> + <title>GMime 2.6 Reference Manual</title> + <authorgroup> + <author> + <firstname>Jeffrey</firstname> + <surname>Stedfast</surname> + <affiliation> + <address> + <email>fejj@gnome.org</email> + </address> + </affiliation> + </author> + </authorgroup> + <copyright> + <year>2000-2011</year> + <holder>Jeffrey Stedfast</holder> + </copyright> + + <legalnotice> + <para> + 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 + version 2.1 of the License, or (at your option) any later version. + </para> + <para> + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + </para> + <para> + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA + 02110-1301, USA. + </para> + </legalnotice> + + <abstract> + <para>This manual documents the interfaces of the GMime + library and has some short notes to help get you up to speed + with using the library.</para> + </abstract> + </bookinfo> + + <part id="gmime"> + <title>GMime Overview</title> + <partintro> + <para> +GMime is a powerful MIME (Multipurpose Internet Mail Extension) +utility library. It is meant for creating, editing, and parsing MIME +messages and structures. GMime is released under the 2.1 version of +the GNU Lesser General Public License. GMime is based on GLib 2.0's +GObject system allowing for a lot of flexibility. + </para> + <para> +GMime depends on the following libraries: + <variablelist> + <varlistentry> + <term>GLib</term> + <listitem> + <para> +A general-purpose utility library, not specific to graphical user interfaces. +GLib provides many useful data types, macros, type conversions, +string utilities, file utilities, a main loop abstraction, and so on. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </partintro> + &gmime-Building; + &gmime-Compiling; + &gmime-Changes-2-0; + &gmime-Changes-2-2; + &gmime-Changes-2-4; + &gmime-Changes-2-6; + &gmime-Resources; + &gmime-Questions; + </part> + + <part id="fundamentals"> + <title>GMime Fundamentals</title> + &gmime-Streams; + &gmime-Filters; + &gmime-DataWrappers; + </part> + + <part id="core"> + <title>GMime Core Reference</title> + &gmime-Init; + &gmime-charset; + &gmime-iconv; + &gmime-iconv-utils; + &gmime-encodings; + &gmime-utils; + </part> + + <part id="classes"> + <title>GMime Classes</title> + <chapter> + <title>Class hierarchy</title> + &index-Class-Tree; + </chapter> + + <chapter id="Streams"> + <title>Streams</title> + &GMimeStream; + &GMimeStreamFile; + &GMimeStreamFs; + &GMimeStreamMem; + &GMimeStreamMmap; + &GMimeStreamNull; + &GMimeStreamFilter; + &GMimeStreamBuffer; + &GMimeStreamPipe; + &GMimeStreamCat; + </chapter> + + <chapter id="Filters"> + <title>Stream Filters</title> + &GMimeFilter; + &GMimeFilterBasic; + &GMimeFilterBest; + &GMimeFilterCharset; + &GMimeFilterCRLF; + &GMimeFilterEnriched; + &GMimeFilterFrom; + &GMimeFilterGZip; + &GMimeFilterHTML; + &GMimeFilterMd5; + &GMimeFilterStrip; + &GMimeFilterWindows; + &GMimeFilterYenc; + </chapter> + + <chapter id="DataWrappers"> + <title>Data Wrappers</title> + &GMimeDataWrapper; + </chapter> + + <chapter id="Headers"> + <title>Message and MIME Headers</title> + &GMimeHeader; + &GMimeContentType; + &GMimeDisposition; + &GMimeParam; + </chapter> + + <chapter id="InternetAddresses"> + <title>Internet Addresses</title> + &InternetAddress; + &InternetAddressGroup; + &InternetAddressMailbox; + &InternetAddressList; + </chapter> + + <chapter id="MimeParts"> + <title>MIME Messages and Parts</title> + &GMimeObject; + &GMimeMessage; + &GMimePart; + &GMimeMultipart; + &GMimeMultipartEncrypted; + &GMimeMultipartSigned; + &GMimeMessagePart; + &GMimeMessagePartial; + &GMimePartIter; + </chapter> + + <chapter id="Parsers"> + <title>Parsing Messages and MIME Parts</title> + &GMimeParser; + </chapter> + + <chapter id="CryptoContexts"> + <title>Cryptography Contexts</title> + &GMimeCertificate; + &GMimeSignature; + &GMimeCryptoContext; + &GMimeGpgContext; + &GMimePkcs7Context; + </chapter> + </part> +</book> diff --git a/docs/reference/gmime-overrides.txt b/docs/reference/gmime-overrides.txt new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/reference/gmime-overrides.txt diff --git a/docs/reference/gmime-sections.txt b/docs/reference/gmime-sections.txt new file mode 100644 index 0000000..c771bdd --- /dev/null +++ b/docs/reference/gmime-sections.txt @@ -0,0 +1,1362 @@ +<SECTION> +<FILE>gmime</FILE> +GMIME_MAJOR_VERSION +GMIME_MICRO_VERSION +GMIME_MINOR_VERSION +GMIME_BINARY_AGE +GMIME_INTERFACE_AGE +GMIME_CHECK_VERSION +GMIME_ENABLE_RFC2047_WORKAROUNDS +g_mime_init +g_mime_shutdown +gmime_major_version +gmime_minor_version +gmime_micro_version +gmime_binary_age +gmime_interface_age +g_mime_check_version +</SECTION> + +<SECTION> +<FILE>gmime-error</FILE> +GMIME_ERROR +GMIME_ERROR_IS_SYSTEM +</SECTION> + +<SECTION> +<FILE>gmime-stream</FILE> +GMimeSeekWhence +GMimeStreamIOVector +GMimeStream +g_mime_stream_construct +g_mime_stream_read +g_mime_stream_write +g_mime_stream_flush +g_mime_stream_seek +g_mime_stream_tell +g_mime_stream_reset +g_mime_stream_eos +g_mime_stream_close +g_mime_stream_length +g_mime_stream_substream +g_mime_stream_set_bounds +g_mime_stream_write_string +g_mime_stream_printf +g_mime_stream_write_to_stream +g_mime_stream_writev + +<SUBSECTION Private> +g_mime_stream_get_type + +<SUBSECTION Standard> +GMimeStreamClass +GMIME_TYPE_STREAM +GMIME_STREAM +GMIME_IS_STREAM +GMIME_STREAM_CLASS +GMIME_IS_STREAM_CLASS +GMIME_STREAM_GET_CLASS +</SECTION> + +<SECTION> +<FILE>gmime-stream-buffer</FILE> +GMimeStreamBufferMode +GMimeStreamBuffer +g_mime_stream_buffer_new +g_mime_stream_buffer_gets +g_mime_stream_buffer_readln + +<SUBSECTION Private> +g_mime_stream_buffer_get_type + +<SUBSECTION Standard> +GMimeStreamBufferClass +GMIME_TYPE_STREAM_BUFFER +GMIME_STREAM_BUFFER +GMIME_IS_STREAM_BUFFER +GMIME_STREAM_BUFFER_CLASS +GMIME_IS_STREAM_BUFFER_CLASS +GMIME_STREAM_BUFFER_GET_CLASS +</SECTION> + +<SECTION> +<FILE>gmime-stream-cat</FILE> +GMimeStreamCat +g_mime_stream_cat_new +g_mime_stream_cat_add_source + +<SUBSECTION Private> +g_mime_stream_cat_get_type + +<SUBSECTION Standard> +GMimeStreamCatClass +GMIME_TYPE_STREAM_CAT +GMIME_STREAM_CAT +GMIME_IS_STREAM_CAT +GMIME_STREAM_CAT_CLASS +GMIME_IS_STREAM_CAT_CLASS +GMIME_STREAM_CAT_GET_CLASS +</SECTION> + +<SECTION> +<FILE>gmime-stream-file</FILE> +GMimeStreamFile +g_mime_stream_file_new +g_mime_stream_file_new_with_bounds +g_mime_stream_file_get_owner +g_mime_stream_file_set_owner + +<SUBSECTION Private> +g_mime_stream_file_get_type + +<SUBSECTION Standard> +GMimeStreamFileClass +GMIME_TYPE_STREAM_FILE +GMIME_STREAM_FILE +GMIME_IS_STREAM_FILE +GMIME_STREAM_FILE_CLASS +GMIME_IS_STREAM_FILE_CLASS +GMIME_STREAM_FILE_GET_CLASS +</SECTION> + +<SECTION> +<FILE>gmime-stream-fs</FILE> +GMimeStreamFs +g_mime_stream_fs_new +g_mime_stream_fs_new_with_bounds +g_mime_stream_fs_get_owner +g_mime_stream_fs_set_owner + +<SUBSECTION Private> +g_mime_stream_fs_get_type + +<SUBSECTION Standard> +GMimeStreamFsClass +GMIME_TYPE_STREAM_FS +GMIME_STREAM_FS +GMIME_IS_STREAM_FS +GMIME_STREAM_FS_CLASS +GMIME_IS_STREAM_FS_CLASS +GMIME_STREAM_FS_GET_CLASS +</SECTION> + +<SECTION> +<FILE>gmime-stream-gio</FILE> +GMimeStreamGIO +g_mime_stream_gio_new +g_mime_stream_gio_new_with_bounds +g_mime_stream_gio_get_owner +g_mime_stream_gio_set_owner + +<SUBSECTION Private> +g_mime_stream_gio_get_type + +<SUBSECTION Standard> +GMimeStreamGIOClass +GMIME_TYPE_STREAM_GIO +GMIME_STREAM_GIO +GMIME_IS_STREAM_GIO +GMIME_STREAM_GIO_CLASS +GMIME_IS_STREAM_GIO_CLASS +GMIME_STREAM_GIO_GET_CLASS +</SECTION> + +<SECTION> +<FILE>gmime-stream-mem</FILE> +GMimeStreamMem +g_mime_stream_mem_new +g_mime_stream_mem_new_with_byte_array +g_mime_stream_mem_new_with_buffer +g_mime_stream_mem_get_byte_array +g_mime_stream_mem_set_byte_array +g_mime_stream_mem_get_owner +g_mime_stream_mem_set_owner + +<SUBSECTION Private> +g_mime_stream_mem_get_type + +<SUBSECTION Standard> +GMimeStreamMemClass +GMIME_TYPE_STREAM_MEM +GMIME_STREAM_MEM +GMIME_IS_STREAM_MEM +GMIME_STREAM_MEM_CLASS +GMIME_IS_STREAM_MEM_CLASS +GMIME_STREAM_MEM_GET_CLASS +</SECTION> + +<SECTION> +<FILE>gmime-stream-mmap</FILE> +GMimeStreamMmap +g_mime_stream_mmap_new +g_mime_stream_mmap_new_with_bounds + +<SUBSECTION Private> +g_mime_stream_mmap_get_type + +<SUBSECTION Standard> +GMimeStreamMmapClass +GMIME_TYPE_STREAM_MMAP +GMIME_STREAM_MMAP +GMIME_IS_STREAM_MMAP +GMIME_STREAM_MMAP_CLASS +GMIME_IS_STREAM_MMAP_CLASS +GMIME_STREAM_MMAP_GET_CLASS +</SECTION> + +<SECTION> +<FILE>gmime-stream-null</FILE> +GMimeStreamNull +g_mime_stream_null_new + +<SUBSECTION Private> +g_mime_stream_null_get_type + +<SUBSECTION Standard> +GMimeStreamNullClass +GMIME_TYPE_STREAM_NULL +GMIME_STREAM_NULL +GMIME_IS_STREAM_NULL +GMIME_STREAM_NULL_CLASS +GMIME_IS_STREAM_NULL_CLASS +GMIME_STREAM_NULL_GET_CLASS +</SECTION> + +<SECTION> +<FILE>gmime-stream-pipe</FILE> +GMimeStreamPipe +g_mime_stream_pipe_new +g_mime_stream_pipe_get_owner +g_mime_stream_pipe_set_owner + +<SUBSECTION Private> +g_mime_stream_pipe_get_type + +<SUBSECTION Standard> +GMimeStreamPipeClass +GMIME_TYPE_STREAM_PIPE +GMIME_STREAM_PIPE +GMIME_IS_STREAM_PIPE +GMIME_STREAM_PIPE_CLASS +GMIME_IS_STREAM_PIPE_CLASS +GMIME_STREAM_PIPE_GET_CLASS +</SECTION> + +<SECTION> +<FILE>gmime-stream-filter</FILE> +GMimeStreamFilter +g_mime_stream_filter_new +g_mime_stream_filter_add +g_mime_stream_filter_remove + +<SUBSECTION Private> +g_mime_stream_filter_get_type + +<SUBSECTION Standard> +GMimeStreamFilterClass +GMIME_TYPE_STREAM_FILTER +GMIME_STREAM_FILTER +GMIME_IS_STREAM_FILTER +GMIME_STREAM_FILTER_CLASS +GMIME_IS_STREAM_FILTER_CLASS +GMIME_STREAM_FILTER_GET_CLASS +</SECTION> + +<SECTION> +<FILE>gmime-filter</FILE> +GMimeFilter +g_mime_filter_copy +g_mime_filter_filter +g_mime_filter_complete +g_mime_filter_reset +g_mime_filter_backup +g_mime_filter_set_size + +<SUBSECTION Private> +g_mime_filter_get_type + +<SUBSECTION Standard> +GMimeFilterClass +GMIME_TYPE_FILTER +GMIME_FILTER +GMIME_IS_FILTER +GMIME_FILTER_CLASS +GMIME_IS_FILTER_CLASS +GMIME_FILTER_GET_CLASS +</SECTION> + +<SECTION> +<FILE>gmime-filter-basic</FILE> +GMimeFilterBasic +g_mime_filter_basic_new + +<SUBSECTION Private> +g_mime_filter_basic_get_type + +<SUBSECTION Standard> +GMimeFilterBasicClass +GMIME_TYPE_FILTER_BASIC +GMIME_FILTER_BASIC +GMIME_IS_FILTER_BASIC +GMIME_FILTER_BASIC_CLASS +GMIME_IS_FILTER_BASIC_CLASS +GMIME_FILTER_BASIC_GET_CLASS +</SECTION> + +<SECTION> +<FILE>gmime-filter-best</FILE> +GMimeFilterBest +GMimeFilterBestFlags +g_mime_filter_best_new +g_mime_filter_best_charset +g_mime_filter_best_encoding + +<SUBSECTION Private> +g_mime_filter_best_get_type + +<SUBSECTION Standard> +GMimeFilterBestClass +GMIME_TYPE_FILTER_BEST +GMIME_FILTER_BEST +GMIME_IS_FILTER_BEST +GMIME_FILTER_BEST_CLASS +GMIME_IS_FILTER_BEST_CLASS +GMIME_FILTER_BEST_GET_CLASS +</SECTION> + +<SECTION> +<FILE>gmime-filter-charset</FILE> +GMimeFilterCharset +g_mime_filter_charset_new + +<SUBSECTION Private> +g_mime_filter_charset_get_type + +<SUBSECTION Standard> +GMimeFilterCharsetClass +GMIME_TYPE_FILTER_CHARSET +GMIME_FILTER_CHARSET +GMIME_IS_FILTER_CHARSET +GMIME_FILTER_CHARSET_CLASS +GMIME_IS_FILTER_CHARSET_CLASS +GMIME_FILTER_CHARSET_GET_CLASS +</SECTION> + +<SECTION> +<FILE>gmime-filter-crlf</FILE> +GMimeFilterCRLF +g_mime_filter_crlf_new + +<SUBSECTION Private> +g_mime_filter_crlf_get_type + +<SUBSECTION Standard> +GMimeFilterCRLFClass +GMIME_TYPE_FILTER_CRLF +GMIME_FILTER_CRLF +GMIME_IS_FILTER_CRLF +GMIME_FILTER_CRLF_CLASS +GMIME_IS_FILTER_CRLF_CLASS +GMIME_FILTER_CRLF_GET_CLASS +</SECTION> + +<SECTION> +<FILE>gmime-filter-enriched</FILE> +GMIME_FILTER_ENRICHED_IS_RICHTEXT +GMimeFilterEnriched +g_mime_filter_enriched_new + +<SUBSECTION Private> +g_mime_filter_enriched_get_type + +<SUBSECTION Standard> +GMimeFilterEnrichedClass +GMIME_TYPE_FILTER_ENRICHED +GMIME_FILTER_ENRICHED +GMIME_IS_FILTER_ENRICHED +GMIME_FILTER_ENRICHED_CLASS +GMIME_IS_FILTER_ENRICHED_CLASS +GMIME_FILTER_ENRICHED_GET_CLASS +</SECTION> + +<SECTION> +<FILE>gmime-filter-from</FILE> +GMimeFilterFrom +GMimeFilterFromMode +g_mime_filter_from_new + +<SUBSECTION Private> +g_mime_filter_from_get_type + +<SUBSECTION Standard> +GMimeFilterFromClass +GMIME_TYPE_FILTER_FROM +GMIME_FILTER_FROM +GMIME_IS_FILTER_FROM +GMIME_FILTER_FROM_CLASS +GMIME_IS_FILTER_FROM_CLASS +GMIME_FILTER_FROM_GET_CLASS +</SECTION> + +<SECTION> +<FILE>gmime-filter-gzip</FILE> +GMimeFilterGZip +GMimeFilterGZipMode +g_mime_filter_gzip_new + +<SUBSECTION Private> +g_mime_filter_gzip_get_type + +<SUBSECTION Standard> +GMimeFilterGZipClass +GMIME_TYPE_FILTER_GZIP +GMIME_FILTER_GZIP +GMIME_IS_FILTER_GZIP +GMIME_FILTER_GZIP_CLASS +GMIME_IS_FILTER_GZIP_CLASS +GMIME_FILTER_GZIP_GET_CLASS +</SECTION> + +<SECTION> +<FILE>gmime-filter-html</FILE> +GMimeFilterHTML +GMIME_FILTER_HTML_PRE +GMIME_FILTER_HTML_CONVERT_NL +GMIME_FILTER_HTML_CONVERT_SPACES +GMIME_FILTER_HTML_CONVERT_URLS +GMIME_FILTER_HTML_MARK_CITATION +GMIME_FILTER_HTML_CONVERT_ADDRESSES +GMIME_FILTER_HTML_ESCAPE_8BIT +GMIME_FILTER_HTML_CITE +g_mime_filter_html_new + +<SUBSECTION Private> +g_mime_filter_html_get_type + +<SUBSECTION Standard> +GMimeFilterHTMLClass +GMIME_TYPE_FILTER_HTML +GMIME_FILTER_HTML +GMIME_IS_FILTER_HTML +GMIME_FILTER_HTML_CLASS +GMIME_IS_FILTER_HTML_CLASS +GMIME_FILTER_HTML_GET_CLASS +</SECTION> + +<SECTION> +<FILE>gmime-filter-md5</FILE> +GMimeFilterMd5 +g_mime_filter_md5_new +g_mime_filter_md5_get_digest + +<SUBSECTION Private> +g_mime_filter_md5_get_type + +<SUBSECTION Standard> +GMimeFilterMd5Class +GMIME_TYPE_FILTER_MD5 +GMIME_FILTER_MD5 +GMIME_IS_FILTER_MD5 +GMIME_FILTER_MD5_CLASS +GMIME_IS_FILTER_MD5_CLASS +GMIME_FILTER_MD5_GET_CLASS +</SECTION> + +<SECTION> +<FILE>gmime-filter-strip</FILE> +GMimeFilterStrip +g_mime_filter_strip_new + +<SUBSECTION Private> +g_mime_filter_strip_get_type + +<SUBSECTION Standard> +GMimeFilterStripClass +GMIME_TYPE_FILTER_STRIP +GMIME_FILTER_STRIP +GMIME_IS_FILTER_STRIP +GMIME_FILTER_STRIP_CLASS +GMIME_IS_FILTER_STRIP_CLASS +GMIME_FILTER_STRIP_GET_CLASS +</SECTION> + +<SECTION> +<FILE>gmime-filter-windows</FILE> +GMimeFilterWindows +g_mime_filter_windows_new +g_mime_filter_windows_is_windows_charset +g_mime_filter_windows_real_charset + +<SUBSECTION Private> +g_mime_filter_windows_get_type + +<SUBSECTION Standard> +GMimeFilterWindowsClass +GMIME_TYPE_FILTER_WINDOWS +GMIME_FILTER_WINDOWS +GMIME_IS_FILTER_WINDOWS +GMIME_FILTER_WINDOWS_CLASS +GMIME_IS_FILTER_WINDOWS_CLASS +GMIME_FILTER_WINDOWS_GET_CLASS +</SECTION> + +<SECTION> +<FILE>gmime-filter-yenc</FILE> +GMimeFilterYenc +g_mime_filter_yenc_new +g_mime_filter_yenc_set_state +g_mime_filter_yenc_set_crc +g_mime_filter_yenc_get_crc +g_mime_filter_yenc_get_pcrc + +<SUBSECTION> +GMIME_YENCODE_CRC_INIT +GMIME_YENCODE_CRC_FINAL +GMIME_YENCODE_STATE_INIT +GMIME_YDECODE_STATE_INIT +GMIME_YDECODE_STATE_EOLN +GMIME_YDECODE_STATE_ESCAPE +GMIME_YDECODE_STATE_END +GMIME_YDECODE_STATE_BEGIN +GMIME_YDECODE_STATE_DECODE +GMIME_YDECODE_STATE_PART +g_mime_ydecode_step +g_mime_yencode_step +g_mime_yencode_close + +<SUBSECTION Private> +g_mime_filter_yenc_get_type + +<SUBSECTION Standard> +GMimeFilterYencClass +GMIME_TYPE_FILTER_YENC +GMIME_FILTER_YENC +GMIME_IS_FILTER_YENC +GMIME_FILTER_YENC_CLASS +GMIME_IS_FILTER_YENC_CLASS +GMIME_FILTER_YENC_GET_CLASS +</SECTION> + +<SECTION> +<FILE>gmime-data-wrapper</FILE> +GMimeDataWrapper +g_mime_data_wrapper_new +g_mime_data_wrapper_new_with_stream +g_mime_data_wrapper_set_stream +g_mime_data_wrapper_get_stream +g_mime_data_wrapper_set_encoding +g_mime_data_wrapper_get_encoding +g_mime_data_wrapper_write_to_stream + +<SUBSECTION Private> +g_mime_data_wrapper_get_type + +<SUBSECTION Standard> +GMIME_DATA_WRAPPER +GMIME_IS_DATA_WRAPPER +GMIME_TYPE_DATA_WRAPPER +GMIME_DATA_WRAPPER_CLASS +GMIME_IS_DATA_WRAPPER_CLASS +GMIME_DATA_WRAPPER_GET_CLASS +GMimeDataWrapperClass +</SECTION> + +<SECTION> +<FILE>gmime-param</FILE> +GMimeParam +g_mime_param_new +g_mime_param_new_from_string +g_mime_param_destroy +g_mime_param_next +g_mime_param_get_name +g_mime_param_get_value +g_mime_param_append +g_mime_param_append_param +g_mime_param_write_to_string +</SECTION> + +<SECTION> +<FILE>gmime-header</FILE> +GMimeHeaderIter +GMimeHeaderList +GMimeHeaderWriter +GMimeHeaderForeachFunc +g_mime_header_iter_new +g_mime_header_iter_free +g_mime_header_iter_copy +g_mime_header_iter_copy_to +g_mime_header_iter_equal +g_mime_header_iter_first +g_mime_header_iter_last +g_mime_header_iter_next +g_mime_header_iter_prev +g_mime_header_iter_is_valid +g_mime_header_iter_get_name +g_mime_header_iter_get_value +g_mime_header_iter_set_value +g_mime_header_iter_remove +g_mime_header_list_new +g_mime_header_list_destroy +g_mime_header_list_clear +g_mime_header_list_contains +g_mime_header_list_prepend +g_mime_header_list_append +g_mime_header_list_remove +g_mime_header_list_set +g_mime_header_list_get +g_mime_header_list_get_iter +g_mime_header_list_foreach +g_mime_header_list_register_writer +g_mime_header_list_write_to_stream +g_mime_header_list_to_string +g_mime_header_list_get_stream +g_mime_header_list_set_stream +</SECTION> + +<SECTION> +<FILE>gmime-content-type</FILE> +GMimeContentType +g_mime_content_type_new +g_mime_content_type_new_from_string +g_mime_content_type_to_string +g_mime_content_type_is_type +g_mime_content_type_get_media_type +g_mime_content_type_set_media_type +g_mime_content_type_get_media_subtype +g_mime_content_type_set_media_subtype +g_mime_content_type_get_params +g_mime_content_type_set_params +g_mime_content_type_get_parameter +g_mime_content_type_set_parameter + +<SUBSECTION Private> +g_mime_content_type_get_type + +<SUBSECTION Standard> +GMIME_CONTENT_TYPE +GMIME_IS_CONTENT_TYPE +GMIME_TYPE_CONTENT_TYPE +GMIME_CONTENT_TYPE_CLASS +GMIME_IS_CONTENT_TYPE_CLASS +GMIME_CONTENT_TYPE_GET_CLASS +GMimeContentTypeClass +</SECTION> + +<SECTION> +<FILE>gmime-disposition</FILE> +GMIME_DISPOSITION_ATTACHMENT +GMIME_DISPOSITION_INLINE +GMimeContentDisposition +g_mime_content_disposition_new +g_mime_content_disposition_new_from_string +g_mime_content_disposition_set_disposition +g_mime_content_disposition_get_disposition +g_mime_content_disposition_get_params +g_mime_content_disposition_set_params +g_mime_content_disposition_set_parameter +g_mime_content_disposition_get_parameter +g_mime_content_disposition_to_string + +<SUBSECTION Private> +g_mime_content_disposition_get_type + +<SUBSECTION Standard> +GMIME_CONTENT_DISPOSITION +GMIME_IS_CONTENT_DISPOSITION +GMIME_TYPE_CONTENT_DISPOSITION +GMIME_CONTENT_DISPOSITION_CLASS +GMIME_IS_CONTENT_DISPOSITION_CLASS +GMIME_CONTENT_DISPOSITION_GET_CLASS +GMimeContentDispositionClass +</SECTION> + +<SECTION> +<FILE>gmime-object</FILE> +GMimeObject +GMimeObjectForeachFunc +g_mime_object_register_type +g_mime_object_new +g_mime_object_new_type +g_mime_object_set_content_type +g_mime_object_get_content_type +g_mime_object_set_content_type_parameter +g_mime_object_get_content_type_parameter +g_mime_object_set_disposition +g_mime_object_get_disposition +g_mime_object_set_content_disposition +g_mime_object_get_content_disposition +g_mime_object_set_content_disposition_parameter +g_mime_object_get_content_disposition_parameter +g_mime_object_set_content_id +g_mime_object_get_content_id +g_mime_object_prepend_header +g_mime_object_append_header +g_mime_object_remove_header +g_mime_object_set_header +g_mime_object_get_header +g_mime_object_get_headers +g_mime_object_get_header_list +g_mime_object_write_to_stream +g_mime_object_to_string +g_mime_object_encode + +<SUBSECTION Private> +g_mime_object_get_type + +<SUBSECTION Standard> +GMIME_OBJECT +GMIME_IS_OBJECT +GMIME_TYPE_OBJECT +GMIME_OBJECT_CLASS +GMIME_IS_OBJECT_CLASS +GMIME_OBJECT_GET_CLASS +GMimeObjectClass +</SECTION> + +<SECTION> +<FILE>gmime-part</FILE> +GMimePart +g_mime_part_new +g_mime_part_new_with_type +g_mime_part_set_content_description +g_mime_part_get_content_description +g_mime_part_set_content_id +g_mime_part_get_content_id +g_mime_part_set_content_md5 +g_mime_part_get_content_md5 +g_mime_part_verify_content_md5 +g_mime_part_set_content_location +g_mime_part_get_content_location +g_mime_part_set_content_encoding +g_mime_part_get_content_encoding +g_mime_part_get_best_content_encoding +g_mime_part_set_filename +g_mime_part_get_filename +g_mime_part_get_content_object +g_mime_part_set_content_object + +<SUBSECTION Private> +g_mime_part_get_type + +<SUBSECTION Standard> +GMIME_PART +GMIME_IS_PART +GMIME_TYPE_PART +GMIME_PART_CLASS +GMIME_IS_PART_CLASS +GMIME_PART_GET_CLASS +GMimePartClass +</SECTION> + +<SECTION> +<FILE>gmime-part-iter</FILE> +GMimePartIter +g_mime_part_iter_new +g_mime_part_iter_free +g_mime_part_iter_reset +g_mime_part_iter_jump_to +g_mime_part_iter_is_valid +g_mime_part_iter_next +g_mime_part_iter_prev +g_mime_part_iter_get_toplevel +g_mime_part_iter_get_current +g_mime_part_iter_get_parent +g_mime_part_iter_get_path +g_mime_part_iter_replace +g_mime_part_iter_remove +</SECTION> + +<SECTION> +<FILE>gmime-multipart</FILE> +GMimeMultipart +g_mime_multipart_new +g_mime_multipart_new_with_subtype +g_mime_multipart_set_preface +g_mime_multipart_get_preface +g_mime_multipart_set_postface +g_mime_multipart_get_postface +g_mime_multipart_set_boundary +g_mime_multipart_get_boundary +g_mime_multipart_get_count +g_mime_multipart_contains +g_mime_multipart_index_of +g_mime_multipart_add +g_mime_multipart_clear +g_mime_multipart_insert +g_mime_multipart_remove +g_mime_multipart_remove_at +g_mime_multipart_replace +g_mime_multipart_get_part +g_mime_multipart_foreach +g_mime_multipart_get_subpart_from_content_id + +<SUBSECTION Private> +g_mime_multipart_get_type + +<SUBSECTION Standard> +GMIME_MULTIPART +GMIME_IS_MULTIPART +GMIME_TYPE_MULTIPART +GMIME_MULTIPART_CLASS +GMIME_IS_MULTIPART_CLASS +GMIME_MULTIPART_GET_CLASS +GMimeMultipartClass +</SECTION> + +<SECTION> +<FILE>gmime-multipart-encrypted</FILE> +GMimeMultipartEncrypted +g_mime_multipart_encrypted_new +g_mime_multipart_encrypted_encrypt +g_mime_multipart_encrypted_decrypt + +<SUBSECTION Private> +g_mime_multipart_encrypted_get_type + +<SUBSECTION Standard> +GMIME_MULTIPART_ENCRYPTED +GMIME_IS_MULTIPART_ENCRYPTED +GMIME_TYPE_MULTIPART_ENCRYPTED +GMIME_MULTIPART_ENCRYPTED_CLASS +GMIME_IS_MULTIPART_ENCRYPTED_CLASS +GMIME_MULTIPART_ENCRYPTED_GET_CLASS +GMimeMultipartEncryptedClass +</SECTION> + +<SECTION> +<FILE>gmime-multipart-signed</FILE> +GMimeMultipartSigned +g_mime_multipart_signed_new +g_mime_multipart_signed_sign +g_mime_multipart_signed_verify + +<SUBSECTION Private> +g_mime_multipart_signed_get_type + +<SUBSECTION Standard> +GMIME_MULTIPART_SIGNED +GMIME_IS_MULTIPART_SIGNED +GMIME_TYPE_MULTIPART_SIGNED +GMIME_MULTIPART_SIGNED_CLASS +GMIME_IS_MULTIPART_SIGNED_CLASS +GMIME_MULTIPART_SIGNED_GET_CLASS +GMimeMultipartSignedClass +</SECTION> + +<SECTION> +<FILE>gmime-message</FILE> +GMimeRecipientType +GMimeMessage +g_mime_message_new +g_mime_message_set_sender +g_mime_message_get_sender +g_mime_message_set_reply_to +g_mime_message_get_reply_to +g_mime_message_add_recipient +g_mime_message_get_recipients +g_mime_message_get_all_recipients +g_mime_message_set_subject +g_mime_message_get_subject +g_mime_message_set_date +g_mime_message_get_date +g_mime_message_set_date_as_string +g_mime_message_get_date_as_string +g_mime_message_set_message_id +g_mime_message_get_message_id +g_mime_message_set_mime_part +g_mime_message_get_mime_part +g_mime_message_foreach +g_mime_message_get_body + +<SUBSECTION Private> +g_mime_message_get_type + +<SUBSECTION Standard> +GMIME_MESSAGE +GMIME_IS_MESSAGE +GMIME_TYPE_MESSAGE +GMIME_MESSAGE_CLASS +GMIME_IS_MESSAGE_CLASS +GMIME_MESSAGE_GET_CLASS +GMimeMessageClass +</SECTION> + +<SECTION> +<FILE>gmime-message-part</FILE> +GMimeMessagePart +g_mime_message_part_new +g_mime_message_part_new_with_message +g_mime_message_part_get_message +g_mime_message_part_set_message + +<SUBSECTION Private> +g_mime_message_part_get_type + +<SUBSECTION Standard> +GMIME_MESSAGE_PART +GMIME_IS_MESSAGE_PART +GMIME_TYPE_MESSAGE_PART +GMIME_MESSAGE_PART_CLASS +GMIME_IS_MESSAGE_PART_CLASS +GMIME_MESSAGE_PART_GET_CLASS +GMimeMessagePartClass +</SECTION> + +<SECTION> +<FILE>gmime-message-partial</FILE> +GMimeMessagePartial +g_mime_message_partial_new +g_mime_message_partial_get_id +g_mime_message_partial_get_number +g_mime_message_partial_get_total +g_mime_message_partial_reconstruct_message +g_mime_message_partial_split_message + +<SUBSECTION Private> +g_mime_message_partial_get_type + +<SUBSECTION Standard> +GMIME_MESSAGE_PARTIAL +GMIME_IS_MESSAGE_PARTIAL +GMIME_TYPE_MESSAGE_PARTIAL +GMIME_MESSAGE_PARTIAL_CLASS +GMIME_IS_MESSAGE_PARTIAL_CLASS +GMIME_MESSAGE_PARTIAL_GET_CLASS +GMimeMessagePartialClass +</SECTION> + +<SECTION> +<FILE>gmime-utils</FILE> +GMimeReferences +g_mime_utils_header_decode_date +g_mime_utils_header_format_date +g_mime_utils_generate_message_id +g_mime_utils_decode_message_id +g_mime_references_get_message_id +g_mime_references_get_next +g_mime_references_decode +g_mime_references_append +g_mime_references_clear +g_mime_references_free +g_mime_utils_header_fold +g_mime_utils_header_printf +g_mime_utils_quote_string +g_mime_utils_unquote_string +g_mime_utils_text_is_8bit +g_mime_utils_best_encoding +g_mime_utils_decode_8bit +g_mime_utils_header_decode_text +g_mime_utils_header_encode_text +g_mime_utils_header_decode_phrase +g_mime_utils_header_encode_phrase +g_mime_utils_structured_header_fold +g_mime_utils_unstructured_header_fold +</SECTION> + +<SECTION> +<FILE>gmime-encodings</FILE> +GMimeContentEncoding +g_mime_content_encoding_from_string +g_mime_content_encoding_to_string +GMimeEncodingConstraint +GMimeEncoding +g_mime_encoding_init_encode +g_mime_encoding_init_decode +g_mime_encoding_reset +g_mime_encoding_outlen +g_mime_encoding_step +g_mime_encoding_flush +GMIME_BASE64_ENCODE_LEN +g_mime_encoding_base64_decode_step +g_mime_encoding_base64_encode_step +g_mime_encoding_base64_encode_close +GMIME_UUDECODE_STATE_INIT +GMIME_UUDECODE_STATE_BEGIN +GMIME_UUDECODE_STATE_END +GMIME_UUENCODE_LEN +g_mime_encoding_uudecode_step +g_mime_encoding_uuencode_step +g_mime_encoding_uuencode_close +GMIME_QP_ENCODE_LEN +g_mime_encoding_quoted_decode_step +g_mime_encoding_quoted_encode_step +g_mime_encoding_quoted_encode_close + +<SUBSECTION Private> +GMIME_UUDECODE_STATE_MASK + +</SECTION> + +<SECTION> +<FILE>internet-address</FILE> +InternetAddress +internet_address_get_name +internet_address_set_name +internet_address_to_string + +<SUBSECTION Private> +internet_address_get_type + +<SUBSECTION Standard> +INTERNET_ADDRESS +IS_INTERNET_ADDRESS +INTERNET_ADDRESS_TYPE +INTERNET_ADDRESS_CLASS +IS_INTERNET_ADDRESS_CLASS +INTERNET_ADDRESS_GET_CLASS +InternetAddressClass +</SECTION> + +<SECTION> +<FILE>internet-address-group</FILE> +InternetAddressGroup +internet_address_group_new +internet_address_group_get_members +internet_address_group_set_members +internet_address_group_add_member + +<SUBSECTION Private> +internet_address_group_get_type + +<SUBSECTION Standard> +INTERNET_ADDRESS_GROUP +INTERNET_ADDRESS_IS_GROUP +INTERNET_ADDRESS_TYPE_GROUP +INTERNET_ADDRESS_GROUP_CLASS +INTERNET_ADDRESS_IS_GROUP_CLASS +InternetAddressGroupClass +</SECTION> + +<SECTION> +<FILE>internet-address-mailbox</FILE> +InternetAddressMailbox +internet_address_mailbox_new +internet_address_mailbox_get_addr +internet_address_mailbox_set_addr + +<SUBSECTION Private> +internet_address_mailbox_get_type + +<SUBSECTION Standard> +INTERNET_ADDRESS_MAILBOX +INTERNET_ADDRESS_IS_MAILBOX +INTERNET_ADDRESS_TYPE_MAILBOX +INTERNET_ADDRESS_MAILBOX_CLASS +INTERNET_ADDRESS_IS_MAILBOX_CLASS +InternetAddressMailboxClass +</SECTION> + +<SECTION> +<FILE>internet-address-list</FILE> +InternetAddressList +internet_address_list_new +internet_address_list_length +internet_address_list_clear +internet_address_list_add +internet_address_list_insert +internet_address_list_remove +internet_address_list_remove_at +internet_address_list_contains +internet_address_list_index_of +internet_address_list_get_address +internet_address_list_set_address +internet_address_list_prepend +internet_address_list_append +internet_address_list_to_string +internet_address_list_parse_string +internet_address_list_writer + +<SUBSECTION Private> +internet_address_list_get_type + +<SUBSECTION Standard> +INTERNET_ADDRESS_LIST +IS_INTERNET_ADDRESS_LIST +INTERNET_ADDRESS_LIST_TYPE +INTERNET_ADDRESS_LIST_CLASS +IS_INTERNET_ADDRESS_LIST_CLASS +InternetAddressListClass +</SECTION> + +<SECTION> +<FILE>gmime-parser</FILE> +GMimeParser +GMimeParserHeaderRegexFunc +g_mime_parser_new +g_mime_parser_new_with_stream +g_mime_parser_init_with_stream +g_mime_parser_get_persist_stream +g_mime_parser_set_persist_stream +g_mime_parser_get_scan_from +g_mime_parser_set_scan_from +g_mime_parser_get_respect_content_length +g_mime_parser_set_respect_content_length +g_mime_parser_set_header_regex +g_mime_parser_tell +g_mime_parser_eos +g_mime_parser_construct_part +g_mime_parser_construct_message +g_mime_parser_get_from +g_mime_parser_get_from_offset +g_mime_parser_get_headers_begin +g_mime_parser_get_headers_end + +<SUBSECTION Private> +g_mime_parser_get_type + +<SUBSECTION Standard> +GMIME_PARSER +GMIME_IS_PARSER +GMIME_TYPE_PARSER +GMIME_PARSER_CLASS +GMIME_IS_PARSER_CLASS +GMIME_PARSER_GET_CLASS +GMimeParserClass +</SECTION> + +<SECTION> +<FILE>gmime-charset</FILE> +GMimeCharset +g_mime_charset_map_init +g_mime_charset_map_shutdown +g_mime_locale_charset +g_mime_locale_language +g_mime_charset_language +g_mime_charset_canon_name +g_mime_charset_iconv_name +g_mime_charset_name +g_mime_charset_locale_name +g_mime_charset_iso_to_windows +g_mime_charset_init +g_mime_charset_step +g_mime_charset_best_name +g_mime_charset_best +g_mime_charset_can_encode +g_mime_set_user_charsets +g_mime_user_charsets +</SECTION> + +<SECTION> +<FILE>gmime-iconv</FILE> +g_mime_iconv_init +g_mime_iconv_shutdown +g_mime_iconv_open +g_mime_iconv +g_mime_iconv_close +</SECTION> + +<SECTION> +<FILE>gmime-iconv-utils</FILE> +g_mime_iconv_strdup +g_mime_iconv_strndup +g_mime_iconv_utf8_to_locale +g_mime_iconv_utf8_to_locale_length +g_mime_iconv_locale_to_utf8 +g_mime_iconv_locale_to_utf8_length +</SECTION> + +<SECTION> +<FILE>gmime-certificate</FILE> +GMimePubKeyAlgo +GMimeDigestAlgo +GMimeCertificateTrust +GMimeCertificate +g_mime_certificate_new +g_mime_certificate_get_pubkey_algo +g_mime_certificate_set_pubkey_algo +g_mime_certificate_get_digest_algo +g_mime_certificate_set_digest_algo +g_mime_certificate_get_issuer_serial +g_mime_certificate_set_issuer_serial +g_mime_certificate_get_issuer_name +g_mime_certificate_set_issuer_name +g_mime_certificate_get_fingerprint +g_mime_certificate_set_fingerprint +g_mime_certificate_get_created +g_mime_certificate_set_created +g_mime_certificate_get_expires +g_mime_certificate_set_expires +g_mime_certificate_get_key_id +g_mime_certificate_set_key_id +g_mime_certificate_get_trust +g_mime_certificate_set_trust +g_mime_certificate_get_email +g_mime_certificate_set_email +g_mime_certificate_get_name +g_mime_certificate_set_name +<SUBSECTION> +GMimeCertificateList +g_mime_certificate_list_new +g_mime_certificate_list_length +g_mime_certificate_list_clear +g_mime_certificate_list_add +g_mime_certificate_list_insert +g_mime_certificate_list_remove +g_mime_certificate_list_remove_at +g_mime_certificate_list_contains +g_mime_certificate_list_index_of +g_mime_certificate_list_get_certificate +g_mime_certificate_list_set_certificate +<SUBSECTION Private> +g_mime_certificate_get_type +g_mime_certificate_list_get_type + +<SUBSECTION Standard> +GMIME_CERTIFICATE +GMIME_IS_CERTIFICATE +GMIME_TYPE_CERTIFICATE +GMIME_CERTIFICATE_CLASS +GMIME_IS_CERTIFICATE_CLASS +GMIME_CERTIFICATE_GET_CLASS +GMimeCertificateClass +GMIME_CERTIFICATE_LIST +GMIME_IS_CERTIFICATE_LIST +GMIME_TYPE_CERTIFICATE_LIST +GMIME_CERTIFICATE_LIST_CLASS +GMIME_IS_CERTIFICATE_LIST_CLASS +GMIME_CERTIFICATE_LIST_GET_CLASS +GMimeCertificateListClass +</SECTION> + +<SECTION> +<FILE>gmime-signature</FILE> +GMimeSignatureStatus +GMimeSignatureError +GMimeSignature +g_mime_signature_new +g_mime_signature_get_certificate +g_mime_signature_set_certificate +g_mime_signature_get_status +g_mime_signature_set_status +g_mime_signature_get_errors +g_mime_signature_set_errors +g_mime_signature_get_created +g_mime_signature_set_created +g_mime_signature_get_expires +g_mime_signature_set_expires +<SUBSECTION> +GMimeSignatureList +g_mime_signature_list_new +g_mime_signature_list_length +g_mime_signature_list_clear +g_mime_signature_list_add +g_mime_signature_list_insert +g_mime_signature_list_remove +g_mime_signature_list_remove_at +g_mime_signature_list_contains +g_mime_signature_list_index_of +g_mime_signature_list_get_signature +g_mime_signature_list_set_signature +<SUBSECTION Private> +g_mime_signature_get_type +g_mime_signature_list_get_type + +<SUBSECTION Standard> +GMIME_SIGNATURE +GMIME_IS_SIGNATURE +GMIME_TYPE_SIGNATURE +GMIME_SIGNATURE_CLASS +GMIME_IS_SIGNATURE_CLASS +GMIME_SIGNATURE_GET_CLASS +GMimeSignatureClass +GMIME_SIGNATURE_LIST +GMIME_IS_SIGNATURE_LIST +GMIME_TYPE_SIGNATURE_LIST +GMIME_SIGNATURE_LIST_CLASS +GMIME_IS_SIGNATURE_LIST_CLASS +GMIME_SIGNATURE_LIST_GET_CLASS +GMimeSignatureListClass +</SECTION> + +<SECTION> +<FILE>gmime-crypto-context</FILE> +GMimePasswordRequestFunc +GMimeCryptoContext +g_mime_crypto_context_set_request_password +g_mime_crypto_context_get_signature_protocol +g_mime_crypto_context_get_encryption_protocol +g_mime_crypto_context_get_key_exchange_protocol +g_mime_crypto_context_digest_id +g_mime_crypto_context_digest_name +g_mime_crypto_context_sign +g_mime_crypto_context_verify +g_mime_crypto_context_encrypt +g_mime_crypto_context_decrypt +g_mime_crypto_context_import_keys +g_mime_crypto_context_export_keys +<SUBSECTION> +GMimeCipherAlgo +GMimeDecryptResult +g_mime_decrypt_result_new +g_mime_decrypt_result_get_recipients +g_mime_decrypt_result_set_recipients +g_mime_decrypt_result_get_signatures +g_mime_decrypt_result_set_signatures +g_mime_decrypt_result_get_cipher +g_mime_decrypt_result_set_cipher +g_mime_decrypt_result_get_mdc +g_mime_decrypt_result_set_mdc +<SUBSECTION Private> +g_mime_crypto_context_get_type +g_mime_decrypt_result_get_type + +<SUBSECTION Standard> +GMIME_CRYPTO_CONTEXT +GMIME_IS_CRYPTO_CONTEXT +GMIME_TYPE_CRYPTO_CONTEXT +GMIME_CRYPTO_CONTEXT_CLASS +GMIME_IS_CRYPTO_CONTEXT_CLASS +GMIME_CRYPTO_CONTEXT_GET_CLASS +GMimeCryptoContextClass +GMIME_DECRYPT_RESULT +GMIME_IS_DECRYPT_RESULT +GMIME_TYPE_DECRYPT_RESULT +GMIME_DECRYPT_RESULT_CLASS +GMIME_IS_DECRYPT_RESULT_CLASS +GMIME_DECRYPT_RESULT_GET_CLASS +GMimeDecryptResultClass +</SECTION> + +<SECTION> +<FILE>gmime-gpg-context</FILE> +GMimeGpgContext +g_mime_gpg_context_new +g_mime_gpg_context_get_always_trust +g_mime_gpg_context_set_always_trust +g_mime_gpg_context_get_auto_key_retrieve +g_mime_gpg_context_set_auto_key_retrieve +g_mime_gpg_context_get_use_agent +g_mime_gpg_context_set_use_agent + +<SUBSECTION Private> +g_mime_gpg_context_get_type + +<SUBSECTION Standard> +GMIME_GPG_CONTEXT +GMIME_IS_GPG_CONTEXT +GMIME_TYPE_GPG_CONTEXT +GMIME_GPG_CONTEXT_CLASS +GMIME_IS_GPG_CONTEXT_CLASS +GMIME_GPG_CONTEXT_GET_CLASS +GMimeGpgContextClass +</SECTION> + +<SECTION> +<FILE>gmime-pkcs7-context</FILE> +GMimePkcs7Context +g_mime_pkcs7_context_new +g_mime_pkcs7_context_get_always_trust +g_mime_pkcs7_context_set_always_trust + +<SUBSECTION Private> +g_mime_pkcs7_context_get_type + +<SUBSECTION Standard> +GMIME_PKCS7_CONTEXT +GMIME_IS_PKCS7_CONTEXT +GMIME_TYPE_PKCS7_CONTEXT +GMIME_PKCS7_CONTEXT_CLASS +GMIME_IS_PKCS7_CONTEXT_CLASS +GMIME_PKCS7_CONTEXT_GET_CLASS +GMimePkcs7ContextClass +</SECTION> diff --git a/docs/reference/gmime.hierarchy b/docs/reference/gmime.hierarchy new file mode 100644 index 0000000..ed64b5e --- /dev/null +++ b/docs/reference/gmime.hierarchy @@ -0,0 +1,49 @@ +GObject + GMimeObject + GMimeMessage + GMimePart + GMimeMessagePartial + GMimeMultipart + GMimeMultipartEncrypted + GMimeMultipartSigned + GMimeMessagePart + GMimeContentType + GMimeContentDisposition + InternetAddress + InternetAddressGroup + InternetAddressMailbox + InternetAddressList + GMimeCertificate + GMimeCertificateList + GMimeSignature + GMimeSignatureList + GMimeCryptoContext + GMimeGpgContext + GMimePkcs7Context + GMimeDataWrapper + GMimeFilter + GMimeFilterBasic + GMimeFilterBest + GMimeFilterCharset + GMimeFilterCRLF + GMimeFilterEnriched + GMimeFilterFrom + GMimeFilterGZip + GMimeFilterHTML + GMimeFilterMd5 + GMimeFilterStrip + GMimeFilterWindows + GMimeFilterYenc + GMimeParser + GMimeStream + GMimeStreamBuffer + GMimeStreamCat + GMimeStreamFile + GMimeStreamFilter + GMimeStreamFs + GMimeStreamMem + GMimeStreamMmap + GMimeStreamNull + GMimeStreamPipe +GInterface + GTypePlugin diff --git a/docs/reference/html/CryptoContexts.html b/docs/reference/html/CryptoContexts.html new file mode 100644 index 0000000..7eef6aa --- /dev/null +++ b/docs/reference/html/CryptoContexts.html @@ -0,0 +1,47 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Cryptography Contexts</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="classes.html" title="Part IV. GMime Classes"> +<link rel="prev" href="GMimeParser.html" title="GMimeParser"> +<link rel="next" href="GMimeCertificate.html" title="GMimeCertificate"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="GMimeParser.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="classes.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="GMimeCertificate.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="CryptoContexts"></a>Cryptography Contexts</h2></div></div></div> +<div class="toc"><dl> +<dt> +<span class="refentrytitle"><a href="GMimeCertificate.html">GMimeCertificate</a></span><span class="refpurpose"> — Digital certificates</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeSignature.html">GMimeSignature</a></span><span class="refpurpose"> — Digital signatures</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeCryptoContext.html">GMimeCryptoContext</a></span><span class="refpurpose"> — Encryption/signing contexts</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeGpgContext.html">GMimeGpgContext</a></span><span class="refpurpose"> — GnuPG crypto contexts</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimePkcs7Context.html">GMimePkcs7Context</a></span><span class="refpurpose"> — PKCS7 crypto contexts</span> +</dt> +</dl></div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/DataWrappers.html b/docs/reference/html/DataWrappers.html new file mode 100644 index 0000000..3d67bd1 --- /dev/null +++ b/docs/reference/html/DataWrappers.html @@ -0,0 +1,33 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Data Wrappers</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="classes.html" title="Part IV. GMime Classes"> +<link rel="prev" href="GMimeFilterYenc.html" title="GMimeFilterYenc"> +<link rel="next" href="GMimeDataWrapper.html" title="GMimeDataWrapper"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="GMimeFilterYenc.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="classes.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="GMimeDataWrapper.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="DataWrappers"></a>Data Wrappers</h2></div></div></div> +<div class="toc"><dl><dt> +<span class="refentrytitle"><a href="GMimeDataWrapper.html">GMimeDataWrapper</a></span><span class="refpurpose"> — Content objects</span> +</dt></dl></div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/Filters.html b/docs/reference/html/Filters.html new file mode 100644 index 0000000..4b61a2e --- /dev/null +++ b/docs/reference/html/Filters.html @@ -0,0 +1,71 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Stream Filters</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="classes.html" title="Part IV. GMime Classes"> +<link rel="prev" href="GMimeStreamCat.html" title="GMimeStreamCat"> +<link rel="next" href="GMimeFilter.html" title="GMimeFilter"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="GMimeStreamCat.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="classes.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="GMimeFilter.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="Filters"></a>Stream Filters</h2></div></div></div> +<div class="toc"><dl> +<dt> +<span class="refentrytitle"><a href="GMimeFilter.html">GMimeFilter</a></span><span class="refpurpose"> — Abstract filter class</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeFilterBasic.html">GMimeFilterBasic</a></span><span class="refpurpose"> — Basic transfer encoding filter</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeFilterBest.html">GMimeFilterBest</a></span><span class="refpurpose"> — Determine the best charset/encoding to use for a stream</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeFilterCharset.html">GMimeFilterCharset</a></span><span class="refpurpose"> — Charset-conversion filter</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeFilterCRLF.html">GMimeFilterCRLF</a></span><span class="refpurpose"> — Convert line-endings from LF to CRLF or vise versa</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeFilterEnriched.html">GMimeFilterEnriched</a></span><span class="refpurpose"> — Convert text/enriched or text/rtf to HTML</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeFilterFrom.html">GMimeFilterFrom</a></span><span class="refpurpose"> — Escape MBox From_ lines</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeFilterGZip.html">GMimeFilterGZip</a></span><span class="refpurpose"> — GNU Zip compression/decompression</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeFilterHTML.html">GMimeFilterHTML</a></span><span class="refpurpose"> — Convert plain text into HTML</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeFilterMd5.html">GMimeFilterMd5</a></span><span class="refpurpose"> — Calculate an md5sum</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeFilterStrip.html">GMimeFilterStrip</a></span><span class="refpurpose"> — Strip trailing whitespace from the end of lines</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeFilterWindows.html">GMimeFilterWindows</a></span><span class="refpurpose"> — Determine if text is in a Microsoft Windows codepage</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeFilterYenc.html">GMimeFilterYenc</a></span><span class="refpurpose"> — yEncode or yDecode</span> +</dt> +</dl></div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/GMimeCertificate.html b/docs/reference/html/GMimeCertificate.html new file mode 100644 index 0000000..07fab4f --- /dev/null +++ b/docs/reference/html/GMimeCertificate.html @@ -0,0 +1,1160 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimeCertificate</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="CryptoContexts.html" title="Cryptography Contexts"> +<link rel="prev" href="CryptoContexts.html" title="Cryptography Contexts"> +<link rel="next" href="GMimeSignature.html" title="GMimeSignature"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="CryptoContexts.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="CryptoContexts.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="GMimeSignature.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GMimeCertificate.synopsis" class="shortcut">Top</a> +  | + <a href="#GMimeCertificate.description" class="shortcut">Description</a> +  | + <a href="#GMimeCertificate.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GMimeCertificate"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GMimeCertificate.top_of_page"></a>GMimeCertificate</span></h2> +<p>GMimeCertificate — Digital certificates</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GMimeCertificate.synopsis"></a><h2>Synopsis</h2> +<a name="GMimeCertificateList"></a><pre class="synopsis">enum <a class="link" href="GMimeCertificate.html#GMimePubKeyAlgo" title="enum GMimePubKeyAlgo">GMimePubKeyAlgo</a>; +enum <a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo">GMimeDigestAlgo</a>; +enum <a class="link" href="GMimeCertificate.html#GMimeCertificateTrust" title="enum GMimeCertificateTrust">GMimeCertificateTrust</a>; +struct <a class="link" href="GMimeCertificate.html#GMimeCertificate-struct" title="struct GMimeCertificate">GMimeCertificate</a>; +<a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="returnvalue">GMimeCertificate</span></a> * <a class="link" href="GMimeCertificate.html#g-mime-certificate-new" title="g_mime_certificate_new ()">g_mime_certificate_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +<a class="link" href="GMimeCertificate.html#GMimePubKeyAlgo" title="enum GMimePubKeyAlgo"><span class="returnvalue">GMimePubKeyAlgo</span></a> <a class="link" href="GMimeCertificate.html#g-mime-certificate-get-pubkey-algo" title="g_mime_certificate_get_pubkey_algo ()">g_mime_certificate_get_pubkey_algo</a> (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeCertificate.html#g-mime-certificate-set-pubkey-algo" title="g_mime_certificate_set_pubkey_algo ()">g_mime_certificate_set_pubkey_algo</a> (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimePubKeyAlgo" title="enum GMimePubKeyAlgo"><span class="type">GMimePubKeyAlgo</span></a> algo</code></em>); +<a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="returnvalue">GMimeDigestAlgo</span></a> <a class="link" href="GMimeCertificate.html#g-mime-certificate-get-digest-algo" title="g_mime_certificate_get_digest_algo ()">g_mime_certificate_get_digest_algo</a> (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeCertificate.html#g-mime-certificate-set-digest-algo" title="g_mime_certificate_set_digest_algo ()">g_mime_certificate_set_digest_algo</a> (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="type">GMimeDigestAlgo</span></a> algo</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="GMimeCertificate.html#g-mime-certificate-get-issuer-serial" title="g_mime_certificate_get_issuer_serial ()">g_mime_certificate_get_issuer_serial</a> + (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeCertificate.html#g-mime-certificate-set-issuer-serial" title="g_mime_certificate_set_issuer_serial ()">g_mime_certificate_set_issuer_serial</a> + (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *issuer_serial</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="GMimeCertificate.html#g-mime-certificate-get-issuer-name" title="g_mime_certificate_get_issuer_name ()">g_mime_certificate_get_issuer_name</a> (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeCertificate.html#g-mime-certificate-set-issuer-name" title="g_mime_certificate_set_issuer_name ()">g_mime_certificate_set_issuer_name</a> (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *issuer_name</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="GMimeCertificate.html#g-mime-certificate-get-fingerprint" title="g_mime_certificate_get_fingerprint ()">g_mime_certificate_get_fingerprint</a> (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeCertificate.html#g-mime-certificate-set-fingerprint" title="g_mime_certificate_set_fingerprint ()">g_mime_certificate_set_fingerprint</a> (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *fingerprint</code></em>); +<span class="returnvalue">time_t</span> <a class="link" href="GMimeCertificate.html#g-mime-certificate-get-created" title="g_mime_certificate_get_created ()">g_mime_certificate_get_created</a> (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeCertificate.html#g-mime-certificate-set-created" title="g_mime_certificate_set_created ()">g_mime_certificate_set_created</a> (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>, + <em class="parameter"><code><span class="type">time_t</span> created</code></em>); +<span class="returnvalue">time_t</span> <a class="link" href="GMimeCertificate.html#g-mime-certificate-get-expires" title="g_mime_certificate_get_expires ()">g_mime_certificate_get_expires</a> (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeCertificate.html#g-mime-certificate-set-expires" title="g_mime_certificate_set_expires ()">g_mime_certificate_set_expires</a> (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>, + <em class="parameter"><code><span class="type">time_t</span> expires</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="GMimeCertificate.html#g-mime-certificate-get-key-id" title="g_mime_certificate_get_key_id ()">g_mime_certificate_get_key_id</a> (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeCertificate.html#g-mime-certificate-set-key-id" title="g_mime_certificate_set_key_id ()">g_mime_certificate_set_key_id</a> (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *key_id</code></em>); +<a class="link" href="GMimeCertificate.html#GMimeCertificateTrust" title="enum GMimeCertificateTrust"><span class="returnvalue">GMimeCertificateTrust</span></a> <a class="link" href="GMimeCertificate.html#g-mime-certificate-get-trust" title="g_mime_certificate_get_trust ()">g_mime_certificate_get_trust</a> (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeCertificate.html#g-mime-certificate-set-trust" title="g_mime_certificate_set_trust ()">g_mime_certificate_set_trust</a> (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeCertificateTrust" title="enum GMimeCertificateTrust"><span class="type">GMimeCertificateTrust</span></a> trust</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="GMimeCertificate.html#g-mime-certificate-get-email" title="g_mime_certificate_get_email ()">g_mime_certificate_get_email</a> (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeCertificate.html#g-mime-certificate-set-email" title="g_mime_certificate_set_email ()">g_mime_certificate_set_email</a> (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *email</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="GMimeCertificate.html#g-mime-certificate-get-name" title="g_mime_certificate_get_name ()">g_mime_certificate_get_name</a> (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeCertificate.html#g-mime-certificate-set-name" title="g_mime_certificate_set_name ()">g_mime_certificate_set_name</a> (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *name</code></em>); + +struct <a class="link" href="GMimeCertificate.html#GMimeCertificateList-struct" title="struct GMimeCertificateList">GMimeCertificateList</a>; +<a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="returnvalue">GMimeCertificateList</span></a> * <a class="link" href="GMimeCertificate.html#g-mime-certificate-list-new" title="g_mime_certificate_list_new ()">g_mime_certificate_list_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +<span class="returnvalue">int</span> <a class="link" href="GMimeCertificate.html#g-mime-certificate-list-length" title="g_mime_certificate_list_length ()">g_mime_certificate_list_length</a> (<em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> *list</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeCertificate.html#g-mime-certificate-list-clear" title="g_mime_certificate_list_clear ()">g_mime_certificate_list_clear</a> (<em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> *list</code></em>); +<span class="returnvalue">int</span> <a class="link" href="GMimeCertificate.html#g-mime-certificate-list-add" title="g_mime_certificate_list_add ()">g_mime_certificate_list_add</a> (<em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> *list</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeCertificate.html#g-mime-certificate-list-insert" title="g_mime_certificate_list_insert ()">g_mime_certificate_list_insert</a> (<em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> *list</code></em>, + <em class="parameter"><code><span class="type">int</span> index</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="GMimeCertificate.html#g-mime-certificate-list-remove" title="g_mime_certificate_list_remove ()">g_mime_certificate_list_remove</a> (<em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> *list</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="GMimeCertificate.html#g-mime-certificate-list-remove-at" title="g_mime_certificate_list_remove_at ()">g_mime_certificate_list_remove_at</a> (<em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> *list</code></em>, + <em class="parameter"><code><span class="type">int</span> index</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="GMimeCertificate.html#g-mime-certificate-list-contains" title="g_mime_certificate_list_contains ()">g_mime_certificate_list_contains</a> (<em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> *list</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>); +<span class="returnvalue">int</span> <a class="link" href="GMimeCertificate.html#g-mime-certificate-list-index-of" title="g_mime_certificate_list_index_of ()">g_mime_certificate_list_index_of</a> (<em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> *list</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>); +<a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="returnvalue">GMimeCertificate</span></a> * <a class="link" href="GMimeCertificate.html#g-mime-certificate-list-get-certificate" title="g_mime_certificate_list_get_certificate ()">g_mime_certificate_list_get_certificate</a> + (<em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> *list</code></em>, + <em class="parameter"><code><span class="type">int</span> index</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeCertificate.html#g-mime-certificate-list-set-certificate" title="g_mime_certificate_list_set_certificate ()">g_mime_certificate_list_set_certificate</a> + (<em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> *list</code></em>, + <em class="parameter"><code><span class="type">int</span> index</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GMimeCertificate.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----GMimeCertificate +</pre> +<pre class="synopsis"> + GObject + +----GMimeCertificateList +</pre> +</div> +<div class="refsect1"> +<a name="GMimeCertificate.description"></a><h2>Description</h2> +<p> +A <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> is an object containing useful information about a +digital certificate as used in signing and encrypting data. +</p> +</div> +<div class="refsect1"> +<a name="GMimeCertificate.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimePubKeyAlgo"></a><h3>enum GMimePubKeyAlgo</h3> +<pre class="programlisting">typedef enum { + GMIME_PUBKEY_ALGO_DEFAULT = 0, + GMIME_PUBKEY_ALGO_RSA = 1, + GMIME_PUBKEY_ALGO_RSA_E = 2, + GMIME_PUBKEY_ALGO_RSA_S = 3, + GMIME_PUBKEY_ALGO_ELG_E = 16, + GMIME_PUBKEY_ALGO_DSA = 17, + GMIME_PUBKEY_ALGO_ELG = 20 +} GMimePubKeyAlgo; +</pre> +<p> +A public-key algorithm. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><a name="GMIME-PUBKEY-ALGO-DEFAULT:CAPS"></a><span class="term"><code class="literal">GMIME_PUBKEY_ALGO_DEFAULT</code></span></p></td> +<td>The default public-key algorithm. +</td> +</tr> +<tr> +<td><p><a name="GMIME-PUBKEY-ALGO-RSA:CAPS"></a><span class="term"><code class="literal">GMIME_PUBKEY_ALGO_RSA</code></span></p></td> +<td>The RSA algorithm. +</td> +</tr> +<tr> +<td><p><a name="GMIME-PUBKEY-ALGO-RSA-E:CAPS"></a><span class="term"><code class="literal">GMIME_PUBKEY_ALGO_RSA_E</code></span></p></td> +<td>An encryption-only RSA algorithm. +</td> +</tr> +<tr> +<td><p><a name="GMIME-PUBKEY-ALGO-RSA-S:CAPS"></a><span class="term"><code class="literal">GMIME_PUBKEY_ALGO_RSA_S</code></span></p></td> +<td>A signature-only RSA algorithm. +</td> +</tr> +<tr> +<td><p><a name="GMIME-PUBKEY-ALGO-ELG-E:CAPS"></a><span class="term"><code class="literal">GMIME_PUBKEY_ALGO_ELG_E</code></span></p></td> +<td>An encryption-only ElGamal algorithm. +</td> +</tr> +<tr> +<td><p><a name="GMIME-PUBKEY-ALGO-DSA:CAPS"></a><span class="term"><code class="literal">GMIME_PUBKEY_ALGO_DSA</code></span></p></td> +<td>The DSA algorithm. +</td> +</tr> +<tr> +<td><p><a name="GMIME-PUBKEY-ALGO-ELG:CAPS"></a><span class="term"><code class="literal">GMIME_PUBKEY_ALGO_ELG</code></span></p></td> +<td>The ElGamal algorithm. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="GMimeDigestAlgo"></a><h3>enum GMimeDigestAlgo</h3> +<pre class="programlisting">typedef enum { + GMIME_DIGEST_ALGO_DEFAULT = 0, + GMIME_DIGEST_ALGO_MD5 = 1, + GMIME_DIGEST_ALGO_SHA1 = 2, + GMIME_DIGEST_ALGO_RIPEMD160 = 3, + GMIME_DIGEST_ALGO_MD2 = 5, + GMIME_DIGEST_ALGO_TIGER192 = 6, + GMIME_DIGEST_ALGO_HAVAL5160 = 7, + GMIME_DIGEST_ALGO_SHA256 = 8, + GMIME_DIGEST_ALGO_SHA384 = 9, + GMIME_DIGEST_ALGO_SHA512 = 10, + GMIME_DIGEST_ALGO_SHA224 = 11, + GMIME_DIGEST_ALGO_MD4 = 301 +} GMimeDigestAlgo; +</pre> +<p> +A hash algorithm. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><a name="GMIME-DIGEST-ALGO-DEFAULT:CAPS"></a><span class="term"><code class="literal">GMIME_DIGEST_ALGO_DEFAULT</code></span></p></td> +<td>The default hash algorithm. +</td> +</tr> +<tr> +<td><p><a name="GMIME-DIGEST-ALGO-MD5:CAPS"></a><span class="term"><code class="literal">GMIME_DIGEST_ALGO_MD5</code></span></p></td> +<td>The MD5 hash algorithm. +</td> +</tr> +<tr> +<td><p><a name="GMIME-DIGEST-ALGO-SHA1:CAPS"></a><span class="term"><code class="literal">GMIME_DIGEST_ALGO_SHA1</code></span></p></td> +<td>The SHA-1 hash algorithm. +</td> +</tr> +<tr> +<td><p><a name="GMIME-DIGEST-ALGO-RIPEMD160:CAPS"></a><span class="term"><code class="literal">GMIME_DIGEST_ALGO_RIPEMD160</code></span></p></td> +<td>The RIPEMD-160 hash algorithm. +</td> +</tr> +<tr> +<td><p><a name="GMIME-DIGEST-ALGO-MD2:CAPS"></a><span class="term"><code class="literal">GMIME_DIGEST_ALGO_MD2</code></span></p></td> +<td>The MD2 hash algorithm. +</td> +</tr> +<tr> +<td><p><a name="GMIME-DIGEST-ALGO-TIGER192:CAPS"></a><span class="term"><code class="literal">GMIME_DIGEST_ALGO_TIGER192</code></span></p></td> +<td>The TIGER-192 hash algorithm. +</td> +</tr> +<tr> +<td><p><a name="GMIME-DIGEST-ALGO-HAVAL5160:CAPS"></a><span class="term"><code class="literal">GMIME_DIGEST_ALGO_HAVAL5160</code></span></p></td> +<td>The HAVAL-5-160 hash algorithm. +</td> +</tr> +<tr> +<td><p><a name="GMIME-DIGEST-ALGO-SHA256:CAPS"></a><span class="term"><code class="literal">GMIME_DIGEST_ALGO_SHA256</code></span></p></td> +<td>The SHA-256 hash algorithm. +</td> +</tr> +<tr> +<td><p><a name="GMIME-DIGEST-ALGO-SHA384:CAPS"></a><span class="term"><code class="literal">GMIME_DIGEST_ALGO_SHA384</code></span></p></td> +<td>The SHA-384 hash algorithm. +</td> +</tr> +<tr> +<td><p><a name="GMIME-DIGEST-ALGO-SHA512:CAPS"></a><span class="term"><code class="literal">GMIME_DIGEST_ALGO_SHA512</code></span></p></td> +<td>The SHA-512 hash algorithm. +</td> +</tr> +<tr> +<td><p><a name="GMIME-DIGEST-ALGO-SHA224:CAPS"></a><span class="term"><code class="literal">GMIME_DIGEST_ALGO_SHA224</code></span></p></td> +<td>The SHA-224 hash algorithm. +</td> +</tr> +<tr> +<td><p><a name="GMIME-DIGEST-ALGO-MD4:CAPS"></a><span class="term"><code class="literal">GMIME_DIGEST_ALGO_MD4</code></span></p></td> +<td>The MD4 hash algorithm. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="GMimeCertificateTrust"></a><h3>enum GMimeCertificateTrust</h3> +<pre class="programlisting">typedef enum { + GMIME_CERTIFICATE_TRUST_NONE, + GMIME_CERTIFICATE_TRUST_NEVER, + GMIME_CERTIFICATE_TRUST_UNDEFINED, + GMIME_CERTIFICATE_TRUST_MARGINAL, + GMIME_CERTIFICATE_TRUST_FULLY, + GMIME_CERTIFICATE_TRUST_ULTIMATE +} GMimeCertificateTrust; +</pre> +<p> +The trust value of a certificate. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><a name="GMIME-CERTIFICATE-TRUST-NONE:CAPS"></a><span class="term"><code class="literal">GMIME_CERTIFICATE_TRUST_NONE</code></span></p></td> +<td>No trust assigned. +</td> +</tr> +<tr> +<td><p><a name="GMIME-CERTIFICATE-TRUST-NEVER:CAPS"></a><span class="term"><code class="literal">GMIME_CERTIFICATE_TRUST_NEVER</code></span></p></td> +<td>Never trust this certificate. +</td> +</tr> +<tr> +<td><p><a name="GMIME-CERTIFICATE-TRUST-UNDEFINED:CAPS"></a><span class="term"><code class="literal">GMIME_CERTIFICATE_TRUST_UNDEFINED</code></span></p></td> +<td>Undefined trust for this certificate. +</td> +</tr> +<tr> +<td><p><a name="GMIME-CERTIFICATE-TRUST-MARGINAL:CAPS"></a><span class="term"><code class="literal">GMIME_CERTIFICATE_TRUST_MARGINAL</code></span></p></td> +<td>Trust this certificate maginally. +</td> +</tr> +<tr> +<td><p><a name="GMIME-CERTIFICATE-TRUST-FULLY:CAPS"></a><span class="term"><code class="literal">GMIME_CERTIFICATE_TRUST_FULLY</code></span></p></td> +<td>Trust this certificate fully. +</td> +</tr> +<tr> +<td><p><a name="GMIME-CERTIFICATE-TRUST-ULTIMATE:CAPS"></a><span class="term"><code class="literal">GMIME_CERTIFICATE_TRUST_ULTIMATE</code></span></p></td> +<td>Trust this certificate ultimately. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="GMimeCertificate-struct"></a><h3>struct GMimeCertificate</h3> +<pre class="programlisting">struct GMimeCertificate;</pre> +<p> +An object containing useful information about a certificate. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-certificate-new"></a><h3>g_mime_certificate_new ()</h3> +<pre class="programlisting"><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="returnvalue">GMimeCertificate</span></a> * g_mime_certificate_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Creates a new <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> object. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a new <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> object.</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-certificate-get-pubkey-algo"></a><h3>g_mime_certificate_get_pubkey_algo ()</h3> +<pre class="programlisting"><a class="link" href="GMimeCertificate.html#GMimePubKeyAlgo" title="enum GMimePubKeyAlgo"><span class="returnvalue">GMimePubKeyAlgo</span></a> g_mime_certificate_get_pubkey_algo (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>);</pre> +<p> +Get the public-key algorithm used by the certificate. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>cert</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the public-key algorithm used by the certificate or +<a class="link" href="GMimeCertificate.html#GMIME-PUBKEY-ALGO-DEFAULT:CAPS"><span class="type">GMIME_PUBKEY_ALGO_DEFAULT</span></a> if unspecified.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-certificate-set-pubkey-algo"></a><h3>g_mime_certificate_set_pubkey_algo ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_certificate_set_pubkey_algo (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimePubKeyAlgo" title="enum GMimePubKeyAlgo"><span class="type">GMimePubKeyAlgo</span></a> algo</code></em>);</pre> +<p> +Set the public-key algorithm used by the certificate. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>cert</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>algo</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html#GMimePubKeyAlgo" title="enum GMimePubKeyAlgo"><span class="type">GMimePubKeyAlgo</span></a> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-certificate-get-digest-algo"></a><h3>g_mime_certificate_get_digest_algo ()</h3> +<pre class="programlisting"><a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="returnvalue">GMimeDigestAlgo</span></a> g_mime_certificate_get_digest_algo (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>);</pre> +<p> +Get the digest algorithm used by the certificate. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>cert</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the digest algorithm used by the certificate or +<a class="link" href="GMimeCertificate.html#GMIME-DIGEST-ALGO-DEFAULT:CAPS"><span class="type">GMIME_DIGEST_ALGO_DEFAULT</span></a> if unspecified.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-certificate-set-digest-algo"></a><h3>g_mime_certificate_set_digest_algo ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_certificate_set_digest_algo (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="type">GMimeDigestAlgo</span></a> algo</code></em>);</pre> +<p> +Set the digest algorithm used by the certificate. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>cert</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>algo</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="type">GMimeDigestAlgo</span></a> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-certificate-get-issuer-serial"></a><h3>g_mime_certificate_get_issuer_serial ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_certificate_get_issuer_serial + (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>);</pre> +<p> +Get the certificate's issuer serial. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>cert</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the certificate's issuer serial or <code class="literal">NULL</code> if unspecified.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-certificate-set-issuer-serial"></a><h3>g_mime_certificate_set_issuer_serial ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_certificate_set_issuer_serial + (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *issuer_serial</code></em>);</pre> +<p> +Set the certificate's issuer serial. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>cert</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>issuer_serial</code></em> :</span></p></td> +<td>certificate's issuer serial</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-certificate-get-issuer-name"></a><h3>g_mime_certificate_get_issuer_name ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_certificate_get_issuer_name (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>);</pre> +<p> +Get the certificate's issuer name. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>cert</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the certificate's issuer name or <code class="literal">NULL</code> if unspecified.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-certificate-set-issuer-name"></a><h3>g_mime_certificate_set_issuer_name ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_certificate_set_issuer_name (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *issuer_name</code></em>);</pre> +<p> +Set the certificate's issuer name. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>cert</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>issuer_name</code></em> :</span></p></td> +<td>certificate's issuer name</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-certificate-get-fingerprint"></a><h3>g_mime_certificate_get_fingerprint ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_certificate_get_fingerprint (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>);</pre> +<p> +Get the certificate's key fingerprint. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>cert</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the certificate's key fingerprint or <code class="literal">NULL</code> if unspecified.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-certificate-set-fingerprint"></a><h3>g_mime_certificate_set_fingerprint ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_certificate_set_fingerprint (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *fingerprint</code></em>);</pre> +<p> +Set the certificate's key fingerprint. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>cert</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>fingerprint</code></em> :</span></p></td> +<td>fingerprint string</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-certificate-get-created"></a><h3>g_mime_certificate_get_created ()</h3> +<pre class="programlisting"><span class="returnvalue">time_t</span> g_mime_certificate_get_created (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>);</pre> +<p> +Get the creation date of the certificate's key. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>cert</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the creation date of the certificate's key or <code class="literal">-1</code> if unknown.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-certificate-set-created"></a><h3>g_mime_certificate_set_created ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_certificate_set_created (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>, + <em class="parameter"><code><span class="type">time_t</span> created</code></em>);</pre> +<p> +Set the creation date of the certificate's key. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>cert</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>created</code></em> :</span></p></td> +<td>creation date</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-certificate-get-expires"></a><h3>g_mime_certificate_get_expires ()</h3> +<pre class="programlisting"><span class="returnvalue">time_t</span> g_mime_certificate_get_expires (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>);</pre> +<p> +Get the expiration date of the certificate's key. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>cert</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the expiration date of the certificate's key or <code class="literal">-1</code> if unknown.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-certificate-set-expires"></a><h3>g_mime_certificate_set_expires ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_certificate_set_expires (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>, + <em class="parameter"><code><span class="type">time_t</span> expires</code></em>);</pre> +<p> +Set the expiration date of the certificate's key. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>cert</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>expires</code></em> :</span></p></td> +<td>expiration date</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-certificate-get-key-id"></a><h3>g_mime_certificate_get_key_id ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_certificate_get_key_id (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>);</pre> +<p> +Get the certificate's key id. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>cert</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the certificate's key id or <code class="literal">NULL</code> if unspecified.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-certificate-set-key-id"></a><h3>g_mime_certificate_set_key_id ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_certificate_set_key_id (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *key_id</code></em>);</pre> +<p> +Set the certificate's key id. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>cert</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>key_id</code></em> :</span></p></td> +<td>key id</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-certificate-get-trust"></a><h3>g_mime_certificate_get_trust ()</h3> +<pre class="programlisting"><a class="link" href="GMimeCertificate.html#GMimeCertificateTrust" title="enum GMimeCertificateTrust"><span class="returnvalue">GMimeCertificateTrust</span></a> g_mime_certificate_get_trust (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>);</pre> +<p> +Get the certificate trust. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>cert</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the certificate trust.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-certificate-set-trust"></a><h3>g_mime_certificate_set_trust ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_certificate_set_trust (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeCertificateTrust" title="enum GMimeCertificateTrust"><span class="type">GMimeCertificateTrust</span></a> trust</code></em>);</pre> +<p> +Set the certificate trust. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>cert</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>trust</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html#GMimeCertificateTrust" title="enum GMimeCertificateTrust"><span class="type">GMimeCertificateTrust</span></a> value</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-certificate-get-email"></a><h3>g_mime_certificate_get_email ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_certificate_get_email (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>);</pre> +<p> +Get the certificate's email. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>cert</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the certificate's email or <code class="literal">NULL</code> if unspecified.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-certificate-set-email"></a><h3>g_mime_certificate_set_email ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_certificate_set_email (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *email</code></em>);</pre> +<p> +Set the certificate's email. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>cert</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>email</code></em> :</span></p></td> +<td>certificate's email</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-certificate-get-name"></a><h3>g_mime_certificate_get_name ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_certificate_get_name (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>);</pre> +<p> +Get the certificate's name. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>cert</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the certificate's name or <code class="literal">NULL</code> if unspecified.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-certificate-set-name"></a><h3>g_mime_certificate_set_name ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_certificate_set_name (<em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre> +<p> +Set the certificate's name. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>cert</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> +<td>certificate's name</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="GMimeCertificateList-struct"></a><h3>struct GMimeCertificateList</h3> +<pre class="programlisting">struct GMimeCertificateList;</pre> +<p> +A collection of <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> objects. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-certificate-list-new"></a><h3>g_mime_certificate_list_new ()</h3> +<pre class="programlisting"><a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="returnvalue">GMimeCertificateList</span></a> * g_mime_certificate_list_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Creates a new <a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a new <a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a>.</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-certificate-list-length"></a><h3>g_mime_certificate_list_length ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> g_mime_certificate_list_length (<em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> *list</code></em>);</pre> +<p> +Gets the length of the list. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the number of <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> objects in the list.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-certificate-list-clear"></a><h3>g_mime_certificate_list_clear ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_certificate_list_clear (<em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> *list</code></em>);</pre> +<p> +Clears the list of addresses. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-certificate-list-add"></a><h3>g_mime_certificate_list_add ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> g_mime_certificate_list_add (<em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> *list</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>);</pre> +<p> +Adds a <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> to the <a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</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>list</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>cert</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the index of the added <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a>.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-certificate-list-insert"></a><h3>g_mime_certificate_list_insert ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_certificate_list_insert (<em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> *list</code></em>, + <em class="parameter"><code><span class="type">int</span> index</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>);</pre> +<p> +Inserts a <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> into the <a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> at the specified +index. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td> +<td>index to insert at</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>cert</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-certificate-list-remove"></a><h3>g_mime_certificate_list_remove ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_certificate_list_remove (<em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> *list</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>);</pre> +<p> +Removes a <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> from the <a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</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>list</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>cert</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> if the specified <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> was removed or <code class="literal">FALSE</code> +otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-certificate-list-remove-at"></a><h3>g_mime_certificate_list_remove_at ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_certificate_list_remove_at (<em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> *list</code></em>, + <em class="parameter"><code><span class="type">int</span> index</code></em>);</pre> +<p> +Removes a <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> from the <a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> at the specified +index. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td> +<td>index to remove</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> if an <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> was removed or <code class="literal">FALSE</code> otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-certificate-list-contains"></a><h3>g_mime_certificate_list_contains ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_certificate_list_contains (<em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> *list</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>);</pre> +<p> +Checks whether or not the specified <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> is contained within +the <a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</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>list</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>cert</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> if the specified <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> is contained within the +specified <a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> or <code class="literal">FALSE</code> otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-certificate-list-index-of"></a><h3>g_mime_certificate_list_index_of ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> g_mime_certificate_list_index_of (<em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> *list</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>);</pre> +<p> +Gets the index of the specified <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> inside the +<a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</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>list</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>cert</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the index of the requested <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> within the +<a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> or <code class="literal">-1</code> if it is not contained within the +<a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a>.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-certificate-list-get-certificate"></a><h3>g_mime_certificate_list_get_certificate ()</h3> +<pre class="programlisting"><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="returnvalue">GMimeCertificate</span></a> * g_mime_certificate_list_get_certificate + (<em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> *list</code></em>, + <em class="parameter"><code><span class="type">int</span> index</code></em>);</pre> +<p> +Gets the <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> at the specified index. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td> +<td>index of <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> to get</td> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-certificate-list-set-certificate"></a><h3>g_mime_certificate_list_set_certificate ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_certificate_list_set_certificate + (<em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> *list</code></em>, + <em class="parameter"><code><span class="type">int</span> index</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>);</pre> +<p> +Sets the <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> at the specified index to <em class="parameter"><code>cert</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>list</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td> +<td>index of <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> to set</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>cert</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> +</td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/GMimeContentDisposition.html b/docs/reference/html/GMimeContentDisposition.html new file mode 100644 index 0000000..9f92b6d --- /dev/null +++ b/docs/reference/html/GMimeContentDisposition.html @@ -0,0 +1,338 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimeContentDisposition</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="Headers.html" title="Message and MIME Headers"> +<link rel="prev" href="GMimeContentType.html" title="GMimeContentType"> +<link rel="next" href="gmime-GMimeParam.html" title="GMimeParam"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="GMimeContentType.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="Headers.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="gmime-GMimeParam.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GMimeContentDisposition.synopsis" class="shortcut">Top</a> +  | + <a href="#GMimeContentDisposition.description" class="shortcut">Description</a> +  | + <a href="#GMimeContentDisposition.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GMimeContentDisposition"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GMimeContentDisposition.top_of_page"></a>GMimeContentDisposition</span></h2> +<p>GMimeContentDisposition — Content-Disposition fields</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GMimeContentDisposition.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">#define <a class="link" href="GMimeContentDisposition.html#GMIME-DISPOSITION-ATTACHMENT:CAPS" title="GMIME_DISPOSITION_ATTACHMENT">GMIME_DISPOSITION_ATTACHMENT</a> +#define <a class="link" href="GMimeContentDisposition.html#GMIME-DISPOSITION-INLINE:CAPS" title="GMIME_DISPOSITION_INLINE">GMIME_DISPOSITION_INLINE</a> +struct <a class="link" href="GMimeContentDisposition.html#GMimeContentDisposition-struct" title="struct GMimeContentDisposition">GMimeContentDisposition</a>; +<a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="returnvalue">GMimeContentDisposition</span></a> * <a class="link" href="GMimeContentDisposition.html#g-mime-content-disposition-new" title="g_mime_content_disposition_new ()">g_mime_content_disposition_new</a> + (<em class="parameter"><code><span class="type">void</span></code></em>); +<a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="returnvalue">GMimeContentDisposition</span></a> * <a class="link" href="GMimeContentDisposition.html#g-mime-content-disposition-new-from-string" title="g_mime_content_disposition_new_from_string ()">g_mime_content_disposition_new_from_string</a> + (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeContentDisposition.html#g-mime-content-disposition-set-disposition" title="g_mime_content_disposition_set_disposition ()">g_mime_content_disposition_set_disposition</a> + (<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> *value</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="GMimeContentDisposition.html#g-mime-content-disposition-get-disposition" title="g_mime_content_disposition_get_disposition ()">g_mime_content_disposition_get_disposition</a> + (<em class="parameter"><code><a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> *disposition</code></em>); +const <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="returnvalue">GMimeParam</span></a> * <a class="link" href="GMimeContentDisposition.html#g-mime-content-disposition-get-params" title="g_mime_content_disposition_get_params ()">g_mime_content_disposition_get_params</a> + (<em class="parameter"><code><a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> *disposition</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeContentDisposition.html#g-mime-content-disposition-set-params" title="g_mime_content_disposition_set_params ()">g_mime_content_disposition_set_params</a> + (<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><a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> *params</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeContentDisposition.html#g-mime-content-disposition-set-parameter" title="g_mime_content_disposition_set_parameter ()">g_mime_content_disposition_set_parameter</a> + (<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>, + <em class="parameter"><code>const <span class="type">char</span> *value</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="GMimeContentDisposition.html#g-mime-content-disposition-get-parameter" title="g_mime_content_disposition_get_parameter ()">g_mime_content_disposition_get_parameter</a> + (<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>); +<span class="returnvalue">char</span> * <a class="link" href="GMimeContentDisposition.html#g-mime-content-disposition-to-string" title="g_mime_content_disposition_to_string ()">g_mime_content_disposition_to_string</a> + (<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><span class="type">gboolean</span> fold</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GMimeContentDisposition.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----GMimeContentDisposition +</pre> +</div> +<div class="refsect1"> +<a name="GMimeContentDisposition.description"></a><h2>Description</h2> +<p> +A <a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> represents the pre-parsed contents of a +Content-Disposition header field. +</p> +</div> +<div class="refsect1"> +<a name="GMimeContentDisposition.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMIME-DISPOSITION-ATTACHMENT:CAPS"></a><h3>GMIME_DISPOSITION_ATTACHMENT</h3> +<pre class="programlisting">#define GMIME_DISPOSITION_ATTACHMENT "attachment" +</pre> +<p> +Standard attachment disposition. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GMIME-DISPOSITION-INLINE:CAPS"></a><h3>GMIME_DISPOSITION_INLINE</h3> +<pre class="programlisting">#define GMIME_DISPOSITION_INLINE "inline" +</pre> +<p> +Standard inline disposition. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GMimeContentDisposition-struct"></a><h3>struct GMimeContentDisposition</h3> +<pre class="programlisting">struct GMimeContentDisposition;</pre> +<p> +A data structure representing a Content-Disposition. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-content-disposition-new"></a><h3>g_mime_content_disposition_new ()</h3> +<pre class="programlisting"><a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="returnvalue">GMimeContentDisposition</span></a> * g_mime_content_disposition_new + (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Creates a new <a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> object. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a new <a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> object.</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-content-disposition-new-from-string"></a><h3>g_mime_content_disposition_new_from_string ()</h3> +<pre class="programlisting"><a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="returnvalue">GMimeContentDisposition</span></a> * g_mime_content_disposition_new_from_string + (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>);</pre> +<p> +Creates a new <a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> object. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td> +<td>Content-Disposition field value or <code class="literal">NULL</code> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a new <a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> object.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-content-disposition-set-disposition"></a><h3>g_mime_content_disposition_set_disposition ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_content_disposition_set_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> *value</code></em>);</pre> +<p> +Sets the disposition to <em class="parameter"><code>value</code></em> which may be one of +<a class="link" href="GMimeContentDisposition.html#GMIME-DISPOSITION-ATTACHMENT:CAPS" title="GMIME_DISPOSITION_ATTACHMENT"><span class="type">GMIME_DISPOSITION_ATTACHMENT</span></a> or <a class="link" href="GMimeContentDisposition.html#GMIME-DISPOSITION-INLINE:CAPS" title="GMIME_DISPOSITION_INLINE"><span class="type">GMIME_DISPOSITION_INLINE</span></a> or, by +your choice, any other string which would indicate how the MIME +part should be displayed by the MUA. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>disposition</code></em> :</span></p></td> +<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>value</code></em> :</span></p></td> +<td>disposition value</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-content-disposition-get-disposition"></a><h3>g_mime_content_disposition_get_disposition ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_content_disposition_get_disposition + (<em class="parameter"><code><a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> *disposition</code></em>);</pre> +<p> +Gets the disposition or <code class="literal">NULL</code> on fail. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>disposition</code></em> :</span></p></td> +<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"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the disposition string which is probably one of +<a class="link" href="GMimeContentDisposition.html#GMIME-DISPOSITION-ATTACHMENT:CAPS" title="GMIME_DISPOSITION_ATTACHMENT"><span class="type">GMIME_DISPOSITION_ATTACHMENT</span></a> or <a class="link" href="GMimeContentDisposition.html#GMIME-DISPOSITION-INLINE:CAPS" title="GMIME_DISPOSITION_INLINE"><span class="type">GMIME_DISPOSITION_INLINE</span></a>.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-content-disposition-get-params"></a><h3>g_mime_content_disposition_get_params ()</h3> +<pre class="programlisting">const <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="returnvalue">GMimeParam</span></a> * g_mime_content_disposition_get_params + (<em class="parameter"><code><a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> *disposition</code></em>);</pre> +<p> +Gets the Content-Disposition parameter list. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>disposition</code></em> :</span></p></td> +<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"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the list of <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a>'s set on <em class="parameter"><code>disposition</code></em>.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-content-disposition-set-params"></a><h3>g_mime_content_disposition_set_params ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_content_disposition_set_params + (<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><a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> *params</code></em>);</pre> +<p> +Sets the Content-Disposition's parameter list. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>disposition</code></em> :</span></p></td> +<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>params</code></em> :</span></p></td> +<td>a list of <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> objects</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-content-disposition-set-parameter"></a><h3>g_mime_content_disposition_set_parameter ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_content_disposition_set_parameter + (<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>, + <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);</pre> +<p> +Sets a parameter on the Content-Disposition. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>disposition</code></em> :</span></p></td> +<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> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-content-disposition-get-parameter"></a><h3>g_mime_content_disposition_get_parameter ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_content_disposition_get_parameter + (<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. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>disposition</code></em> :</span></p></td> +<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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-content-disposition-to-string"></a><h3>g_mime_content_disposition_to_string ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * g_mime_content_disposition_to_string + (<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><span class="type">gboolean</span> fold</code></em>);</pre> +<p> +Allocates a string buffer containing the Content-Disposition header +represented by the disposition object <em class="parameter"><code>disposition</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>disposition</code></em> :</span></p></td> +<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>fold</code></em> :</span></p></td> +<td>fold header if needed</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a string containing the disposition header</td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/GMimeContentType.html b/docs/reference/html/GMimeContentType.html new file mode 100644 index 0000000..a1c47c9 --- /dev/null +++ b/docs/reference/html/GMimeContentType.html @@ -0,0 +1,389 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimeContentType</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="Headers.html" title="Message and MIME Headers"> +<link rel="prev" href="gmime-GMimeHeader.html" title="GMimeHeader"> +<link rel="next" href="GMimeContentDisposition.html" title="GMimeContentDisposition"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="gmime-GMimeHeader.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="Headers.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="GMimeContentDisposition.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GMimeContentType.synopsis" class="shortcut">Top</a> +  | + <a href="#GMimeContentType.description" class="shortcut">Description</a> +  | + <a href="#GMimeContentType.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GMimeContentType"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GMimeContentType.top_of_page"></a>GMimeContentType</span></h2> +<p>GMimeContentType — Content-Type fields</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GMimeContentType.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">struct <a class="link" href="GMimeContentType.html#GMimeContentType-struct" title="struct GMimeContentType">GMimeContentType</a>; +<a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="returnvalue">GMimeContentType</span></a> * <a class="link" href="GMimeContentType.html#g-mime-content-type-new" title="g_mime_content_type_new ()">g_mime_content_type_new</a> (<em class="parameter"><code>const <span class="type">char</span> *type</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *subtype</code></em>); +<a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="returnvalue">GMimeContentType</span></a> * <a class="link" href="GMimeContentType.html#g-mime-content-type-new-from-string" title="g_mime_content_type_new_from_string ()">g_mime_content_type_new_from_string</a> (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>); +<span class="returnvalue">char</span> * <a class="link" href="GMimeContentType.html#g-mime-content-type-to-string" title="g_mime_content_type_to_string ()">g_mime_content_type_to_string</a> (<em class="parameter"><code><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> *mime_type</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="GMimeContentType.html#g-mime-content-type-is-type" title="g_mime_content_type_is_type ()">g_mime_content_type_is_type</a> (<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> *type</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *subtype</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="GMimeContentType.html#g-mime-content-type-get-media-type" title="g_mime_content_type_get_media_type ()">g_mime_content_type_get_media_type</a> (<em class="parameter"><code><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> *mime_type</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeContentType.html#g-mime-content-type-set-media-type" title="g_mime_content_type_set_media_type ()">g_mime_content_type_set_media_type</a> (<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> *type</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="GMimeContentType.html#g-mime-content-type-get-media-subtype" title="g_mime_content_type_get_media_subtype ()">g_mime_content_type_get_media_subtype</a> + (<em class="parameter"><code><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> *mime_type</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeContentType.html#g-mime-content-type-set-media-subtype" title="g_mime_content_type_set_media_subtype ()">g_mime_content_type_set_media_subtype</a> + (<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> *subtype</code></em>); +const <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="returnvalue">GMimeParam</span></a> * <a class="link" href="GMimeContentType.html#g-mime-content-type-get-params" title="g_mime_content_type_get_params ()">g_mime_content_type_get_params</a> (<em class="parameter"><code><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> *mime_type</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeContentType.html#g-mime-content-type-set-params" title="g_mime_content_type_set_params ()">g_mime_content_type_set_params</a> (<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><a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> *params</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="GMimeContentType.html#g-mime-content-type-get-parameter" title="g_mime_content_type_get_parameter ()">g_mime_content_type_get_parameter</a> (<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>); +<span class="returnvalue">void</span> <a class="link" href="GMimeContentType.html#g-mime-content-type-set-parameter" title="g_mime_content_type_set_parameter ()">g_mime_content_type_set_parameter</a> (<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>, + <em class="parameter"><code>const <span class="type">char</span> *value</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GMimeContentType.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----GMimeContentType +</pre> +</div> +<div class="refsect1"> +<a name="GMimeContentType.description"></a><h2>Description</h2> +<p> +A <a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> represents the pre-parsed contents of a +Content-Type header field. +</p> +</div> +<div class="refsect1"> +<a name="GMimeContentType.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimeContentType-struct"></a><h3>struct GMimeContentType</h3> +<pre class="programlisting">struct GMimeContentType;</pre> +<p> +A data structure representing a Content-Type. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-content-type-new"></a><h3>g_mime_content_type_new ()</h3> +<pre class="programlisting"><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="returnvalue">GMimeContentType</span></a> * g_mime_content_type_new (<em class="parameter"><code>const <span class="type">char</span> *type</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *subtype</code></em>);</pre> +<p> +Creates a Content-Type object with type <em class="parameter"><code>type</code></em> and subtype <em class="parameter"><code>subtype</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>type</code></em> :</span></p></td> +<td>MIME type (or <code class="literal">NULL</code> for "text")</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>subtype</code></em> :</span></p></td> +<td>MIME subtype (or <code class="literal">NULL</code> for "plain")</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a new <a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> object.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-content-type-new-from-string"></a><h3>g_mime_content_type_new_from_string ()</h3> +<pre class="programlisting"><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="returnvalue">GMimeContentType</span></a> * g_mime_content_type_new_from_string (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>);</pre> +<p> +Constructs a new Content-Type object based on the input string. +</p> +<div class="variablelist"><table border="0"> +<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 containing a content-type (and params)</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a new <a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> object based on the input string.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-content-type-to-string"></a><h3>g_mime_content_type_to_string ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * g_mime_content_type_to_string (<em class="parameter"><code><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> *mime_type</code></em>);</pre> +<p> +Allocates a string buffer containing the type and subtype defined +by the <em class="parameter"><code>mime_type</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>mime_type</code></em> :</span></p></td> +<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"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>an allocated string containing the type and subtype of the +content-type in the format: type/subtype.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-content-type-is-type"></a><h3>g_mime_content_type_is_type ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_content_type_is_type (<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> *type</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *subtype</code></em>);</pre> +<p> +Compares the given type and subtype with that of the given mime +type object. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>mime_type</code></em> :</span></p></td> +<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>type</code></em> :</span></p></td> +<td>MIME type to compare against</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>subtype</code></em> :</span></p></td> +<td>MIME subtype to compare against</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>TRUE if the MIME types match or FALSE otherwise. You may +use "*" in place of <em class="parameter"><code>type</code></em> and/or <em class="parameter"><code>subtype</code></em> as a wilcard.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-content-type-get-media-type"></a><h3>g_mime_content_type_get_media_type ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_content_type_get_media_type (<em class="parameter"><code><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> *mime_type</code></em>);</pre> +<p> +Gets the Content-Type's media type. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>mime_type</code></em> :</span></p></td> +<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"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the Content-Type's media type.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-content-type-set-media-type"></a><h3>g_mime_content_type_set_media_type ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_content_type_set_media_type (<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> *type</code></em>);</pre> +<p> +Sets the Content-Type's media type. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>mime_type</code></em> :</span></p></td> +<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>type</code></em> :</span></p></td> +<td>media type</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-content-type-get-media-subtype"></a><h3>g_mime_content_type_get_media_subtype ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_content_type_get_media_subtype + (<em class="parameter"><code><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> *mime_type</code></em>);</pre> +<p> +Gets the Content-Type's media sub-type. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>mime_type</code></em> :</span></p></td> +<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"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the Content-Type's media sub-type.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-content-type-set-media-subtype"></a><h3>g_mime_content_type_set_media_subtype ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_content_type_set_media_subtype + (<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> *subtype</code></em>);</pre> +<p> +Sets the Content-Type's media subtype. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>mime_type</code></em> :</span></p></td> +<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>subtype</code></em> :</span></p></td> +<td>media subtype</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-content-type-get-params"></a><h3>g_mime_content_type_get_params ()</h3> +<pre class="programlisting">const <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="returnvalue">GMimeParam</span></a> * g_mime_content_type_get_params (<em class="parameter"><code><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> *mime_type</code></em>);</pre> +<p> +Gets the Content-Type's parameter list. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>mime_type</code></em> :</span></p></td> +<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"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the Content-Type's parameter list.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-content-type-set-params"></a><h3>g_mime_content_type_set_params ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_content_type_set_params (<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><a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> *params</code></em>);</pre> +<p> +Sets the Content-Type's parameter list. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>mime_type</code></em> :</span></p></td> +<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>params</code></em> :</span></p></td> +<td>a list of <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> objects</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-content-type-get-parameter"></a><h3>g_mime_content_type_get_parameter ()</h3> +<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. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>mime_type</code></em> :</span></p></td> +<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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-content-type-set-parameter"></a><h3>g_mime_content_type_set_parameter ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_content_type_set_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>, + <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);</pre> +<p> +Sets a parameter on the Content-Type. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>mime_type</code></em> :</span></p></td> +<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> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/GMimeCryptoContext.html b/docs/reference/html/GMimeCryptoContext.html new file mode 100644 index 0000000..e247f67 --- /dev/null +++ b/docs/reference/html/GMimeCryptoContext.html @@ -0,0 +1,959 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimeCryptoContext</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="CryptoContexts.html" title="Cryptography Contexts"> +<link rel="prev" href="GMimeSignature.html" title="GMimeSignature"> +<link rel="next" href="GMimeGpgContext.html" title="GMimeGpgContext"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="GMimeSignature.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="CryptoContexts.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="GMimeGpgContext.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GMimeCryptoContext.synopsis" class="shortcut">Top</a> +  | + <a href="#GMimeCryptoContext.description" class="shortcut">Description</a> +  | + <a href="#GMimeCryptoContext.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GMimeCryptoContext"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GMimeCryptoContext.top_of_page"></a>GMimeCryptoContext</span></h2> +<p>GMimeCryptoContext — Encryption/signing contexts</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GMimeCryptoContext.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis"><span class="returnvalue">gboolean</span> (<a class="link" href="GMimeCryptoContext.html#GMimePasswordRequestFunc" title="GMimePasswordRequestFunc ()">*GMimePasswordRequestFunc</a>) (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *user_id</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *prompt_ctx</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> reprompt</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *response</code></em>, + <em class="parameter"><code><span class="type">GError</span> **err</code></em>); +struct <a class="link" href="GMimeCryptoContext.html#GMimeCryptoContext-struct" title="struct GMimeCryptoContext">GMimeCryptoContext</a>; +<span class="returnvalue">void</span> <a class="link" href="GMimeCryptoContext.html#g-mime-crypto-context-set-request-password" title="g_mime_crypto_context_set_request_password ()">g_mime_crypto_context_set_request_password</a> + (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimePasswordRequestFunc" title="GMimePasswordRequestFunc ()"><span class="type">GMimePasswordRequestFunc</span></a> request_passwd</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="GMimeCryptoContext.html#g-mime-crypto-context-get-signature-protocol" title="g_mime_crypto_context_get_signature_protocol ()">g_mime_crypto_context_get_signature_protocol</a> + (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="GMimeCryptoContext.html#g-mime-crypto-context-get-encryption-protocol" title="g_mime_crypto_context_get_encryption_protocol ()">g_mime_crypto_context_get_encryption_protocol</a> + (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="GMimeCryptoContext.html#g-mime-crypto-context-get-key-exchange-protocol" title="g_mime_crypto_context_get_key_exchange_protocol ()">g_mime_crypto_context_get_key_exchange_protocol</a> + (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>); +<a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="returnvalue">GMimeDigestAlgo</span></a> <a class="link" href="GMimeCryptoContext.html#g-mime-crypto-context-digest-id" title="g_mime_crypto_context_digest_id ()">g_mime_crypto_context_digest_id</a> (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *name</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="GMimeCryptoContext.html#g-mime-crypto-context-digest-name" title="g_mime_crypto_context_digest_name ()">g_mime_crypto_context_digest_name</a> (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="type">GMimeDigestAlgo</span></a> digest</code></em>); +<span class="returnvalue">int</span> <a class="link" href="GMimeCryptoContext.html#g-mime-crypto-context-sign" title="g_mime_crypto_context_sign ()">g_mime_crypto_context_sign</a> (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *userid</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="type">GMimeDigestAlgo</span></a> digest</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *istream</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *ostream</code></em>, + <em class="parameter"><code><span class="type">GError</span> **err</code></em>); +<a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="returnvalue">GMimeSignatureList</span></a> * <a class="link" href="GMimeCryptoContext.html#g-mime-crypto-context-verify" title="g_mime_crypto_context_verify ()">g_mime_crypto_context_verify</a> (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="type">GMimeDigestAlgo</span></a> digest</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *istream</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *sigstream</code></em>, + <em class="parameter"><code><span class="type">GError</span> **err</code></em>); +<span class="returnvalue">int</span> <a class="link" href="GMimeCryptoContext.html#g-mime-crypto-context-encrypt" title="g_mime_crypto_context_encrypt ()">g_mime_crypto_context_encrypt</a> (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> sign</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *userid</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="type">GMimeDigestAlgo</span></a> digest</code></em>, + <em class="parameter"><code><span class="type">GPtrArray</span> *recipients</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *istream</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *ostream</code></em>, + <em class="parameter"><code><span class="type">GError</span> **err</code></em>); +<a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="returnvalue">GMimeDecryptResult</span></a> * <a class="link" href="GMimeCryptoContext.html#g-mime-crypto-context-decrypt" title="g_mime_crypto_context_decrypt ()">g_mime_crypto_context_decrypt</a> (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *istream</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *ostream</code></em>, + <em class="parameter"><code><span class="type">GError</span> **err</code></em>); +<span class="returnvalue">int</span> <a class="link" href="GMimeCryptoContext.html#g-mime-crypto-context-import-keys" title="g_mime_crypto_context_import_keys ()">g_mime_crypto_context_import_keys</a> (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *istream</code></em>, + <em class="parameter"><code><span class="type">GError</span> **err</code></em>); +<span class="returnvalue">int</span> <a class="link" href="GMimeCryptoContext.html#g-mime-crypto-context-export-keys" title="g_mime_crypto_context_export_keys ()">g_mime_crypto_context_export_keys</a> (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code><span class="type">GPtrArray</span> *keys</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *ostream</code></em>, + <em class="parameter"><code><span class="type">GError</span> **err</code></em>); + +enum <a class="link" href="GMimeCryptoContext.html#GMimeCipherAlgo" title="enum GMimeCipherAlgo">GMimeCipherAlgo</a>; +struct <a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult">GMimeDecryptResult</a>; +<a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="returnvalue">GMimeDecryptResult</span></a> * <a class="link" href="GMimeCryptoContext.html#g-mime-decrypt-result-new" title="g_mime_decrypt_result_new ()">g_mime_decrypt_result_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +<a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="returnvalue">GMimeCertificateList</span></a> * <a class="link" href="GMimeCryptoContext.html#g-mime-decrypt-result-get-recipients" title="g_mime_decrypt_result_get_recipients ()">g_mime_decrypt_result_get_recipients</a> + (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> *result</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeCryptoContext.html#g-mime-decrypt-result-set-recipients" title="g_mime_decrypt_result_set_recipients ()">g_mime_decrypt_result_set_recipients</a> + (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> *result</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> *recipients</code></em>); +<a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="returnvalue">GMimeSignatureList</span></a> * <a class="link" href="GMimeCryptoContext.html#g-mime-decrypt-result-get-signatures" title="g_mime_decrypt_result_get_signatures ()">g_mime_decrypt_result_get_signatures</a> + (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> *result</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeCryptoContext.html#g-mime-decrypt-result-set-signatures" title="g_mime_decrypt_result_set_signatures ()">g_mime_decrypt_result_set_signatures</a> + (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> *result</code></em>, + <em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *signatures</code></em>); +<a class="link" href="GMimeCryptoContext.html#GMimeCipherAlgo" title="enum GMimeCipherAlgo"><span class="returnvalue">GMimeCipherAlgo</span></a> <a class="link" href="GMimeCryptoContext.html#g-mime-decrypt-result-get-cipher" title="g_mime_decrypt_result_get_cipher ()">g_mime_decrypt_result_get_cipher</a> (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> *result</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeCryptoContext.html#g-mime-decrypt-result-set-cipher" title="g_mime_decrypt_result_set_cipher ()">g_mime_decrypt_result_set_cipher</a> (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> *result</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimeCipherAlgo" title="enum GMimeCipherAlgo"><span class="type">GMimeCipherAlgo</span></a> cipher</code></em>); +<a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="returnvalue">GMimeDigestAlgo</span></a> <a class="link" href="GMimeCryptoContext.html#g-mime-decrypt-result-get-mdc" title="g_mime_decrypt_result_get_mdc ()">g_mime_decrypt_result_get_mdc</a> (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> *result</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeCryptoContext.html#g-mime-decrypt-result-set-mdc" title="g_mime_decrypt_result_set_mdc ()">g_mime_decrypt_result_set_mdc</a> (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> *result</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="type">GMimeDigestAlgo</span></a> mdc</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GMimeCryptoContext.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----GMimeCryptoContext + +----<a class="link" href="GMimeGpgContext.html" title="GMimeGpgContext">GMimeGpgContext</a> + +----<a class="link" href="GMimePkcs7Context.html" title="GMimePkcs7Context">GMimePkcs7Context</a> +</pre> +</div> +<div class="refsect1"> +<a name="GMimeCryptoContext.description"></a><h2>Description</h2> +<p> +A <a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> is used for encrypting, decrypting, signing +and verifying cryptographic signatures. +</p> +</div> +<div class="refsect1"> +<a name="GMimeCryptoContext.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimePasswordRequestFunc"></a><h3>GMimePasswordRequestFunc ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> (*GMimePasswordRequestFunc) (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *user_id</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *prompt_ctx</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> reprompt</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *response</code></em>, + <em class="parameter"><code><span class="type">GError</span> **err</code></em>);</pre> +<p> +A password request callback allowing a <a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> to +prompt the user for a password for a given key. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> +<td>the <a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> making the request</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>user_id</code></em> :</span></p></td> +<td>the user_id of the password being requested</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>prompt_ctx</code></em> :</span></p></td> +<td>a string containing some helpful context for the prompt</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>reprompt</code></em> :</span></p></td> +<td> +<code class="literal">TRUE</code> if this password request is a reprompt due to a previously bad password response</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>response</code></em> :</span></p></td> +<td>a stream for the application to write the password to (followed by a newline '\n' character)</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td> +<td>a <span class="type">GError</span> for the callback to set if an error occurs</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> on success or <code class="literal">FALSE</code> on error.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="GMimeCryptoContext-struct"></a><h3>struct GMimeCryptoContext</h3> +<pre class="programlisting">struct GMimeCryptoContext;</pre> +<p> +A crypto context for use with MIME. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-crypto-context-set-request-password"></a><h3>g_mime_crypto_context_set_request_password ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_crypto_context_set_request_password + (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimePasswordRequestFunc" title="GMimePasswordRequestFunc ()"><span class="type">GMimePasswordRequestFunc</span></a> request_passwd</code></em>);</pre> +<p> +Sets the function used by the <em class="parameter"><code>ctx</code></em> for requesting a password from +the user. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>request_passwd</code></em> :</span></p></td> +<td>a callback function for requesting a password</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-crypto-context-get-signature-protocol"></a><h3>g_mime_crypto_context_get_signature_protocol ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_crypto_context_get_signature_protocol + (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>);</pre> +<p> +Gets the signature protocol for the crypto context. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the signature protocol or <code class="literal">NULL</code> if not supported.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-crypto-context-get-encryption-protocol"></a><h3>g_mime_crypto_context_get_encryption_protocol ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_crypto_context_get_encryption_protocol + (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>);</pre> +<p> +Gets the encryption protocol for the crypto context. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the encryption protocol or <code class="literal">NULL</code> if not supported.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-crypto-context-get-key-exchange-protocol"></a><h3>g_mime_crypto_context_get_key_exchange_protocol ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_crypto_context_get_key_exchange_protocol + (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>);</pre> +<p> +Gets the key exchange protocol for the crypto context. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the key exchange protocol or <code class="literal">NULL</code> if not supported.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-crypto-context-digest-id"></a><h3>g_mime_crypto_context_digest_id ()</h3> +<pre class="programlisting"><a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="returnvalue">GMimeDigestAlgo</span></a> g_mime_crypto_context_digest_id (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre> +<p> +Gets the digest id based on the digest name. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> +<td>digest name</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the equivalent digest id or <a class="link" href="GMimeCertificate.html#GMIME-DIGEST-ALGO-DEFAULT:CAPS"><span class="type">GMIME_DIGEST_ALGO_DEFAULT</span></a> on fail.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-crypto-context-digest-name"></a><h3>g_mime_crypto_context_digest_name ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_crypto_context_digest_name (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="type">GMimeDigestAlgo</span></a> digest</code></em>);</pre> +<p> +Gets the digest name based on the digest id <em class="parameter"><code>digest</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>ctx</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>digest</code></em> :</span></p></td> +<td>digest id</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the equivalent digest name or <code class="literal">NULL</code> on fail.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-crypto-context-sign"></a><h3>g_mime_crypto_context_sign ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> g_mime_crypto_context_sign (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *userid</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="type">GMimeDigestAlgo</span></a> digest</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *istream</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *ostream</code></em>, + <em class="parameter"><code><span class="type">GError</span> **err</code></em>);</pre> +<p> +Signs the input stream and writes the resulting signature to the output stream. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>userid</code></em> :</span></p></td> +<td>private key to use to sign the stream</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>digest</code></em> :</span></p></td> +<td>digest algorithm to use</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>istream</code></em> :</span></p></td> +<td>input stream</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>ostream</code></em> :</span></p></td> +<td>output stream</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td> +<td>a <span class="type">GError</span> +</td> +</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#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="type">GMimeDigestAlgo</span></a> used on success (useful if <em class="parameter"><code>digest</code></em> is +specified as <a class="link" href="GMimeCertificate.html#GMIME-DIGEST-ALGO-DEFAULT:CAPS"><span class="type">GMIME_DIGEST_ALGO_DEFAULT</span></a>) or <code class="literal">-1</code> on fail.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-crypto-context-verify"></a><h3>g_mime_crypto_context_verify ()</h3> +<pre class="programlisting"><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="returnvalue">GMimeSignatureList</span></a> * g_mime_crypto_context_verify (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="type">GMimeDigestAlgo</span></a> digest</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *istream</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *sigstream</code></em>, + <em class="parameter"><code><span class="type">GError</span> **err</code></em>);</pre> +<p> +Verifies the signature. If <em class="parameter"><code>istream</code></em> is a clearsigned stream, +you should pass <code class="literal">NULL</code> as the sigstream parameter. Otherwise +<em class="parameter"><code>sigstream</code></em> is assumed to be the signature stream and is used to +verify the integirity of the <em class="parameter"><code>istream</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>ctx</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>digest</code></em> :</span></p></td> +<td>digest algorithm used, if known</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>istream</code></em> :</span></p></td> +<td>input stream</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>sigstream</code></em> :</span></p></td> +<td>optional detached-signature stream</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td> +<td>a <span class="type">GError</span> +</td> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-crypto-context-encrypt"></a><h3>g_mime_crypto_context_encrypt ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> g_mime_crypto_context_encrypt (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> sign</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *userid</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="type">GMimeDigestAlgo</span></a> digest</code></em>, + <em class="parameter"><code><span class="type">GPtrArray</span> *recipients</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *istream</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *ostream</code></em>, + <em class="parameter"><code><span class="type">GError</span> **err</code></em>);</pre> +<p> +Encrypts (and optionally signs) the cleartext input stream and +writes the resulting ciphertext to the output stream. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>sign</code></em> :</span></p></td> +<td>sign as well as encrypt</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>userid</code></em> :</span></p></td> +<td>key id (or email address) to use when signing (assuming <em class="parameter"><code>sign</code></em> is <code class="literal">TRUE</code>)</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>digest</code></em> :</span></p></td> +<td>digest algorithm to use when signing</td> +</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> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>istream</code></em> :</span></p></td> +<td>cleartext input stream</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>ostream</code></em> :</span></p></td> +<td>ciphertext output stream</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td> +<td>a <span class="type">GError</span> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">0</code> on success or <code class="literal">-1</code> on fail.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-crypto-context-decrypt"></a><h3>g_mime_crypto_context_decrypt ()</h3> +<pre class="programlisting"><a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="returnvalue">GMimeDecryptResult</span></a> * g_mime_crypto_context_decrypt (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *istream</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *ostream</code></em>, + <em class="parameter"><code><span class="type">GError</span> **err</code></em>);</pre> +<p> +Decrypts the ciphertext input stream and writes the resulting +cleartext to the output stream. +</p> +<p> +If the encrypted input stream was also signed, the returned +<a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> will have a non-<code class="literal">NULL</code> list of signatures, each with a +<a class="link" href="GMimeSignature.html#GMimeSignatureStatus" title="enum GMimeSignatureStatus"><span class="type">GMimeSignatureStatus</span></a> (among other details about each signature). +</p> +<p> +On success, the returned <a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> will contain a list of +certificates, one for each recipient, that the original encrypted stream +was encrypted to. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>istream</code></em> :</span></p></td> +<td>input/ciphertext stream</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>ostream</code></em> :</span></p></td> +<td>output/cleartext stream</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td> +<td>a <span class="type">GError</span> +</td> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-crypto-context-import-keys"></a><h3>g_mime_crypto_context_import_keys ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> g_mime_crypto_context_import_keys (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *istream</code></em>, + <em class="parameter"><code><span class="type">GError</span> **err</code></em>);</pre> +<p> +Imports a stream of keys/certificates contained within <em class="parameter"><code>istream</code></em> +into the key/certificate database controlled by <em class="parameter"><code>ctx</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>ctx</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>istream</code></em> :</span></p></td> +<td>input stream (containing keys)</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td> +<td>a <span class="type">GError</span> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">0</code> on success or <code class="literal">-1</code> on fail.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-crypto-context-export-keys"></a><h3>g_mime_crypto_context_export_keys ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> g_mime_crypto_context_export_keys (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code><span class="type">GPtrArray</span> *keys</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *ostream</code></em>, + <em class="parameter"><code><span class="type">GError</span> **err</code></em>);</pre> +<p> +Exports the keys/certificates in <em class="parameter"><code>keys</code></em> to the stream <em class="parameter"><code>ostream</code></em> from +the key/certificate database controlled by <em class="parameter"><code>ctx</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>ctx</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>keys</code></em> :</span></p></td> +<td>an array of key ids</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>ostream</code></em> :</span></p></td> +<td>output stream</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td> +<td>a <span class="type">GError</span> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">0</code> on success or <code class="literal">-1</code> on fail.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="GMimeCipherAlgo"></a><h3>enum GMimeCipherAlgo</h3> +<pre class="programlisting">typedef enum { + GMIME_CIPHER_ALGO_DEFAULT = 0, + GMIME_CIPHER_ALGO_IDEA = 1, + GMIME_CIPHER_ALGO_3DES = 2, + GMIME_CIPHER_ALGO_CAST5 = 3, + GMIME_CIPHER_ALGO_BLOWFISH = 4, + GMIME_CIPHER_ALGO_AES = 7, + GMIME_CIPHER_ALGO_AES192 = 8, + GMIME_CIPHER_ALGO_AES256 = 9, + GMIME_CIPHER_ALGO_TWOFISH = 10, + GMIME_CIPHER_ALGO_CAMELLIA128 = 11, + GMIME_CIPHER_ALGO_CAMELLIA192 = 12, + GMIME_CIPHER_ALGO_CAMELLIA256 = 13 +} GMimeCipherAlgo; +</pre> +<p> +A cipher algorithm. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><a name="GMIME-CIPHER-ALGO-DEFAULT:CAPS"></a><span class="term"><code class="literal">GMIME_CIPHER_ALGO_DEFAULT</code></span></p></td> +<td>The default (or unknown) cipher. +</td> +</tr> +<tr> +<td><p><a name="GMIME-CIPHER-ALGO-IDEA:CAPS"></a><span class="term"><code class="literal">GMIME_CIPHER_ALGO_IDEA</code></span></p></td> +<td>The IDEA cipher. +</td> +</tr> +<tr> +<td><p><a name="GMIME-CIPHER-ALGO-3DES:CAPS"></a><span class="term"><code class="literal">GMIME_CIPHER_ALGO_3DES</code></span></p></td> +<td>The 3DES cipher. +</td> +</tr> +<tr> +<td><p><a name="GMIME-CIPHER-ALGO-CAST5:CAPS"></a><span class="term"><code class="literal">GMIME_CIPHER_ALGO_CAST5</code></span></p></td> +<td>The CAST5 cipher. +</td> +</tr> +<tr> +<td><p><a name="GMIME-CIPHER-ALGO-BLOWFISH:CAPS"></a><span class="term"><code class="literal">GMIME_CIPHER_ALGO_BLOWFISH</code></span></p></td> +<td>The Blowfish cipher. +</td> +</tr> +<tr> +<td><p><a name="GMIME-CIPHER-ALGO-AES:CAPS"></a><span class="term"><code class="literal">GMIME_CIPHER_ALGO_AES</code></span></p></td> +<td>The AES (aka RIJANDALE) cipher. +</td> +</tr> +<tr> +<td><p><a name="GMIME-CIPHER-ALGO-AES192:CAPS"></a><span class="term"><code class="literal">GMIME_CIPHER_ALGO_AES192</code></span></p></td> +<td>The AES-192 cipher. +</td> +</tr> +<tr> +<td><p><a name="GMIME-CIPHER-ALGO-AES256:CAPS"></a><span class="term"><code class="literal">GMIME_CIPHER_ALGO_AES256</code></span></p></td> +<td>The AES-256 cipher. +</td> +</tr> +<tr> +<td><p><a name="GMIME-CIPHER-ALGO-TWOFISH:CAPS"></a><span class="term"><code class="literal">GMIME_CIPHER_ALGO_TWOFISH</code></span></p></td> +<td>The Twofish cipher. +</td> +</tr> +<tr> +<td><p><a name="GMIME-CIPHER-ALGO-CAMELLIA128:CAPS"></a><span class="term"><code class="literal">GMIME_CIPHER_ALGO_CAMELLIA128</code></span></p></td> +<td>The Camellia-128 cipher. +</td> +</tr> +<tr> +<td><p><a name="GMIME-CIPHER-ALGO-CAMELLIA192:CAPS"></a><span class="term"><code class="literal">GMIME_CIPHER_ALGO_CAMELLIA192</code></span></p></td> +<td>The Camellia-192 cipher. +</td> +</tr> +<tr> +<td><p><a name="GMIME-CIPHER-ALGO-CAMELLIA256:CAPS"></a><span class="term"><code class="literal">GMIME_CIPHER_ALGO_CAMELLIA256</code></span></p></td> +<td>The Camellia-256 cipher. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="GMimeDecryptResult"></a><h3>struct GMimeDecryptResult</h3> +<pre class="programlisting">struct GMimeDecryptResult { + GObject parent_object; + + GMimeCertificateList *recipients; + GMimeSignatureList *signatures; + GMimeCipherAlgo cipher; + GMimeDigestAlgo mdc; +}; +</pre> +<p> +An object containing the results from decrypting an encrypted stream. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><span class="type">GObject</span> <em class="structfield"><code><a name="GMimeDecryptResult.parent-object"></a>parent_object</code></em>;</span></p></td> +<td>parent <span class="type">GObject</span> +</td> +</tr> +<tr> +<td><p><span class="term"><a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> *<em class="structfield"><code><a name="GMimeDecryptResult.recipients"></a>recipients</code></em>;</span></p></td> +<td>A <a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *<em class="structfield"><code><a name="GMimeDecryptResult.signatures"></a>signatures</code></em>;</span></p></td> +<td>A <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> if signed or <code class="literal">NULL</code> otherwise.</td> +</tr> +<tr> +<td><p><span class="term"><a class="link" href="GMimeCryptoContext.html#GMimeCipherAlgo" title="enum GMimeCipherAlgo"><span class="type">GMimeCipherAlgo</span></a> <em class="structfield"><code><a name="GMimeDecryptResult.cipher"></a>cipher</code></em>;</span></p></td> +<td>The cipher algorithm used to encrypt the stream.</td> +</tr> +<tr> +<td><p><span class="term"><a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="type">GMimeDigestAlgo</span></a> <em class="structfield"><code><a name="GMimeDecryptResult.mdc"></a>mdc</code></em>;</span></p></td> +<td>The MDC digest algorithm used, if any.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-decrypt-result-new"></a><h3>g_mime_decrypt_result_new ()</h3> +<pre class="programlisting"><a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="returnvalue">GMimeDecryptResult</span></a> * g_mime_decrypt_result_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Creates a new <a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> object. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a new <a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> object.</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-decrypt-result-get-recipients"></a><h3>g_mime_decrypt_result_get_recipients ()</h3> +<pre class="programlisting"><a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="returnvalue">GMimeCertificateList</span></a> * g_mime_decrypt_result_get_recipients + (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> *result</code></em>);</pre> +<p> +Gets the list of certificates that the stream had been encrypted to. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td> +<td>A <a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</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="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a>.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-decrypt-result-set-recipients"></a><h3>g_mime_decrypt_result_set_recipients ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_decrypt_result_set_recipients + (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> *result</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> *recipients</code></em>);</pre> +<p> +Sets the list of certificates that the stream had been encrypted to. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td> +<td>A <a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>recipients</code></em> :</span></p></td> +<td>A <a class="link" href="GMimeCertificate.html#GMimeCertificateList"><span class="type">GMimeCertificateList</span></a> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-decrypt-result-get-signatures"></a><h3>g_mime_decrypt_result_get_signatures ()</h3> +<pre class="programlisting"><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="returnvalue">GMimeSignatureList</span></a> * g_mime_decrypt_result_get_signatures + (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> *result</code></em>);</pre> +<p> +Gets a list of signatures if the encrypted stream had also been signed. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td> +<td>A <a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</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="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> or <code class="literal">NULL</code> if the stream was not signed.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-decrypt-result-set-signatures"></a><h3>g_mime_decrypt_result_set_signatures ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_decrypt_result_set_signatures + (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> *result</code></em>, + <em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *signatures</code></em>);</pre> +<p> +Sets the list of signatures. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td> +<td>A <a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>signatures</code></em> :</span></p></td> +<td>A <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-decrypt-result-get-cipher"></a><h3>g_mime_decrypt_result_get_cipher ()</h3> +<pre class="programlisting"><a class="link" href="GMimeCryptoContext.html#GMimeCipherAlgo" title="enum GMimeCipherAlgo"><span class="returnvalue">GMimeCipherAlgo</span></a> g_mime_decrypt_result_get_cipher (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> *result</code></em>);</pre> +<p> +Get the cipher algorithm used. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the cipher algorithm used.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-decrypt-result-set-cipher"></a><h3>g_mime_decrypt_result_set_cipher ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_decrypt_result_set_cipher (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> *result</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimeCipherAlgo" title="enum GMimeCipherAlgo"><span class="type">GMimeCipherAlgo</span></a> cipher</code></em>);</pre> +<p> +Set the cipher algorithm used. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>cipher</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCryptoContext.html#GMimeCipherAlgo" title="enum GMimeCipherAlgo"><span class="type">GMimeCipherAlgo</span></a> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-decrypt-result-get-mdc"></a><h3>g_mime_decrypt_result_get_mdc ()</h3> +<pre class="programlisting"><a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="returnvalue">GMimeDigestAlgo</span></a> g_mime_decrypt_result_get_mdc (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> *result</code></em>);</pre> +<p> +Get the mdc digest algorithm used. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the mdc digest algorithm used.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-decrypt-result-set-mdc"></a><h3>g_mime_decrypt_result_set_mdc ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_decrypt_result_set_mdc (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> *result</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="type">GMimeDigestAlgo</span></a> mdc</code></em>);</pre> +<p> +Set the mdc digest algorithm used. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>mdc</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="type">GMimeDigestAlgo</span></a> +</td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/GMimeDataWrapper.html b/docs/reference/html/GMimeDataWrapper.html new file mode 100644 index 0000000..16333a5 --- /dev/null +++ b/docs/reference/html/GMimeDataWrapper.html @@ -0,0 +1,263 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimeDataWrapper</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="DataWrappers.html" title="Data Wrappers"> +<link rel="prev" href="DataWrappers.html" title="Data Wrappers"> +<link rel="next" href="Headers.html" title="Message and MIME Headers"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="DataWrappers.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="DataWrappers.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="Headers.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GMimeDataWrapper.synopsis" class="shortcut">Top</a> +  | + <a href="#GMimeDataWrapper.description" class="shortcut">Description</a> +  | + <a href="#GMimeDataWrapper.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GMimeDataWrapper"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GMimeDataWrapper.top_of_page"></a>GMimeDataWrapper</span></h2> +<p>GMimeDataWrapper — Content objects</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GMimeDataWrapper.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">struct <a class="link" href="GMimeDataWrapper.html#GMimeDataWrapper-struct" title="struct GMimeDataWrapper">GMimeDataWrapper</a>; +<a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="returnvalue">GMimeDataWrapper</span></a> * <a class="link" href="GMimeDataWrapper.html#g-mime-data-wrapper-new" title="g_mime_data_wrapper_new ()">g_mime_data_wrapper_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +<a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="returnvalue">GMimeDataWrapper</span></a> * <a class="link" href="GMimeDataWrapper.html#g-mime-data-wrapper-new-with-stream" title="g_mime_data_wrapper_new_with_stream ()">g_mime_data_wrapper_new_with_stream</a> (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</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="GMimeDataWrapper.html#g-mime-data-wrapper-set-stream" title="g_mime_data_wrapper_set_stream ()">g_mime_data_wrapper_set_stream</a> (<em class="parameter"><code><a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> *wrapper</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>); +<a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> * <a class="link" href="GMimeDataWrapper.html#g-mime-data-wrapper-get-stream" title="g_mime_data_wrapper_get_stream ()">g_mime_data_wrapper_get_stream</a> (<em class="parameter"><code><a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> *wrapper</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeDataWrapper.html#g-mime-data-wrapper-set-encoding" title="g_mime_data_wrapper_set_encoding ()">g_mime_data_wrapper_set_encoding</a> (<em class="parameter"><code><a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> *wrapper</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>); +<a class="link" href="gmime-gmime-encodings.html#GMimeContentEncoding" title="enum GMimeContentEncoding"><span class="returnvalue">GMimeContentEncoding</span></a> <a class="link" href="GMimeDataWrapper.html#g-mime-data-wrapper-get-encoding" title="g_mime_data_wrapper_get_encoding ()">g_mime_data_wrapper_get_encoding</a> (<em class="parameter"><code><a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> *wrapper</code></em>); +<span class="returnvalue">ssize_t</span> <a class="link" href="GMimeDataWrapper.html#g-mime-data-wrapper-write-to-stream" title="g_mime_data_wrapper_write_to_stream ()">g_mime_data_wrapper_write_to_stream</a> (<em class="parameter"><code><a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> *wrapper</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GMimeDataWrapper.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----GMimeDataWrapper +</pre> +</div> +<div class="refsect1"> +<a name="GMimeDataWrapper.description"></a><h2>Description</h2> +<p> +A <a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> is a wrapper object for a <a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a>'s body, +allowing clients to read the content from the backing stream +without having to know whether it is encoded/compressed/etc and not +neding to know how to undo said encoding(s). +</p> +</div> +<div class="refsect1"> +<a name="GMimeDataWrapper.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimeDataWrapper-struct"></a><h3>struct GMimeDataWrapper</h3> +<pre class="programlisting">struct GMimeDataWrapper;</pre> +<p> +A wrapper for a stream which may be encoded. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-data-wrapper-new"></a><h3>g_mime_data_wrapper_new ()</h3> +<pre class="programlisting"><a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="returnvalue">GMimeDataWrapper</span></a> * g_mime_data_wrapper_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Creates a new <a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> object. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a new data wrapper object.</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-data-wrapper-new-with-stream"></a><h3>g_mime_data_wrapper_new_with_stream ()</h3> +<pre class="programlisting"><a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="returnvalue">GMimeDataWrapper</span></a> * g_mime_data_wrapper_new_with_stream (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</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> +Creates a new <a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> object around <em class="parameter"><code>stream</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>stream</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>encoding</code></em> :</span></p></td> +<td>stream's encoding</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a data wrapper around <em class="parameter"><code>stream</code></em>. Since the wrapper owns its +own reference on the stream, caller is responsible for unrefing +its own copy.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-data-wrapper-set-stream"></a><h3>g_mime_data_wrapper_set_stream ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_data_wrapper_set_stream (<em class="parameter"><code><a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> *wrapper</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>);</pre> +<p> +Replaces the wrapper's internal stream with <em class="parameter"><code>stream</code></em>. Don't forget, +if <em class="parameter"><code>stream</code></em> is not of the same encoding as the old stream, you'll +want to call <a class="link" href="GMimeDataWrapper.html#g-mime-data-wrapper-set-encoding" title="g_mime_data_wrapper_set_encoding ()"><code class="function">g_mime_data_wrapper_set_encoding()</code></a> as well. +</p> +<p> +Note: caller is responsible for its own reference on +<em class="parameter"><code>stream</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>wrapper</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-data-wrapper-get-stream"></a><h3>g_mime_data_wrapper_get_stream ()</h3> +<pre class="programlisting"><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> * g_mime_data_wrapper_get_stream (<em class="parameter"><code><a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> *wrapper</code></em>);</pre> +<p> +Gets a reference to the stream wrapped by <em class="parameter"><code>wrapper</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>wrapper</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> +</td> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-data-wrapper-set-encoding"></a><h3>g_mime_data_wrapper_set_encoding ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_data_wrapper_set_encoding (<em class="parameter"><code><a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> *wrapper</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> +Sets the encoding type of the internal stream. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>wrapper</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>encoding</code></em> :</span></p></td> +<td>encoding</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-data-wrapper-get-encoding"></a><h3>g_mime_data_wrapper_get_encoding ()</h3> +<pre class="programlisting"><a class="link" href="gmime-gmime-encodings.html#GMimeContentEncoding" title="enum GMimeContentEncoding"><span class="returnvalue">GMimeContentEncoding</span></a> g_mime_data_wrapper_get_encoding (<em class="parameter"><code><a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> *wrapper</code></em>);</pre> +<p> +Gets the encoding type of the stream wrapped by <em class="parameter"><code>wrapper</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>wrapper</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the encoding type of the internal stream.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-data-wrapper-write-to-stream"></a><h3>g_mime_data_wrapper_write_to_stream ()</h3> +<pre class="programlisting"><span class="returnvalue">ssize_t</span> g_mime_data_wrapper_write_to_stream (<em class="parameter"><code><a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> *wrapper</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>);</pre> +<p> +Writes the raw (decoded) data to the output stream. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>wrapper</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td> +<td>output stream</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the number of bytes written or <code class="literal">-1</code> on failure.</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="GMimeDataWrapper.see-also"></a><h2>See Also</h2> +<a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/GMimeFilter.html b/docs/reference/html/GMimeFilter.html new file mode 100644 index 0000000..be4be39 --- /dev/null +++ b/docs/reference/html/GMimeFilter.html @@ -0,0 +1,303 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimeFilter</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="Filters.html" title="Stream Filters"> +<link rel="prev" href="Filters.html" title="Stream Filters"> +<link rel="next" href="GMimeFilterBasic.html" title="GMimeFilterBasic"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="Filters.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="Filters.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="GMimeFilterBasic.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GMimeFilter.synopsis" class="shortcut">Top</a> +  | + <a href="#GMimeFilter.description" class="shortcut">Description</a> +  | + <a href="#GMimeFilter.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GMimeFilter"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GMimeFilter.top_of_page"></a>GMimeFilter</span></h2> +<p>GMimeFilter — Abstract filter class</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GMimeFilter.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">struct <a class="link" href="GMimeFilter.html#GMimeFilter-struct" title="struct GMimeFilter">GMimeFilter</a>; +<a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> * <a class="link" href="GMimeFilter.html#g-mime-filter-copy" title="g_mime_filter_copy ()">g_mime_filter_copy</a> (<em class="parameter"><code><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> *filter</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeFilter.html#g-mime-filter-filter" title="g_mime_filter_filter ()">g_mime_filter_filter</a> (<em class="parameter"><code><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> *filter</code></em>, + <em class="parameter"><code><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">size_t</span> prespace</code></em>, + <em class="parameter"><code><span class="type">char</span> **outbuf</code></em>, + <em class="parameter"><code><span class="type">size_t</span> *outlen</code></em>, + <em class="parameter"><code><span class="type">size_t</span> *outprespace</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeFilter.html#g-mime-filter-complete" title="g_mime_filter_complete ()">g_mime_filter_complete</a> (<em class="parameter"><code><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> *filter</code></em>, + <em class="parameter"><code><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">size_t</span> prespace</code></em>, + <em class="parameter"><code><span class="type">char</span> **outbuf</code></em>, + <em class="parameter"><code><span class="type">size_t</span> *outlen</code></em>, + <em class="parameter"><code><span class="type">size_t</span> *outprespace</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeFilter.html#g-mime-filter-reset" title="g_mime_filter_reset ()">g_mime_filter_reset</a> (<em class="parameter"><code><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> *filter</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeFilter.html#g-mime-filter-backup" title="g_mime_filter_backup ()">g_mime_filter_backup</a> (<em class="parameter"><code><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> *filter</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *data</code></em>, + <em class="parameter"><code><span class="type">size_t</span> length</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeFilter.html#g-mime-filter-set-size" title="g_mime_filter_set_size ()">g_mime_filter_set_size</a> (<em class="parameter"><code><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> *filter</code></em>, + <em class="parameter"><code><span class="type">size_t</span> size</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> keep</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GMimeFilter.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----GMimeFilter + +----<a class="link" href="GMimeFilterBasic.html" title="GMimeFilterBasic">GMimeFilterBasic</a> + +----<a class="link" href="GMimeFilterBest.html" title="GMimeFilterBest">GMimeFilterBest</a> + +----<a class="link" href="GMimeFilterCharset.html" title="GMimeFilterCharset">GMimeFilterCharset</a> + +----<a class="link" href="GMimeFilterCRLF.html" title="GMimeFilterCRLF">GMimeFilterCRLF</a> + +----<a class="link" href="GMimeFilterEnriched.html" title="GMimeFilterEnriched">GMimeFilterEnriched</a> + +----<a class="link" href="GMimeFilterFrom.html" title="GMimeFilterFrom">GMimeFilterFrom</a> + +----<a class="link" href="GMimeFilterGZip.html" title="GMimeFilterGZip">GMimeFilterGZip</a> + +----<a class="link" href="GMimeFilterHTML.html" title="GMimeFilterHTML">GMimeFilterHTML</a> + +----<a class="link" href="GMimeFilterMd5.html" title="GMimeFilterMd5">GMimeFilterMd5</a> + +----<a class="link" href="GMimeFilterStrip.html" title="GMimeFilterStrip">GMimeFilterStrip</a> + +----<a class="link" href="GMimeFilterWindows.html" title="GMimeFilterWindows">GMimeFilterWindows</a> + +----<a class="link" href="GMimeFilterYenc.html" title="GMimeFilterYenc">GMimeFilterYenc</a> +</pre> +</div> +<div class="refsect1"> +<a name="GMimeFilter.description"></a><h2>Description</h2> +<p> +Stream filters are an efficient way of converting data from one +format to another. +</p> +</div> +<div class="refsect1"> +<a name="GMimeFilter.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimeFilter-struct"></a><h3>struct GMimeFilter</h3> +<pre class="programlisting">struct GMimeFilter;</pre> +<p> +Base class for filters used by <a class="link" href="GMimeStreamFilter.html" title="GMimeStreamFilter"><span class="type">GMimeStreamFilter</span></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-filter-copy"></a><h3>g_mime_filter_copy ()</h3> +<pre class="programlisting"><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> * g_mime_filter_copy (<em class="parameter"><code><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> *filter</code></em>);</pre> +<p> +Copies <em class="parameter"><code>filter</code></em> into a new GMimeFilter object. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>filter</code></em> :</span></p></td> +<td>filter</td> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-filter-filter"></a><h3>g_mime_filter_filter ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_filter_filter (<em class="parameter"><code><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> *filter</code></em>, + <em class="parameter"><code><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">size_t</span> prespace</code></em>, + <em class="parameter"><code><span class="type">char</span> **outbuf</code></em>, + <em class="parameter"><code><span class="type">size_t</span> *outlen</code></em>, + <em class="parameter"><code><span class="type">size_t</span> *outprespace</code></em>);</pre> +<p> +Filters the input data and writes it to <em class="parameter"><code>out</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>filter</code></em> :</span></p></td> +<td>filter</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>inbuf</code></em> :</span></p></td> +<td>input buffer</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>inlen</code></em> :</span></p></td> +<td>input buffer length</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>prespace</code></em> :</span></p></td> +<td>prespace buffer length</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>outbuf</code></em> :</span></p></td> +<td>pointer to output buffer</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>outlen</code></em> :</span></p></td> +<td>pointer to output length</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-filter-complete"></a><h3>g_mime_filter_complete ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_filter_complete (<em class="parameter"><code><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> *filter</code></em>, + <em class="parameter"><code><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">size_t</span> prespace</code></em>, + <em class="parameter"><code><span class="type">char</span> **outbuf</code></em>, + <em class="parameter"><code><span class="type">size_t</span> *outlen</code></em>, + <em class="parameter"><code><span class="type">size_t</span> *outprespace</code></em>);</pre> +<p> +Completes the filtering. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>filter</code></em> :</span></p></td> +<td>filter</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>inbuf</code></em> :</span></p></td> +<td>input buffer</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>inlen</code></em> :</span></p></td> +<td>input buffer length</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>prespace</code></em> :</span></p></td> +<td>prespace buffer length</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>outbuf</code></em> :</span></p></td> +<td>pointer to output buffer</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>outlen</code></em> :</span></p></td> +<td>pointer to output length</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-filter-reset"></a><h3>g_mime_filter_reset ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_filter_reset (<em class="parameter"><code><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> *filter</code></em>);</pre> +<p> +Resets the filter. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><em class="parameter"><code>filter</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> object</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-filter-backup"></a><h3>g_mime_filter_backup ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_filter_backup (<em class="parameter"><code><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> *filter</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *data</code></em>, + <em class="parameter"><code><span class="type">size_t</span> length</code></em>);</pre> +<p> +Sets number of bytes backed up on the input, new calls replace +previous ones +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>filter</code></em> :</span></p></td> +<td>filter</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>data to backup</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td> +<td>length of <em class="parameter"><code>data</code></em> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-filter-set-size"></a><h3>g_mime_filter_set_size ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_filter_set_size (<em class="parameter"><code><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> *filter</code></em>, + <em class="parameter"><code><span class="type">size_t</span> size</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> keep</code></em>);</pre> +<p> +Ensure this much size is available for filter output (if required) +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>filter</code></em> :</span></p></td> +<td>filter</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td> +<td>requested size for the output buffer</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>keep</code></em> :</span></p></td> +<td> +<code class="literal">TRUE</code> if existing data in the output buffer should be kept</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="GMimeFilter.see-also"></a><h2>See Also</h2> +<a class="link" href="GMimeStreamFilter.html" title="GMimeStreamFilter"><span class="type">GMimeStreamFilter</span></a> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/GMimeFilterBasic.html b/docs/reference/html/GMimeFilterBasic.html new file mode 100644 index 0000000..d4b518c --- /dev/null +++ b/docs/reference/html/GMimeFilterBasic.html @@ -0,0 +1,113 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimeFilterBasic</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="Filters.html" title="Stream Filters"> +<link rel="prev" href="GMimeFilter.html" title="GMimeFilter"> +<link rel="next" href="GMimeFilterBest.html" title="GMimeFilterBest"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="GMimeFilter.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="Filters.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="GMimeFilterBest.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GMimeFilterBasic.synopsis" class="shortcut">Top</a> +  | + <a href="#GMimeFilterBasic.description" class="shortcut">Description</a> +  | + <a href="#GMimeFilterBasic.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GMimeFilterBasic"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GMimeFilterBasic.top_of_page"></a>GMimeFilterBasic</span></h2> +<p>GMimeFilterBasic — Basic transfer encoding filter</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GMimeFilterBasic.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">struct <a class="link" href="GMimeFilterBasic.html#GMimeFilterBasic-struct" title="struct GMimeFilterBasic">GMimeFilterBasic</a>; +<a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> * <a class="link" href="GMimeFilterBasic.html#g-mime-filter-basic-new" title="g_mime_filter_basic_new ()">g_mime_filter_basic_new</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>, + <em class="parameter"><code><span class="type">gboolean</span> encode</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GMimeFilterBasic.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----<a class="link" href="GMimeFilter.html" title="GMimeFilter">GMimeFilter</a> + +----GMimeFilterBasic +</pre> +</div> +<div class="refsect1"> +<a name="GMimeFilterBasic.description"></a><h2>Description</h2> +<p> +A <a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> which can encode or decode basic MIME encodings such +as Quoted-Printable, Base64 and UUEncode. +</p> +</div> +<div class="refsect1"> +<a name="GMimeFilterBasic.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimeFilterBasic-struct"></a><h3>struct GMimeFilterBasic</h3> +<pre class="programlisting">struct GMimeFilterBasic;</pre> +<p> +A basic encoder/decoder filter for the MIME encodings. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-filter-basic-new"></a><h3>g_mime_filter_basic_new ()</h3> +<pre class="programlisting"><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> * g_mime_filter_basic_new (<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>, + <em class="parameter"><code><span class="type">gboolean</span> encode</code></em>);</pre> +<p> +Creates a new basic filter for <em class="parameter"><code>encoding</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>encoding</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-gmime-encodings.html#GMimeContentEncoding" title="enum GMimeContentEncoding"><span class="type">GMimeContentEncoding</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>encode</code></em> :</span></p></td> +<td> +<code class="literal">TRUE</code> to encode or <code class="literal">FALSE</code> to decode</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a new basic encoder filter.</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="GMimeFilterBasic.see-also"></a><h2>See Also</h2> +<a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/GMimeFilterBest.html b/docs/reference/html/GMimeFilterBest.html new file mode 100644 index 0000000..8ee75e0 --- /dev/null +++ b/docs/reference/html/GMimeFilterBest.html @@ -0,0 +1,203 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimeFilterBest</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="Filters.html" title="Stream Filters"> +<link rel="prev" href="GMimeFilterBasic.html" title="GMimeFilterBasic"> +<link rel="next" href="GMimeFilterCharset.html" title="GMimeFilterCharset"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="GMimeFilterBasic.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="Filters.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="GMimeFilterCharset.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GMimeFilterBest.synopsis" class="shortcut">Top</a> +  | + <a href="#GMimeFilterBest.description" class="shortcut">Description</a> +  | + <a href="#GMimeFilterBest.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GMimeFilterBest"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GMimeFilterBest.top_of_page"></a>GMimeFilterBest</span></h2> +<p>GMimeFilterBest — Determine the best charset/encoding to use for a stream</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GMimeFilterBest.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">struct <a class="link" href="GMimeFilterBest.html#GMimeFilterBest-struct" title="struct GMimeFilterBest">GMimeFilterBest</a>; +enum <a class="link" href="GMimeFilterBest.html#GMimeFilterBestFlags" title="enum GMimeFilterBestFlags">GMimeFilterBestFlags</a>; +<a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> * <a class="link" href="GMimeFilterBest.html#g-mime-filter-best-new" title="g_mime_filter_best_new ()">g_mime_filter_best_new</a> (<em class="parameter"><code><a class="link" href="GMimeFilterBest.html#GMimeFilterBestFlags" title="enum GMimeFilterBestFlags"><span class="type">GMimeFilterBestFlags</span></a> flags</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="GMimeFilterBest.html#g-mime-filter-best-charset" title="g_mime_filter_best_charset ()">g_mime_filter_best_charset</a> (<em class="parameter"><code><a class="link" href="GMimeFilterBest.html" title="GMimeFilterBest"><span class="type">GMimeFilterBest</span></a> *best</code></em>); +<a class="link" href="gmime-gmime-encodings.html#GMimeContentEncoding" title="enum GMimeContentEncoding"><span class="returnvalue">GMimeContentEncoding</span></a> <a class="link" href="GMimeFilterBest.html#g-mime-filter-best-encoding" title="g_mime_filter_best_encoding ()">g_mime_filter_best_encoding</a> (<em class="parameter"><code><a class="link" href="GMimeFilterBest.html" title="GMimeFilterBest"><span class="type">GMimeFilterBest</span></a> *best</code></em>, + <em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeEncodingConstraint" title="enum GMimeEncodingConstraint"><span class="type">GMimeEncodingConstraint</span></a> constraint</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GMimeFilterBest.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----<a class="link" href="GMimeFilter.html" title="GMimeFilter">GMimeFilter</a> + +----GMimeFilterBest +</pre> +</div> +<div class="refsect1"> +<a name="GMimeFilterBest.description"></a><h2>Description</h2> +<p> +A <a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> which is meant to determine the best charset and/or +transfer encoding suitable for the stream which is filtered through +it. +</p> +</div> +<div class="refsect1"> +<a name="GMimeFilterBest.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimeFilterBest-struct"></a><h3>struct GMimeFilterBest</h3> +<pre class="programlisting">struct GMimeFilterBest;</pre> +<p> +A filter for calculating the best encoding and/or charset to encode +the data passed through it. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="GMimeFilterBestFlags"></a><h3>enum GMimeFilterBestFlags</h3> +<pre class="programlisting">typedef enum { + GMIME_FILTER_BEST_CHARSET = (1 << 0), + GMIME_FILTER_BEST_ENCODING = (1 << 1) +} GMimeFilterBestFlags; +</pre> +<p> +Bit flags to enable charset and/or encoding scanning to make +educated guesses as to what the best charset and/or encodings to +use for the content passed through the filter. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><a name="GMIME-FILTER-BEST-CHARSET:CAPS"></a><span class="term"><code class="literal">GMIME_FILTER_BEST_CHARSET</code></span></p></td> +<td>Enable best-charset detection. +</td> +</tr> +<tr> +<td><p><a name="GMIME-FILTER-BEST-ENCODING:CAPS"></a><span class="term"><code class="literal">GMIME_FILTER_BEST_ENCODING</code></span></p></td> +<td>Enable best-encoding detection. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-filter-best-new"></a><h3>g_mime_filter_best_new ()</h3> +<pre class="programlisting"><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> * g_mime_filter_best_new (<em class="parameter"><code><a class="link" href="GMimeFilterBest.html#GMimeFilterBestFlags" title="enum GMimeFilterBestFlags"><span class="type">GMimeFilterBestFlags</span></a> flags</code></em>);</pre> +<p> +Creates a new GMimeFilterBest filter. <em class="parameter"><code>flags</code></em> are used to determine +which information to keep statistics of. If the +<a class="link" href="GMimeFilterBest.html#GMIME-FILTER-BEST-CHARSET:CAPS"><span class="type">GMIME_FILTER_BEST_CHARSET</span></a> bit is set, the filter will be able to +compute the best charset for encoding the stream of data +filtered. If the <a class="link" href="GMimeFilterBest.html#GMIME-FILTER-BEST-ENCODING:CAPS"><span class="type">GMIME_FILTER_BEST_ENCODING</span></a> bit is set, the filter +will be able to compute the best Content-Transfer-Encoding for use +with the stream being filtered. +</p> +<p> +Note: In order for the <a class="link" href="GMimeFilterBest.html#g-mime-filter-best-charset" title="g_mime_filter_best_charset ()"><code class="function">g_mime_filter_best_charset()</code></a> function to +work, the stream being filtered MUST already be encoded 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>flags</code></em> :</span></p></td> +<td>filter flags</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a new best filter with flags <em class="parameter"><code>flags</code></em>.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-filter-best-charset"></a><h3>g_mime_filter_best_charset ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_filter_best_charset (<em class="parameter"><code><a class="link" href="GMimeFilterBest.html" title="GMimeFilterBest"><span class="type">GMimeFilterBest</span></a> *best</code></em>);</pre> +<p> +Calculates the best charset for encoding the stream filtered +through the <em class="parameter"><code>best</code></em> filter. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>best</code></em> :</span></p></td> +<td>best filter</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a pointer to a string containing the name of the charset +best suited for the text filtered through <em class="parameter"><code>best</code></em>.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-filter-best-encoding"></a><h3>g_mime_filter_best_encoding ()</h3> +<pre class="programlisting"><a class="link" href="gmime-gmime-encodings.html#GMimeContentEncoding" title="enum GMimeContentEncoding"><span class="returnvalue">GMimeContentEncoding</span></a> g_mime_filter_best_encoding (<em class="parameter"><code><a class="link" href="GMimeFilterBest.html" title="GMimeFilterBest"><span class="type">GMimeFilterBest</span></a> *best</code></em>, + <em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeEncodingConstraint" title="enum GMimeEncodingConstraint"><span class="type">GMimeEncodingConstraint</span></a> constraint</code></em>);</pre> +<p> +Calculates the most efficient Content-Transfer-Encoding for the +stream filtered through <em class="parameter"><code>best</code></em> that fits within the encoding +<em class="parameter"><code>constraint</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>best</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeFilterBest.html" title="GMimeFilterBest"><span class="type">GMimeFilterBest</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>constraint</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-gmime-encodings.html#GMimeEncodingConstraint" title="enum GMimeEncodingConstraint"><span class="type">GMimeEncodingConstraint</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the best encoding for the stream filtered by <em class="parameter"><code>best</code></em>.</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="GMimeFilterBest.see-also"></a><h2>See Also</h2> +<a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/GMimeFilterCRLF.html b/docs/reference/html/GMimeFilterCRLF.html new file mode 100644 index 0000000..ad3c075 --- /dev/null +++ b/docs/reference/html/GMimeFilterCRLF.html @@ -0,0 +1,121 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimeFilterCRLF</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="Filters.html" title="Stream Filters"> +<link rel="prev" href="GMimeFilterCharset.html" title="GMimeFilterCharset"> +<link rel="next" href="GMimeFilterEnriched.html" title="GMimeFilterEnriched"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="GMimeFilterCharset.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="Filters.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="GMimeFilterEnriched.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GMimeFilterCRLF.synopsis" class="shortcut">Top</a> +  | + <a href="#GMimeFilterCRLF.description" class="shortcut">Description</a> +  | + <a href="#GMimeFilterCRLF.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GMimeFilterCRLF"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GMimeFilterCRLF.top_of_page"></a>GMimeFilterCRLF</span></h2> +<p>GMimeFilterCRLF — Convert line-endings from LF to CRLF or vise versa</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GMimeFilterCRLF.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">struct <a class="link" href="GMimeFilterCRLF.html#GMimeFilterCRLF-struct" title="struct GMimeFilterCRLF">GMimeFilterCRLF</a>; +<a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> * <a class="link" href="GMimeFilterCRLF.html#g-mime-filter-crlf-new" title="g_mime_filter_crlf_new ()">g_mime_filter_crlf_new</a> (<em class="parameter"><code><span class="type">gboolean</span> encode</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> dots</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GMimeFilterCRLF.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----<a class="link" href="GMimeFilter.html" title="GMimeFilter">GMimeFilter</a> + +----GMimeFilterCRLF +</pre> +</div> +<div class="refsect1"> +<a name="GMimeFilterCRLF.description"></a><h2>Description</h2> +<p> +A <a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> for converting between DOS and UNIX line-endings. +</p> +</div> +<div class="refsect1"> +<a name="GMimeFilterCRLF.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimeFilterCRLF-struct"></a><h3>struct GMimeFilterCRLF</h3> +<pre class="programlisting">struct GMimeFilterCRLF;</pre> +<p> +A filter to convert between line-ending formats and encode/decode +lines beginning with a '.'. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-filter-crlf-new"></a><h3>g_mime_filter_crlf_new ()</h3> +<pre class="programlisting"><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> * g_mime_filter_crlf_new (<em class="parameter"><code><span class="type">gboolean</span> encode</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> dots</code></em>);</pre> +<p> +Creates a new <a class="link" href="GMimeFilterCRLF.html" title="GMimeFilterCRLF"><span class="type">GMimeFilterCRLF</span></a> filter. +</p> +<p> +If <em class="parameter"><code>encode</code></em> is <code class="literal">TRUE</code>, then lone line-feeds ('\n') will be 'encoded' +into the canonical CRLF end-of-line sequence ("\r\n") otherwise +CRLF sequences will be 'decoded' into the UNIX line-ending form +('\n'). +</p> +<p> +The <em class="parameter"><code>dots</code></em> parameter tells the filter whether or not it should +encode or decode lines beginning with a dot ('.'). If both <em class="parameter"><code>encode</code></em> +and <em class="parameter"><code>dots</code></em> are <code class="literal">TRUE</code>, then a '.' at the beginning of a line will be +'encoded' into "..". If <em class="parameter"><code>encode</code></em> is <code class="literal">FALSE</code>, then ".." at the +beginning of a line will be decoded into a single '.'. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>encode</code></em> :</span></p></td> +<td> +<code class="literal">TRUE</code> if the filter should encode or <code class="literal">FALSE</code> otherwise</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>dots</code></em> :</span></p></td> +<td>encode/decode dots (as for SMTP)</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a new <a class="link" href="GMimeFilterCRLF.html" title="GMimeFilterCRLF"><span class="type">GMimeFilterCRLF</span></a> filter.</td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/GMimeFilterCharset.html b/docs/reference/html/GMimeFilterCharset.html new file mode 100644 index 0000000..ef0588d --- /dev/null +++ b/docs/reference/html/GMimeFilterCharset.html @@ -0,0 +1,108 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimeFilterCharset</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="Filters.html" title="Stream Filters"> +<link rel="prev" href="GMimeFilterBest.html" title="GMimeFilterBest"> +<link rel="next" href="GMimeFilterCRLF.html" title="GMimeFilterCRLF"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="GMimeFilterBest.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="Filters.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="GMimeFilterCRLF.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GMimeFilterCharset.synopsis" class="shortcut">Top</a> +  | + <a href="#GMimeFilterCharset.description" class="shortcut">Description</a> +  | + <a href="#GMimeFilterCharset.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GMimeFilterCharset"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GMimeFilterCharset.top_of_page"></a>GMimeFilterCharset</span></h2> +<p>GMimeFilterCharset — Charset-conversion filter</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GMimeFilterCharset.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">struct <a class="link" href="GMimeFilterCharset.html#GMimeFilterCharset-struct" title="struct GMimeFilterCharset">GMimeFilterCharset</a>; +<a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> * <a class="link" href="GMimeFilterCharset.html#g-mime-filter-charset-new" title="g_mime_filter_charset_new ()">g_mime_filter_charset_new</a> (<em class="parameter"><code>const <span class="type">char</span> *from_charset</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *to_charset</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GMimeFilterCharset.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----<a class="link" href="GMimeFilter.html" title="GMimeFilter">GMimeFilter</a> + +----GMimeFilterCharset +</pre> +</div> +<div class="refsect1"> +<a name="GMimeFilterCharset.description"></a><h2>Description</h2> +<p> +A <a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> which is used for converting text from one charset +to another. +</p> +</div> +<div class="refsect1"> +<a name="GMimeFilterCharset.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimeFilterCharset-struct"></a><h3>struct GMimeFilterCharset</h3> +<pre class="programlisting">struct GMimeFilterCharset;</pre> +<p> +A filter to convert between charsets. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-filter-charset-new"></a><h3>g_mime_filter_charset_new ()</h3> +<pre class="programlisting"><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> * g_mime_filter_charset_new (<em class="parameter"><code>const <span class="type">char</span> *from_charset</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *to_charset</code></em>);</pre> +<p> +Creates a new <a class="link" href="GMimeFilterCharset.html" title="GMimeFilterCharset"><span class="type">GMimeFilterCharset</span></a> filter. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>from_charset</code></em> :</span></p></td> +<td>charset to convert from</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>to_charset</code></em> :</span></p></td> +<td>charset to convert to</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a new charset filter or <code class="literal">NULL</code> if the charset conversion is +not possible.</td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/GMimeFilterEnriched.html b/docs/reference/html/GMimeFilterEnriched.html new file mode 100644 index 0000000..1c69842 --- /dev/null +++ b/docs/reference/html/GMimeFilterEnriched.html @@ -0,0 +1,116 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimeFilterEnriched</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="Filters.html" title="Stream Filters"> +<link rel="prev" href="GMimeFilterCRLF.html" title="GMimeFilterCRLF"> +<link rel="next" href="GMimeFilterFrom.html" title="GMimeFilterFrom"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="GMimeFilterCRLF.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="Filters.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="GMimeFilterFrom.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GMimeFilterEnriched.synopsis" class="shortcut">Top</a> +  | + <a href="#GMimeFilterEnriched.description" class="shortcut">Description</a> +  | + <a href="#GMimeFilterEnriched.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GMimeFilterEnriched"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GMimeFilterEnriched.top_of_page"></a>GMimeFilterEnriched</span></h2> +<p>GMimeFilterEnriched — Convert text/enriched or text/rtf to HTML</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GMimeFilterEnriched.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">#define <a class="link" href="GMimeFilterEnriched.html#GMIME-FILTER-ENRICHED-IS-RICHTEXT:CAPS" title="GMIME_FILTER_ENRICHED_IS_RICHTEXT">GMIME_FILTER_ENRICHED_IS_RICHTEXT</a> +struct <a class="link" href="GMimeFilterEnriched.html#GMimeFilterEnriched-struct" title="struct GMimeFilterEnriched">GMimeFilterEnriched</a>; +<a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> * <a class="link" href="GMimeFilterEnriched.html#g-mime-filter-enriched-new" title="g_mime_filter_enriched_new ()">g_mime_filter_enriched_new</a> (<em class="parameter"><code><span class="type">guint32</span> flags</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GMimeFilterEnriched.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----<a class="link" href="GMimeFilter.html" title="GMimeFilter">GMimeFilter</a> + +----GMimeFilterEnriched +</pre> +</div> +<div class="refsect1"> +<a name="GMimeFilterEnriched.description"></a><h2>Description</h2> +<p> +A <a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> used for converting text/enriched or text/rtf to HTML. +</p> +</div> +<div class="refsect1"> +<a name="GMimeFilterEnriched.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMIME-FILTER-ENRICHED-IS-RICHTEXT:CAPS"></a><h3>GMIME_FILTER_ENRICHED_IS_RICHTEXT</h3> +<pre class="programlisting">#define GMIME_FILTER_ENRICHED_IS_RICHTEXT (1 << 0) +</pre> +<p> +A bit flag for <a class="link" href="GMimeFilterEnriched.html#g-mime-filter-enriched-new" title="g_mime_filter_enriched_new ()"><code class="function">g_mime_filter_enriched_new()</code></a> which signifies that +the filter should expect Rich Text (aka RTF). +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GMimeFilterEnriched-struct"></a><h3>struct GMimeFilterEnriched</h3> +<pre class="programlisting">struct GMimeFilterEnriched;</pre> +<p> +A filter for converting text/enriched or text/richtext textual +streams into text/html. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-filter-enriched-new"></a><h3>g_mime_filter_enriched_new ()</h3> +<pre class="programlisting"><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> * g_mime_filter_enriched_new (<em class="parameter"><code><span class="type">guint32</span> flags</code></em>);</pre> +<p> +Creates a new GMimeFilterEnriched object. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td> +<td>flags</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a new GMimeFilter object.</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="GMimeFilterEnriched.see-also"></a><h2>See Also</h2> +<a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/GMimeFilterFrom.html b/docs/reference/html/GMimeFilterFrom.html new file mode 100644 index 0000000..7e4c664 --- /dev/null +++ b/docs/reference/html/GMimeFilterFrom.html @@ -0,0 +1,149 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimeFilterFrom</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="Filters.html" title="Stream Filters"> +<link rel="prev" href="GMimeFilterEnriched.html" title="GMimeFilterEnriched"> +<link rel="next" href="GMimeFilterGZip.html" title="GMimeFilterGZip"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="GMimeFilterEnriched.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="Filters.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="GMimeFilterGZip.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GMimeFilterFrom.synopsis" class="shortcut">Top</a> +  | + <a href="#GMimeFilterFrom.description" class="shortcut">Description</a> +  | + <a href="#GMimeFilterFrom.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GMimeFilterFrom"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GMimeFilterFrom.top_of_page"></a>GMimeFilterFrom</span></h2> +<p>GMimeFilterFrom — Escape MBox From_ lines</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GMimeFilterFrom.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">struct <a class="link" href="GMimeFilterFrom.html#GMimeFilterFrom-struct" title="struct GMimeFilterFrom">GMimeFilterFrom</a>; +enum <a class="link" href="GMimeFilterFrom.html#GMimeFilterFromMode" title="enum GMimeFilterFromMode">GMimeFilterFromMode</a>; +<a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> * <a class="link" href="GMimeFilterFrom.html#g-mime-filter-from-new" title="g_mime_filter_from_new ()">g_mime_filter_from_new</a> (<em class="parameter"><code><a class="link" href="GMimeFilterFrom.html#GMimeFilterFromMode" title="enum GMimeFilterFromMode"><span class="type">GMimeFilterFromMode</span></a> mode</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GMimeFilterFrom.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----<a class="link" href="GMimeFilter.html" title="GMimeFilter">GMimeFilter</a> + +----GMimeFilterFrom +</pre> +</div> +<div class="refsect1"> +<a name="GMimeFilterFrom.description"></a><h2>Description</h2> +<p> +A <a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> used for escaping MBox From_ lines using either the +traditional ">From " or quoted-printable encoding. +</p> +</div> +<div class="refsect1"> +<a name="GMimeFilterFrom.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimeFilterFrom-struct"></a><h3>struct GMimeFilterFrom</h3> +<pre class="programlisting">struct GMimeFilterFrom;</pre> +<p> +A filter for armoring or escaping lines beginning with "From ". +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="GMimeFilterFromMode"></a><h3>enum GMimeFilterFromMode</h3> +<pre class="programlisting">typedef enum { + GMIME_FILTER_FROM_MODE_DEFAULT = 0, + GMIME_FILTER_FROM_MODE_ESCAPE = 0, + GMIME_FILTER_FROM_MODE_ARMOR = 1 +} GMimeFilterFromMode; +</pre> +<p> +The mode for a <a class="link" href="GMimeFilterFrom.html" title="GMimeFilterFrom"><span class="type">GMimeFilterFrom</span></a> filter. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><a name="GMIME-FILTER-FROM-MODE-DEFAULT:CAPS"></a><span class="term"><code class="literal">GMIME_FILTER_FROM_MODE_DEFAULT</code></span></p></td> +<td>Default mode. +</td> +</tr> +<tr> +<td><p><a name="GMIME-FILTER-FROM-MODE-ESCAPE:CAPS"></a><span class="term"><code class="literal">GMIME_FILTER_FROM_MODE_ESCAPE</code></span></p></td> +<td>Escape 'From ' lines with a '>' +</td> +</tr> +<tr> +<td><p><a name="GMIME-FILTER-FROM-MODE-ARMOR:CAPS"></a><span class="term"><code class="literal">GMIME_FILTER_FROM_MODE_ARMOR</code></span></p></td> +<td>QP-Encode 'From ' lines +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-filter-from-new"></a><h3>g_mime_filter_from_new ()</h3> +<pre class="programlisting"><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> * g_mime_filter_from_new (<em class="parameter"><code><a class="link" href="GMimeFilterFrom.html#GMimeFilterFromMode" title="enum GMimeFilterFromMode"><span class="type">GMimeFilterFromMode</span></a> mode</code></em>);</pre> +<p> +Creates a new GMimeFilterFrom filter. If <em class="parameter"><code>mode</code></em> is +<a class="link" href="GMimeFilterFrom.html#GMIME-FILTER-FROM-MODE-ARMOR:CAPS"><span class="type">GMIME_FILTER_FROM_MODE_ARMOR</span></a>, the from-filter will encode from +lines using the quoted-printable encoding resulting in "=46rom ". +Using the <a class="link" href="GMimeFilterFrom.html#GMIME-FILTER-FROM-MODE-DEFAULT:CAPS"><span class="type">GMIME_FILTER_FROM_MODE_DEFAULT</span></a> or +<a class="link" href="GMimeFilterFrom.html#GMIME-FILTER-FROM-MODE-ESCAPE:CAPS"><span class="type">GMIME_FILTER_FROM_MODE_ESCAPE</span></a> mode (they are the same), from lines +will be escaped to ">From ". +</p> +<p> +Note: If you plan on using a from-filter in mode ARMOR, you should +remember to also use a <a class="link" href="GMimeFilterBasic.html" title="GMimeFilterBasic"><span class="type">GMimeFilterBasic</span></a> filter with an encoding of +<a class="link" href="gmime-gmime-encodings.html#GMIME-CONTENT-ENCODING-QUOTEDPRINTABLE:CAPS"><span class="type">GMIME_CONTENT_ENCODING_QUOTEDPRINTABLE</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>mode</code></em> :</span></p></td> +<td>filter mode</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a new from filter with mode <em class="parameter"><code>mode</code></em>.</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="GMimeFilterFrom.see-also"></a><h2>See Also</h2> +<a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/GMimeFilterGZip.html b/docs/reference/html/GMimeFilterGZip.html new file mode 100644 index 0000000..8bbc1b7 --- /dev/null +++ b/docs/reference/html/GMimeFilterGZip.html @@ -0,0 +1,139 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimeFilterGZip</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="Filters.html" title="Stream Filters"> +<link rel="prev" href="GMimeFilterFrom.html" title="GMimeFilterFrom"> +<link rel="next" href="GMimeFilterHTML.html" title="GMimeFilterHTML"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="GMimeFilterFrom.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="Filters.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="GMimeFilterHTML.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GMimeFilterGZip.synopsis" class="shortcut">Top</a> +  | + <a href="#GMimeFilterGZip.description" class="shortcut">Description</a> +  | + <a href="#GMimeFilterGZip.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GMimeFilterGZip"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GMimeFilterGZip.top_of_page"></a>GMimeFilterGZip</span></h2> +<p>GMimeFilterGZip — GNU Zip compression/decompression</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GMimeFilterGZip.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">struct <a class="link" href="GMimeFilterGZip.html#GMimeFilterGZip-struct" title="struct GMimeFilterGZip">GMimeFilterGZip</a>; +enum <a class="link" href="GMimeFilterGZip.html#GMimeFilterGZipMode" title="enum GMimeFilterGZipMode">GMimeFilterGZipMode</a>; +<a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> * <a class="link" href="GMimeFilterGZip.html#g-mime-filter-gzip-new" title="g_mime_filter_gzip_new ()">g_mime_filter_gzip_new</a> (<em class="parameter"><code><a class="link" href="GMimeFilterGZip.html#GMimeFilterGZipMode" title="enum GMimeFilterGZipMode"><span class="type">GMimeFilterGZipMode</span></a> mode</code></em>, + <em class="parameter"><code><span class="type">int</span> level</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GMimeFilterGZip.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----<a class="link" href="GMimeFilter.html" title="GMimeFilter">GMimeFilter</a> + +----GMimeFilterGZip +</pre> +</div> +<div class="refsect1"> +<a name="GMimeFilterGZip.description"></a><h2>Description</h2> +<p> +A <a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> used for compressing or decompressing a stream using +GNU Zip. +</p> +</div> +<div class="refsect1"> +<a name="GMimeFilterGZip.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimeFilterGZip-struct"></a><h3>struct GMimeFilterGZip</h3> +<pre class="programlisting">struct GMimeFilterGZip;</pre> +<p> +A filter for compresing or decompressing a gzip stream. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="GMimeFilterGZipMode"></a><h3>enum GMimeFilterGZipMode</h3> +<pre class="programlisting">typedef enum { + GMIME_FILTER_GZIP_MODE_ZIP, + GMIME_FILTER_GZIP_MODE_UNZIP +} GMimeFilterGZipMode; +</pre> +<p> +The mode for the <a class="link" href="GMimeFilterGZip.html" title="GMimeFilterGZip"><span class="type">GMimeFilterGZip</span></a> filter. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><a name="GMIME-FILTER-GZIP-MODE-ZIP:CAPS"></a><span class="term"><code class="literal">GMIME_FILTER_GZIP_MODE_ZIP</code></span></p></td> +<td>Compress (zip) mode. +</td> +</tr> +<tr> +<td><p><a name="GMIME-FILTER-GZIP-MODE-UNZIP:CAPS"></a><span class="term"><code class="literal">GMIME_FILTER_GZIP_MODE_UNZIP</code></span></p></td> +<td>Uncompress (unzip) mode. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-filter-gzip-new"></a><h3>g_mime_filter_gzip_new ()</h3> +<pre class="programlisting"><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> * g_mime_filter_gzip_new (<em class="parameter"><code><a class="link" href="GMimeFilterGZip.html#GMimeFilterGZipMode" title="enum GMimeFilterGZipMode"><span class="type">GMimeFilterGZipMode</span></a> mode</code></em>, + <em class="parameter"><code><span class="type">int</span> level</code></em>);</pre> +<p> +Creates a new gzip (or gunzip) filter. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>mode</code></em> :</span></p></td> +<td>zip or unzip</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>level</code></em> :</span></p></td> +<td>compression level</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a new gzip (or gunzip) filter.</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="GMimeFilterGZip.see-also"></a><h2>See Also</h2> +<a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/GMimeFilterHTML.html b/docs/reference/html/GMimeFilterHTML.html new file mode 100644 index 0000000..0b3a46d --- /dev/null +++ b/docs/reference/html/GMimeFilterHTML.html @@ -0,0 +1,192 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimeFilterHTML</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="Filters.html" title="Stream Filters"> +<link rel="prev" href="GMimeFilterGZip.html" title="GMimeFilterGZip"> +<link rel="next" href="GMimeFilterMd5.html" title="GMimeFilterMd5"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="GMimeFilterGZip.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="Filters.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="GMimeFilterMd5.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GMimeFilterHTML.synopsis" class="shortcut">Top</a> +  | + <a href="#GMimeFilterHTML.description" class="shortcut">Description</a> +  | + <a href="#GMimeFilterHTML.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GMimeFilterHTML"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GMimeFilterHTML.top_of_page"></a>GMimeFilterHTML</span></h2> +<p>GMimeFilterHTML — Convert plain text into HTML</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GMimeFilterHTML.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">struct <a class="link" href="GMimeFilterHTML.html#GMimeFilterHTML-struct" title="struct GMimeFilterHTML">GMimeFilterHTML</a>; +#define <a class="link" href="GMimeFilterHTML.html#GMIME-FILTER-HTML-PRE:CAPS" title="GMIME_FILTER_HTML_PRE">GMIME_FILTER_HTML_PRE</a> +#define <a class="link" href="GMimeFilterHTML.html#GMIME-FILTER-HTML-CONVERT-NL:CAPS" title="GMIME_FILTER_HTML_CONVERT_NL">GMIME_FILTER_HTML_CONVERT_NL</a> +#define <a class="link" href="GMimeFilterHTML.html#GMIME-FILTER-HTML-CONVERT-SPACES:CAPS" title="GMIME_FILTER_HTML_CONVERT_SPACES">GMIME_FILTER_HTML_CONVERT_SPACES</a> +#define <a class="link" href="GMimeFilterHTML.html#GMIME-FILTER-HTML-CONVERT-URLS:CAPS" title="GMIME_FILTER_HTML_CONVERT_URLS">GMIME_FILTER_HTML_CONVERT_URLS</a> +#define <a class="link" href="GMimeFilterHTML.html#GMIME-FILTER-HTML-MARK-CITATION:CAPS" title="GMIME_FILTER_HTML_MARK_CITATION">GMIME_FILTER_HTML_MARK_CITATION</a> +#define <a class="link" href="GMimeFilterHTML.html#GMIME-FILTER-HTML-CONVERT-ADDRESSES:CAPS" title="GMIME_FILTER_HTML_CONVERT_ADDRESSES">GMIME_FILTER_HTML_CONVERT_ADDRESSES</a> +#define <a class="link" href="GMimeFilterHTML.html#GMIME-FILTER-HTML-ESCAPE-8BIT:CAPS" title="GMIME_FILTER_HTML_ESCAPE_8BIT">GMIME_FILTER_HTML_ESCAPE_8BIT</a> +#define <a class="link" href="GMimeFilterHTML.html#GMIME-FILTER-HTML-CITE:CAPS" title="GMIME_FILTER_HTML_CITE">GMIME_FILTER_HTML_CITE</a> +<a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> * <a class="link" href="GMimeFilterHTML.html#g-mime-filter-html-new" title="g_mime_filter_html_new ()">g_mime_filter_html_new</a> (<em class="parameter"><code><span class="type">guint32</span> flags</code></em>, + <em class="parameter"><code><span class="type">guint32</span> colour</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GMimeFilterHTML.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----<a class="link" href="GMimeFilter.html" title="GMimeFilter">GMimeFilter</a> + +----GMimeFilterHTML +</pre> +</div> +<div class="refsect1"> +<a name="GMimeFilterHTML.description"></a><h2>Description</h2> +<p> +A <a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> used for converting plain text into HTML. +</p> +</div> +<div class="refsect1"> +<a name="GMimeFilterHTML.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimeFilterHTML-struct"></a><h3>struct GMimeFilterHTML</h3> +<pre class="programlisting">struct GMimeFilterHTML;</pre> +<p> +A filter for converting text/plain into text/html. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="GMIME-FILTER-HTML-PRE:CAPS"></a><h3>GMIME_FILTER_HTML_PRE</h3> +<pre class="programlisting">#define GMIME_FILTER_HTML_PRE (1 << 0) +</pre> +<p> +Wrap stream in <pre> tags. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GMIME-FILTER-HTML-CONVERT-NL:CAPS"></a><h3>GMIME_FILTER_HTML_CONVERT_NL</h3> +<pre class="programlisting">#define GMIME_FILTER_HTML_CONVERT_NL (1 << 1) +</pre> +<p> +Convert new-lines ('\n') into <br> tags. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GMIME-FILTER-HTML-CONVERT-SPACES:CAPS"></a><h3>GMIME_FILTER_HTML_CONVERT_SPACES</h3> +<pre class="programlisting">#define GMIME_FILTER_HTML_CONVERT_SPACES (1 << 2) +</pre> +<p> +Preserve whitespace by converting spaces into their appropriate +html entities. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GMIME-FILTER-HTML-CONVERT-URLS:CAPS"></a><h3>GMIME_FILTER_HTML_CONVERT_URLS</h3> +<pre class="programlisting">#define GMIME_FILTER_HTML_CONVERT_URLS (1 << 3) +</pre> +<p> +Wrap detected URLs in <a href=...> tags. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GMIME-FILTER-HTML-MARK-CITATION:CAPS"></a><h3>GMIME_FILTER_HTML_MARK_CITATION</h3> +<pre class="programlisting">#define GMIME_FILTER_HTML_MARK_CITATION (1 << 4) +</pre> +<p> +Change the colour of citation text. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GMIME-FILTER-HTML-CONVERT-ADDRESSES:CAPS"></a><h3>GMIME_FILTER_HTML_CONVERT_ADDRESSES</h3> +<pre class="programlisting">#define GMIME_FILTER_HTML_CONVERT_ADDRESSES (1 << 5) +</pre> +<p> +Wrap email addresses in "mailto:" href tags. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GMIME-FILTER-HTML-ESCAPE-8BIT:CAPS"></a><h3>GMIME_FILTER_HTML_ESCAPE_8BIT</h3> +<pre class="programlisting">#define GMIME_FILTER_HTML_ESCAPE_8BIT (1 << 6) +</pre> +<p> +Converts 8bit characters to '?'. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GMIME-FILTER-HTML-CITE:CAPS"></a><h3>GMIME_FILTER_HTML_CITE</h3> +<pre class="programlisting">#define GMIME_FILTER_HTML_CITE (1 << 7) +</pre> +<p> +Cites text by prepending "> " to each cited line. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-filter-html-new"></a><h3>g_mime_filter_html_new ()</h3> +<pre class="programlisting"><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> * g_mime_filter_html_new (<em class="parameter"><code><span class="type">guint32</span> flags</code></em>, + <em class="parameter"><code><span class="type">guint32</span> colour</code></em>);</pre> +<p> +Creates a new GMimeFilterHTML filter which can be used to convert a +plain UTF-8 text stream into an html stream. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td> +<td>html flags</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>colour</code></em> :</span></p></td> +<td>citation colour</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a new html filter.</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="GMimeFilterHTML.see-also"></a><h2>See Also</h2> +<a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/GMimeFilterMd5.html b/docs/reference/html/GMimeFilterMd5.html new file mode 100644 index 0000000..8166ef0 --- /dev/null +++ b/docs/reference/html/GMimeFilterMd5.html @@ -0,0 +1,122 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimeFilterMd5</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="Filters.html" title="Stream Filters"> +<link rel="prev" href="GMimeFilterHTML.html" title="GMimeFilterHTML"> +<link rel="next" href="GMimeFilterStrip.html" title="GMimeFilterStrip"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="GMimeFilterHTML.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="Filters.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="GMimeFilterStrip.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GMimeFilterMd5.synopsis" class="shortcut">Top</a> +  | + <a href="#GMimeFilterMd5.description" class="shortcut">Description</a> +  | + <a href="#GMimeFilterMd5.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GMimeFilterMd5"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GMimeFilterMd5.top_of_page"></a>GMimeFilterMd5</span></h2> +<p>GMimeFilterMd5 — Calculate an md5sum</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GMimeFilterMd5.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">struct <a class="link" href="GMimeFilterMd5.html#GMimeFilterMd5-struct" title="struct GMimeFilterMd5">GMimeFilterMd5</a>; +<a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> * <a class="link" href="GMimeFilterMd5.html#g-mime-filter-md5-new" title="g_mime_filter_md5_new ()">g_mime_filter_md5_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeFilterMd5.html#g-mime-filter-md5-get-digest" title="g_mime_filter_md5_get_digest ()">g_mime_filter_md5_get_digest</a> (<em class="parameter"><code><a class="link" href="GMimeFilterMd5.html" title="GMimeFilterMd5"><span class="type">GMimeFilterMd5</span></a> *md5</code></em>, + <em class="parameter"><code>unsigned <span class="type">char</span> digest[16]</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GMimeFilterMd5.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----<a class="link" href="GMimeFilter.html" title="GMimeFilter">GMimeFilter</a> + +----GMimeFilterMd5 +</pre> +</div> +<div class="refsect1"> +<a name="GMimeFilterMd5.description"></a><h2>Description</h2> +<p> +Calculate an md5sum for a stream. +</p> +</div> +<div class="refsect1"> +<a name="GMimeFilterMd5.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimeFilterMd5-struct"></a><h3>struct GMimeFilterMd5</h3> +<pre class="programlisting">struct GMimeFilterMd5;</pre> +<p> +A filter for calculating the MD5 checksum of a stream. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-filter-md5-new"></a><h3>g_mime_filter_md5_new ()</h3> +<pre class="programlisting"><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> * g_mime_filter_md5_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Creates a new Md5 filter. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a new Md5 filter.</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-filter-md5-get-digest"></a><h3>g_mime_filter_md5_get_digest ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_filter_md5_get_digest (<em class="parameter"><code><a class="link" href="GMimeFilterMd5.html" title="GMimeFilterMd5"><span class="type">GMimeFilterMd5</span></a> *md5</code></em>, + <em class="parameter"><code>unsigned <span class="type">char</span> digest[16]</code></em>);</pre> +<p> +Outputs the md5 digest into <em class="parameter"><code>digest</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>md5</code></em> :</span></p></td> +<td>md5 filter object</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>digest</code></em> :</span></p></td> +<td>output buffer of at least 16 bytes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="GMimeFilterMd5.see-also"></a><h2>See Also</h2> +<a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/GMimeFilterStrip.html b/docs/reference/html/GMimeFilterStrip.html new file mode 100644 index 0000000..522cec1 --- /dev/null +++ b/docs/reference/html/GMimeFilterStrip.html @@ -0,0 +1,100 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimeFilterStrip</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="Filters.html" title="Stream Filters"> +<link rel="prev" href="GMimeFilterMd5.html" title="GMimeFilterMd5"> +<link rel="next" href="GMimeFilterWindows.html" title="GMimeFilterWindows"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="GMimeFilterMd5.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="Filters.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="GMimeFilterWindows.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GMimeFilterStrip.synopsis" class="shortcut">Top</a> +  | + <a href="#GMimeFilterStrip.description" class="shortcut">Description</a> +  | + <a href="#GMimeFilterStrip.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GMimeFilterStrip"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GMimeFilterStrip.top_of_page"></a>GMimeFilterStrip</span></h2> +<p>GMimeFilterStrip — Strip trailing whitespace from the end of lines</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GMimeFilterStrip.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">struct <a class="link" href="GMimeFilterStrip.html#GMimeFilterStrip-struct" title="struct GMimeFilterStrip">GMimeFilterStrip</a>; +<a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> * <a class="link" href="GMimeFilterStrip.html#g-mime-filter-strip-new" title="g_mime_filter_strip_new ()">g_mime_filter_strip_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GMimeFilterStrip.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----<a class="link" href="GMimeFilter.html" title="GMimeFilter">GMimeFilter</a> + +----GMimeFilterStrip +</pre> +</div> +<div class="refsect1"> +<a name="GMimeFilterStrip.description"></a><h2>Description</h2> +<p> +A <a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> used for stripping trailing whitespace from the end +of lines. +</p> +</div> +<div class="refsect1"> +<a name="GMimeFilterStrip.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimeFilterStrip-struct"></a><h3>struct GMimeFilterStrip</h3> +<pre class="programlisting">struct GMimeFilterStrip;</pre> +<p> +A filter for stripping whitespace from the end of lines. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-filter-strip-new"></a><h3>g_mime_filter_strip_new ()</h3> +<pre class="programlisting"><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> * g_mime_filter_strip_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Creates a new <a class="link" href="GMimeFilterStrip.html" title="GMimeFilterStrip"><span class="type">GMimeFilterStrip</span></a> filter which will strip trailing +whitespace from every line of input passed through the filter. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a new strip filter.</td> +</tr></tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="GMimeFilterStrip.see-also"></a><h2>See Also</h2> +<a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/GMimeFilterWindows.html b/docs/reference/html/GMimeFilterWindows.html new file mode 100644 index 0000000..435cfd3 --- /dev/null +++ b/docs/reference/html/GMimeFilterWindows.html @@ -0,0 +1,160 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimeFilterWindows</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="Filters.html" title="Stream Filters"> +<link rel="prev" href="GMimeFilterStrip.html" title="GMimeFilterStrip"> +<link rel="next" href="GMimeFilterYenc.html" title="GMimeFilterYenc"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="GMimeFilterStrip.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="Filters.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="GMimeFilterYenc.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GMimeFilterWindows.synopsis" class="shortcut">Top</a> +  | + <a href="#GMimeFilterWindows.description" class="shortcut">Description</a> +  | + <a href="#GMimeFilterWindows.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GMimeFilterWindows"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GMimeFilterWindows.top_of_page"></a>GMimeFilterWindows</span></h2> +<p>GMimeFilterWindows — Determine if text is in a Microsoft Windows codepage</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GMimeFilterWindows.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">struct <a class="link" href="GMimeFilterWindows.html#GMimeFilterWindows-struct" title="struct GMimeFilterWindows">GMimeFilterWindows</a>; +<a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> * <a class="link" href="GMimeFilterWindows.html#g-mime-filter-windows-new" title="g_mime_filter_windows_new ()">g_mime_filter_windows_new</a> (<em class="parameter"><code>const <span class="type">char</span> *claimed_charset</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="GMimeFilterWindows.html#g-mime-filter-windows-is-windows-charset" title="g_mime_filter_windows_is_windows_charset ()">g_mime_filter_windows_is_windows_charset</a> + (<em class="parameter"><code><a class="link" href="GMimeFilterWindows.html" title="GMimeFilterWindows"><span class="type">GMimeFilterWindows</span></a> *filter</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="GMimeFilterWindows.html#g-mime-filter-windows-real-charset" title="g_mime_filter_windows_real_charset ()">g_mime_filter_windows_real_charset</a> (<em class="parameter"><code><a class="link" href="GMimeFilterWindows.html" title="GMimeFilterWindows"><span class="type">GMimeFilterWindows</span></a> *filter</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GMimeFilterWindows.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----<a class="link" href="GMimeFilter.html" title="GMimeFilter">GMimeFilter</a> + +----GMimeFilterWindows +</pre> +</div> +<div class="refsect1"> +<a name="GMimeFilterWindows.description"></a><h2>Description</h2> +<p> +A <a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> used for determining if text marked as iso-8859-## +is actually encoded in one of the Windows-CP125# charsets. +</p> +</div> +<div class="refsect1"> +<a name="GMimeFilterWindows.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimeFilterWindows-struct"></a><h3>struct GMimeFilterWindows</h3> +<pre class="programlisting">struct GMimeFilterWindows;</pre> +<p> +A filter for detecting whether or not a text stream claimed to be +iso-8859-X is really that charset or if it is really a +Windows-CP125x charset. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-filter-windows-new"></a><h3>g_mime_filter_windows_new ()</h3> +<pre class="programlisting"><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> * g_mime_filter_windows_new (<em class="parameter"><code>const <span class="type">char</span> *claimed_charset</code></em>);</pre> +<p> +Creates a new GMimeFilterWindows filter. When a stream of text has +been filtered, it can be determined whether or not said text stream +was in <em class="parameter"><code>claimed_charset</code></em> or the equivalent Windows-CP125# charset. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>claimed_charset</code></em> :</span></p></td> +<td>charset that a text stream claims to be</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a new windows filter.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-filter-windows-is-windows-charset"></a><h3>g_mime_filter_windows_is_windows_charset ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_filter_windows_is_windows_charset + (<em class="parameter"><code><a class="link" href="GMimeFilterWindows.html" title="GMimeFilterWindows"><span class="type">GMimeFilterWindows</span></a> *filter</code></em>);</pre> +<p> +Determines whether or not a Windows-CP125# charset has been +detected so far. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>filter</code></em> :</span></p></td> +<td>windows filter object</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> if the filtered stream has been detected to contain +Windows-CP125# characters or <code class="literal">FALSE</code> otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-filter-windows-real-charset"></a><h3>g_mime_filter_windows_real_charset ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_filter_windows_real_charset (<em class="parameter"><code><a class="link" href="GMimeFilterWindows.html" title="GMimeFilterWindows"><span class="type">GMimeFilterWindows</span></a> *filter</code></em>);</pre> +<p> +Figures out the real charset that the text is encoded in based on whether or not Windows-CP125# characters were found. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>filter</code></em> :</span></p></td> +<td>windows filter object</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a const string pointer to the claimed charset if filtered +text stream was found not to contain any Windows-CP125# characters +or the proper Windows-CP125# charset.</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="GMimeFilterWindows.see-also"></a><h2>See Also</h2> +<a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/GMimeFilterYenc.html b/docs/reference/html/GMimeFilterYenc.html new file mode 100644 index 0000000..ce4c6ca --- /dev/null +++ b/docs/reference/html/GMimeFilterYenc.html @@ -0,0 +1,498 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimeFilterYenc</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="Filters.html" title="Stream Filters"> +<link rel="prev" href="GMimeFilterWindows.html" title="GMimeFilterWindows"> +<link rel="next" href="DataWrappers.html" title="Data Wrappers"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="GMimeFilterWindows.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="Filters.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="DataWrappers.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GMimeFilterYenc.synopsis" class="shortcut">Top</a> +  | + <a href="#GMimeFilterYenc.description" class="shortcut">Description</a> +  | + <a href="#GMimeFilterYenc.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GMimeFilterYenc"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GMimeFilterYenc.top_of_page"></a>GMimeFilterYenc</span></h2> +<p>GMimeFilterYenc — yEncode or yDecode</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GMimeFilterYenc.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">struct <a class="link" href="GMimeFilterYenc.html#GMimeFilterYenc-struct" title="struct GMimeFilterYenc">GMimeFilterYenc</a>; +<a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> * <a class="link" href="GMimeFilterYenc.html#g-mime-filter-yenc-new" title="g_mime_filter_yenc_new ()">g_mime_filter_yenc_new</a> (<em class="parameter"><code><span class="type">gboolean</span> encode</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeFilterYenc.html#g-mime-filter-yenc-set-state" title="g_mime_filter_yenc_set_state ()">g_mime_filter_yenc_set_state</a> (<em class="parameter"><code><a class="link" href="GMimeFilterYenc.html" title="GMimeFilterYenc"><span class="type">GMimeFilterYenc</span></a> *yenc</code></em>, + <em class="parameter"><code><span class="type">int</span> state</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeFilterYenc.html#g-mime-filter-yenc-set-crc" title="g_mime_filter_yenc_set_crc ()">g_mime_filter_yenc_set_crc</a> (<em class="parameter"><code><a class="link" href="GMimeFilterYenc.html" title="GMimeFilterYenc"><span class="type">GMimeFilterYenc</span></a> *yenc</code></em>, + <em class="parameter"><code><span class="type">guint32</span> crc</code></em>); +<span class="returnvalue">guint32</span> <a class="link" href="GMimeFilterYenc.html#g-mime-filter-yenc-get-crc" title="g_mime_filter_yenc_get_crc ()">g_mime_filter_yenc_get_crc</a> (<em class="parameter"><code><a class="link" href="GMimeFilterYenc.html" title="GMimeFilterYenc"><span class="type">GMimeFilterYenc</span></a> *yenc</code></em>); +<span class="returnvalue">guint32</span> <a class="link" href="GMimeFilterYenc.html#g-mime-filter-yenc-get-pcrc" title="g_mime_filter_yenc_get_pcrc ()">g_mime_filter_yenc_get_pcrc</a> (<em class="parameter"><code><a class="link" href="GMimeFilterYenc.html" title="GMimeFilterYenc"><span class="type">GMimeFilterYenc</span></a> *yenc</code></em>); + +#define <a class="link" href="GMimeFilterYenc.html#GMIME-YENCODE-CRC-INIT:CAPS" title="GMIME_YENCODE_CRC_INIT">GMIME_YENCODE_CRC_INIT</a> +#define <a class="link" href="GMimeFilterYenc.html#GMIME-YENCODE-CRC-FINAL:CAPS" title="GMIME_YENCODE_CRC_FINAL()">GMIME_YENCODE_CRC_FINAL</a> (crc) +#define <a class="link" href="GMimeFilterYenc.html#GMIME-YENCODE-STATE-INIT:CAPS" title="GMIME_YENCODE_STATE_INIT">GMIME_YENCODE_STATE_INIT</a> +#define <a class="link" href="GMimeFilterYenc.html#GMIME-YDECODE-STATE-INIT:CAPS" title="GMIME_YDECODE_STATE_INIT">GMIME_YDECODE_STATE_INIT</a> +#define <a class="link" href="GMimeFilterYenc.html#GMIME-YDECODE-STATE-EOLN:CAPS" title="GMIME_YDECODE_STATE_EOLN">GMIME_YDECODE_STATE_EOLN</a> +#define <a class="link" href="GMimeFilterYenc.html#GMIME-YDECODE-STATE-ESCAPE:CAPS" title="GMIME_YDECODE_STATE_ESCAPE">GMIME_YDECODE_STATE_ESCAPE</a> +#define <a class="link" href="GMimeFilterYenc.html#GMIME-YDECODE-STATE-END:CAPS" title="GMIME_YDECODE_STATE_END">GMIME_YDECODE_STATE_END</a> +#define <a class="link" href="GMimeFilterYenc.html#GMIME-YDECODE-STATE-BEGIN:CAPS" title="GMIME_YDECODE_STATE_BEGIN">GMIME_YDECODE_STATE_BEGIN</a> +#define <a class="link" href="GMimeFilterYenc.html#GMIME-YDECODE-STATE-DECODE:CAPS" title="GMIME_YDECODE_STATE_DECODE">GMIME_YDECODE_STATE_DECODE</a> +#define <a class="link" href="GMimeFilterYenc.html#GMIME-YDECODE-STATE-PART:CAPS" title="GMIME_YDECODE_STATE_PART">GMIME_YDECODE_STATE_PART</a> +<span class="returnvalue">size_t</span> <a class="link" href="GMimeFilterYenc.html#g-mime-ydecode-step" title="g_mime_ydecode_step ()">g_mime_ydecode_step</a> (<em class="parameter"><code>const unsigned <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>unsigned <span class="type">char</span> *outbuf</code></em>, + <em class="parameter"><code><span class="type">int</span> *state</code></em>, + <em class="parameter"><code><span class="type">guint32</span> *pcrc</code></em>, + <em class="parameter"><code><span class="type">guint32</span> *crc</code></em>); +<span class="returnvalue">size_t</span> <a class="link" href="GMimeFilterYenc.html#g-mime-yencode-step" title="g_mime_yencode_step ()">g_mime_yencode_step</a> (<em class="parameter"><code>const unsigned <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>unsigned <span class="type">char</span> *outbuf</code></em>, + <em class="parameter"><code><span class="type">int</span> *state</code></em>, + <em class="parameter"><code><span class="type">guint32</span> *pcrc</code></em>, + <em class="parameter"><code><span class="type">guint32</span> *crc</code></em>); +<span class="returnvalue">size_t</span> <a class="link" href="GMimeFilterYenc.html#g-mime-yencode-close" title="g_mime_yencode_close ()">g_mime_yencode_close</a> (<em class="parameter"><code>const unsigned <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>unsigned <span class="type">char</span> *outbuf</code></em>, + <em class="parameter"><code><span class="type">int</span> *state</code></em>, + <em class="parameter"><code><span class="type">guint32</span> *pcrc</code></em>, + <em class="parameter"><code><span class="type">guint32</span> *crc</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GMimeFilterYenc.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----<a class="link" href="GMimeFilter.html" title="GMimeFilter">GMimeFilter</a> + +----GMimeFilterYenc +</pre> +</div> +<div class="refsect1"> +<a name="GMimeFilterYenc.description"></a><h2>Description</h2> +<p> +A <a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> used to encode or decode the Usenet yEncoding. +</p> +</div> +<div class="refsect1"> +<a name="GMimeFilterYenc.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimeFilterYenc-struct"></a><h3>struct GMimeFilterYenc</h3> +<pre class="programlisting">struct GMimeFilterYenc;</pre> +<p> +A filter for yEncoding or yDecoding a stream. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-filter-yenc-new"></a><h3>g_mime_filter_yenc_new ()</h3> +<pre class="programlisting"><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="returnvalue">GMimeFilter</span></a> * g_mime_filter_yenc_new (<em class="parameter"><code><span class="type">gboolean</span> encode</code></em>);</pre> +<p> +Creates a new yEnc filter. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>encode</code></em> :</span></p></td> +<td>encode vs decode</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a new yEnc filter.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-filter-yenc-set-state"></a><h3>g_mime_filter_yenc_set_state ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_filter_yenc_set_state (<em class="parameter"><code><a class="link" href="GMimeFilterYenc.html" title="GMimeFilterYenc"><span class="type">GMimeFilterYenc</span></a> *yenc</code></em>, + <em class="parameter"><code><span class="type">int</span> state</code></em>);</pre> +<p> +Sets the current state of the yencoder/ydecoder +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>yenc</code></em> :</span></p></td> +<td>yEnc filter</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td> +<td>encode/decode state</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-filter-yenc-set-crc"></a><h3>g_mime_filter_yenc_set_crc ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_filter_yenc_set_crc (<em class="parameter"><code><a class="link" href="GMimeFilterYenc.html" title="GMimeFilterYenc"><span class="type">GMimeFilterYenc</span></a> *yenc</code></em>, + <em class="parameter"><code><span class="type">guint32</span> crc</code></em>);</pre> +<p> +Sets the current crc32 value on the yEnc filter <em class="parameter"><code>yenc</code></em> to <em class="parameter"><code>crc</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>yenc</code></em> :</span></p></td> +<td>yEnc filter</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>crc</code></em> :</span></p></td> +<td>crc32</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-filter-yenc-get-crc"></a><h3>g_mime_filter_yenc_get_crc ()</h3> +<pre class="programlisting"><span class="returnvalue">guint32</span> g_mime_filter_yenc_get_crc (<em class="parameter"><code><a class="link" href="GMimeFilterYenc.html" title="GMimeFilterYenc"><span class="type">GMimeFilterYenc</span></a> *yenc</code></em>);</pre> +<p> +Get the computed crc or (guint32) -1 on fail. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>yenc</code></em> :</span></p></td> +<td>yEnc filter</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the computed crc or (guint32) -1 on fail.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-filter-yenc-get-pcrc"></a><h3>g_mime_filter_yenc_get_pcrc ()</h3> +<pre class="programlisting"><span class="returnvalue">guint32</span> g_mime_filter_yenc_get_pcrc (<em class="parameter"><code><a class="link" href="GMimeFilterYenc.html" title="GMimeFilterYenc"><span class="type">GMimeFilterYenc</span></a> *yenc</code></em>);</pre> +<p> +Get the computed part crc or (guint32) -1 on fail. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>yenc</code></em> :</span></p></td> +<td>yEnc filter</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the computed part crc or (guint32) -1 on fail.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="GMIME-YENCODE-CRC-INIT:CAPS"></a><h3>GMIME_YENCODE_CRC_INIT</h3> +<pre class="programlisting">#define GMIME_YENCODE_CRC_INIT (~0) +</pre> +<p> +Initial state for the crc and pcrc state variables. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GMIME-YENCODE-CRC-FINAL:CAPS"></a><h3>GMIME_YENCODE_CRC_FINAL()</h3> +<pre class="programlisting">#define GMIME_YENCODE_CRC_FINAL(crc) (~crc) +</pre> +<p> +Gets the final crc value from <em class="parameter"><code>crc</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>crc</code></em> :</span></p></td> +<td>crc or pcrc state variable</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="GMIME-YENCODE-STATE-INIT:CAPS"></a><h3>GMIME_YENCODE_STATE_INIT</h3> +<pre class="programlisting">#define GMIME_YENCODE_STATE_INIT (0) +</pre> +<p> +Initial state for the <a class="link" href="GMimeFilterYenc.html#g-mime-ydecode-step" title="g_mime_ydecode_step ()"><code class="function">g_mime_ydecode_step()</code></a> function. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GMIME-YDECODE-STATE-INIT:CAPS"></a><h3>GMIME_YDECODE_STATE_INIT</h3> +<pre class="programlisting">#define GMIME_YDECODE_STATE_INIT (0) +</pre> +<p> +Initial state for the <a class="link" href="GMimeFilterYenc.html#g-mime-ydecode-step" title="g_mime_ydecode_step ()"><code class="function">g_mime_ydecode_step()</code></a> function. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GMIME-YDECODE-STATE-EOLN:CAPS"></a><h3>GMIME_YDECODE_STATE_EOLN</h3> +<pre class="programlisting">#define GMIME_YDECODE_STATE_EOLN (1 << 8) +</pre> +<p> +State bit that denotes the yEnc filter has reached an end-of-line. +</p> +<p> +This state is for internal use only. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GMIME-YDECODE-STATE-ESCAPE:CAPS"></a><h3>GMIME_YDECODE_STATE_ESCAPE</h3> +<pre class="programlisting">#define GMIME_YDECODE_STATE_ESCAPE (1 << 9) +</pre> +<p> +State bit that denotes the yEnc filter has reached an escape +sequence. +</p> +<p> +This state is for internal use only. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GMIME-YDECODE-STATE-END:CAPS"></a><h3>GMIME_YDECODE_STATE_END</h3> +<pre class="programlisting">#define GMIME_YDECODE_STATE_END (1 << 15) +</pre> +<p> +State bit that denoates that <a class="link" href="GMimeFilterYenc.html#g-mime-ydecode-step" title="g_mime_ydecode_step ()"><code class="function">g_mime_ydecode_step()</code></a> has finished +decoding. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GMIME-YDECODE-STATE-BEGIN:CAPS"></a><h3>GMIME_YDECODE_STATE_BEGIN</h3> +<pre class="programlisting">#define GMIME_YDECODE_STATE_BEGIN (1 << 12) +</pre> +<p> +State bit that denotes the yEnc filter has found the =ybegin line. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GMIME-YDECODE-STATE-DECODE:CAPS"></a><h3>GMIME_YDECODE_STATE_DECODE</h3> +<pre class="programlisting">#define GMIME_YDECODE_STATE_DECODE (1 << 14) +</pre> +<p> +State bit that denotes yEnc filter has begun decoding the actual +yencoded content and will continue to do so until an =yend line is +found (or until there is nothing left to decode). +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GMIME-YDECODE-STATE-PART:CAPS"></a><h3>GMIME_YDECODE_STATE_PART</h3> +<pre class="programlisting">#define GMIME_YDECODE_STATE_PART (1 << 13) +</pre> +<p> +State bit that denotes the yEnc filter has found the =ypart +line. (Note: not all yencoded blocks have one) +</p> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-ydecode-step"></a><h3>g_mime_ydecode_step ()</h3> +<pre class="programlisting"><span class="returnvalue">size_t</span> g_mime_ydecode_step (<em class="parameter"><code>const unsigned <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>unsigned <span class="type">char</span> *outbuf</code></em>, + <em class="parameter"><code><span class="type">int</span> *state</code></em>, + <em class="parameter"><code><span class="type">guint32</span> *pcrc</code></em>, + <em class="parameter"><code><span class="type">guint32</span> *crc</code></em>);</pre> +<p> +Performs a 'decode step' on a chunk of yEncoded data of length +<em class="parameter"><code>inlen</code></em> pointed to by <em class="parameter"><code>inbuf</code></em> and writes to <em class="parameter"><code>outbuf</code></em>. Assumes the =ybegin +and =ypart lines have already been stripped off. +</p> +<p> +To get the crc32 value of the part, use <a class="link" href="GMimeFilterYenc.html#GMIME-YENCODE-CRC-FINAL:CAPS" title="GMIME_YENCODE_CRC_FINAL()"><span class="type">GMIME_YENCODE_CRC_FINAL</span></a> +(<em class="parameter"><code>pcrc</code></em>). If there are more parts, you should reuse <em class="parameter"><code>crc</code></em> without +re-initializing. Once all parts have been decoded, you may get the +combined crc32 value of all the parts using <a class="link" href="GMimeFilterYenc.html#GMIME-YENCODE-CRC-FINAL:CAPS" title="GMIME_YENCODE_CRC_FINAL()"><span class="type">GMIME_YENCODE_CRC_FINAL</span></a> +(<em class="parameter"><code>crc</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>inbuf</code></em> :</span></p></td> +<td>input buffer</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>inlen</code></em> :</span></p></td> +<td>input buffer length</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>outbuf</code></em> :</span></p></td> +<td>output buffer</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td> +<td>ydecode state</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>pcrc</code></em> :</span></p></td> +<td>part crc state</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>crc</code></em> :</span></p></td> +<td>crc state</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the number of bytes decoded.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-yencode-step"></a><h3>g_mime_yencode_step ()</h3> +<pre class="programlisting"><span class="returnvalue">size_t</span> g_mime_yencode_step (<em class="parameter"><code>const unsigned <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>unsigned <span class="type">char</span> *outbuf</code></em>, + <em class="parameter"><code><span class="type">int</span> *state</code></em>, + <em class="parameter"><code><span class="type">guint32</span> *pcrc</code></em>, + <em class="parameter"><code><span class="type">guint32</span> *crc</code></em>);</pre> +<p> +Performs an yEncode 'encode step' on a chunk of raw data of length +<em class="parameter"><code>inlen</code></em> pointed to by <em class="parameter"><code>inbuf</code></em> and writes to <em class="parameter"><code>outbuf</code></em>. +</p> +<p> +<em class="parameter"><code>state</code></em> should be initialized to <a class="link" href="GMimeFilterYenc.html#GMIME-YENCODE-STATE-INIT:CAPS" title="GMIME_YENCODE_STATE_INIT"><span class="type">GMIME_YENCODE_STATE_INIT</span></a> before +beginning making the first call to this function. Subsequent calls +should reuse <em class="parameter"><code>state</code></em>. +</p> +<p> +Along the same lines, <em class="parameter"><code>pcrc</code></em> and <em class="parameter"><code>crc</code></em> should be initialized to +<a class="link" href="GMimeFilterYenc.html#GMIME-YENCODE-CRC-INIT:CAPS" title="GMIME_YENCODE_CRC_INIT"><span class="type">GMIME_YENCODE_CRC_INIT</span></a> before using. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>inbuf</code></em> :</span></p></td> +<td>input buffer</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>inlen</code></em> :</span></p></td> +<td>input buffer length</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>outbuf</code></em> :</span></p></td> +<td>output buffer</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td> +<td>yencode state</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>pcrc</code></em> :</span></p></td> +<td>part crc state</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>crc</code></em> :</span></p></td> +<td>crc state</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the number of bytes encoded.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-yencode-close"></a><h3>g_mime_yencode_close ()</h3> +<pre class="programlisting"><span class="returnvalue">size_t</span> g_mime_yencode_close (<em class="parameter"><code>const unsigned <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>unsigned <span class="type">char</span> *outbuf</code></em>, + <em class="parameter"><code><span class="type">int</span> *state</code></em>, + <em class="parameter"><code><span class="type">guint32</span> *pcrc</code></em>, + <em class="parameter"><code><span class="type">guint32</span> *crc</code></em>);</pre> +<p> +Call this function when finished encoding data with +<a class="link" href="GMimeFilterYenc.html#g-mime-yencode-step" title="g_mime_yencode_step ()"><code class="function">g_mime_yencode_step()</code></a> to flush off the remaining state. +</p> +<p> +<a class="link" href="GMimeFilterYenc.html#GMIME-YENCODE-CRC-FINAL:CAPS" title="GMIME_YENCODE_CRC_FINAL()"><span class="type">GMIME_YENCODE_CRC_FINAL</span></a> (<em class="parameter"><code>pcrc</code></em>) will give you the crc32 of the +encoded "part". If there are more "parts" to encode, you should +re-use <em class="parameter"><code>crc</code></em> when encoding the next "parts" and then use +<a class="link" href="GMimeFilterYenc.html#GMIME-YENCODE-CRC-FINAL:CAPS" title="GMIME_YENCODE_CRC_FINAL()"><span class="type">GMIME_YENCODE_CRC_FINAL</span></a> (<em class="parameter"><code>crc</code></em>) to get the combined crc32 value of +all the parts. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>inbuf</code></em> :</span></p></td> +<td>input buffer</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>inlen</code></em> :</span></p></td> +<td>input buffer length</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>outbuf</code></em> :</span></p></td> +<td>output buffer</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td> +<td>yencode state</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>pcrc</code></em> :</span></p></td> +<td>part crc state</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>crc</code></em> :</span></p></td> +<td>crc state</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the number of bytes encoded.</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="GMimeFilterYenc.see-also"></a><h2>See Also</h2> +<a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/GMimeGpgContext.html b/docs/reference/html/GMimeGpgContext.html new file mode 100644 index 0000000..2df5eca --- /dev/null +++ b/docs/reference/html/GMimeGpgContext.html @@ -0,0 +1,264 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimeGpgContext</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="CryptoContexts.html" title="Cryptography Contexts"> +<link rel="prev" href="GMimeCryptoContext.html" title="GMimeCryptoContext"> +<link rel="next" href="GMimePkcs7Context.html" title="GMimePkcs7Context"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="GMimeCryptoContext.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="CryptoContexts.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="GMimePkcs7Context.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GMimeGpgContext.synopsis" class="shortcut">Top</a> +  | + <a href="#GMimeGpgContext.description" class="shortcut">Description</a> +  | + <a href="#GMimeGpgContext.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GMimeGpgContext"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GMimeGpgContext.top_of_page"></a>GMimeGpgContext</span></h2> +<p>GMimeGpgContext — GnuPG crypto contexts</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GMimeGpgContext.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">struct <a class="link" href="GMimeGpgContext.html#GMimeGpgContext-struct" title="struct GMimeGpgContext">GMimeGpgContext</a>; +<a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="returnvalue">GMimeCryptoContext</span></a> * <a class="link" href="GMimeGpgContext.html#g-mime-gpg-context-new" title="g_mime_gpg_context_new ()">g_mime_gpg_context_new</a> (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimePasswordRequestFunc" title="GMimePasswordRequestFunc ()"><span class="type">GMimePasswordRequestFunc</span></a> request_passwd</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *path</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="GMimeGpgContext.html#g-mime-gpg-context-get-always-trust" title="g_mime_gpg_context_get_always_trust ()">g_mime_gpg_context_get_always_trust</a> (<em class="parameter"><code><a class="link" href="GMimeGpgContext.html" title="GMimeGpgContext"><span class="type">GMimeGpgContext</span></a> *ctx</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeGpgContext.html#g-mime-gpg-context-set-always-trust" title="g_mime_gpg_context_set_always_trust ()">g_mime_gpg_context_set_always_trust</a> (<em class="parameter"><code><a class="link" href="GMimeGpgContext.html" title="GMimeGpgContext"><span class="type">GMimeGpgContext</span></a> *ctx</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> always_trust</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="GMimeGpgContext.html#g-mime-gpg-context-get-auto-key-retrieve" title="g_mime_gpg_context_get_auto_key_retrieve ()">g_mime_gpg_context_get_auto_key_retrieve</a> + (<em class="parameter"><code><a class="link" href="GMimeGpgContext.html" title="GMimeGpgContext"><span class="type">GMimeGpgContext</span></a> *ctx</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeGpgContext.html#g-mime-gpg-context-set-auto-key-retrieve" title="g_mime_gpg_context_set_auto_key_retrieve ()">g_mime_gpg_context_set_auto_key_retrieve</a> + (<em class="parameter"><code><a class="link" href="GMimeGpgContext.html" title="GMimeGpgContext"><span class="type">GMimeGpgContext</span></a> *ctx</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> auto_key_retrieve</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="GMimeGpgContext.html#g-mime-gpg-context-get-use-agent" title="g_mime_gpg_context_get_use_agent ()">g_mime_gpg_context_get_use_agent</a> (<em class="parameter"><code><a class="link" href="GMimeGpgContext.html" title="GMimeGpgContext"><span class="type">GMimeGpgContext</span></a> *ctx</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeGpgContext.html#g-mime-gpg-context-set-use-agent" title="g_mime_gpg_context_set_use_agent ()">g_mime_gpg_context_set_use_agent</a> (<em class="parameter"><code><a class="link" href="GMimeGpgContext.html" title="GMimeGpgContext"><span class="type">GMimeGpgContext</span></a> *ctx</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> use_agent</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GMimeGpgContext.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----<a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext">GMimeCryptoContext</a> + +----GMimeGpgContext +</pre> +</div> +<div class="refsect1"> +<a name="GMimeGpgContext.description"></a><h2>Description</h2> +<p> +A <a class="link" href="GMimeGpgContext.html" title="GMimeGpgContext"><span class="type">GMimeGpgContext</span></a> is a <a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> that uses GnuPG to do +all of the encryption and digital signatures. +</p> +</div> +<div class="refsect1"> +<a name="GMimeGpgContext.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimeGpgContext-struct"></a><h3>struct GMimeGpgContext</h3> +<pre class="programlisting">struct GMimeGpgContext;</pre> +<p> +A GnuPG crypto context. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-gpg-context-new"></a><h3>g_mime_gpg_context_new ()</h3> +<pre class="programlisting"><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="returnvalue">GMimeCryptoContext</span></a> * g_mime_gpg_context_new (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimePasswordRequestFunc" title="GMimePasswordRequestFunc ()"><span class="type">GMimePasswordRequestFunc</span></a> request_passwd</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *path</code></em>);</pre> +<p> +Creates a new gpg crypto context object. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>request_passwd</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCryptoContext.html#GMimePasswordRequestFunc" title="GMimePasswordRequestFunc ()"><span class="type">GMimePasswordRequestFunc</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td> +<td>path to gpg binary</td> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-gpg-context-get-always-trust"></a><h3>g_mime_gpg_context_get_always_trust ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_gpg_context_get_always_trust (<em class="parameter"><code><a class="link" href="GMimeGpgContext.html" title="GMimeGpgContext"><span class="type">GMimeGpgContext</span></a> *ctx</code></em>);</pre> +<p> +Gets the always_trust flag on the gpg context. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeGpgContext.html" title="GMimeGpgContext"><span class="type">GMimeGpgContext</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the always_trust flag on the gpg context.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-gpg-context-set-always-trust"></a><h3>g_mime_gpg_context_set_always_trust ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_gpg_context_set_always_trust (<em class="parameter"><code><a class="link" href="GMimeGpgContext.html" title="GMimeGpgContext"><span class="type">GMimeGpgContext</span></a> *ctx</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> always_trust</code></em>);</pre> +<p> +Sets the <em class="parameter"><code>always_trust</code></em> flag on the gpg context which is used for +encryption. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeGpgContext.html" title="GMimeGpgContext"><span class="type">GMimeGpgContext</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>always_trust</code></em> :</span></p></td> +<td>always trust flag</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-gpg-context-get-auto-key-retrieve"></a><h3>g_mime_gpg_context_get_auto_key_retrieve ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_gpg_context_get_auto_key_retrieve + (<em class="parameter"><code><a class="link" href="GMimeGpgContext.html" title="GMimeGpgContext"><span class="type">GMimeGpgContext</span></a> *ctx</code></em>);</pre> +<p> +Gets the <em class="parameter"><code>auto_key_retrieve</code></em> flag on the gpg context. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeGpgContext.html" title="GMimeGpgContext"><span class="type">GMimeGpgContext</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the <em class="parameter"><code>auto_key_retrieve</code></em> flag on the gpg context.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-gpg-context-set-auto-key-retrieve"></a><h3>g_mime_gpg_context_set_auto_key_retrieve ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_gpg_context_set_auto_key_retrieve + (<em class="parameter"><code><a class="link" href="GMimeGpgContext.html" title="GMimeGpgContext"><span class="type">GMimeGpgContext</span></a> *ctx</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> auto_key_retrieve</code></em>);</pre> +<p> +Sets the <em class="parameter"><code>auto_key_retrieve</code></em> flag on the gpg context which is used +for signature verification. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeGpgContext.html" title="GMimeGpgContext"><span class="type">GMimeGpgContext</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>auto_key_retrieve</code></em> :</span></p></td> +<td>auto-retrieve keys from a keys server</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-gpg-context-get-use-agent"></a><h3>g_mime_gpg_context_get_use_agent ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_gpg_context_get_use_agent (<em class="parameter"><code><a class="link" href="GMimeGpgContext.html" title="GMimeGpgContext"><span class="type">GMimeGpgContext</span></a> *ctx</code></em>);</pre> +<p> +Gets the use_agent flag on the gpg context. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeGpgContext.html" title="GMimeGpgContext"><span class="type">GMimeGpgContext</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the use_agent flag on the gpg context, which indicates +that GnuPG should attempt to use gpg-agent for credentials.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-gpg-context-set-use-agent"></a><h3>g_mime_gpg_context_set_use_agent ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_gpg_context_set_use_agent (<em class="parameter"><code><a class="link" href="GMimeGpgContext.html" title="GMimeGpgContext"><span class="type">GMimeGpgContext</span></a> *ctx</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> use_agent</code></em>);</pre> +<p> +Sets the <em class="parameter"><code>use_agent</code></em> flag on the gpg context, which indicates that +GnuPG should attempt to use gpg-agent for credentials. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeGpgContext.html" title="GMimeGpgContext"><span class="type">GMimeGpgContext</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>use_agent</code></em> :</span></p></td> +<td>always trust flag</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="GMimeGpgContext.see-also"></a><h2>See Also</h2> +<a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/GMimeMessage.html b/docs/reference/html/GMimeMessage.html new file mode 100644 index 0000000..225e4e4 --- /dev/null +++ b/docs/reference/html/GMimeMessage.html @@ -0,0 +1,624 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimeMessage</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="MimeParts.html" title="MIME Messages and Parts"> +<link rel="prev" href="GMimeObject.html" title="GMimeObject"> +<link rel="next" href="GMimePart.html" title="GMimePart"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="GMimeObject.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="MimeParts.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="GMimePart.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GMimeMessage.synopsis" class="shortcut">Top</a> +  | + <a href="#GMimeMessage.description" class="shortcut">Description</a> +  | + <a href="#GMimeMessage.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GMimeMessage"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GMimeMessage.top_of_page"></a>GMimeMessage</span></h2> +<p>GMimeMessage — Messages</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GMimeMessage.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">enum <a class="link" href="GMimeMessage.html#GMimeRecipientType" title="enum GMimeRecipientType">GMimeRecipientType</a>; +struct <a class="link" href="GMimeMessage.html#GMimeMessage-struct" title="struct GMimeMessage">GMimeMessage</a>; +<a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="returnvalue">GMimeMessage</span></a> * <a class="link" href="GMimeMessage.html#g-mime-message-new" title="g_mime_message_new ()">g_mime_message_new</a> (<em class="parameter"><code><span class="type">gboolean</span> pretty_headers</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeMessage.html#g-mime-message-set-sender" title="g_mime_message_set_sender ()">g_mime_message_set_sender</a> (<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> *sender</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="GMimeMessage.html#g-mime-message-get-sender" title="g_mime_message_get_sender ()">g_mime_message_get_sender</a> (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeMessage.html#g-mime-message-set-reply-to" title="g_mime_message_set_reply_to ()">g_mime_message_set_reply_to</a> (<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>); +const <span class="returnvalue">char</span> * <a class="link" href="GMimeMessage.html#g-mime-message-get-reply-to" title="g_mime_message_get_reply_to ()">g_mime_message_get_reply_to</a> (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeMessage.html#g-mime-message-add-recipient" title="g_mime_message_add_recipient ()">g_mime_message_add_recipient</a> (<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>, + <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>); +<a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="returnvalue">InternetAddressList</span></a> * <a class="link" href="GMimeMessage.html#g-mime-message-get-recipients" title="g_mime_message_get_recipients ()">g_mime_message_get_recipients</a> (<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>); +<a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="returnvalue">InternetAddressList</span></a> * <a class="link" href="GMimeMessage.html#g-mime-message-get-all-recipients" title="g_mime_message_get_all_recipients ()">g_mime_message_get_all_recipients</a> (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeMessage.html#g-mime-message-set-subject" title="g_mime_message_set_subject ()">g_mime_message_set_subject</a> (<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>); +const <span class="returnvalue">char</span> * <a class="link" href="GMimeMessage.html#g-mime-message-get-subject" title="g_mime_message_get_subject ()">g_mime_message_get_subject</a> (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeMessage.html#g-mime-message-set-date" title="g_mime_message_set_date ()">g_mime_message_set_date</a> (<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><span class="type">time_t</span> date</code></em>, + <em class="parameter"><code><span class="type">int</span> tz_offset</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeMessage.html#g-mime-message-get-date" title="g_mime_message_get_date ()">g_mime_message_get_date</a> (<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><span class="type">time_t</span> *date</code></em>, + <em class="parameter"><code><span class="type">int</span> *tz_offset</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeMessage.html#g-mime-message-set-date-as-string" title="g_mime_message_set_date_as_string ()">g_mime_message_set_date_as_string</a> (<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> *str</code></em>); +<span class="returnvalue">char</span> * <a class="link" href="GMimeMessage.html#g-mime-message-get-date-as-string" title="g_mime_message_get_date_as_string ()">g_mime_message_get_date_as_string</a> (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeMessage.html#g-mime-message-set-message-id" title="g_mime_message_set_message_id ()">g_mime_message_set_message_id</a> (<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> *message_id</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="GMimeMessage.html#g-mime-message-get-message-id" title="g_mime_message_get_message_id ()">g_mime_message_get_message_id</a> (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeMessage.html#g-mime-message-set-mime-part" title="g_mime_message_set_mime_part ()">g_mime_message_set_mime_part</a> (<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="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *mime_part</code></em>); +<a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> * <a class="link" href="GMimeMessage.html#g-mime-message-get-mime-part" title="g_mime_message_get_mime_part ()">g_mime_message_get_mime_part</a> (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeMessage.html#g-mime-message-foreach" title="g_mime_message_foreach ()">g_mime_message_foreach</a> (<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="GMimeObject.html#GMimeObjectForeachFunc" title="GMimeObjectForeachFunc ()"><span class="type">GMimeObjectForeachFunc</span></a> callback</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>); +<a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> * <a class="link" href="GMimeMessage.html#g-mime-message-get-body" title="g_mime_message_get_body ()">g_mime_message_get_body</a> (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GMimeMessage.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----<a class="link" href="GMimeObject.html" title="GMimeObject">GMimeObject</a> + +----GMimeMessage +</pre> +</div> +<div class="refsect1"> +<a name="GMimeMessage.description"></a><h2>Description</h2> +<p> +A <a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> represents an rfc822 message. +</p> +</div> +<div class="refsect1"> +<a name="GMimeMessage.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimeRecipientType"></a><h3>enum GMimeRecipientType</h3> +<pre class="programlisting">typedef enum { + GMIME_RECIPIENT_TYPE_TO, + GMIME_RECIPIENT_TYPE_CC, + GMIME_RECIPIENT_TYPE_BCC +} GMimeRecipientType; +</pre> +<p> +A message recipient type. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><a name="GMIME-RECIPIENT-TYPE-TO:CAPS"></a><span class="term"><code class="literal">GMIME_RECIPIENT_TYPE_TO</code></span></p></td> +<td>Represents the recipients in the To: header. +</td> +</tr> +<tr> +<td><p><a name="GMIME-RECIPIENT-TYPE-CC:CAPS"></a><span class="term"><code class="literal">GMIME_RECIPIENT_TYPE_CC</code></span></p></td> +<td>Represents the recipients in the Cc: header. +</td> +</tr> +<tr> +<td><p><a name="GMIME-RECIPIENT-TYPE-BCC:CAPS"></a><span class="term"><code class="literal">GMIME_RECIPIENT_TYPE_BCC</code></span></p></td> +<td>Represents the recipients in the Bcc: header. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="GMimeMessage-struct"></a><h3>struct GMimeMessage</h3> +<pre class="programlisting">struct GMimeMessage;</pre> +<p> +A MIME Message object. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-message-new"></a><h3>g_mime_message_new ()</h3> +<pre class="programlisting"><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="returnvalue">GMimeMessage</span></a> * g_mime_message_new (<em class="parameter"><code><span class="type">gboolean</span> pretty_headers</code></em>);</pre> +<p> +If <em class="parameter"><code>pretty_headers</code></em> is <code class="literal">TRUE</code>, then the standard rfc822 headers are +initialized so as to put headers in a nice friendly order. This is +strictly a cosmetic thing, so if you are unsure, it is safe to say +no (<code class="literal">FALSE</code>). +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>pretty_headers</code></em> :</span></p></td> +<td>make pretty headers</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>an empty <a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> object.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-message-set-sender"></a><h3>g_mime_message_set_sender ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_message_set_sender (<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> *sender</code></em>);</pre> +<p> +Set the sender's name and address on the MIME Message. +(ex: "\"Joe Sixpack\" <joe<em class="parameter"><code>sixpack.org</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 to change</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>sender</code></em> :</span></p></td> +<td>The name and address of the sender</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-message-get-sender"></a><h3>g_mime_message_get_sender ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_message_get_sender (<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 email address of the sender from <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> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-message-set-reply-to"></a><h3>g_mime_message_set_reply_to ()</h3> +<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. +</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> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>reply_to</code></em> :</span></p></td> +<td>The Reply-To address</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-message-get-reply-to"></a><h3>g_mime_message_get_reply_to ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_message_get_reply_to (<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 Reply-To address from <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> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-message-add-recipient"></a><h3>g_mime_message_add_recipient ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_message_add_recipient (<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>, + <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. +</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> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td> +<td>A <a class="link" href="GMimeMessage.html#GMimeRecipientType" title="enum GMimeRecipientType"><span class="type">GMimeRecipientType</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> +<td>The recipient's name (or <code class="literal">NULL</code>)</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>addr</code></em> :</span></p></td> +<td>The recipient's address</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-message-get-recipients"></a><h3>g_mime_message_get_recipients ()</h3> +<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>. +</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> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td> +<td>A <a class="link" href="GMimeMessage.html#GMimeRecipientType" title="enum GMimeRecipientType"><span class="type">GMimeRecipientType</span></a> +</td> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-message-get-all-recipients"></a><h3>g_mime_message_get_all_recipients ()</h3> +<pre class="programlisting"><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="returnvalue">InternetAddressList</span></a> * g_mime_message_get_all_recipients (<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 complete list of recipients for <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> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-message-set-subject"></a><h3>g_mime_message_set_subject ()</h3> +<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. +</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> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>subject</code></em> :</span></p></td> +<td>Subject string</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<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. +</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> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-message-set-date"></a><h3>g_mime_message_set_date ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_message_set_date (<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><span class="type">time_t</span> date</code></em>, + <em class="parameter"><code><span class="type">int</span> tz_offset</code></em>);</pre> +<p> +Sets the Date header on a MIME Message. +</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> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>date</code></em> :</span></p></td> +<td>a date to be used in the Date header</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>tz_offset</code></em> :</span></p></td> +<td>timezone offset (in +/- hours)</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-message-get-date"></a><h3>g_mime_message_get_date ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_message_get_date (<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><span class="type">time_t</span> *date</code></em>, + <em class="parameter"><code><span class="type">int</span> *tz_offset</code></em>);</pre> +<p> +Stores the date in time_t format in <em class="parameter"><code>date</code></em>. If <em class="parameter"><code>tz_offset</code></em> is +non-<code class="literal">NULL</code>, then the timezone offset in will be stored in +<em class="parameter"><code>tz_offset</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> +</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> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-message-set-date-as-string"></a><h3>g_mime_message_set_date_as_string ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_message_set_date_as_string (<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> *str</code></em>);</pre> +<p> +Sets the sent-date of the message. +</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> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td> +<td>a date string</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-message-get-date-as-string"></a><h3>g_mime_message_get_date_as_string ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * g_mime_message_get_date_as_string (<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 sent-date in string format. +</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> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a newly allocated string containing the Date header value.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-message-set-message-id"></a><h3>g_mime_message_set_message_id ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_message_set_message_id (<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> *message_id</code></em>);</pre> +<p> +Set the Message-Id on a message. +</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> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>message_id</code></em> :</span></p></td> +<td>message-id (addr-spec portion)</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-message-get-message-id"></a><h3>g_mime_message_get_message_id ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_message_get_message_id (<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-Id header of <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> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the Message-Id of a message.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-message-set-mime-part"></a><h3>g_mime_message_set_mime_part ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_message_set_mime_part (<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="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *mime_part</code></em>);</pre> +<p> +Set the root-level MIME part of the message. +</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> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>mime_part</code></em> :</span></p></td> +<td>The root-level MIME Part</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-message-get-mime-part"></a><h3>g_mime_message_get_mime_part ()</h3> +<pre class="programlisting"><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> * g_mime_message_get_mime_part (<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 toplevel MIME part contained within <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> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-message-foreach"></a><h3>g_mime_message_foreach ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_message_foreach (<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="GMimeObject.html#GMimeObjectForeachFunc" title="GMimeObjectForeachFunc ()"><span class="type">GMimeObjectForeachFunc</span></a> callback</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> +<p> +Recursively calls <em class="parameter"><code>callback</code></em> on each of the mime parts in the mime message. +</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>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> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> +<td>user-supplied callback data</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-message-get-body"></a><h3>g_mime_message_get_body ()</h3> +<pre class="programlisting"><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> * g_mime_message_get_body (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>);</pre> +<p> +Attempts to identify the MIME part containing the body of the +message. +</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> +</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. +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> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/GMimeMessagePart.html b/docs/reference/html/GMimeMessagePart.html new file mode 100644 index 0000000..e4e41d5 --- /dev/null +++ b/docs/reference/html/GMimeMessagePart.html @@ -0,0 +1,181 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimeMessagePart</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="MimeParts.html" title="MIME Messages and Parts"> +<link rel="prev" href="GMimeMultipartSigned.html" title="GMimeMultipartSigned"> +<link rel="next" href="GMimeMessagePartial.html" title="GMimeMessagePartial"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="GMimeMultipartSigned.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="MimeParts.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="GMimeMessagePartial.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GMimeMessagePart.synopsis" class="shortcut">Top</a> +  | + <a href="#GMimeMessagePart.description" class="shortcut">Description</a> +  | + <a href="#GMimeMessagePart.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GMimeMessagePart"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GMimeMessagePart.top_of_page"></a>GMimeMessagePart</span></h2> +<p>GMimeMessagePart — Message parts</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GMimeMessagePart.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">struct <a class="link" href="GMimeMessagePart.html#GMimeMessagePart-struct" title="struct GMimeMessagePart">GMimeMessagePart</a>; +<a class="link" href="GMimeMessagePart.html" title="GMimeMessagePart"><span class="returnvalue">GMimeMessagePart</span></a> * <a class="link" href="GMimeMessagePart.html#g-mime-message-part-new" title="g_mime_message_part_new ()">g_mime_message_part_new</a> (<em class="parameter"><code>const <span class="type">char</span> *subtype</code></em>); +<a class="link" href="GMimeMessagePart.html" title="GMimeMessagePart"><span class="returnvalue">GMimeMessagePart</span></a> * <a class="link" href="GMimeMessagePart.html#g-mime-message-part-new-with-message" title="g_mime_message_part_new_with_message ()">g_mime_message_part_new_with_message</a> + (<em class="parameter"><code>const <span class="type">char</span> *subtype</code></em>, + <em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>); +<a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="returnvalue">GMimeMessage</span></a> * <a class="link" href="GMimeMessagePart.html#g-mime-message-part-get-message" title="g_mime_message_part_get_message ()">g_mime_message_part_get_message</a> (<em class="parameter"><code><a class="link" href="GMimeMessagePart.html" title="GMimeMessagePart"><span class="type">GMimeMessagePart</span></a> *part</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeMessagePart.html#g-mime-message-part-set-message" title="g_mime_message_part_set_message ()">g_mime_message_part_set_message</a> (<em class="parameter"><code><a class="link" href="GMimeMessagePart.html" title="GMimeMessagePart"><span class="type">GMimeMessagePart</span></a> *part</code></em>, + <em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GMimeMessagePart.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----<a class="link" href="GMimeObject.html" title="GMimeObject">GMimeObject</a> + +----GMimeMessagePart +</pre> +</div> +<div class="refsect1"> +<a name="GMimeMessagePart.description"></a><h2>Description</h2> +<p> +A <a class="link" href="GMimeMessagePart.html" title="GMimeMessagePart"><span class="type">GMimeMessagePart</span></a> represents message/rfc822 and message/news MIME +parts. +</p> +</div> +<div class="refsect1"> +<a name="GMimeMessagePart.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimeMessagePart-struct"></a><h3>struct GMimeMessagePart</h3> +<pre class="programlisting">struct GMimeMessagePart;</pre> +<p> +A message/rfc822 or message/news MIME part. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-message-part-new"></a><h3>g_mime_message_part_new ()</h3> +<pre class="programlisting"><a class="link" href="GMimeMessagePart.html" title="GMimeMessagePart"><span class="returnvalue">GMimeMessagePart</span></a> * g_mime_message_part_new (<em class="parameter"><code>const <span class="type">char</span> *subtype</code></em>);</pre> +<p> +Creates a new MIME message part object with a default content-type +of message/<em class="parameter"><code>subtype</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>subtype</code></em> :</span></p></td> +<td>message subtype or <code class="literal">NULL</code> for "rfc822"</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>an empty MIME message part object with a default +content-type of message/<em class="parameter"><code>subtype</code></em>.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-message-part-new-with-message"></a><h3>g_mime_message_part_new_with_message ()</h3> +<pre class="programlisting"><a class="link" href="GMimeMessagePart.html" title="GMimeMessagePart"><span class="returnvalue">GMimeMessagePart</span></a> * g_mime_message_part_new_with_message + (<em class="parameter"><code>const <span class="type">char</span> *subtype</code></em>, + <em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>);</pre> +<p> +Creates a new MIME message part object with a default content-type +of message/<em class="parameter"><code>subtype</code></em> containing <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>subtype</code></em> :</span></p></td> +<td>message subtype or <code class="literal">NULL</code> for "rfc822"</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td> +<td>message</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a MIME message part object with a default content-type of +message/<em class="parameter"><code>subtype</code></em> containing <em class="parameter"><code>message</code></em>.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-message-part-get-message"></a><h3>g_mime_message_part_get_message ()</h3> +<pre class="programlisting"><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="returnvalue">GMimeMessage</span></a> * g_mime_message_part_get_message (<em class="parameter"><code><a class="link" href="GMimeMessagePart.html" title="GMimeMessagePart"><span class="type">GMimeMessagePart</span></a> *part</code></em>);</pre> +<p> +Gets the message object on the message part object <em class="parameter"><code>part</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>part</code></em> :</span></p></td> +<td>message part</td> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-message-part-set-message"></a><h3>g_mime_message_part_set_message ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_message_part_set_message (<em class="parameter"><code><a class="link" href="GMimeMessagePart.html" title="GMimeMessagePart"><span class="type">GMimeMessagePart</span></a> *part</code></em>, + <em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>);</pre> +<p> +Sets the <em class="parameter"><code>message</code></em> object on the message part object <em class="parameter"><code>part</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>part</code></em> :</span></p></td> +<td>message part</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td> +<td>message</td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/GMimeMessagePartial.html b/docs/reference/html/GMimeMessagePartial.html new file mode 100644 index 0000000..6bd6790 --- /dev/null +++ b/docs/reference/html/GMimeMessagePartial.html @@ -0,0 +1,253 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimeMessagePartial</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="MimeParts.html" title="MIME Messages and Parts"> +<link rel="prev" href="GMimeMessagePart.html" title="GMimeMessagePart"> +<link rel="next" href="gmime-GMimePartIter.html" title="GMimePartIter"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="GMimeMessagePart.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="MimeParts.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="gmime-GMimePartIter.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GMimeMessagePartial.synopsis" class="shortcut">Top</a> +  | + <a href="#GMimeMessagePartial.description" class="shortcut">Description</a> +  | + <a href="#GMimeMessagePartial.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GMimeMessagePartial"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GMimeMessagePartial.top_of_page"></a>GMimeMessagePartial</span></h2> +<p>GMimeMessagePartial — Partial MIME parts</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GMimeMessagePartial.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">struct <a class="link" href="GMimeMessagePartial.html#GMimeMessagePartial-struct" title="struct GMimeMessagePartial">GMimeMessagePartial</a>; +<a class="link" href="GMimeMessagePartial.html" title="GMimeMessagePartial"><span class="returnvalue">GMimeMessagePartial</span></a> * <a class="link" href="GMimeMessagePartial.html#g-mime-message-partial-new" title="g_mime_message_partial_new ()">g_mime_message_partial_new</a> (<em class="parameter"><code>const <span class="type">char</span> *id</code></em>, + <em class="parameter"><code><span class="type">int</span> number</code></em>, + <em class="parameter"><code><span class="type">int</span> total</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="GMimeMessagePartial.html#g-mime-message-partial-get-id" title="g_mime_message_partial_get_id ()">g_mime_message_partial_get_id</a> (<em class="parameter"><code><a class="link" href="GMimeMessagePartial.html" title="GMimeMessagePartial"><span class="type">GMimeMessagePartial</span></a> *partial</code></em>); +<span class="returnvalue">int</span> <a class="link" href="GMimeMessagePartial.html#g-mime-message-partial-get-number" title="g_mime_message_partial_get_number ()">g_mime_message_partial_get_number</a> (<em class="parameter"><code><a class="link" href="GMimeMessagePartial.html" title="GMimeMessagePartial"><span class="type">GMimeMessagePartial</span></a> *partial</code></em>); +<span class="returnvalue">int</span> <a class="link" href="GMimeMessagePartial.html#g-mime-message-partial-get-total" title="g_mime_message_partial_get_total ()">g_mime_message_partial_get_total</a> (<em class="parameter"><code><a class="link" href="GMimeMessagePartial.html" title="GMimeMessagePartial"><span class="type">GMimeMessagePartial</span></a> *partial</code></em>); +<a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="returnvalue">GMimeMessage</span></a> * <a class="link" href="GMimeMessagePartial.html#g-mime-message-partial-reconstruct-message" title="g_mime_message_partial_reconstruct_message ()">g_mime_message_partial_reconstruct_message</a> + (<em class="parameter"><code><a class="link" href="GMimeMessagePartial.html" title="GMimeMessagePartial"><span class="type">GMimeMessagePartial</span></a> **partials</code></em>, + <em class="parameter"><code><span class="type">size_t</span> num</code></em>); +<a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="returnvalue">GMimeMessage</span></a> ** <a class="link" href="GMimeMessagePartial.html#g-mime-message-partial-split-message" title="g_mime_message_partial_split_message ()">g_mime_message_partial_split_message</a> + (<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><span class="type">size_t</span> max_size</code></em>, + <em class="parameter"><code><span class="type">size_t</span> *nparts</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GMimeMessagePartial.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----<a class="link" href="GMimeObject.html" title="GMimeObject">GMimeObject</a> + +----<a class="link" href="GMimePart.html" title="GMimePart">GMimePart</a> + +----GMimeMessagePartial +</pre> +</div> +<div class="refsect1"> +<a name="GMimeMessagePartial.description"></a><h2>Description</h2> +<p> +A <a class="link" href="GMimeMessagePartial.html" title="GMimeMessagePartial"><span class="type">GMimeMessagePartial</span></a> represents the message/partial MIME part. +</p> +</div> +<div class="refsect1"> +<a name="GMimeMessagePartial.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimeMessagePartial-struct"></a><h3>struct GMimeMessagePartial</h3> +<pre class="programlisting">struct GMimeMessagePartial;</pre> +<p> +A message/partial MIME part. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-message-partial-new"></a><h3>g_mime_message_partial_new ()</h3> +<pre class="programlisting"><a class="link" href="GMimeMessagePartial.html" title="GMimeMessagePartial"><span class="returnvalue">GMimeMessagePartial</span></a> * g_mime_message_partial_new (<em class="parameter"><code>const <span class="type">char</span> *id</code></em>, + <em class="parameter"><code><span class="type">int</span> number</code></em>, + <em class="parameter"><code><span class="type">int</span> total</code></em>);</pre> +<p> +Creates a new MIME message/partial object. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td> +<td>message/partial part id</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>number</code></em> :</span></p></td> +<td>message/partial part number</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>total</code></em> :</span></p></td> +<td>total number of message/partial parts</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>an empty MIME message/partial object.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-message-partial-get-id"></a><h3>g_mime_message_partial_get_id ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_message_partial_get_id (<em class="parameter"><code><a class="link" href="GMimeMessagePartial.html" title="GMimeMessagePartial"><span class="type">GMimeMessagePartial</span></a> *partial</code></em>);</pre> +<p> +Gets the message/partial id parameter value. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>partial</code></em> :</span></p></td> +<td>message/partial object</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the message/partial id or <code class="literal">NULL</code> on fail.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-message-partial-get-number"></a><h3>g_mime_message_partial_get_number ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> g_mime_message_partial_get_number (<em class="parameter"><code><a class="link" href="GMimeMessagePartial.html" title="GMimeMessagePartial"><span class="type">GMimeMessagePartial</span></a> *partial</code></em>);</pre> +<p> +Gets the message/partial part number. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>partial</code></em> :</span></p></td> +<td>message/partial object</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the message/partial part number or <code class="literal">-1</code> on fail.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-message-partial-get-total"></a><h3>g_mime_message_partial_get_total ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> g_mime_message_partial_get_total (<em class="parameter"><code><a class="link" href="GMimeMessagePartial.html" title="GMimeMessagePartial"><span class="type">GMimeMessagePartial</span></a> *partial</code></em>);</pre> +<p> +Gets the total number of message/partial parts needed to +reconstruct the original message. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>partial</code></em> :</span></p></td> +<td>message/partial object</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the total number of message/partial parts needed to +reconstruct the original message or -1 on fail.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-message-partial-reconstruct-message"></a><h3>g_mime_message_partial_reconstruct_message ()</h3> +<pre class="programlisting"><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="returnvalue">GMimeMessage</span></a> * g_mime_message_partial_reconstruct_message + (<em class="parameter"><code><a class="link" href="GMimeMessagePartial.html" title="GMimeMessagePartial"><span class="type">GMimeMessagePartial</span></a> **partials</code></em>, + <em class="parameter"><code><span class="type">size_t</span> num</code></em>);</pre> +<p> +Reconstructs the GMimeMessage from the given message/partial parts +in <em class="parameter"><code>partials</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>partials</code></em> :</span></p></td> +<td>an array of message/partial mime parts</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>num</code></em> :</span></p></td> +<td>the number of elements in <em class="parameter"><code>partials</code></em> +</td> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-message-partial-split-message"></a><h3>g_mime_message_partial_split_message ()</h3> +<pre class="programlisting"><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="returnvalue">GMimeMessage</span></a> ** g_mime_message_partial_split_message + (<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><span class="type">size_t</span> max_size</code></em>, + <em class="parameter"><code><span class="type">size_t</span> *nparts</code></em>);</pre> +<p> +Splits <em class="parameter"><code>message</code></em> into an array of <a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> objects each +containing a single <a class="link" href="GMimeMessagePartial.html" title="GMimeMessagePartial"><span class="type">GMimeMessagePartial</span></a> object containing +<em class="parameter"><code>max_size</code></em> bytes or fewer. <em class="parameter"><code>nparts</code></em> is set to the number of +<a class="link" href="GMimeMessagePartial.html" title="GMimeMessagePartial"><span class="type">GMimeMessagePartial</span></a> objects created. +</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>message object</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>max_size</code></em> :</span></p></td> +<td>max size</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>nparts</code></em> :</span></p></td> +<td>number of parts</td> +</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> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/GMimeMultipart.html b/docs/reference/html/GMimeMultipart.html new file mode 100644 index 0000000..ca2a23f --- /dev/null +++ b/docs/reference/html/GMimeMultipart.html @@ -0,0 +1,600 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimeMultipart</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="MimeParts.html" title="MIME Messages and Parts"> +<link rel="prev" href="GMimePart.html" title="GMimePart"> +<link rel="next" href="GMimeMultipartEncrypted.html" title="GMimeMultipartEncrypted"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="GMimePart.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="MimeParts.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="GMimeMultipartEncrypted.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GMimeMultipart.synopsis" class="shortcut">Top</a> +  | + <a href="#GMimeMultipart.description" class="shortcut">Description</a> +  | + <a href="#GMimeMultipart.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GMimeMultipart"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GMimeMultipart.top_of_page"></a>GMimeMultipart</span></h2> +<p>GMimeMultipart — MIME multiparts</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GMimeMultipart.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">struct <a class="link" href="GMimeMultipart.html#GMimeMultipart-struct" title="struct GMimeMultipart">GMimeMultipart</a>; +<a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="returnvalue">GMimeMultipart</span></a> * <a class="link" href="GMimeMultipart.html#g-mime-multipart-new" title="g_mime_multipart_new ()">g_mime_multipart_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +<a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="returnvalue">GMimeMultipart</span></a> * <a class="link" href="GMimeMultipart.html#g-mime-multipart-new-with-subtype" title="g_mime_multipart_new_with_subtype ()">g_mime_multipart_new_with_subtype</a> (<em class="parameter"><code>const <span class="type">char</span> *subtype</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeMultipart.html#g-mime-multipart-set-preface" title="g_mime_multipart_set_preface ()">g_mime_multipart_set_preface</a> (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *preface</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="GMimeMultipart.html#g-mime-multipart-get-preface" title="g_mime_multipart_get_preface ()">g_mime_multipart_get_preface</a> (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeMultipart.html#g-mime-multipart-set-postface" title="g_mime_multipart_set_postface ()">g_mime_multipart_set_postface</a> (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *postface</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="GMimeMultipart.html#g-mime-multipart-get-postface" title="g_mime_multipart_get_postface ()">g_mime_multipart_get_postface</a> (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeMultipart.html#g-mime-multipart-set-boundary" title="g_mime_multipart_set_boundary ()">g_mime_multipart_set_boundary</a> (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *boundary</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="GMimeMultipart.html#g-mime-multipart-get-boundary" title="g_mime_multipart_get_boundary ()">g_mime_multipart_get_boundary</a> (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>); +<span class="returnvalue">int</span> <a class="link" href="GMimeMultipart.html#g-mime-multipart-get-count" title="g_mime_multipart_get_count ()">g_mime_multipart_get_count</a> (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="GMimeMultipart.html#g-mime-multipart-contains" title="g_mime_multipart_contains ()">g_mime_multipart_contains</a> (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>, + <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *part</code></em>); +<span class="returnvalue">int</span> <a class="link" href="GMimeMultipart.html#g-mime-multipart-index-of" title="g_mime_multipart_index_of ()">g_mime_multipart_index_of</a> (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>, + <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *part</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeMultipart.html#g-mime-multipart-add" title="g_mime_multipart_add ()">g_mime_multipart_add</a> (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>, + <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *part</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeMultipart.html#g-mime-multipart-clear" title="g_mime_multipart_clear ()">g_mime_multipart_clear</a> (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeMultipart.html#g-mime-multipart-insert" title="g_mime_multipart_insert ()">g_mime_multipart_insert</a> (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>, + <em class="parameter"><code><span class="type">int</span> index</code></em>, + <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *part</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="GMimeMultipart.html#g-mime-multipart-remove" title="g_mime_multipart_remove ()">g_mime_multipart_remove</a> (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>, + <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *part</code></em>); +<a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> * <a class="link" href="GMimeMultipart.html#g-mime-multipart-remove-at" title="g_mime_multipart_remove_at ()">g_mime_multipart_remove_at</a> (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>, + <em class="parameter"><code><span class="type">int</span> index</code></em>); +<a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> * <a class="link" href="GMimeMultipart.html#g-mime-multipart-replace" title="g_mime_multipart_replace ()">g_mime_multipart_replace</a> (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>, + <em class="parameter"><code><span class="type">int</span> index</code></em>, + <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *replacement</code></em>); +<a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> * <a class="link" href="GMimeMultipart.html#g-mime-multipart-get-part" title="g_mime_multipart_get_part ()">g_mime_multipart_get_part</a> (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>, + <em class="parameter"><code><span class="type">int</span> index</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeMultipart.html#g-mime-multipart-foreach" title="g_mime_multipart_foreach ()">g_mime_multipart_foreach</a> (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>, + <em class="parameter"><code><a class="link" href="GMimeObject.html#GMimeObjectForeachFunc" title="GMimeObjectForeachFunc ()"><span class="type">GMimeObjectForeachFunc</span></a> callback</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>); +<a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> * <a class="link" href="GMimeMultipart.html#g-mime-multipart-get-subpart-from-content-id" title="g_mime_multipart_get_subpart_from_content_id ()">g_mime_multipart_get_subpart_from_content_id</a> + (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *content_id</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GMimeMultipart.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----<a class="link" href="GMimeObject.html" title="GMimeObject">GMimeObject</a> + +----GMimeMultipart + +----<a class="link" href="GMimeMultipartEncrypted.html" title="GMimeMultipartEncrypted">GMimeMultipartEncrypted</a> + +----<a class="link" href="GMimeMultipartSigned.html" title="GMimeMultipartSigned">GMimeMultipartSigned</a> +</pre> +</div> +<div class="refsect1"> +<a name="GMimeMultipart.description"></a><h2>Description</h2> +<p> +A <a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> represents all multipart MIME container parts. +</p> +</div> +<div class="refsect1"> +<a name="GMimeMultipart.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimeMultipart-struct"></a><h3>struct GMimeMultipart</h3> +<pre class="programlisting">struct GMimeMultipart;</pre> +<p> +A base MIME multipart object. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-multipart-new"></a><h3>g_mime_multipart_new ()</h3> +<pre class="programlisting"><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="returnvalue">GMimeMultipart</span></a> * g_mime_multipart_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Creates a new MIME multipart object with a default content-type of +multipart/mixed. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>an empty MIME multipart object with a default content-type of +multipart/mixed.</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-multipart-new-with-subtype"></a><h3>g_mime_multipart_new_with_subtype ()</h3> +<pre class="programlisting"><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="returnvalue">GMimeMultipart</span></a> * g_mime_multipart_new_with_subtype (<em class="parameter"><code>const <span class="type">char</span> *subtype</code></em>);</pre> +<p> +Creates a new MIME multipart object with a content-type of +multipart/<em class="parameter"><code>subtype</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>subtype</code></em> :</span></p></td> +<td>content-type subtype</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>an empty MIME multipart object with a content-type of +multipart/<em class="parameter"><code>subtype</code></em>.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-multipart-set-preface"></a><h3>g_mime_multipart_set_preface ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_multipart_set_preface (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *preface</code></em>);</pre> +<p> +Sets the preface on the multipart. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>multipart</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> object</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>preface</code></em> :</span></p></td> +<td>preface</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-multipart-get-preface"></a><h3>g_mime_multipart_get_preface ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_multipart_get_preface (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>);</pre> +<p> +Gets the preface on the multipart. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>multipart</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> object</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a pointer to the preface string on the multipart.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-multipart-set-postface"></a><h3>g_mime_multipart_set_postface ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_multipart_set_postface (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *postface</code></em>);</pre> +<p> +Sets the postface on the multipart. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>multipart</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> object</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>postface</code></em> :</span></p></td> +<td>postface</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-multipart-get-postface"></a><h3>g_mime_multipart_get_postface ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_multipart_get_postface (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>);</pre> +<p> +Gets the postface on the multipart. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>multipart</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> object</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a pointer to the postface string on the multipart.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-multipart-set-boundary"></a><h3>g_mime_multipart_set_boundary ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_multipart_set_boundary (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *boundary</code></em>);</pre> +<p> +Sets <em class="parameter"><code>boundary</code></em> as the boundary on the multipart. If <em class="parameter"><code>boundary</code></em> is +<code class="literal">NULL</code>, then a boundary will be auto-generated for you. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>multipart</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> object</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>boundary</code></em> :</span></p></td> +<td>boundary or <code class="literal">NULL</code> to autogenerate one</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-multipart-get-boundary"></a><h3>g_mime_multipart_get_boundary ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_multipart_get_boundary (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>);</pre> +<p> +Gets the boundary on the multipart. If the internal boundary is +<code class="literal">NULL</code>, then an auto-generated boundary will be set on the multipart +and returned. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>multipart</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> object</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the boundary on the multipart.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-multipart-get-count"></a><h3>g_mime_multipart_get_count ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> g_mime_multipart_get_count (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>);</pre> +<p> +Gets the number of mime parts contained within the multipart. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>multipart</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> object</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the number of mime parts contained within the multipart.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-multipart-contains"></a><h3>g_mime_multipart_contains ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_multipart_contains (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>, + <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *part</code></em>);</pre> +<p> +Checks if <em class="parameter"><code>part</code></em> is contained within <em class="parameter"><code>multipart</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>multipart</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> object</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>part</code></em> :</span></p></td> +<td>mime part</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> if <em class="parameter"><code>part</code></em> is a subpart of <em class="parameter"><code>multipart</code></em> or <code class="literal">FALSE</code> +otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-multipart-index-of"></a><h3>g_mime_multipart_index_of ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> g_mime_multipart_index_of (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>, + <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *part</code></em>);</pre> +<p> +Gets the index of <em class="parameter"><code>part</code></em> within <em class="parameter"><code>multipart</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>multipart</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> object</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>part</code></em> :</span></p></td> +<td>mime part</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the index of <em class="parameter"><code>part</code></em> within <em class="parameter"><code>multipart</code></em> or <code class="literal">-1</code> if not found.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-multipart-add"></a><h3>g_mime_multipart_add ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_multipart_add (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>, + <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *part</code></em>);</pre> +<p> +Adds a mime part to the multipart. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>multipart</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> object</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>part</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-multipart-clear"></a><h3>g_mime_multipart_clear ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_multipart_clear (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>);</pre> +<p> +Removes all subparts from <em class="parameter"><code>multipart</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>multipart</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> object</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-multipart-insert"></a><h3>g_mime_multipart_insert ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_multipart_insert (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>, + <em class="parameter"><code><span class="type">int</span> index</code></em>, + <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *part</code></em>);</pre> +<p> +Inserts the specified mime part into the multipart at the position +<em class="parameter"><code>index</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>multipart</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> object</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td> +<td>position to insert the mime part</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>part</code></em> :</span></p></td> +<td>mime part</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-multipart-remove"></a><h3>g_mime_multipart_remove ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_multipart_remove (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>, + <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *part</code></em>);</pre> +<p> +Removes the specified mime part from the multipart. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>multipart</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> object</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>part</code></em> :</span></p></td> +<td>mime part</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> if the part was removed or <code class="literal">FALSE</code> otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-multipart-remove-at"></a><h3>g_mime_multipart_remove_at ()</h3> +<pre class="programlisting"><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> * g_mime_multipart_remove_at (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>, + <em class="parameter"><code><span class="type">int</span> index</code></em>);</pre> +<p> +Removes the mime part at position <em class="parameter"><code>index</code></em> from the multipart. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>multipart</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> object</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td> +<td>position of the mime part to remove</td> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-multipart-replace"></a><h3>g_mime_multipart_replace ()</h3> +<pre class="programlisting"><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> * g_mime_multipart_replace (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>, + <em class="parameter"><code><span class="type">int</span> index</code></em>, + <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *replacement</code></em>);</pre> +<p> +Replaces the mime part at position <em class="parameter"><code>index</code></em> within <em class="parameter"><code>multipart</code></em> with +<em class="parameter"><code>replacement</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>multipart</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> object</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td> +<td>position of the mime part to replace</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>replacement</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> to use as the replacement</td> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-multipart-get-part"></a><h3>g_mime_multipart_get_part ()</h3> +<pre class="programlisting"><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> * g_mime_multipart_get_part (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>, + <em class="parameter"><code><span class="type">int</span> index</code></em>);</pre> +<p> +Gets the mime part at position <em class="parameter"><code>index</code></em> within the multipart. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>multipart</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> object</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td> +<td>position of the mime part</td> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-multipart-foreach"></a><h3>g_mime_multipart_foreach ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_multipart_foreach (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>, + <em class="parameter"><code><a class="link" href="GMimeObject.html#GMimeObjectForeachFunc" title="GMimeObjectForeachFunc ()"><span class="type">GMimeObjectForeachFunc</span></a> callback</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> +<p> +Recursively calls <em class="parameter"><code>callback</code></em> on each of <em class="parameter"><code>multipart</code></em>'s subparts. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>multipart</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> +</td> +</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> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> +<td>user-supplied callback data</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-multipart-get-subpart-from-content-id"></a><h3>g_mime_multipart_get_subpart_from_content_id ()</h3> +<pre class="programlisting"><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> * g_mime_multipart_get_subpart_from_content_id + (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *content_id</code></em>);</pre> +<p> +Gets the mime part with the content-id <em class="parameter"><code>content_id</code></em> from the +multipart <em class="parameter"><code>multipart</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>multipart</code></em> :</span></p></td> +<td>a multipart</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>content_id</code></em> :</span></p></td> +<td>the content id of the part to look for</td> +</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> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/GMimeMultipartEncrypted.html b/docs/reference/html/GMimeMultipartEncrypted.html new file mode 100644 index 0000000..5fab7c6 --- /dev/null +++ b/docs/reference/html/GMimeMultipartEncrypted.html @@ -0,0 +1,226 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimeMultipartEncrypted</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="MimeParts.html" title="MIME Messages and Parts"> +<link rel="prev" href="GMimeMultipart.html" title="GMimeMultipart"> +<link rel="next" href="GMimeMultipartSigned.html" title="GMimeMultipartSigned"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="GMimeMultipart.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="MimeParts.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="GMimeMultipartSigned.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GMimeMultipartEncrypted.synopsis" class="shortcut">Top</a> +  | + <a href="#GMimeMultipartEncrypted.description" class="shortcut">Description</a> +  | + <a href="#GMimeMultipartEncrypted.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GMimeMultipartEncrypted"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GMimeMultipartEncrypted.top_of_page"></a>GMimeMultipartEncrypted</span></h2> +<p>GMimeMultipartEncrypted — Encrypted MIME multiparts</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GMimeMultipartEncrypted.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">struct <a class="link" href="GMimeMultipartEncrypted.html#GMimeMultipartEncrypted-struct" title="struct GMimeMultipartEncrypted">GMimeMultipartEncrypted</a>; +<a class="link" href="GMimeMultipartEncrypted.html" title="GMimeMultipartEncrypted"><span class="returnvalue">GMimeMultipartEncrypted</span></a> * <a class="link" href="GMimeMultipartEncrypted.html#g-mime-multipart-encrypted-new" title="g_mime_multipart_encrypted_new ()">g_mime_multipart_encrypted_new</a> + (<em class="parameter"><code><span class="type">void</span></code></em>); +<span class="returnvalue">int</span> <a class="link" href="GMimeMultipartEncrypted.html#g-mime-multipart-encrypted-encrypt" title="g_mime_multipart_encrypted_encrypt ()">g_mime_multipart_encrypted_encrypt</a> (<em class="parameter"><code><a class="link" href="GMimeMultipartEncrypted.html" title="GMimeMultipartEncrypted"><span class="type">GMimeMultipartEncrypted</span></a> *mpe</code></em>, + <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *content</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> sign</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *userid</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="type">GMimeDigestAlgo</span></a> digest</code></em>, + <em class="parameter"><code><span class="type">GPtrArray</span> *recipients</code></em>, + <em class="parameter"><code><span class="type">GError</span> **err</code></em>); +<a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> * <a class="link" href="GMimeMultipartEncrypted.html#g-mime-multipart-encrypted-decrypt" title="g_mime_multipart_encrypted_decrypt ()">g_mime_multipart_encrypted_decrypt</a> (<em class="parameter"><code><a class="link" href="GMimeMultipartEncrypted.html" title="GMimeMultipartEncrypted"><span class="type">GMimeMultipartEncrypted</span></a> *mpe</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> **result</code></em>, + <em class="parameter"><code><span class="type">GError</span> **err</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GMimeMultipartEncrypted.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----<a class="link" href="GMimeObject.html" title="GMimeObject">GMimeObject</a> + +----<a class="link" href="GMimeMultipart.html" title="GMimeMultipart">GMimeMultipart</a> + +----GMimeMultipartEncrypted +</pre> +</div> +<div class="refsect1"> +<a name="GMimeMultipartEncrypted.description"></a><h2>Description</h2> +<p> +A <a class="link" href="GMimeMultipartEncrypted.html" title="GMimeMultipartEncrypted"><span class="type">GMimeMultipartEncrypted</span></a> part is a special subclass of +<a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> to make it easier to manipulate the +multipart/encrypted MIME type. +</p> +</div> +<div class="refsect1"> +<a name="GMimeMultipartEncrypted.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimeMultipartEncrypted-struct"></a><h3>struct GMimeMultipartEncrypted</h3> +<pre class="programlisting">struct GMimeMultipartEncrypted;</pre> +<p> +A multipart/encrypted MIME part. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-multipart-encrypted-new"></a><h3>g_mime_multipart_encrypted_new ()</h3> +<pre class="programlisting"><a class="link" href="GMimeMultipartEncrypted.html" title="GMimeMultipartEncrypted"><span class="returnvalue">GMimeMultipartEncrypted</span></a> * g_mime_multipart_encrypted_new + (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Creates a new MIME multipart/encrypted object. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>an empty MIME multipart/encrypted object.</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-multipart-encrypted-encrypt"></a><h3>g_mime_multipart_encrypted_encrypt ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> g_mime_multipart_encrypted_encrypt (<em class="parameter"><code><a class="link" href="GMimeMultipartEncrypted.html" title="GMimeMultipartEncrypted"><span class="type">GMimeMultipartEncrypted</span></a> *mpe</code></em>, + <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *content</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> sign</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *userid</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="type">GMimeDigestAlgo</span></a> digest</code></em>, + <em class="parameter"><code><span class="type">GPtrArray</span> *recipients</code></em>, + <em class="parameter"><code><span class="type">GError</span> **err</code></em>);</pre> +<p> +Attempts to encrypt (and conditionally sign) the <em class="parameter"><code>content</code></em> MIME part +to the public keys of <em class="parameter"><code>recipients</code></em> using the <em class="parameter"><code>ctx</code></em> encryption +context. If successful, the encrypted <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> is set as the +encrypted part of the multipart/encrypted object <em class="parameter"><code>mpe</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>mpe</code></em> :</span></p></td> +<td>multipart/encrypted object</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>content</code></em> :</span></p></td> +<td>MIME part to encrypt</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> +<td>encryption context</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>sign</code></em> :</span></p></td> +<td> +<code class="literal">TRUE</code> if the content should also be signed or <code class="literal">FALSE</code> otherwise</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>userid</code></em> :</span></p></td> +<td>user id to use for signing (only used if <em class="parameter"><code>sign</code></em> is <code class="literal">TRUE</code>)</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>digest</code></em> :</span></p></td> +<td>digest algorithm to use when signing</td> +</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> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td> +<td>a <span class="type">GError</span> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">0</code> on success or <code class="literal">-1</code> on fail. If the encryption fails, an +exception will be set on <em class="parameter"><code>err</code></em> to provide information as to why the +failure occured.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-multipart-encrypted-decrypt"></a><h3>g_mime_multipart_encrypted_decrypt ()</h3> +<pre class="programlisting"><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> * g_mime_multipart_encrypted_decrypt (<em class="parameter"><code><a class="link" href="GMimeMultipartEncrypted.html" title="GMimeMultipartEncrypted"><span class="type">GMimeMultipartEncrypted</span></a> *mpe</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> **result</code></em>, + <em class="parameter"><code><span class="type">GError</span> **err</code></em>);</pre> +<p> +Attempts to decrypt the encrypted MIME part contained within the +multipart/encrypted object <em class="parameter"><code>mpe</code></em> using the <em class="parameter"><code>ctx</code></em> decryption context. +</p> +<p> +If <em class="parameter"><code>result</code></em> is non-<code class="literal">NULL</code>, then on a successful decrypt operation, it will be +updated to point to a newly-allocated <a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> with signature +status information as well as a list of recipients that the part was +encrypted to. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>mpe</code></em> :</span></p></td> +<td>multipart/encrypted object</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> +<td>decryption context</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td> +<td>a <span class="type">GMimeDecryptionResult</span> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td> +<td>a <span class="type">GError</span> +</td> +</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> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="GMimeMultipartEncrypted.see-also"></a><h2>See Also</h2> +<a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/GMimeMultipartSigned.html b/docs/reference/html/GMimeMultipartSigned.html new file mode 100644 index 0000000..391158a --- /dev/null +++ b/docs/reference/html/GMimeMultipartSigned.html @@ -0,0 +1,196 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimeMultipartSigned</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="MimeParts.html" title="MIME Messages and Parts"> +<link rel="prev" href="GMimeMultipartEncrypted.html" title="GMimeMultipartEncrypted"> +<link rel="next" href="GMimeMessagePart.html" title="GMimeMessagePart"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="GMimeMultipartEncrypted.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="MimeParts.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="GMimeMessagePart.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GMimeMultipartSigned.synopsis" class="shortcut">Top</a> +  | + <a href="#GMimeMultipartSigned.description" class="shortcut">Description</a> +  | + <a href="#GMimeMultipartSigned.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GMimeMultipartSigned"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GMimeMultipartSigned.top_of_page"></a>GMimeMultipartSigned</span></h2> +<p>GMimeMultipartSigned — Signed MIME multiparts</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GMimeMultipartSigned.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">struct <a class="link" href="GMimeMultipartSigned.html#GMimeMultipartSigned-struct" title="struct GMimeMultipartSigned">GMimeMultipartSigned</a>; +<a class="link" href="GMimeMultipartSigned.html" title="GMimeMultipartSigned"><span class="returnvalue">GMimeMultipartSigned</span></a> * <a class="link" href="GMimeMultipartSigned.html#g-mime-multipart-signed-new" title="g_mime_multipart_signed_new ()">g_mime_multipart_signed_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +<span class="returnvalue">int</span> <a class="link" href="GMimeMultipartSigned.html#g-mime-multipart-signed-sign" title="g_mime_multipart_signed_sign ()">g_mime_multipart_signed_sign</a> (<em class="parameter"><code><a class="link" href="GMimeMultipartSigned.html" title="GMimeMultipartSigned"><span class="type">GMimeMultipartSigned</span></a> *mps</code></em>, + <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *content</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *userid</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="type">GMimeDigestAlgo</span></a> digest</code></em>, + <em class="parameter"><code><span class="type">GError</span> **err</code></em>); +<a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="returnvalue">GMimeSignatureList</span></a> * <a class="link" href="GMimeMultipartSigned.html#g-mime-multipart-signed-verify" title="g_mime_multipart_signed_verify ()">g_mime_multipart_signed_verify</a> (<em class="parameter"><code><a class="link" href="GMimeMultipartSigned.html" title="GMimeMultipartSigned"><span class="type">GMimeMultipartSigned</span></a> *mps</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code><span class="type">GError</span> **err</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GMimeMultipartSigned.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----<a class="link" href="GMimeObject.html" title="GMimeObject">GMimeObject</a> + +----<a class="link" href="GMimeMultipart.html" title="GMimeMultipart">GMimeMultipart</a> + +----GMimeMultipartSigned +</pre> +</div> +<div class="refsect1"> +<a name="GMimeMultipartSigned.description"></a><h2>Description</h2> +<p> +A <a class="link" href="GMimeMultipartSigned.html" title="GMimeMultipartSigned"><span class="type">GMimeMultipartSigned</span></a> part is a special subclass of +<a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> to make it easier to manipulate the +multipart/signed MIME type. +</p> +</div> +<div class="refsect1"> +<a name="GMimeMultipartSigned.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimeMultipartSigned-struct"></a><h3>struct GMimeMultipartSigned</h3> +<pre class="programlisting">struct GMimeMultipartSigned;</pre> +<p> +A multipart/signed MIME part. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-multipart-signed-new"></a><h3>g_mime_multipart_signed_new ()</h3> +<pre class="programlisting"><a class="link" href="GMimeMultipartSigned.html" title="GMimeMultipartSigned"><span class="returnvalue">GMimeMultipartSigned</span></a> * g_mime_multipart_signed_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Creates a new MIME multipart/signed object. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>an empty MIME multipart/signed object.</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-multipart-signed-sign"></a><h3>g_mime_multipart_signed_sign ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> g_mime_multipart_signed_sign (<em class="parameter"><code><a class="link" href="GMimeMultipartSigned.html" title="GMimeMultipartSigned"><span class="type">GMimeMultipartSigned</span></a> *mps</code></em>, + <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *content</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *userid</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="type">GMimeDigestAlgo</span></a> digest</code></em>, + <em class="parameter"><code><span class="type">GError</span> **err</code></em>);</pre> +<p> +Attempts to sign the <em class="parameter"><code>content</code></em> MIME part with <em class="parameter"><code>userid</code></em>'s private key +using the <em class="parameter"><code>ctx</code></em> signing context with the <em class="parameter"><code>digest</code></em> algorithm. If +successful, the signed <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> is set as the signed part of +the multipart/signed object <em class="parameter"><code>mps</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>mps</code></em> :</span></p></td> +<td>multipart/signed object</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>content</code></em> :</span></p></td> +<td>MIME part to sign</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> +<td>encryption crypto context</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>userid</code></em> :</span></p></td> +<td>user id to sign with</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>digest</code></em> :</span></p></td> +<td>preferred digest algorithm</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td> +<td>exception</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">0</code> on success or <code class="literal">-1</code> on fail. If the signing fails, an +exception will be set on <em class="parameter"><code>err</code></em> to provide information as to why the +failure occured.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-multipart-signed-verify"></a><h3>g_mime_multipart_signed_verify ()</h3> +<pre class="programlisting"><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="returnvalue">GMimeSignatureList</span></a> * g_mime_multipart_signed_verify (<em class="parameter"><code><a class="link" href="GMimeMultipartSigned.html" title="GMimeMultipartSigned"><span class="type">GMimeMultipartSigned</span></a> *mps</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>, + <em class="parameter"><code><span class="type">GError</span> **err</code></em>);</pre> +<p> +Attempts to verify the signed MIME part contained within the +multipart/signed object <em class="parameter"><code>mps</code></em> using the <em class="parameter"><code>ctx</code></em> crypto context. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>mps</code></em> :</span></p></td> +<td>multipart/signed object</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> +<td>encryption crypto context</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td> +<td>exception</td> +</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> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="GMimeMultipartSigned.see-also"></a><h2>See Also</h2> +<a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/GMimeObject.html b/docs/reference/html/GMimeObject.html new file mode 100644 index 0000000..fdf9850 --- /dev/null +++ b/docs/reference/html/GMimeObject.html @@ -0,0 +1,831 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimeObject</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="MimeParts.html" title="MIME Messages and Parts"> +<link rel="prev" href="MimeParts.html" title="MIME Messages and Parts"> +<link rel="next" href="GMimeMessage.html" title="GMimeMessage"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="MimeParts.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="MimeParts.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="GMimeMessage.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GMimeObject.synopsis" class="shortcut">Top</a> +  | + <a href="#GMimeObject.description" class="shortcut">Description</a> +  | + <a href="#GMimeObject.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GMimeObject"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GMimeObject.top_of_page"></a>GMimeObject</span></h2> +<p>GMimeObject — Abstract MIME objects</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GMimeObject.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">struct <a class="link" href="GMimeObject.html#GMimeObject-struct" title="struct GMimeObject">GMimeObject</a>; +<span class="returnvalue">void</span> (<a class="link" href="GMimeObject.html#GMimeObjectForeachFunc" title="GMimeObjectForeachFunc ()">*GMimeObjectForeachFunc</a>) (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *parent</code></em>, + <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *part</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeObject.html#g-mime-object-register-type" title="g_mime_object_register_type ()">g_mime_object_register_type</a> (<em class="parameter"><code>const <span class="type">char</span> *type</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *subtype</code></em>, + <em class="parameter"><code><span class="type">GType</span> object_type</code></em>); +<a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> * <a class="link" href="GMimeObject.html#g-mime-object-new" title="g_mime_object_new ()">g_mime_object_new</a> (<em class="parameter"><code><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> *content_type</code></em>); +<a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> * <a class="link" href="GMimeObject.html#g-mime-object-new-type" title="g_mime_object_new_type ()">g_mime_object_new_type</a> (<em class="parameter"><code>const <span class="type">char</span> *type</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *subtype</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeObject.html#g-mime-object-set-content-type" title="g_mime_object_set_content_type ()">g_mime_object_set_content_type</a> (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>, + <em class="parameter"><code><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> *content_type</code></em>); +<a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="returnvalue">GMimeContentType</span></a> * <a class="link" href="GMimeObject.html#g-mime-object-get-content-type" title="g_mime_object_get_content_type ()">g_mime_object_get_content_type</a> (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeObject.html#g-mime-object-set-content-type-parameter" title="g_mime_object_set_content_type_parameter ()">g_mime_object_set_content_type_parameter</a> + (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</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> *value</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="GMimeObject.html#g-mime-object-get-content-type-parameter" title="g_mime_object_get_content_type_parameter ()">g_mime_object_get_content_type_parameter</a> + (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *name</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeObject.html#g-mime-object-set-disposition" title="g_mime_object_set_disposition ()">g_mime_object_set_disposition</a> (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *disposition</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="GMimeObject.html#g-mime-object-get-disposition" title="g_mime_object_get_disposition ()">g_mime_object_get_disposition</a> (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeObject.html#g-mime-object-set-content-disposition" title="g_mime_object_set_content_disposition ()">g_mime_object_set_content_disposition</a> + (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>, + <em class="parameter"><code><a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> *disposition</code></em>); +<a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="returnvalue">GMimeContentDisposition</span></a> * <a class="link" href="GMimeObject.html#g-mime-object-get-content-disposition" title="g_mime_object_get_content_disposition ()">g_mime_object_get_content_disposition</a> + (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeObject.html#g-mime-object-set-content-disposition-parameter" title="g_mime_object_set_content_disposition_parameter ()">g_mime_object_set_content_disposition_parameter</a> + (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *attribute</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *value</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="GMimeObject.html#g-mime-object-get-content-disposition-parameter" title="g_mime_object_get_content_disposition_parameter ()">g_mime_object_get_content_disposition_parameter</a> + (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *attribute</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeObject.html#g-mime-object-set-content-id" title="g_mime_object_set_content_id ()">g_mime_object_set_content_id</a> (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *content_id</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="GMimeObject.html#g-mime-object-get-content-id" title="g_mime_object_get_content_id ()">g_mime_object_get_content_id</a> (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeObject.html#g-mime-object-prepend-header" title="g_mime_object_prepend_header ()">g_mime_object_prepend_header</a> (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *header</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *value</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeObject.html#g-mime-object-append-header" title="g_mime_object_append_header ()">g_mime_object_append_header</a> (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *header</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *value</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="GMimeObject.html#g-mime-object-remove-header" title="g_mime_object_remove_header ()">g_mime_object_remove_header</a> (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *header</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeObject.html#g-mime-object-set-header" title="g_mime_object_set_header ()">g_mime_object_set_header</a> (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *header</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *value</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="GMimeObject.html#g-mime-object-get-header" title="g_mime_object_get_header ()">g_mime_object_get_header</a> (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *header</code></em>); +<span class="returnvalue">char</span> * <a class="link" href="GMimeObject.html#g-mime-object-get-headers" title="g_mime_object_get_headers ()">g_mime_object_get_headers</a> (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>); +<a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="returnvalue">GMimeHeaderList</span></a> * <a class="link" href="GMimeObject.html#g-mime-object-get-header-list" title="g_mime_object_get_header_list ()">g_mime_object_get_header_list</a> (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>); +<span class="returnvalue">ssize_t</span> <a class="link" href="GMimeObject.html#g-mime-object-write-to-stream" title="g_mime_object_write_to_stream ()">g_mime_object_write_to_stream</a> (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>); +<span class="returnvalue">char</span> * <a class="link" href="GMimeObject.html#g-mime-object-to-string" title="g_mime_object_to_string ()">g_mime_object_to_string</a> (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeObject.html#g-mime-object-encode" title="g_mime_object_encode ()">g_mime_object_encode</a> (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>, + <em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeEncodingConstraint" title="enum GMimeEncodingConstraint"><span class="type">GMimeEncodingConstraint</span></a> constraint</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GMimeObject.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----GMimeObject + +----<a class="link" href="GMimeMessage.html" title="GMimeMessage">GMimeMessage</a> + +----<a class="link" href="GMimePart.html" title="GMimePart">GMimePart</a> + +----<a class="link" href="GMimeMultipart.html" title="GMimeMultipart">GMimeMultipart</a> + +----<a class="link" href="GMimeMessagePart.html" title="GMimeMessagePart">GMimeMessagePart</a> +</pre> +</div> +<div class="refsect1"> +<a name="GMimeObject.description"></a><h2>Description</h2> +<p> +<a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> is an abstract class from which all message and MIME +parts are derived. +</p> +</div> +<div class="refsect1"> +<a name="GMimeObject.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimeObject-struct"></a><h3>struct GMimeObject</h3> +<pre class="programlisting">struct GMimeObject;</pre> +<p> +Base class for all MIME parts. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="GMimeObjectForeachFunc"></a><h3>GMimeObjectForeachFunc ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> (*GMimeObjectForeachFunc) (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *parent</code></em>, + <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *part</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> +<p> +The function signature for a callback to <a class="link" href="GMimeMessage.html#g-mime-message-foreach" title="g_mime_message_foreach ()"><code class="function">g_mime_message_foreach()</code></a> +and <a class="link" href="GMimeMultipart.html#g-mime-multipart-foreach" title="g_mime_multipart_foreach ()"><code class="function">g_mime_multipart_foreach()</code></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>parent</code></em> :</span></p></td> +<td>parent <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>part</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> +<td>User-supplied callback data.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-object-register-type"></a><h3>g_mime_object_register_type ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_object_register_type (<em class="parameter"><code>const <span class="type">char</span> *type</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *subtype</code></em>, + <em class="parameter"><code><span class="type">GType</span> object_type</code></em>);</pre> +<p> +Registers the object type <em class="parameter"><code>object_type</code></em> for use with the +<a class="link" href="GMimeObject.html#g-mime-object-new-type" title="g_mime_object_new_type ()"><code class="function">g_mime_object_new_type()</code></a> convenience function. +</p> +<p> +Note: You may use the wildcard "*" to match any type and/or +subtype. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td> +<td>mime type</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>subtype</code></em> :</span></p></td> +<td>mime subtype</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>object_type</code></em> :</span></p></td> +<td>object type</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-object-new"></a><h3>g_mime_object_new ()</h3> +<pre class="programlisting"><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> * g_mime_object_new (<em class="parameter"><code><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> *content_type</code></em>);</pre> +<p> +Performs a lookup of registered <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> subclasses, registered +using <a class="link" href="GMimeObject.html#g-mime-object-register-type" title="g_mime_object_register_type ()"><code class="function">g_mime_object_register_type()</code></a>, to find an appropriate class +capable of handling MIME parts of the specified Content-Type. If no +class has been registered to handle that type, it looks for a +registered class that can handle <em class="parameter"><code>content_type</code></em>'s media type. If +that also fails, then it will use the generic part class, +<a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</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>content_type</code></em> :</span></p></td> +<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"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>an appropriate <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> registered to handle MIME +parts appropriate for <em class="parameter"><code>content_type</code></em>.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-object-new-type"></a><h3>g_mime_object_new_type ()</h3> +<pre class="programlisting"><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> * g_mime_object_new_type (<em class="parameter"><code>const <span class="type">char</span> *type</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *subtype</code></em>);</pre> +<p> +Performs a lookup of registered <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> subclasses, registered +using <a class="link" href="GMimeObject.html#g-mime-object-register-type" title="g_mime_object_register_type ()"><code class="function">g_mime_object_register_type()</code></a>, to find an appropriate class +capable of handling MIME parts of type <em class="parameter"><code>type</code></em>/<em class="parameter"><code>subtype</code></em>. If no class +has been registered to handle that type, it looks for a registered +class that can handle <em class="parameter"><code>type</code></em>. If that also fails, then it will use +the generic part class, <a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</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>type</code></em> :</span></p></td> +<td>mime type</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>subtype</code></em> :</span></p></td> +<td>mime subtype</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>an appropriate <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> registered to handle mime-types +of <em class="parameter"><code>type</code></em>/<em class="parameter"><code>subtype</code></em>.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-object-set-content-type"></a><h3>g_mime_object_set_content_type ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_object_set_content_type (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>, + <em class="parameter"><code><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> *content_type</code></em>);</pre> +<p> +Sets the content-type for the specified MIME object and then +serializes it to the Content-Type header field. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>content_type</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> object</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-object-get-content-type"></a><h3>g_mime_object_get_content_type ()</h3> +<pre class="programlisting"><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="returnvalue">GMimeContentType</span></a> * g_mime_object_get_content_type (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>);</pre> +<p> +Gets the <a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> object for the given MIME object or +<code class="literal">NULL</code> on fail. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> +</td> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-object-set-content-type-parameter"></a><h3>g_mime_object_set_content_type_parameter ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_object_set_content_type_parameter + (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</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> *value</code></em>);</pre> +<p> +Sets the content-type param <em class="parameter"><code>name</code></em> to the value <em class="parameter"><code>value</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>object</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> +<td>param name</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> +<td>param value</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-object-get-content-type-parameter"></a><h3>g_mime_object_get_content_type_parameter ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_object_get_content_type_parameter + (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre> +<p> +Gets the value of the content-type param <em class="parameter"><code>name</code></em> set on the MIME part +<em class="parameter"><code>object</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>object</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> +<td>param name</td> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-object-set-disposition"></a><h3>g_mime_object_set_disposition ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_object_set_disposition (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *disposition</code></em>);</pre> +<p> +Sets the disposition to <em class="parameter"><code>disposition</code></em> which may be one of +<a class="link" href="GMimeContentDisposition.html#GMIME-DISPOSITION-ATTACHMENT:CAPS" title="GMIME_DISPOSITION_ATTACHMENT"><span class="type">GMIME_DISPOSITION_ATTACHMENT</span></a> or <a class="link" href="GMimeContentDisposition.html#GMIME-DISPOSITION-INLINE:CAPS" title="GMIME_DISPOSITION_INLINE"><span class="type">GMIME_DISPOSITION_INLINE</span></a> or, by +your choice, any other string which would indicate how the MIME +part should be displayed by the MUA. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>disposition</code></em> :</span></p></td> +<td>disposition ("attachment" or "inline")</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-object-get-disposition"></a><h3>g_mime_object_get_disposition ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_object_get_disposition (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>);</pre> +<p> +Gets the MIME object's disposition if set or <code class="literal">NULL</code> otherwise. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the disposition string which is probably one of +<a class="link" href="GMimeContentDisposition.html#GMIME-DISPOSITION-ATTACHMENT:CAPS" title="GMIME_DISPOSITION_ATTACHMENT"><span class="type">GMIME_DISPOSITION_ATTACHMENT</span></a> or <a class="link" href="GMimeContentDisposition.html#GMIME-DISPOSITION-INLINE:CAPS" title="GMIME_DISPOSITION_INLINE"><span class="type">GMIME_DISPOSITION_INLINE</span></a>.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-object-set-content-disposition"></a><h3>g_mime_object_set_content_disposition ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_object_set_content_disposition + (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>, + <em class="parameter"><code><a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> *disposition</code></em>);</pre> +<p> +Set the content disposition for the specified mime part and then +serializes it to the Content-Disposition header field. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>disposition</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> object</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-object-get-content-disposition"></a><h3>g_mime_object_get_content_disposition ()</h3> +<pre class="programlisting"><a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="returnvalue">GMimeContentDisposition</span></a> * g_mime_object_get_content_disposition + (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>);</pre> +<p> +Gets the <a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> for the specified MIME object. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> +</td> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-object-set-content-disposition-parameter"></a><h3>g_mime_object_set_content_disposition_parameter ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_object_set_content_disposition_parameter + (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *attribute</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);</pre> +<p> +Add a content-disposition parameter to the specified mime part. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> +</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> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-object-get-content-disposition-parameter"></a><h3>g_mime_object_get_content_disposition_parameter ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_object_get_content_disposition_parameter + (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>, + <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. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-object-set-content-id"></a><h3>g_mime_object_set_content_id ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_object_set_content_id (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *content_id</code></em>);</pre> +<p> +Sets the Content-Id of the MIME object. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>content_id</code></em> :</span></p></td> +<td>content-id (addr-spec portion)</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-object-get-content-id"></a><h3>g_mime_object_get_content_id ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_object_get_content_id (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>);</pre> +<p> +Gets the Content-Id of the MIME object or NULL if one is not set. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a const pointer to the Content-Id header.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-object-prepend-header"></a><h3>g_mime_object_prepend_header ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_object_prepend_header (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *header</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);</pre> +<p> +Prepends a raw, unprocessed header to the MIME object. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>header</code></em> :</span></p></td> +<td>header name</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> +<td>header value</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-object-append-header"></a><h3>g_mime_object_append_header ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_object_append_header (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *header</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);</pre> +<p> +Appends a raw, unprocessed header to the MIME object. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>header</code></em> :</span></p></td> +<td>header name</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> +<td>header value</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-object-remove-header"></a><h3>g_mime_object_remove_header ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_object_remove_header (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *header</code></em>);</pre> +<p> +Removed the specified header if it exists. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>header</code></em> :</span></p></td> +<td>header name</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> if the header was removed or <code class="literal">FALSE</code> if it could not +be found.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-object-set-header"></a><h3>g_mime_object_set_header ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_object_set_header (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *header</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);</pre> +<p> +Sets an arbitrary raw, unprocessed header on the MIME object. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>header</code></em> :</span></p></td> +<td>header name</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> +<td>header value</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-object-get-header"></a><h3>g_mime_object_get_header ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_object_get_header (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *header</code></em>);</pre> +<p> +Gets the raw, unprocessed value of the requested header. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>header</code></em> :</span></p></td> +<td>header name</td> +</tr> +<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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-object-get-headers"></a><h3>g_mime_object_get_headers ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * g_mime_object_get_headers (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>);</pre> +<p> +Allocates a string buffer containing all of the MIME object's raw +headers. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> +</td> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-object-get-header-list"></a><h3>g_mime_object_get_header_list ()</h3> +<pre class="programlisting"><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="returnvalue">GMimeHeaderList</span></a> * g_mime_object_get_header_list (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>);</pre> +<p> +Get the header list for <em class="parameter"><code>object</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>object</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> +</td> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-object-write-to-stream"></a><h3>g_mime_object_write_to_stream ()</h3> +<pre class="programlisting"><span class="returnvalue">ssize_t</span> g_mime_object_write_to_stream (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>);</pre> +<p> +Write the contents of the MIME object to <em class="parameter"><code>stream</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>object</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td> +<td>stream</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the number of bytes written or <code class="literal">-1</code> on fail.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-object-to-string"></a><h3>g_mime_object_to_string ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * g_mime_object_to_string (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>);</pre> +<p> +Allocates a string buffer containing the contents of <em class="parameter"><code>object</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>object</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>an allocated string containing the contents of the mime +object.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-object-encode"></a><h3>g_mime_object_encode ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_object_encode (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>, + <em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeEncodingConstraint" title="enum GMimeEncodingConstraint"><span class="type">GMimeEncodingConstraint</span></a> constraint</code></em>);</pre> +<p> +Calculates and sets the most efficient Content-Transfer-Encoding +for this <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> and all child parts based on the <em class="parameter"><code>constraint</code></em> +provided. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>constraint</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-gmime-encodings.html#GMimeEncodingConstraint" title="enum GMimeEncodingConstraint"><span class="type">GMimeEncodingConstraint</span></a> +</td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/GMimeParser.html b/docs/reference/html/GMimeParser.html new file mode 100644 index 0000000..e3f5692 --- /dev/null +++ b/docs/reference/html/GMimeParser.html @@ -0,0 +1,597 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimeParser</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="Parsers.html" title="Parsing Messages and MIME Parts"> +<link rel="prev" href="Parsers.html" title="Parsing Messages and MIME Parts"> +<link rel="next" href="CryptoContexts.html" title="Cryptography Contexts"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="Parsers.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="Parsers.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="CryptoContexts.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GMimeParser.synopsis" class="shortcut">Top</a> +  | + <a href="#GMimeParser.description" class="shortcut">Description</a> +  | + <a href="#GMimeParser.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GMimeParser"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GMimeParser.top_of_page"></a>GMimeParser</span></h2> +<p>GMimeParser — Message and MIME part parser</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GMimeParser.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">struct <a class="link" href="GMimeParser.html#GMimeParser-struct" title="struct GMimeParser">GMimeParser</a>; +<span class="returnvalue">void</span> (<a class="link" href="GMimeParser.html#GMimeParserHeaderRegexFunc" title="GMimeParserHeaderRegexFunc ()">*GMimeParserHeaderRegexFunc</a>) (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *header</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *value</code></em>, + <em class="parameter"><code><span class="type">gint64</span> offset</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>); +<a class="link" href="GMimeParser.html" title="GMimeParser"><span class="returnvalue">GMimeParser</span></a> * <a class="link" href="GMimeParser.html#g-mime-parser-new" title="g_mime_parser_new ()">g_mime_parser_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +<a class="link" href="GMimeParser.html" title="GMimeParser"><span class="returnvalue">GMimeParser</span></a> * <a class="link" href="GMimeParser.html#g-mime-parser-new-with-stream" title="g_mime_parser_new_with_stream ()">g_mime_parser_new_with_stream</a> (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeParser.html#g-mime-parser-init-with-stream" title="g_mime_parser_init_with_stream ()">g_mime_parser_init_with_stream</a> (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="GMimeParser.html#g-mime-parser-get-persist-stream" title="g_mime_parser_get_persist_stream ()">g_mime_parser_get_persist_stream</a> (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeParser.html#g-mime-parser-set-persist-stream" title="g_mime_parser_set_persist_stream ()">g_mime_parser_set_persist_stream</a> (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> persist</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="GMimeParser.html#g-mime-parser-get-scan-from" title="g_mime_parser_get_scan_from ()">g_mime_parser_get_scan_from</a> (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeParser.html#g-mime-parser-set-scan-from" title="g_mime_parser_set_scan_from ()">g_mime_parser_set_scan_from</a> (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> scan_from</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="GMimeParser.html#g-mime-parser-get-respect-content-length" title="g_mime_parser_get_respect_content_length ()">g_mime_parser_get_respect_content_length</a> + (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeParser.html#g-mime-parser-set-respect-content-length" title="g_mime_parser_set_respect_content_length ()">g_mime_parser_set_respect_content_length</a> + (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> respect_content_length</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeParser.html#g-mime-parser-set-header-regex" title="g_mime_parser_set_header_regex ()">g_mime_parser_set_header_regex</a> (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *regex</code></em>, + <em class="parameter"><code><a class="link" href="GMimeParser.html#GMimeParserHeaderRegexFunc" title="GMimeParserHeaderRegexFunc ()"><span class="type">GMimeParserHeaderRegexFunc</span></a> header_cb</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>); +<span class="returnvalue">gint64</span> <a class="link" href="GMimeParser.html#g-mime-parser-tell" title="g_mime_parser_tell ()">g_mime_parser_tell</a> (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="GMimeParser.html#g-mime-parser-eos" title="g_mime_parser_eos ()">g_mime_parser_eos</a> (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>); +<a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> * <a class="link" href="GMimeParser.html#g-mime-parser-construct-part" title="g_mime_parser_construct_part ()">g_mime_parser_construct_part</a> (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>); +<a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="returnvalue">GMimeMessage</span></a> * <a class="link" href="GMimeParser.html#g-mime-parser-construct-message" title="g_mime_parser_construct_message ()">g_mime_parser_construct_message</a> (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>); +<span class="returnvalue">char</span> * <a class="link" href="GMimeParser.html#g-mime-parser-get-from" title="g_mime_parser_get_from ()">g_mime_parser_get_from</a> (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>); +<span class="returnvalue">gint64</span> <a class="link" href="GMimeParser.html#g-mime-parser-get-from-offset" title="g_mime_parser_get_from_offset ()">g_mime_parser_get_from_offset</a> (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>); +<span class="returnvalue">gint64</span> <a class="link" href="GMimeParser.html#g-mime-parser-get-headers-begin" title="g_mime_parser_get_headers_begin ()">g_mime_parser_get_headers_begin</a> (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>); +<span class="returnvalue">gint64</span> <a class="link" href="GMimeParser.html#g-mime-parser-get-headers-end" title="g_mime_parser_get_headers_end ()">g_mime_parser_get_headers_end</a> (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GMimeParser.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----GMimeParser +</pre> +</div> +<div class="refsect1"> +<a name="GMimeParser.description"></a><h2>Description</h2> +<p> +A <a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> parses a stream into a <a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> or other +<a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> and can also handle parsing MBox formatted streams +into multiple <a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> objects. +</p> +</div> +<div class="refsect1"> +<a name="GMimeParser.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimeParser-struct"></a><h3>struct GMimeParser</h3> +<pre class="programlisting">struct GMimeParser;</pre> +<p> +A MIME parser context. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="GMimeParserHeaderRegexFunc"></a><h3>GMimeParserHeaderRegexFunc ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> (*GMimeParserHeaderRegexFunc) (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *header</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *value</code></em>, + <em class="parameter"><code><span class="type">gint64</span> offset</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> +<p> +Function signature for the callback to +<a class="link" href="GMimeParser.html#g-mime-parser-set-header-regex" title="g_mime_parser_set_header_regex ()"><code class="function">g_mime_parser_set_header_regex()</code></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td> +<td>The <a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> object.</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>header</code></em> :</span></p></td> +<td>The header field matched.</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> +<td>The header field value.</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td> +<td>The header field offset.</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> +<td>The user-supplied callback data.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-parser-new"></a><h3>g_mime_parser_new ()</h3> +<pre class="programlisting"><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="returnvalue">GMimeParser</span></a> * g_mime_parser_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Creates a new parser object. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a new parser object.</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-parser-new-with-stream"></a><h3>g_mime_parser_new_with_stream ()</h3> +<pre class="programlisting"><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="returnvalue">GMimeParser</span></a> * g_mime_parser_new_with_stream (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>);</pre> +<p> +Creates a new parser object preset to parse <em class="parameter"><code>stream</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>stream</code></em> :</span></p></td> +<td>raw message or part stream</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a new parser object.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-parser-init-with-stream"></a><h3>g_mime_parser_init_with_stream ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_parser_init_with_stream (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>);</pre> +<p> +Initializes <em class="parameter"><code>parser</code></em> to use <em class="parameter"><code>stream</code></em>. +</p> +<p> +WARNING: Initializing a parser with a stream is comparable to +selling your soul (<em class="parameter"><code>stream</code></em>) to the devil (<em class="parameter"><code>parser</code></em>). You are +basically giving the parser complete control of the stream, this +means that you had better not touch the stream so long as the +parser is still using it. This means no reading, writing, seeking, +or resetting of the stream. Anything that will/could change the +current stream's offset is PROHIBITED. +</p> +<p> +It is also recommended that you not use <a class="link" href="GMimeStream.html#g-mime-stream-tell" title="g_mime_stream_tell ()"><code class="function">g_mime_stream_tell()</code></a> +because it will not necessarily give you the current <em class="parameter"><code>parser</code></em> offset +since <em class="parameter"><code>parser</code></em> handles its own internal read-ahead buffer. Instead, +it is recommended that you use <a class="link" href="GMimeParser.html#g-mime-parser-tell" title="g_mime_parser_tell ()"><code class="function">g_mime_parser_tell()</code></a> if you have a +reason to need the current offset of the <em class="parameter"><code>parser</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>parser</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> context</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td> +<td>raw message or part stream</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-parser-get-persist-stream"></a><h3>g_mime_parser_get_persist_stream ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_parser_get_persist_stream (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>);</pre> +<p> +Gets whether or not the underlying stream is persistent. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> context</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> if the <em class="parameter"><code>parser</code></em> will leave the content on disk or +<code class="literal">FALSE</code> if it will load the content into memory.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-parser-set-persist-stream"></a><h3>g_mime_parser_set_persist_stream ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_parser_set_persist_stream (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> persist</code></em>);</pre> +<p> +Sets whether or not the <em class="parameter"><code>parser</code></em>'s underlying stream is persistent. +</p> +<p> +If <em class="parameter"><code>persist</code></em> is <code class="literal">TRUE</code>, the <em class="parameter"><code>parser</code></em> will attempt to construct +messages/parts whose content will remain on disk rather than being +loaded into memory so as to reduce memory usage. This is the default. +</p> +<p> +If <em class="parameter"><code>persist</code></em> is <code class="literal">FALSE</code>, the <em class="parameter"><code>parser</code></em> will always load message content +into memory. +</p> +<p> +Note: This attribute only serves as a hint to the <em class="parameter"><code>parser</code></em>. If the +underlying stream does not support seeking, then this attribute +will be ignored. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> context</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>persist</code></em> :</span></p></td> +<td>persist attribute</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-parser-get-scan-from"></a><h3>g_mime_parser_get_scan_from ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_parser_get_scan_from (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>);</pre> +<p> +Gets whether or not <em class="parameter"><code>parser</code></em> is set to scan mbox-style From-lines. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> context</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>whether or not <em class="parameter"><code>parser</code></em> is set to scan mbox-style +From-lines.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-parser-set-scan-from"></a><h3>g_mime_parser_set_scan_from ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_parser_set_scan_from (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> scan_from</code></em>);</pre> +<p> +Sets whether or not <em class="parameter"><code>parser</code></em> should scan mbox-style From-lines. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> context</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>scan_from</code></em> :</span></p></td> +<td> +<code class="literal">TRUE</code> to scan From-lines or <code class="literal">FALSE</code> otherwise</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-parser-get-respect-content-length"></a><h3>g_mime_parser_get_respect_content_length ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_parser_get_respect_content_length + (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>);</pre> +<p> +Gets whether or not <em class="parameter"><code>parser</code></em> is set to use Content-Length for +determining the offset of the end of the message. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> context</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>whether or not <em class="parameter"><code>parser</code></em> is set to use Content-Length for +determining the offset of the end of the message.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-parser-set-respect-content-length"></a><h3>g_mime_parser_set_respect_content_length ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_parser_set_respect_content_length + (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> respect_content_length</code></em>);</pre> +<p> +Sets whether or not <em class="parameter"><code>parser</code></em> should respect Content-Length headers +when deciding where to look for the start of the next message. Only +used when the parser is also set to scan for From-lines. +</p> +<p> +Most notably useful when parsing broken Solaris mbox files (See +http://www.jwz.org/doc/content-length.html for details). +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> context</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>respect_content_length</code></em> :</span></p></td> +<td> +<code class="literal">TRUE</code> if the parser should use Content-Length headers or <code class="literal">FALSE</code> otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-parser-set-header-regex"></a><h3>g_mime_parser_set_header_regex ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_parser_set_header_regex (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *regex</code></em>, + <em class="parameter"><code><a class="link" href="GMimeParser.html#GMimeParserHeaderRegexFunc" title="GMimeParserHeaderRegexFunc ()"><span class="type">GMimeParserHeaderRegexFunc</span></a> header_cb</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> +<p> +Sets the regular expression pattern <em class="parameter"><code>regex</code></em> on <em class="parameter"><code>parser</code></em>. Whenever a +header matching the pattern <em class="parameter"><code>regex</code></em> is parsed, <em class="parameter"><code>header_cb</code></em> is called +with <em class="parameter"><code>user_data</code></em> as the user_data argument. +</p> +<p> +If <em class="parameter"><code>regex</code></em> is <code class="literal">NULL</code>, then the previously registered regex callback +is unregistered and no new callback is set. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> context</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>regex</code></em> :</span></p></td> +<td>regular expression</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>header_cb</code></em> :</span></p></td> +<td>callback function</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> +<td>user data</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-parser-tell"></a><h3>g_mime_parser_tell ()</h3> +<pre class="programlisting"><span class="returnvalue">gint64</span> g_mime_parser_tell (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>);</pre> +<p> +Gets the current stream offset from the parser's internal stream. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> context</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the current stream offset from the parser's internal stream +or <code class="literal">-1</code> on error.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-parser-eos"></a><h3>g_mime_parser_eos ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_parser_eos (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>);</pre> +<p> +Tests the end-of-stream indicator for <em class="parameter"><code>parser</code></em>'s internal stream. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> context</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> on EOS or <code class="literal">FALSE</code> otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-parser-construct-part"></a><h3>g_mime_parser_construct_part ()</h3> +<pre class="programlisting"><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> * g_mime_parser_construct_part (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>);</pre> +<p> +Constructs a MIME part from <em class="parameter"><code>parser</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>parser</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> context</td> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-parser-construct-message"></a><h3>g_mime_parser_construct_message ()</h3> +<pre class="programlisting"><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="returnvalue">GMimeMessage</span></a> * g_mime_parser_construct_message (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>);</pre> +<p> +Constructs a MIME message from <em class="parameter"><code>parser</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>parser</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> context</td> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-parser-get-from"></a><h3>g_mime_parser_get_from ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * g_mime_parser_get_from (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>);</pre> +<p> +Gets the mbox-style From-line of the most recently parsed message +(gotten from <a class="link" href="GMimeParser.html#g-mime-parser-construct-message" title="g_mime_parser_construct_message ()"><code class="function">g_mime_parser_construct_message()</code></a>). +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> context</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the mbox-style From-line of the most recently parsed +message or <code class="literal">NULL</code> on error.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-parser-get-from-offset"></a><h3>g_mime_parser_get_from_offset ()</h3> +<pre class="programlisting"><span class="returnvalue">gint64</span> g_mime_parser_get_from_offset (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>);</pre> +<p> +Gets the offset of the most recently parsed mbox-style From-line +(gotten from <a class="link" href="GMimeParser.html#g-mime-parser-construct-message" title="g_mime_parser_construct_message ()"><code class="function">g_mime_parser_construct_message()</code></a>). +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> context</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the offset of the most recently parsed mbox-style From-line +or <code class="literal">-1</code> on error.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-parser-get-headers-begin"></a><h3>g_mime_parser_get_headers_begin ()</h3> +<pre class="programlisting"><span class="returnvalue">gint64</span> g_mime_parser_get_headers_begin (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>);</pre> +<p> +Gets the stream offset of the beginning of the headers of the most +recently parsed message. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> context</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the offset of the beginning of the headers of the most +recently parsed message or <code class="literal">-1</code> on error.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-parser-get-headers-end"></a><h3>g_mime_parser_get_headers_end ()</h3> +<pre class="programlisting"><span class="returnvalue">gint64</span> g_mime_parser_get_headers_end (<em class="parameter"><code><a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> *parser</code></em>);</pre> +<p> +Gets the stream offset of the end of the headers of the most +recently parsed message. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeParser.html" title="GMimeParser"><span class="type">GMimeParser</span></a> context</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the offset of the end of the headers of the most recently +parsed message or <code class="literal">-1</code> on error.</td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/GMimePart.html b/docs/reference/html/GMimePart.html new file mode 100644 index 0000000..1d6b778 --- /dev/null +++ b/docs/reference/html/GMimePart.html @@ -0,0 +1,514 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimePart</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="MimeParts.html" title="MIME Messages and Parts"> +<link rel="prev" href="GMimeMessage.html" title="GMimeMessage"> +<link rel="next" href="GMimeMultipart.html" title="GMimeMultipart"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="GMimeMessage.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="MimeParts.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="GMimeMultipart.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GMimePart.synopsis" class="shortcut">Top</a> +  | + <a href="#GMimePart.description" class="shortcut">Description</a> +  | + <a href="#GMimePart.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GMimePart"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GMimePart.top_of_page"></a>GMimePart</span></h2> +<p>GMimePart — MIME parts</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GMimePart.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">struct <a class="link" href="GMimePart.html#GMimePart-struct" title="struct GMimePart">GMimePart</a>; +<a class="link" href="GMimePart.html" title="GMimePart"><span class="returnvalue">GMimePart</span></a> * <a class="link" href="GMimePart.html#g-mime-part-new" title="g_mime_part_new ()">g_mime_part_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +<a class="link" href="GMimePart.html" title="GMimePart"><span class="returnvalue">GMimePart</span></a> * <a class="link" href="GMimePart.html#g-mime-part-new-with-type" title="g_mime_part_new_with_type ()">g_mime_part_new_with_type</a> (<em class="parameter"><code>const <span class="type">char</span> *type</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *subtype</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimePart.html#g-mime-part-set-content-description" title="g_mime_part_set_content_description ()">g_mime_part_set_content_description</a> (<em class="parameter"><code><a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> *mime_part</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *description</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="GMimePart.html#g-mime-part-get-content-description" title="g_mime_part_get_content_description ()">g_mime_part_get_content_description</a> (<em class="parameter"><code><a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> *mime_part</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimePart.html#g-mime-part-set-content-id" title="g_mime_part_set_content_id ()">g_mime_part_set_content_id</a> (<em class="parameter"><code><a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> *mime_part</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *content_id</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="GMimePart.html#g-mime-part-get-content-id" title="g_mime_part_get_content_id ()">g_mime_part_get_content_id</a> (<em class="parameter"><code><a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> *mime_part</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimePart.html#g-mime-part-set-content-md5" title="g_mime_part_set_content_md5 ()">g_mime_part_set_content_md5</a> (<em class="parameter"><code><a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> *mime_part</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *content_md5</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="GMimePart.html#g-mime-part-get-content-md5" title="g_mime_part_get_content_md5 ()">g_mime_part_get_content_md5</a> (<em class="parameter"><code><a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> *mime_part</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="GMimePart.html#g-mime-part-verify-content-md5" title="g_mime_part_verify_content_md5 ()">g_mime_part_verify_content_md5</a> (<em class="parameter"><code><a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> *mime_part</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimePart.html#g-mime-part-set-content-location" title="g_mime_part_set_content_location ()">g_mime_part_set_content_location</a> (<em class="parameter"><code><a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> *mime_part</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *content_location</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="GMimePart.html#g-mime-part-get-content-location" title="g_mime_part_get_content_location ()">g_mime_part_get_content_location</a> (<em class="parameter"><code><a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> *mime_part</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimePart.html#g-mime-part-set-content-encoding" title="g_mime_part_set_content_encoding ()">g_mime_part_set_content_encoding</a> (<em class="parameter"><code><a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> *mime_part</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>); +<a class="link" href="gmime-gmime-encodings.html#GMimeContentEncoding" title="enum GMimeContentEncoding"><span class="returnvalue">GMimeContentEncoding</span></a> <a class="link" href="GMimePart.html#g-mime-part-get-content-encoding" title="g_mime_part_get_content_encoding ()">g_mime_part_get_content_encoding</a> (<em class="parameter"><code><a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> *mime_part</code></em>); +<a class="link" href="gmime-gmime-encodings.html#GMimeContentEncoding" title="enum GMimeContentEncoding"><span class="returnvalue">GMimeContentEncoding</span></a> <a class="link" href="GMimePart.html#g-mime-part-get-best-content-encoding" title="g_mime_part_get_best_content_encoding ()">g_mime_part_get_best_content_encoding</a> + (<em class="parameter"><code><a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> *mime_part</code></em>, + <em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeEncodingConstraint" title="enum GMimeEncodingConstraint"><span class="type">GMimeEncodingConstraint</span></a> constraint</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimePart.html#g-mime-part-set-filename" title="g_mime_part_set_filename ()">g_mime_part_set_filename</a> (<em class="parameter"><code><a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> *mime_part</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *filename</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="GMimePart.html#g-mime-part-get-filename" title="g_mime_part_get_filename ()">g_mime_part_get_filename</a> (<em class="parameter"><code><a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> *mime_part</code></em>); +<a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="returnvalue">GMimeDataWrapper</span></a> * <a class="link" href="GMimePart.html#g-mime-part-get-content-object" title="g_mime_part_get_content_object ()">g_mime_part_get_content_object</a> (<em class="parameter"><code><a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> *mime_part</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimePart.html#g-mime-part-set-content-object" title="g_mime_part_set_content_object ()">g_mime_part_set_content_object</a> (<em class="parameter"><code><a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> *mime_part</code></em>, + <em class="parameter"><code><a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> *content</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GMimePart.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----<a class="link" href="GMimeObject.html" title="GMimeObject">GMimeObject</a> + +----GMimePart + +----<a class="link" href="GMimeMessagePartial.html" title="GMimeMessagePartial">GMimeMessagePartial</a> +</pre> +</div> +<div class="refsect1"> +<a name="GMimePart.description"></a><h2>Description</h2> +<p> +A <a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> represents any MIME leaf part (meaning it has no +sub-parts). +</p> +</div> +<div class="refsect1"> +<a name="GMimePart.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimePart-struct"></a><h3>struct GMimePart</h3> +<pre class="programlisting">struct GMimePart;</pre> +<p> +A leaf-node MIME part object. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-part-new"></a><h3>g_mime_part_new ()</h3> +<pre class="programlisting"><a class="link" href="GMimePart.html" title="GMimePart"><span class="returnvalue">GMimePart</span></a> * g_mime_part_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Creates a new MIME Part object with a default content-type of +text/plain. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>an empty MIME Part object with a default content-type of +text/plain.</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-part-new-with-type"></a><h3>g_mime_part_new_with_type ()</h3> +<pre class="programlisting"><a class="link" href="GMimePart.html" title="GMimePart"><span class="returnvalue">GMimePart</span></a> * g_mime_part_new_with_type (<em class="parameter"><code>const <span class="type">char</span> *type</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *subtype</code></em>);</pre> +<p> +Creates a new MIME Part with a sepcified type. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td> +<td>content-type string</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>subtype</code></em> :</span></p></td> +<td>content-subtype string</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>an empty MIME Part object with the specified content-type.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-part-set-content-description"></a><h3>g_mime_part_set_content_description ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_part_set_content_description (<em class="parameter"><code><a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> *mime_part</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *description</code></em>);</pre> +<p> +Set the content description for the specified mime part. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>mime_part</code></em> :</span></p></td> +<td>a <a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> object</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>description</code></em> :</span></p></td> +<td>content description</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-part-get-content-description"></a><h3>g_mime_part_get_content_description ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_part_get_content_description (<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 value of the Content-Description for the specified mime +part if it exists or <code class="literal">NULL</code> otherwise. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>mime_part</code></em> :</span></p></td> +<td>a <a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> object</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the content description for the specified mime part.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-part-set-content-id"></a><h3>g_mime_part_set_content_id ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_part_set_content_id (<em class="parameter"><code><a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> *mime_part</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *content_id</code></em>);</pre> +<p> +Set the content id for the specified mime part. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>mime_part</code></em> :</span></p></td> +<td>a <a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> object</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>content_id</code></em> :</span></p></td> +<td>content id</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-part-get-content-id"></a><h3>g_mime_part_get_content_id ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_part_get_content_id (<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 content-id of the specified mime part if it exists, or +<code class="literal">NULL</code> otherwise. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>mime_part</code></em> :</span></p></td> +<td>a <a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> object</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the content id for the specified mime part.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-part-set-content-md5"></a><h3>g_mime_part_set_content_md5 ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_part_set_content_md5 (<em class="parameter"><code><a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> *mime_part</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *content_md5</code></em>);</pre> +<p> +Set the content md5 for the specified mime part. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>mime_part</code></em> :</span></p></td> +<td>a <a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> object</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>content_md5</code></em> :</span></p></td> +<td>content md5 or <code class="literal">NULL</code> to generate the md5 digest.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-part-get-content-md5"></a><h3>g_mime_part_get_content_md5 ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_part_get_content_md5 (<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 md5sum contained in the Content-Md5 header of the +specified mime part if it exists, or <code class="literal">NULL</code> otherwise. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>mime_part</code></em> :</span></p></td> +<td>a <a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> object</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the content md5 for the specified mime part.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-part-verify-content-md5"></a><h3>g_mime_part_verify_content_md5 ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_part_verify_content_md5 (<em class="parameter"><code><a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> *mime_part</code></em>);</pre> +<p> +Verify the content md5 for the specified mime part. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>mime_part</code></em> :</span></p></td> +<td>a <a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> object</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> if the md5 is valid or <code class="literal">FALSE</code> otherwise. Note: will +return <code class="literal">FALSE</code> if the mime part does not contain a Content-MD5.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-part-set-content-location"></a><h3>g_mime_part_set_content_location ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_part_set_content_location (<em class="parameter"><code><a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> *mime_part</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *content_location</code></em>);</pre> +<p> +Set the content location for the specified mime part. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>mime_part</code></em> :</span></p></td> +<td>a <a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> object</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>content_location</code></em> :</span></p></td> +<td>content location</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-part-get-content-location"></a><h3>g_mime_part_get_content_location ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_part_get_content_location (<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 value of the Content-Location header if it exists, or +<code class="literal">NULL</code> otherwise. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>mime_part</code></em> :</span></p></td> +<td>a <a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> object</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the content location for the specified mime part.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-part-set-content-encoding"></a><h3>g_mime_part_set_content_encoding ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_part_set_content_encoding (<em class="parameter"><code><a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> *mime_part</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> +Set the content encoding for the specified mime part. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>mime_part</code></em> :</span></p></td> +<td>a <a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> object</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>encoding</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-gmime-encodings.html#GMimeContentEncoding" title="enum GMimeContentEncoding"><span class="type">GMimeContentEncoding</span></a> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-part-get-content-encoding"></a><h3>g_mime_part_get_content_encoding ()</h3> +<pre class="programlisting"><a class="link" href="gmime-gmime-encodings.html#GMimeContentEncoding" title="enum GMimeContentEncoding"><span class="returnvalue">GMimeContentEncoding</span></a> g_mime_part_get_content_encoding (<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 content encoding of the mime part. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>mime_part</code></em> :</span></p></td> +<td>a <a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> object</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the content encoding for the specified mime part.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-part-get-best-content-encoding"></a><h3>g_mime_part_get_best_content_encoding ()</h3> +<pre class="programlisting"><a class="link" href="gmime-gmime-encodings.html#GMimeContentEncoding" title="enum GMimeContentEncoding"><span class="returnvalue">GMimeContentEncoding</span></a> g_mime_part_get_best_content_encoding + (<em class="parameter"><code><a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> *mime_part</code></em>, + <em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeEncodingConstraint" title="enum GMimeEncodingConstraint"><span class="type">GMimeEncodingConstraint</span></a> constraint</code></em>);</pre> +<p> +Calculates the most efficient content encoding for the <em class="parameter"><code>mime_part</code></em> +given the <em class="parameter"><code>constraint</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>mime_part</code></em> :</span></p></td> +<td>a <a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> object</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>constraint</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-gmime-encodings.html#GMimeEncodingConstraint" title="enum GMimeEncodingConstraint"><span class="type">GMimeEncodingConstraint</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the best content encoding for the specified mime part.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-part-set-filename"></a><h3>g_mime_part_set_filename ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_part_set_filename (<em class="parameter"><code><a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> *mime_part</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *filename</code></em>);</pre> +<p> +Sets the "filename" parameter on the Content-Disposition and also sets the +"name" parameter on the Content-Type. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>mime_part</code></em> :</span></p></td> +<td>a <a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> object</td> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<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. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>mime_part</code></em> :</span></p></td> +<td>a <a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> object</td> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-part-get-content-object"></a><h3>g_mime_part_get_content_object ()</h3> +<pre class="programlisting"><a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="returnvalue">GMimeDataWrapper</span></a> * g_mime_part_get_content_object (<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 internal data-wrapper of the specified mime part, or <code class="literal">NULL</code> +on error. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>mime_part</code></em> :</span></p></td> +<td>a <a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> object</td> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-part-set-content-object"></a><h3>g_mime_part_set_content_object ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_part_set_content_object (<em class="parameter"><code><a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> *mime_part</code></em>, + <em class="parameter"><code><a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> *content</code></em>);</pre> +<p> +Sets the content object on the mime part. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>mime_part</code></em> :</span></p></td> +<td>a <a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a> object</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>content</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> content object</td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/GMimePkcs7Context.html b/docs/reference/html/GMimePkcs7Context.html new file mode 100644 index 0000000..ab12a55 --- /dev/null +++ b/docs/reference/html/GMimePkcs7Context.html @@ -0,0 +1,158 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimePkcs7Context</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="CryptoContexts.html" title="Cryptography Contexts"> +<link rel="prev" href="GMimeGpgContext.html" title="GMimeGpgContext"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="GMimeGpgContext.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="CryptoContexts.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td> </td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GMimePkcs7Context.synopsis" class="shortcut">Top</a> +  | + <a href="#GMimePkcs7Context.description" class="shortcut">Description</a> +  | + <a href="#GMimePkcs7Context.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GMimePkcs7Context"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GMimePkcs7Context.top_of_page"></a>GMimePkcs7Context</span></h2> +<p>GMimePkcs7Context — PKCS7 crypto contexts</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GMimePkcs7Context.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">struct <a class="link" href="GMimePkcs7Context.html#GMimePkcs7Context-struct" title="struct GMimePkcs7Context">GMimePkcs7Context</a>; +<a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="returnvalue">GMimeCryptoContext</span></a> * <a class="link" href="GMimePkcs7Context.html#g-mime-pkcs7-context-new" title="g_mime_pkcs7_context_new ()">g_mime_pkcs7_context_new</a> (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimePasswordRequestFunc" title="GMimePasswordRequestFunc ()"><span class="type">GMimePasswordRequestFunc</span></a> request_passwd</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="GMimePkcs7Context.html#g-mime-pkcs7-context-get-always-trust" title="g_mime_pkcs7_context_get_always_trust ()">g_mime_pkcs7_context_get_always_trust</a> + (<em class="parameter"><code><a class="link" href="GMimePkcs7Context.html" title="GMimePkcs7Context"><span class="type">GMimePkcs7Context</span></a> *ctx</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimePkcs7Context.html#g-mime-pkcs7-context-set-always-trust" title="g_mime_pkcs7_context_set_always_trust ()">g_mime_pkcs7_context_set_always_trust</a> + (<em class="parameter"><code><a class="link" href="GMimePkcs7Context.html" title="GMimePkcs7Context"><span class="type">GMimePkcs7Context</span></a> *ctx</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> always_trust</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GMimePkcs7Context.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----<a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext">GMimeCryptoContext</a> + +----GMimePkcs7Context +</pre> +</div> +<div class="refsect1"> +<a name="GMimePkcs7Context.description"></a><h2>Description</h2> +<p> +A <a class="link" href="GMimePkcs7Context.html" title="GMimePkcs7Context"><span class="type">GMimePkcs7Context</span></a> is a <a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> that uses GnuPG to do +all of the encryption and digital signatures. +</p> +</div> +<div class="refsect1"> +<a name="GMimePkcs7Context.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimePkcs7Context-struct"></a><h3>struct GMimePkcs7Context</h3> +<pre class="programlisting">struct GMimePkcs7Context;</pre> +<p> +A PKCS7 crypto context. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-pkcs7-context-new"></a><h3>g_mime_pkcs7_context_new ()</h3> +<pre class="programlisting"><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="returnvalue">GMimeCryptoContext</span></a> * g_mime_pkcs7_context_new (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimePasswordRequestFunc" title="GMimePasswordRequestFunc ()"><span class="type">GMimePasswordRequestFunc</span></a> request_passwd</code></em>);</pre> +<p> +Creates a new pkcs7 crypto context object. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>request_passwd</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCryptoContext.html#GMimePasswordRequestFunc" title="GMimePasswordRequestFunc ()"><span class="type">GMimePasswordRequestFunc</span></a> +</td> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-pkcs7-context-get-always-trust"></a><h3>g_mime_pkcs7_context_get_always_trust ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_pkcs7_context_get_always_trust + (<em class="parameter"><code><a class="link" href="GMimePkcs7Context.html" title="GMimePkcs7Context"><span class="type">GMimePkcs7Context</span></a> *ctx</code></em>);</pre> +<p> +Gets the <em class="parameter"><code>always_trust</code></em> flag on the pkcs7 context. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> +<td>a <a class="link" href="GMimePkcs7Context.html" title="GMimePkcs7Context"><span class="type">GMimePkcs7Context</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the <em class="parameter"><code>always_trust</code></em> flag on the pkcs7 context.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-pkcs7-context-set-always-trust"></a><h3>g_mime_pkcs7_context_set_always_trust ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_pkcs7_context_set_always_trust + (<em class="parameter"><code><a class="link" href="GMimePkcs7Context.html" title="GMimePkcs7Context"><span class="type">GMimePkcs7Context</span></a> *ctx</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> always_trust</code></em>);</pre> +<p> +Sets the <em class="parameter"><code>always_trust</code></em> flag on the pkcs7 context which is used for +encryption. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td> +<td>a <a class="link" href="GMimePkcs7Context.html" title="GMimePkcs7Context"><span class="type">GMimePkcs7Context</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>always_trust</code></em> :</span></p></td> +<td>always trust flag</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="GMimePkcs7Context.see-also"></a><h2>See Also</h2> +<a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/GMimeSignature.html b/docs/reference/html/GMimeSignature.html new file mode 100644 index 0000000..5a18b45 --- /dev/null +++ b/docs/reference/html/GMimeSignature.html @@ -0,0 +1,754 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimeSignature</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="CryptoContexts.html" title="Cryptography Contexts"> +<link rel="prev" href="GMimeCertificate.html" title="GMimeCertificate"> +<link rel="next" href="GMimeCryptoContext.html" title="GMimeCryptoContext"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="GMimeCertificate.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="CryptoContexts.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="GMimeCryptoContext.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GMimeSignature.synopsis" class="shortcut">Top</a> +  | + <a href="#GMimeSignature.description" class="shortcut">Description</a> +  | + <a href="#GMimeSignature.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GMimeSignature"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GMimeSignature.top_of_page"></a>GMimeSignature</span></h2> +<p>GMimeSignature — Digital signatures</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GMimeSignature.synopsis"></a><h2>Synopsis</h2> +<a name="GMimeSignatureList"></a><pre class="synopsis">enum <a class="link" href="GMimeSignature.html#GMimeSignatureStatus" title="enum GMimeSignatureStatus">GMimeSignatureStatus</a>; +enum <a class="link" href="GMimeSignature.html#GMimeSignatureError" title="enum GMimeSignatureError">GMimeSignatureError</a>; +struct <a class="link" href="GMimeSignature.html#GMimeSignature-struct" title="struct GMimeSignature">GMimeSignature</a>; +<a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="returnvalue">GMimeSignature</span></a> * <a class="link" href="GMimeSignature.html#g-mime-signature-new" title="g_mime_signature_new ()">g_mime_signature_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +<a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="returnvalue">GMimeCertificate</span></a> * <a class="link" href="GMimeSignature.html#g-mime-signature-get-certificate" title="g_mime_signature_get_certificate ()">g_mime_signature_get_certificate</a> (<em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeSignature.html#g-mime-signature-set-certificate" title="g_mime_signature_set_certificate ()">g_mime_signature_set_certificate</a> (<em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>); +<a class="link" href="GMimeSignature.html#GMimeSignatureStatus" title="enum GMimeSignatureStatus"><span class="returnvalue">GMimeSignatureStatus</span></a> <a class="link" href="GMimeSignature.html#g-mime-signature-get-status" title="g_mime_signature_get_status ()">g_mime_signature_get_status</a> (<em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeSignature.html#g-mime-signature-set-status" title="g_mime_signature_set_status ()">g_mime_signature_set_status</a> (<em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>, + <em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureStatus" title="enum GMimeSignatureStatus"><span class="type">GMimeSignatureStatus</span></a> status</code></em>); +<a class="link" href="GMimeSignature.html#GMimeSignatureError" title="enum GMimeSignatureError"><span class="returnvalue">GMimeSignatureError</span></a> <a class="link" href="GMimeSignature.html#g-mime-signature-get-errors" title="g_mime_signature_get_errors ()">g_mime_signature_get_errors</a> (<em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeSignature.html#g-mime-signature-set-errors" title="g_mime_signature_set_errors ()">g_mime_signature_set_errors</a> (<em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>, + <em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureError" title="enum GMimeSignatureError"><span class="type">GMimeSignatureError</span></a> errors</code></em>); +<span class="returnvalue">time_t</span> <a class="link" href="GMimeSignature.html#g-mime-signature-get-created" title="g_mime_signature_get_created ()">g_mime_signature_get_created</a> (<em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeSignature.html#g-mime-signature-set-created" title="g_mime_signature_set_created ()">g_mime_signature_set_created</a> (<em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>, + <em class="parameter"><code><span class="type">time_t</span> created</code></em>); +<span class="returnvalue">time_t</span> <a class="link" href="GMimeSignature.html#g-mime-signature-get-expires" title="g_mime_signature_get_expires ()">g_mime_signature_get_expires</a> (<em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeSignature.html#g-mime-signature-set-expires" title="g_mime_signature_set_expires ()">g_mime_signature_set_expires</a> (<em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>, + <em class="parameter"><code><span class="type">time_t</span> expires</code></em>); + +struct <a class="link" href="GMimeSignature.html#GMimeSignatureList-struct" title="struct GMimeSignatureList">GMimeSignatureList</a>; +<a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="returnvalue">GMimeSignatureList</span></a> * <a class="link" href="GMimeSignature.html#g-mime-signature-list-new" title="g_mime_signature_list_new ()">g_mime_signature_list_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +<span class="returnvalue">int</span> <a class="link" href="GMimeSignature.html#g-mime-signature-list-length" title="g_mime_signature_list_length ()">g_mime_signature_list_length</a> (<em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *list</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeSignature.html#g-mime-signature-list-clear" title="g_mime_signature_list_clear ()">g_mime_signature_list_clear</a> (<em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *list</code></em>); +<span class="returnvalue">int</span> <a class="link" href="GMimeSignature.html#g-mime-signature-list-add" title="g_mime_signature_list_add ()">g_mime_signature_list_add</a> (<em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *list</code></em>, + <em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeSignature.html#g-mime-signature-list-insert" title="g_mime_signature_list_insert ()">g_mime_signature_list_insert</a> (<em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *list</code></em>, + <em class="parameter"><code><span class="type">int</span> index</code></em>, + <em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="GMimeSignature.html#g-mime-signature-list-remove" title="g_mime_signature_list_remove ()">g_mime_signature_list_remove</a> (<em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *list</code></em>, + <em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="GMimeSignature.html#g-mime-signature-list-remove-at" title="g_mime_signature_list_remove_at ()">g_mime_signature_list_remove_at</a> (<em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *list</code></em>, + <em class="parameter"><code><span class="type">int</span> index</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="GMimeSignature.html#g-mime-signature-list-contains" title="g_mime_signature_list_contains ()">g_mime_signature_list_contains</a> (<em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *list</code></em>, + <em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>); +<span class="returnvalue">int</span> <a class="link" href="GMimeSignature.html#g-mime-signature-list-index-of" title="g_mime_signature_list_index_of ()">g_mime_signature_list_index_of</a> (<em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *list</code></em>, + <em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>); +<a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="returnvalue">GMimeSignature</span></a> * <a class="link" href="GMimeSignature.html#g-mime-signature-list-get-signature" title="g_mime_signature_list_get_signature ()">g_mime_signature_list_get_signature</a> (<em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *list</code></em>, + <em class="parameter"><code><span class="type">int</span> index</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeSignature.html#g-mime-signature-list-set-signature" title="g_mime_signature_list_set_signature ()">g_mime_signature_list_set_signature</a> (<em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *list</code></em>, + <em class="parameter"><code><span class="type">int</span> index</code></em>, + <em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GMimeSignature.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----GMimeSignature +</pre> +<pre class="synopsis"> + GObject + +----GMimeSignatureList +</pre> +</div> +<div class="refsect1"> +<a name="GMimeSignature.description"></a><h2>Description</h2> +<p> +A <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> is an object containing useful information about a +digital signature as used in signing and encrypting data. +</p> +</div> +<div class="refsect1"> +<a name="GMimeSignature.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimeSignatureStatus"></a><h3>enum GMimeSignatureStatus</h3> +<pre class="programlisting">typedef enum { + GMIME_SIGNATURE_STATUS_GOOD, + GMIME_SIGNATURE_STATUS_ERROR, + GMIME_SIGNATURE_STATUS_BAD +} GMimeSignatureStatus; +</pre> +<p> +A value representing the signature status for a particular +<a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><a name="GMIME-SIGNATURE-STATUS-GOOD:CAPS"></a><span class="term"><code class="literal">GMIME_SIGNATURE_STATUS_GOOD</code></span></p></td> +<td>Good signature. +</td> +</tr> +<tr> +<td><p><a name="GMIME-SIGNATURE-STATUS-ERROR:CAPS"></a><span class="term"><code class="literal">GMIME_SIGNATURE_STATUS_ERROR</code></span></p></td> +<td>An error occurred. +</td> +</tr> +<tr> +<td><p><a name="GMIME-SIGNATURE-STATUS-BAD:CAPS"></a><span class="term"><code class="literal">GMIME_SIGNATURE_STATUS_BAD</code></span></p></td> +<td>Bad signature. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="GMimeSignatureError"></a><h3>enum GMimeSignatureError</h3> +<pre class="programlisting">typedef enum { + GMIME_SIGNATURE_ERROR_NONE = 0, + GMIME_SIGNATURE_ERROR_EXPSIG = (1 << 0), /* expired signature */ + GMIME_SIGNATURE_ERROR_NO_PUBKEY = (1 << 1), /* no public key */ + GMIME_SIGNATURE_ERROR_EXPKEYSIG = (1 << 2), /* expired key */ + GMIME_SIGNATURE_ERROR_REVKEYSIG = (1 << 3), /* revoked key */ + GMIME_SIGNATURE_ERROR_UNSUPP_ALGO = (1 << 4) /* unsupported algorithm */ +} GMimeSignatureError; +</pre> +<p> +Possible errors that a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> could have. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><a name="GMIME-SIGNATURE-ERROR-NONE:CAPS"></a><span class="term"><code class="literal">GMIME_SIGNATURE_ERROR_NONE</code></span></p></td> +<td>No error. +</td> +</tr> +<tr> +<td><p><a name="GMIME-SIGNATURE-ERROR-EXPSIG:CAPS"></a><span class="term"><code class="literal">GMIME_SIGNATURE_ERROR_EXPSIG</code></span></p></td> +<td>Expired signature. +</td> +</tr> +<tr> +<td><p><a name="GMIME-SIGNATURE-ERROR-NO-PUBKEY:CAPS"></a><span class="term"><code class="literal">GMIME_SIGNATURE_ERROR_NO_PUBKEY</code></span></p></td> +<td>No public key found. +</td> +</tr> +<tr> +<td><p><a name="GMIME-SIGNATURE-ERROR-EXPKEYSIG:CAPS"></a><span class="term"><code class="literal">GMIME_SIGNATURE_ERROR_EXPKEYSIG</code></span></p></td> +<td>Expired signature key. +</td> +</tr> +<tr> +<td><p><a name="GMIME-SIGNATURE-ERROR-REVKEYSIG:CAPS"></a><span class="term"><code class="literal">GMIME_SIGNATURE_ERROR_REVKEYSIG</code></span></p></td> +<td>Revoked signature key. +</td> +</tr> +<tr> +<td><p><a name="GMIME-SIGNATURE-ERROR-UNSUPP-ALGO:CAPS"></a><span class="term"><code class="literal">GMIME_SIGNATURE_ERROR_UNSUPP_ALGO</code></span></p></td> +<td>Unsupported algorithm. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="GMimeSignature-struct"></a><h3>struct GMimeSignature</h3> +<pre class="programlisting">struct GMimeSignature;</pre> +<p> +An object containing useful information about a signature. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-signature-new"></a><h3>g_mime_signature_new ()</h3> +<pre class="programlisting"><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="returnvalue">GMimeSignature</span></a> * g_mime_signature_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Creates a new <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> object. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><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" title="GMimeSignature"><span class="type">GMimeSignature</span></a> object.</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-signature-get-certificate"></a><h3>g_mime_signature_get_certificate ()</h3> +<pre class="programlisting"><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="returnvalue">GMimeCertificate</span></a> * g_mime_signature_get_certificate (<em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>);</pre> +<p> +Get the signature's certificate. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>sig</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the signature's certificate.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-signature-set-certificate"></a><h3>g_mime_signature_set_certificate ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_signature_set_certificate (<em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>, + <em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>);</pre> +<p> +Set the signature's certificate. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>sig</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>cert</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-signature-get-status"></a><h3>g_mime_signature_get_status ()</h3> +<pre class="programlisting"><a class="link" href="GMimeSignature.html#GMimeSignatureStatus" title="enum GMimeSignatureStatus"><span class="returnvalue">GMimeSignatureStatus</span></a> g_mime_signature_get_status (<em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>);</pre> +<p> +Get the signature status. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>sig</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the signature status.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-signature-set-status"></a><h3>g_mime_signature_set_status ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_signature_set_status (<em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>, + <em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureStatus" title="enum GMimeSignatureStatus"><span class="type">GMimeSignatureStatus</span></a> status</code></em>);</pre> +<p> +Set the status on the signature. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>sig</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>status</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeSignature.html#GMimeSignatureStatus" title="enum GMimeSignatureStatus"><span class="type">GMimeSignatureStatus</span></a> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-signature-get-errors"></a><h3>g_mime_signature_get_errors ()</h3> +<pre class="programlisting"><a class="link" href="GMimeSignature.html#GMimeSignatureError" title="enum GMimeSignatureError"><span class="returnvalue">GMimeSignatureError</span></a> g_mime_signature_get_errors (<em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>);</pre> +<p> +Get the signature errors. If the <a class="link" href="GMimeSignature.html#GMimeSignatureStatus" title="enum GMimeSignatureStatus"><span class="type">GMimeSignatureStatus</span></a> returned from +<a class="link" href="GMimeSignature.html#g-mime-signature-get-status" title="g_mime_signature_get_status ()"><code class="function">g_mime_signature_get_status()</code></a> is not <a class="link" href="GMimeSignature.html#GMIME-SIGNATURE-STATUS-GOOD:CAPS"><span class="type">GMIME_SIGNATURE_STATUS_GOOD</span></a>, then the +errors may provide a clue as to why. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>sig</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a bitfield of errors.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-signature-set-errors"></a><h3>g_mime_signature_set_errors ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_signature_set_errors (<em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>, + <em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureError" title="enum GMimeSignatureError"><span class="type">GMimeSignatureError</span></a> errors</code></em>);</pre> +<p> +Set the errors on the signature. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>sig</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>errors</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeSignature.html#GMimeSignatureError" title="enum GMimeSignatureError"><span class="type">GMimeSignatureError</span></a> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-signature-get-created"></a><h3>g_mime_signature_get_created ()</h3> +<pre class="programlisting"><span class="returnvalue">time_t</span> g_mime_signature_get_created (<em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>);</pre> +<p> +Get the creation date of the signature. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>sig</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the creation date of the signature or <code class="literal">-1</code> if unknown.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-signature-set-created"></a><h3>g_mime_signature_set_created ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_signature_set_created (<em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>, + <em class="parameter"><code><span class="type">time_t</span> created</code></em>);</pre> +<p> +Set the creation date of the signature. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>sig</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>created</code></em> :</span></p></td> +<td>creation date</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-signature-get-expires"></a><h3>g_mime_signature_get_expires ()</h3> +<pre class="programlisting"><span class="returnvalue">time_t</span> g_mime_signature_get_expires (<em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>);</pre> +<p> +Get the expiration date of the signature. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>sig</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the expiration date of the signature or <code class="literal">-1</code> if unknown.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-signature-set-expires"></a><h3>g_mime_signature_set_expires ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_signature_set_expires (<em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>, + <em class="parameter"><code><span class="type">time_t</span> expires</code></em>);</pre> +<p> +Set the expiration date of the signature. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>sig</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>expires</code></em> :</span></p></td> +<td>expiration date</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="GMimeSignatureList-struct"></a><h3>struct GMimeSignatureList</h3> +<pre class="programlisting">struct GMimeSignatureList;</pre> +<p> +A collection of <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> objects. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-signature-list-new"></a><h3>g_mime_signature_list_new ()</h3> +<pre class="programlisting"><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="returnvalue">GMimeSignatureList</span></a> * g_mime_signature_list_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Creates a new <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><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>.</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-signature-list-length"></a><h3>g_mime_signature_list_length ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> g_mime_signature_list_length (<em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *list</code></em>);</pre> +<p> +Gets the length of the list. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the number of <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> objects in the list.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-signature-list-clear"></a><h3>g_mime_signature_list_clear ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_signature_list_clear (<em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *list</code></em>);</pre> +<p> +Clears the list of addresses. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-signature-list-add"></a><h3>g_mime_signature_list_add ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> g_mime_signature_list_add (<em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *list</code></em>, + <em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>);</pre> +<p> +Adds a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> to the <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</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>list</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>sig</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the index of the added <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a>.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-signature-list-insert"></a><h3>g_mime_signature_list_insert ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_signature_list_insert (<em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *list</code></em>, + <em class="parameter"><code><span class="type">int</span> index</code></em>, + <em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>);</pre> +<p> +Inserts a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> into the <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> at the specified +index. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td> +<td>index to insert at</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>sig</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-signature-list-remove"></a><h3>g_mime_signature_list_remove ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_signature_list_remove (<em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *list</code></em>, + <em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>);</pre> +<p> +Removes a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> from the <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</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>list</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>sig</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> if the specified <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> was removed or <code class="literal">FALSE</code> +otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-signature-list-remove-at"></a><h3>g_mime_signature_list_remove_at ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_signature_list_remove_at (<em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *list</code></em>, + <em class="parameter"><code><span class="type">int</span> index</code></em>);</pre> +<p> +Removes a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> from the <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> at the specified +index. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td> +<td>index to remove</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> if an <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> was removed or <code class="literal">FALSE</code> otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-signature-list-contains"></a><h3>g_mime_signature_list_contains ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_signature_list_contains (<em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *list</code></em>, + <em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>);</pre> +<p> +Checks whether or not the specified <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> is contained within +the <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</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>list</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>sig</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> if the specified <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> is contained within the +specified <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> or <code class="literal">FALSE</code> otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-signature-list-index-of"></a><h3>g_mime_signature_list_index_of ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> g_mime_signature_list_index_of (<em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *list</code></em>, + <em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>);</pre> +<p> +Gets the index of the specified <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> inside the +<a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</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>list</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>sig</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the index of the requested <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> within the +<a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> or <code class="literal">-1</code> if it is not contained within the +<a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a>.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-signature-list-get-signature"></a><h3>g_mime_signature_list_get_signature ()</h3> +<pre class="programlisting"><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="returnvalue">GMimeSignature</span></a> * g_mime_signature_list_get_signature (<em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *list</code></em>, + <em class="parameter"><code><span class="type">int</span> index</code></em>);</pre> +<p> +Gets the <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> at the specified index. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td> +<td>index of <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> to get</td> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-signature-list-set-signature"></a><h3>g_mime_signature_list_set_signature ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_signature_list_set_signature (<em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *list</code></em>, + <em class="parameter"><code><span class="type">int</span> index</code></em>, + <em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>);</pre> +<p> +Sets the <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> at the specified index to <em class="parameter"><code>sig</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>list</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td> +<td>index of <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> to set</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>sig</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> +</td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/GMimeStream.html b/docs/reference/html/GMimeStream.html new file mode 100644 index 0000000..3666047 --- /dev/null +++ b/docs/reference/html/GMimeStream.html @@ -0,0 +1,631 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimeStream</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="Streams.html" title="Streams"> +<link rel="prev" href="Streams.html" title="Streams"> +<link rel="next" href="GMimeStreamFile.html" title="GMimeStreamFile"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="Streams.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="Streams.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="GMimeStreamFile.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GMimeStream.synopsis" class="shortcut">Top</a> +  | + <a href="#GMimeStream.description" class="shortcut">Description</a> +  | + <a href="#GMimeStream.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GMimeStream"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GMimeStream.top_of_page"></a>GMimeStream</span></h2> +<p>GMimeStream — Abstract stream class</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GMimeStream.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">enum <a class="link" href="GMimeStream.html#GMimeSeekWhence" title="enum GMimeSeekWhence">GMimeSeekWhence</a>; + <a class="link" href="GMimeStream.html#GMimeStreamIOVector" title="GMimeStreamIOVector">GMimeStreamIOVector</a>; +struct <a class="link" href="GMimeStream.html#GMimeStream-struct" title="struct GMimeStream">GMimeStream</a>; +<span class="returnvalue">void</span> <a class="link" href="GMimeStream.html#g-mime-stream-construct" title="g_mime_stream_construct ()">g_mime_stream_construct</a> (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</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>); +<span class="returnvalue">ssize_t</span> <a class="link" href="GMimeStream.html#g-mime-stream-read" title="g_mime_stream_read ()">g_mime_stream_read</a> (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>, + <em class="parameter"><code><span class="type">char</span> *buf</code></em>, + <em class="parameter"><code><span class="type">size_t</span> len</code></em>); +<span class="returnvalue">ssize_t</span> <a class="link" href="GMimeStream.html#g-mime-stream-write" title="g_mime_stream_write ()">g_mime_stream_write</a> (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *buf</code></em>, + <em class="parameter"><code><span class="type">size_t</span> len</code></em>); +<span class="returnvalue">int</span> <a class="link" href="GMimeStream.html#g-mime-stream-flush" title="g_mime_stream_flush ()">g_mime_stream_flush</a> (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>); +<span class="returnvalue">gint64</span> <a class="link" href="GMimeStream.html#g-mime-stream-seek" title="g_mime_stream_seek ()">g_mime_stream_seek</a> (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>, + <em class="parameter"><code><span class="type">gint64</span> offset</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html#GMimeSeekWhence" title="enum GMimeSeekWhence"><span class="type">GMimeSeekWhence</span></a> whence</code></em>); +<span class="returnvalue">gint64</span> <a class="link" href="GMimeStream.html#g-mime-stream-tell" title="g_mime_stream_tell ()">g_mime_stream_tell</a> (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>); +<span class="returnvalue">int</span> <a class="link" href="GMimeStream.html#g-mime-stream-reset" title="g_mime_stream_reset ()">g_mime_stream_reset</a> (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="GMimeStream.html#g-mime-stream-eos" title="g_mime_stream_eos ()">g_mime_stream_eos</a> (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>); +<span class="returnvalue">int</span> <a class="link" href="GMimeStream.html#g-mime-stream-close" title="g_mime_stream_close ()">g_mime_stream_close</a> (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>); +<span class="returnvalue">gint64</span> <a class="link" href="GMimeStream.html#g-mime-stream-length" title="g_mime_stream_length ()">g_mime_stream_length</a> (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>); +<a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> * <a class="link" href="GMimeStream.html#g-mime-stream-substream" title="g_mime_stream_substream ()">g_mime_stream_substream</a> (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</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>); +<span class="returnvalue">void</span> <a class="link" href="GMimeStream.html#g-mime-stream-set-bounds" title="g_mime_stream_set_bounds ()">g_mime_stream_set_bounds</a> (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</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>); +<span class="returnvalue">ssize_t</span> <a class="link" href="GMimeStream.html#g-mime-stream-write-string" title="g_mime_stream_write_string ()">g_mime_stream_write_string</a> (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *str</code></em>); +<span class="returnvalue">ssize_t</span> <a class="link" href="GMimeStream.html#g-mime-stream-printf" title="g_mime_stream_printf ()">g_mime_stream_printf</a> (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *fmt</code></em>, + <em class="parameter"><code>...</code></em>); +<span class="returnvalue">ssize_t</span> <a class="link" href="GMimeStream.html#g-mime-stream-write-to-stream" title="g_mime_stream_write_to_stream ()">g_mime_stream_write_to_stream</a> (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *src</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *dest</code></em>); +<span class="returnvalue">ssize_t</span> <a class="link" href="GMimeStream.html#g-mime-stream-writev" title="g_mime_stream_writev ()">g_mime_stream_writev</a> (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html#GMimeStreamIOVector" title="GMimeStreamIOVector"><span class="type">GMimeStreamIOVector</span></a> *vector</code></em>, + <em class="parameter"><code><span class="type">size_t</span> count</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GMimeStream.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----GMimeStream + +----<a class="link" href="GMimeStreamBuffer.html" title="GMimeStreamBuffer">GMimeStreamBuffer</a> + +----<a class="link" href="GMimeStreamCat.html" title="GMimeStreamCat">GMimeStreamCat</a> + +----<a class="link" href="GMimeStreamFile.html" title="GMimeStreamFile">GMimeStreamFile</a> + +----<a class="link" href="GMimeStreamFilter.html" title="GMimeStreamFilter">GMimeStreamFilter</a> + +----<a class="link" href="GMimeStreamFs.html" title="GMimeStreamFs">GMimeStreamFs</a> + +----<a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem">GMimeStreamMem</a> + +----<a class="link" href="GMimeStreamMmap.html" title="GMimeStreamMmap">GMimeStreamMmap</a> + +----<a class="link" href="GMimeStreamNull.html" title="GMimeStreamNull">GMimeStreamNull</a> + +----<a class="link" href="GMimeStreamPipe.html" title="GMimeStreamPipe">GMimeStreamPipe</a> +</pre> +</div> +<div class="refsect1"> +<a name="GMimeStream.description"></a><h2>Description</h2> +<p> +Streams are the fundamental method for reading and writing data +used by GMime. You'll probably notice that the basic API is similar +to that of the low-level Unix I/O layer (<code class="function">read()</code>, <code class="function">write()</code>, <code class="function">lseek()</code>, +etc) with some additional nicities such as a printf-like function. +</p> +</div> +<div class="refsect1"> +<a name="GMimeStream.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimeSeekWhence"></a><h3>enum GMimeSeekWhence</h3> +<pre class="programlisting">typedef enum { + GMIME_STREAM_SEEK_SET = SEEK_SET, + GMIME_STREAM_SEEK_CUR = SEEK_CUR, + GMIME_STREAM_SEEK_END = SEEK_END +} GMimeSeekWhence; +</pre> +<p> +Relative seek position. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><a name="GMIME-STREAM-SEEK-SET:CAPS"></a><span class="term"><code class="literal">GMIME_STREAM_SEEK_SET</code></span></p></td> +<td>Seek relative to the beginning of the stream. +</td> +</tr> +<tr> +<td><p><a name="GMIME-STREAM-SEEK-CUR:CAPS"></a><span class="term"><code class="literal">GMIME_STREAM_SEEK_CUR</code></span></p></td> +<td>Seek relative to the current position in the stream. +</td> +</tr> +<tr> +<td><p><a name="GMIME-STREAM-SEEK-END:CAPS"></a><span class="term"><code class="literal">GMIME_STREAM_SEEK_END</code></span></p></td> +<td>Seek relative to the end of the stream. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="GMimeStreamIOVector"></a><h3>GMimeStreamIOVector</h3> +<pre class="programlisting">typedef struct { + void *data; + size_t len; +} GMimeStreamIOVector; +</pre> +<p> +An I/O vector for use with <a class="link" href="GMimeStream.html#g-mime-stream-writev" title="g_mime_stream_writev ()"><code class="function">g_mime_stream_writev()</code></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><span class="type">void</span> *<em class="structfield"><code><a name="GMimeStreamIOVector.data"></a>data</code></em>;</span></p></td> +<td>data to pass to the I/O function.</td> +</tr> +<tr> +<td><p><span class="term"><span class="type">size_t</span> <em class="structfield"><code><a name="GMimeStreamIOVector.len"></a>len</code></em>;</span></p></td> +<td>length of the data, in bytes.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="GMimeStream-struct"></a><h3>struct GMimeStream</h3> +<pre class="programlisting">struct GMimeStream;</pre> +<p> +Abstract I/O stream class. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-construct"></a><h3>g_mime_stream_construct ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_stream_construct (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</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>);</pre> +<p> +Initializes a new stream with bounds <em class="parameter"><code>start</code></em> and <em class="parameter"><code>end</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>stream</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>start</code></em> :</span></p></td> +<td>start boundary</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>end</code></em> :</span></p></td> +<td>end boundary</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-read"></a><h3>g_mime_stream_read ()</h3> +<pre class="programlisting"><span class="returnvalue">ssize_t</span> g_mime_stream_read (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>, + <em class="parameter"><code><span class="type">char</span> *buf</code></em>, + <em class="parameter"><code><span class="type">size_t</span> len</code></em>);</pre> +<p> +Attempts to read up to <em class="parameter"><code>len</code></em> bytes from <em class="parameter"><code>stream</code></em> into <em class="parameter"><code>buf</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>stream</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>buf</code></em> :</span></p></td> +<td>buffer</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>len</code></em> :</span></p></td> +<td>buffer length</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the number of bytes read or <code class="literal">-1</code> on fail.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-write"></a><h3>g_mime_stream_write ()</h3> +<pre class="programlisting"><span class="returnvalue">ssize_t</span> g_mime_stream_write (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *buf</code></em>, + <em class="parameter"><code><span class="type">size_t</span> len</code></em>);</pre> +<p> +Attempts to write up to <em class="parameter"><code>len</code></em> bytes of <em class="parameter"><code>buf</code></em> to <em class="parameter"><code>stream</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>stream</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>buf</code></em> :</span></p></td> +<td>buffer</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>len</code></em> :</span></p></td> +<td>buffer length</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the number of bytes written or <code class="literal">-1</code> on fail.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-flush"></a><h3>g_mime_stream_flush ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> g_mime_stream_flush (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>);</pre> +<p> +Sync's the stream to disk. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">0</code> on success or <code class="literal">-1</code> on fail.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-seek"></a><h3>g_mime_stream_seek ()</h3> +<pre class="programlisting"><span class="returnvalue">gint64</span> g_mime_stream_seek (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>, + <em class="parameter"><code><span class="type">gint64</span> offset</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html#GMimeSeekWhence" title="enum GMimeSeekWhence"><span class="type">GMimeSeekWhence</span></a> whence</code></em>);</pre> +<p> +Repositions the offset of the stream <em class="parameter"><code>stream</code></em> to +the argument <em class="parameter"><code>offset</code></em> according to the +directive <em class="parameter"><code>whence</code></em> as follows: +</p> +<p> + <a class="link" href="GMimeStream.html#GMIME-STREAM-SEEK-SET:CAPS"><span class="type">GMIME_STREAM_SEEK_SET</span></a>: Seek <em class="parameter"><code>offset</code></em> bytes relative to + the beginning (bound_start) of the stream. +</p> +<p> + <a class="link" href="GMimeStream.html#GMIME-STREAM-SEEK-CUR:CAPS"><span class="type">GMIME_STREAM_SEEK_CUR</span></a>: Seek <em class="parameter"><code>offset</code></em> bytes relative to the + current offset of the stream. +</p> +<p> + <a class="link" href="GMimeStream.html#GMIME-STREAM-SEEK-END:CAPS"><span class="type">GMIME_STREAM_SEEK_END</span></a>: Seek <em class="parameter"><code>offset</code></em> bytes relative to the + end of the stream (bound_end if non-negative). +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td> +<td>positional offset</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>whence</code></em> :</span></p></td> +<td>seek directive</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the resultant position on success or <code class="literal">-1</code> on fail.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-tell"></a><h3>g_mime_stream_tell ()</h3> +<pre class="programlisting"><span class="returnvalue">gint64</span> g_mime_stream_tell (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>);</pre> +<p> +Gets the current offset within the stream. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the current position within the stream or <code class="literal">-1</code> on fail.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-reset"></a><h3>g_mime_stream_reset ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> g_mime_stream_reset (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>);</pre> +<p> +Resets the stream. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">0</code> on success or <code class="literal">-1</code> on fail.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-eos"></a><h3>g_mime_stream_eos ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_stream_eos (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>);</pre> +<p> +Tests the end-of-stream indicator for <em class="parameter"><code>stream</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>stream</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> on EOS or <code class="literal">FALSE</code> otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-close"></a><h3>g_mime_stream_close ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> g_mime_stream_close (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>);</pre> +<p> +Closes the stream. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">0</code> on success or <code class="literal">-1</code> on fail.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-length"></a><h3>g_mime_stream_length ()</h3> +<pre class="programlisting"><span class="returnvalue">gint64</span> g_mime_stream_length (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>);</pre> +<p> +Gets the length of the stream. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the length of the stream or <code class="literal">-1</code> if unknown.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-substream"></a><h3>g_mime_stream_substream ()</h3> +<pre class="programlisting"><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> * g_mime_stream_substream (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</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>);</pre> +<p> +Creates a new 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>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>start</code></em> :</span></p></td> +<td>start boundary</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>end</code></em> :</span></p></td> +<td>end boundary</td> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-set-bounds"></a><h3>g_mime_stream_set_bounds ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_stream_set_bounds (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</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>);</pre> +<p> +Set the bounds on a stream. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>start</code></em> :</span></p></td> +<td>start boundary</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>end</code></em> :</span></p></td> +<td>end boundary</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-write-string"></a><h3>g_mime_stream_write_string ()</h3> +<pre class="programlisting"><span class="returnvalue">ssize_t</span> g_mime_stream_write_string (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *str</code></em>);</pre> +<p> +Writes <em class="parameter"><code>string</code></em> to <em class="parameter"><code>stream</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>stream</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td> +<td>string to write</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the number of bytes written or <code class="literal">-1</code> on fail.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-printf"></a><h3>g_mime_stream_printf ()</h3> +<pre class="programlisting"><span class="returnvalue">ssize_t</span> g_mime_stream_printf (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *fmt</code></em>, + <em class="parameter"><code>...</code></em>);</pre> +<p> +Write formatted output to a stream. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>fmt</code></em> :</span></p></td> +<td>format</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the number of bytes written or <code class="literal">-1</code> on fail.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-write-to-stream"></a><h3>g_mime_stream_write_to_stream ()</h3> +<pre class="programlisting"><span class="returnvalue">ssize_t</span> g_mime_stream_write_to_stream (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *src</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *dest</code></em>);</pre> +<p> +Attempts to write the source stream to the destination stream. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>src</code></em> :</span></p></td> +<td>source stream</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>dest</code></em> :</span></p></td> +<td>destination stream</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the number of bytes written or <code class="literal">-1</code> on fail.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-writev"></a><h3>g_mime_stream_writev ()</h3> +<pre class="programlisting"><span class="returnvalue">ssize_t</span> g_mime_stream_writev (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html#GMimeStreamIOVector" title="GMimeStreamIOVector"><span class="type">GMimeStreamIOVector</span></a> *vector</code></em>, + <em class="parameter"><code><span class="type">size_t</span> count</code></em>);</pre> +<p> +Writes at most <em class="parameter"><code>count</code></em> blocks described by <em class="parameter"><code>vector</code></em> to <em class="parameter"><code>stream</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>stream</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>vector</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeStream.html#GMimeStreamIOVector" title="GMimeStreamIOVector"><span class="type">GMimeStreamIOVector</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>count</code></em> :</span></p></td> +<td>number of vector elements</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the number of bytes written or <code class="literal">-1</code> on fail.</td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/GMimeStreamBuffer.html b/docs/reference/html/GMimeStreamBuffer.html new file mode 100644 index 0000000..1552a94 --- /dev/null +++ b/docs/reference/html/GMimeStreamBuffer.html @@ -0,0 +1,214 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimeStreamBuffer</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="Streams.html" title="Streams"> +<link rel="prev" href="GMimeStreamFilter.html" title="GMimeStreamFilter"> +<link rel="next" href="GMimeStreamPipe.html" title="GMimeStreamPipe"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="GMimeStreamFilter.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="Streams.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="GMimeStreamPipe.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GMimeStreamBuffer.synopsis" class="shortcut">Top</a> +  | + <a href="#GMimeStreamBuffer.description" class="shortcut">Description</a> +  | + <a href="#GMimeStreamBuffer.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GMimeStreamBuffer"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GMimeStreamBuffer.top_of_page"></a>GMimeStreamBuffer</span></h2> +<p>GMimeStreamBuffer — A buffered stream</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GMimeStreamBuffer.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">enum <a class="link" href="GMimeStreamBuffer.html#GMimeStreamBufferMode" title="enum GMimeStreamBufferMode">GMimeStreamBufferMode</a>; +struct <a class="link" href="GMimeStreamBuffer.html#GMimeStreamBuffer-struct" title="struct GMimeStreamBuffer">GMimeStreamBuffer</a>; +<a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> * <a class="link" href="GMimeStreamBuffer.html#g-mime-stream-buffer-new" title="g_mime_stream_buffer_new ()">g_mime_stream_buffer_new</a> (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *source</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStreamBuffer.html#GMimeStreamBufferMode" title="enum GMimeStreamBufferMode"><span class="type">GMimeStreamBufferMode</span></a> mode</code></em>); +<span class="returnvalue">ssize_t</span> <a class="link" href="GMimeStreamBuffer.html#g-mime-stream-buffer-gets" title="g_mime_stream_buffer_gets ()">g_mime_stream_buffer_gets</a> (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>, + <em class="parameter"><code><span class="type">char</span> *buf</code></em>, + <em class="parameter"><code><span class="type">size_t</span> max</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeStreamBuffer.html#g-mime-stream-buffer-readln" title="g_mime_stream_buffer_readln ()">g_mime_stream_buffer_readln</a> (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>, + <em class="parameter"><code><span class="type">GByteArray</span> *buffer</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GMimeStreamBuffer.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----<a class="link" href="GMimeStream.html" title="GMimeStream">GMimeStream</a> + +----GMimeStreamBuffer +</pre> +</div> +<div class="refsect1"> +<a name="GMimeStreamBuffer.description"></a><h2>Description</h2> +<p> +A <a class="link" href="GMimeStreamBuffer.html" title="GMimeStreamBuffer"><span class="type">GMimeStreamBuffer</span></a> can be used on top of any other type of stream +and has 3 modes: block reads, block writes, and cached reads. Block +reads are especially useful if you will be making a lot of small +reads from a stream that accesses the file system. Block writes are +useful for very much the same reason. The final mode, cached reads, +can become memory intensive but can be very helpful when inheriting +from a stream that does not support seeking (Note: this mode is the +least tested so be careful using it). +</p> +</div> +<div class="refsect1"> +<a name="GMimeStreamBuffer.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimeStreamBufferMode"></a><h3>enum GMimeStreamBufferMode</h3> +<pre class="programlisting">typedef enum { + GMIME_STREAM_BUFFER_CACHE_READ, + GMIME_STREAM_BUFFER_BLOCK_READ, + GMIME_STREAM_BUFFER_BLOCK_WRITE +} GMimeStreamBufferMode; +</pre> +<p> +The buffering mode for a <a class="link" href="GMimeStreamBuffer.html" title="GMimeStreamBuffer"><span class="type">GMimeStreamBuffer</span></a> stream. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><a name="GMIME-STREAM-BUFFER-CACHE-READ:CAPS"></a><span class="term"><code class="literal">GMIME_STREAM_BUFFER_CACHE_READ</code></span></p></td> +<td>Cache all reads. +</td> +</tr> +<tr> +<td><p><a name="GMIME-STREAM-BUFFER-BLOCK-READ:CAPS"></a><span class="term"><code class="literal">GMIME_STREAM_BUFFER_BLOCK_READ</code></span></p></td> +<td>Read in 4k blocks. +</td> +</tr> +<tr> +<td><p><a name="GMIME-STREAM-BUFFER-BLOCK-WRITE:CAPS"></a><span class="term"><code class="literal">GMIME_STREAM_BUFFER_BLOCK_WRITE</code></span></p></td> +<td>Write in 4k blocks. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="GMimeStreamBuffer-struct"></a><h3>struct GMimeStreamBuffer</h3> +<pre class="programlisting">struct GMimeStreamBuffer;</pre> +<p> +A buffered stream wrapper around any <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> object. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-buffer-new"></a><h3>g_mime_stream_buffer_new ()</h3> +<pre class="programlisting"><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> * g_mime_stream_buffer_new (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *source</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStreamBuffer.html#GMimeStreamBufferMode" title="enum GMimeStreamBufferMode"><span class="type">GMimeStreamBufferMode</span></a> mode</code></em>);</pre> +<p> +Creates a new GMimeStreamBuffer object. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td> +<td>source stream</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>mode</code></em> :</span></p></td> +<td>buffering mode</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a new buffer stream with source <em class="parameter"><code>source</code></em> and mode <em class="parameter"><code>mode</code></em>.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-buffer-gets"></a><h3>g_mime_stream_buffer_gets ()</h3> +<pre class="programlisting"><span class="returnvalue">ssize_t</span> g_mime_stream_buffer_gets (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>, + <em class="parameter"><code><span class="type">char</span> *buf</code></em>, + <em class="parameter"><code><span class="type">size_t</span> max</code></em>);</pre> +<p> +Reads in at most one less than <em class="parameter"><code>max</code></em> characters from <em class="parameter"><code>stream</code></em> and +stores them into the buffer pointed to by <em class="parameter"><code>buf</code></em>. Reading stops after +an EOS or newline ('\n'). If a newline is read, it is stored into +the buffer. A '\0' is stored after the last character in the +buffer. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td> +<td>stream</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>buf</code></em> :</span></p></td> +<td>line buffer</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>max</code></em> :</span></p></td> +<td>max length of a line</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the number of characters read into <em class="parameter"><code>buf</code></em> on success or <code class="literal">-1</code> +on fail.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-buffer-readln"></a><h3>g_mime_stream_buffer_readln ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_stream_buffer_readln (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>, + <em class="parameter"><code><span class="type">GByteArray</span> *buffer</code></em>);</pre> +<p> +Reads a single line into <em class="parameter"><code>buffer</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>stream</code></em> :</span></p></td> +<td>stream</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td> +<td>output buffer</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="GMimeStreamBuffer.see-also"></a><h2>See Also</h2> +<a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/GMimeStreamCat.html b/docs/reference/html/GMimeStreamCat.html new file mode 100644 index 0000000..d383521 --- /dev/null +++ b/docs/reference/html/GMimeStreamCat.html @@ -0,0 +1,128 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimeStreamCat</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="Streams.html" title="Streams"> +<link rel="prev" href="GMimeStreamPipe.html" title="GMimeStreamPipe"> +<link rel="next" href="Filters.html" title="Stream Filters"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="GMimeStreamPipe.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="Streams.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="Filters.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GMimeStreamCat.synopsis" class="shortcut">Top</a> +  | + <a href="#GMimeStreamCat.description" class="shortcut">Description</a> +  | + <a href="#GMimeStreamCat.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GMimeStreamCat"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GMimeStreamCat.top_of_page"></a>GMimeStreamCat</span></h2> +<p>GMimeStreamCat — A concatenated stream</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GMimeStreamCat.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">struct <a class="link" href="GMimeStreamCat.html#GMimeStreamCat-struct" title="struct GMimeStreamCat">GMimeStreamCat</a>; +<a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> * <a class="link" href="GMimeStreamCat.html#g-mime-stream-cat-new" title="g_mime_stream_cat_new ()">g_mime_stream_cat_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +<span class="returnvalue">int</span> <a class="link" href="GMimeStreamCat.html#g-mime-stream-cat-add-source" title="g_mime_stream_cat_add_source ()">g_mime_stream_cat_add_source</a> (<em class="parameter"><code><a class="link" href="GMimeStreamCat.html" title="GMimeStreamCat"><span class="type">GMimeStreamCat</span></a> *cat</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *source</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GMimeStreamCat.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----<a class="link" href="GMimeStream.html" title="GMimeStream">GMimeStream</a> + +----GMimeStreamCat +</pre> +</div> +<div class="refsect1"> +<a name="GMimeStreamCat.description"></a><h2>Description</h2> +<p> +A <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> which chains together any number of other streams. +</p> +</div> +<div class="refsect1"> +<a name="GMimeStreamCat.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimeStreamCat-struct"></a><h3>struct GMimeStreamCat</h3> +<pre class="programlisting">struct GMimeStreamCat;</pre> +<p> +A concatenation of other <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> objects. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-cat-new"></a><h3>g_mime_stream_cat_new ()</h3> +<pre class="programlisting"><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> * g_mime_stream_cat_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Creates a new <a class="link" href="GMimeStreamCat.html" title="GMimeStreamCat"><span class="type">GMimeStreamCat</span></a> object. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a new <a class="link" href="GMimeStreamCat.html" title="GMimeStreamCat"><span class="type">GMimeStreamCat</span></a> stream.</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-cat-add-source"></a><h3>g_mime_stream_cat_add_source ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> g_mime_stream_cat_add_source (<em class="parameter"><code><a class="link" href="GMimeStreamCat.html" title="GMimeStreamCat"><span class="type">GMimeStreamCat</span></a> *cat</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *source</code></em>);</pre> +<p> +Adds the <em class="parameter"><code>source</code></em> stream to the <em class="parameter"><code>cat</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>cat</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeStreamCat.html" title="GMimeStreamCat"><span class="type">GMimeStreamCat</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td> +<td>a source stream</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">0</code> on success or <code class="literal">-1</code> on fail.</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="GMimeStreamCat.see-also"></a><h2>See Also</h2> +<a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/GMimeStreamFile.html b/docs/reference/html/GMimeStreamFile.html new file mode 100644 index 0000000..2e2ee47 --- /dev/null +++ b/docs/reference/html/GMimeStreamFile.html @@ -0,0 +1,206 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimeStreamFile</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="Streams.html" title="Streams"> +<link rel="prev" href="GMimeStream.html" title="GMimeStream"> +<link rel="next" href="GMimeStreamFs.html" title="GMimeStreamFs"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="GMimeStream.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="Streams.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="GMimeStreamFs.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GMimeStreamFile.synopsis" class="shortcut">Top</a> +  | + <a href="#GMimeStreamFile.description" class="shortcut">Description</a> +  | + <a href="#GMimeStreamFile.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GMimeStreamFile"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GMimeStreamFile.top_of_page"></a>GMimeStreamFile</span></h2> +<p>GMimeStreamFile — A Standard-C FILE-based stream</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GMimeStreamFile.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">struct <a class="link" href="GMimeStreamFile.html#GMimeStreamFile-struct" title="struct GMimeStreamFile">GMimeStreamFile</a>; +<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" title="g_mime_stream_file_new ()">g_mime_stream_file_new</a> (<em class="parameter"><code><span class="type">FILE</span> *fp</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-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>); +<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>); +</pre> +</div> +<div class="refsect1"> +<a name="GMimeStreamFile.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----<a class="link" href="GMimeStream.html" title="GMimeStream">GMimeStream</a> + +----GMimeStreamFile +</pre> +</div> +<div class="refsect1"> +<a name="GMimeStreamFile.description"></a><h2>Description</h2> +<p> +A simple <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> implementation that sits on top of the +Standard C FILE pointer based I/O layer. Unlike <a class="link" href="GMimeStreamFs.html" title="GMimeStreamFs"><span class="type">GMimeStreamFs</span></a>, a +<a class="link" href="GMimeStreamFile.html" title="GMimeStreamFile"><span class="type">GMimeStreamFile</span></a> will typically buffer read and write operations at +the FILE level and so it may be wasteful to wrap one in a +<a class="link" href="GMimeStreamBuffer.html" title="GMimeStreamBuffer"><span class="type">GMimeStreamBuffer</span></a> stream. +</p> +</div> +<div class="refsect1"> +<a name="GMimeStreamFile.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimeStreamFile-struct"></a><h3>struct GMimeStreamFile</h3> +<pre class="programlisting">struct GMimeStreamFile;</pre> +<p> +A <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> wrapper around standard-c FILE pointers. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-file-new"></a><h3>g_mime_stream_file_new ()</h3> +<pre class="programlisting"><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> * g_mime_stream_file_new (<em class="parameter"><code><span class="type">FILE</span> *fp</code></em>);</pre> +<p> +Creates a new <a class="link" href="GMimeStreamFile.html" title="GMimeStreamFile"><span class="type">GMimeStreamFile</span></a> object around <em class="parameter"><code>fp</code></em>. +</p> +<p> +Note: The created <a class="link" href="GMimeStreamFile.html" title="GMimeStreamFile"><span class="type">GMimeStreamFile</span></a> object will own the FILE pointer +passed in. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>fp</code></em> :</span></p></td> +<td>a FILE pointer</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a stream using <em class="parameter"><code>fp</code></em>.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-file-new-with-bounds"></a><h3>g_mime_stream_file_new_with_bounds ()</h3> +<pre class="programlisting"><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> * g_mime_stream_file_new_with_bounds (<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>);</pre> +<p> +Creates a new <a class="link" href="GMimeStreamFile.html" title="GMimeStreamFile"><span class="type">GMimeStreamFile</span></a> object around <em class="parameter"><code>fp</code></em> with bounds <em class="parameter"><code>start</code></em> +and <em class="parameter"><code>end</code></em>. +</p> +<p> +Note: The created <a class="link" href="GMimeStreamFile.html" title="GMimeStreamFile"><span class="type">GMimeStreamFile</span></a> object will own the FILE pointer +passed in. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>fp</code></em> :</span></p></td> +<td>a FILE pointer</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>start</code></em> :</span></p></td> +<td>start boundary</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>end</code></em> :</span></p></td> +<td>end boundary</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a stream using <em class="parameter"><code>fp</code></em> with bounds <em class="parameter"><code>start</code></em> and <em class="parameter"><code>end</code></em>.</td> +</tr> +</tbody> +</table></div> +</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> +Gets whether or not <em class="parameter"><code>stream</code></em> owns the backend FILE pointer. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeStreamFile.html" title="GMimeStreamFile"><span class="type">GMimeStreamFile</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> if <em class="parameter"><code>stream</code></em> owns the backend FILE pointer or <code class="literal">FALSE</code> +otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-file-set-owner"></a><h3>g_mime_stream_file_set_owner ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_stream_file_set_owner (<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>);</pre> +<p> +Sets whether or not <em class="parameter"><code>stream</code></em> owns the backend FILE pointer. +</p> +<p> +Note: <em class="parameter"><code>owner</code></em> should be <code class="literal">TRUE</code> if the stream should <code class="function">fclose()</code> the +backend FILE pointer when destroyed or <code class="literal">FALSE</code> otherwise. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeStreamFile.html" title="GMimeStreamFile"><span class="type">GMimeStreamFile</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>owner</code></em> :</span></p></td> +<td> +<code class="literal">TRUE</code> if this stream should own the FILE pointer or <code class="literal">FALSE</code> otherwise</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="GMimeStreamFile.see-also"></a><h2>See Also</h2> +<a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/GMimeStreamFilter.html b/docs/reference/html/GMimeStreamFilter.html new file mode 100644 index 0000000..3300ccd --- /dev/null +++ b/docs/reference/html/GMimeStreamFilter.html @@ -0,0 +1,170 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimeStreamFilter</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="Streams.html" title="Streams"> +<link rel="prev" href="GMimeStreamNull.html" title="GMimeStreamNull"> +<link rel="next" href="GMimeStreamBuffer.html" title="GMimeStreamBuffer"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="GMimeStreamNull.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="Streams.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="GMimeStreamBuffer.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GMimeStreamFilter.synopsis" class="shortcut">Top</a> +  | + <a href="#GMimeStreamFilter.description" class="shortcut">Description</a> +  | + <a href="#GMimeStreamFilter.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GMimeStreamFilter"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GMimeStreamFilter.top_of_page"></a>GMimeStreamFilter</span></h2> +<p>GMimeStreamFilter — A filtering stream</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GMimeStreamFilter.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">struct <a class="link" href="GMimeStreamFilter.html#GMimeStreamFilter-struct" title="struct GMimeStreamFilter">GMimeStreamFilter</a>; +<a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> * <a class="link" href="GMimeStreamFilter.html#g-mime-stream-filter-new" title="g_mime_stream_filter_new ()">g_mime_stream_filter_new</a> (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>); +<span class="returnvalue">int</span> <a class="link" href="GMimeStreamFilter.html#g-mime-stream-filter-add" title="g_mime_stream_filter_add ()">g_mime_stream_filter_add</a> (<em class="parameter"><code><a class="link" href="GMimeStreamFilter.html" title="GMimeStreamFilter"><span class="type">GMimeStreamFilter</span></a> *stream</code></em>, + <em class="parameter"><code><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> *filter</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeStreamFilter.html#g-mime-stream-filter-remove" title="g_mime_stream_filter_remove ()">g_mime_stream_filter_remove</a> (<em class="parameter"><code><a class="link" href="GMimeStreamFilter.html" title="GMimeStreamFilter"><span class="type">GMimeStreamFilter</span></a> *stream</code></em>, + <em class="parameter"><code><span class="type">int</span> id</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GMimeStreamFilter.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----<a class="link" href="GMimeStream.html" title="GMimeStream">GMimeStream</a> + +----GMimeStreamFilter +</pre> +</div> +<div class="refsect1"> +<a name="GMimeStreamFilter.description"></a><h2>Description</h2> +<p> +A <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> meant for filtering data passing through it. +</p> +<p> +This stream class is useful for converting data of one type to +another using <a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> objects. +</p> +<p> +When data passes through a <a class="link" href="GMimeStreamFilter.html" title="GMimeStreamFilter"><span class="type">GMimeStreamFilter</span></a>, it will pass through +<a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> filters in the order they were added. +</p> +</div> +<div class="refsect1"> +<a name="GMimeStreamFilter.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimeStreamFilter-struct"></a><h3>struct GMimeStreamFilter</h3> +<pre class="programlisting">struct GMimeStreamFilter;</pre> +<p> +A <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> which passes data through any <a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> objects. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-filter-new"></a><h3>g_mime_stream_filter_new ()</h3> +<pre class="programlisting"><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> * g_mime_stream_filter_new (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>);</pre> +<p> +Creates a new <a class="link" href="GMimeStreamFilter.html" title="GMimeStreamFilter"><span class="type">GMimeStreamFilter</span></a> object using <em class="parameter"><code>stream</code></em> as the source +stream. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td> +<td>source stream</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a new filter stream with <em class="parameter"><code>stream</code></em> as its source.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-filter-add"></a><h3>g_mime_stream_filter_add ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> g_mime_stream_filter_add (<em class="parameter"><code><a class="link" href="GMimeStreamFilter.html" title="GMimeStreamFilter"><span class="type">GMimeStreamFilter</span></a> *stream</code></em>, + <em class="parameter"><code><a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> *filter</code></em>);</pre> +<p> +Adds <em class="parameter"><code>filter</code></em> to <em class="parameter"><code>stream</code></em>. Filters are applied in the same order in +which they are added. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeStreamFilter.html" title="GMimeStreamFilter"><span class="type">GMimeStreamFilter</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>filter</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeFilter.html" title="GMimeFilter"><span class="type">GMimeFilter</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>an id for the filter.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-filter-remove"></a><h3>g_mime_stream_filter_remove ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_stream_filter_remove (<em class="parameter"><code><a class="link" href="GMimeStreamFilter.html" title="GMimeStreamFilter"><span class="type">GMimeStreamFilter</span></a> *stream</code></em>, + <em class="parameter"><code><span class="type">int</span> id</code></em>);</pre> +<p> +Removed a filter from the stream based on the id (as returned from +filter_add). +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeStreamFilter.html" title="GMimeStreamFilter"><span class="type">GMimeStreamFilter</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td> +<td>filter id</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="GMimeStreamFilter.see-also"></a><h2>See Also</h2> +<a class="link" href="Filters.html" title="Stream Filters"><span class="type">Filters</span></a> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/GMimeStreamFs.html b/docs/reference/html/GMimeStreamFs.html new file mode 100644 index 0000000..c2d88ca --- /dev/null +++ b/docs/reference/html/GMimeStreamFs.html @@ -0,0 +1,195 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimeStreamFs</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="Streams.html" title="Streams"> +<link rel="prev" href="GMimeStreamFile.html" title="GMimeStreamFile"> +<link rel="next" href="GMimeStreamMem.html" title="GMimeStreamMem"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="GMimeStreamFile.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="Streams.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="GMimeStreamMem.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GMimeStreamFs.synopsis" class="shortcut">Top</a> +  | + <a href="#GMimeStreamFs.description" class="shortcut">Description</a> +  | + <a href="#GMimeStreamFs.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GMimeStreamFs"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GMimeStreamFs.top_of_page"></a>GMimeStreamFs</span></h2> +<p>GMimeStreamFs — A low-level FileSystem stream</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GMimeStreamFs.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">struct <a class="link" href="GMimeStreamFs.html#GMimeStreamFs-struct" title="struct GMimeStreamFs">GMimeStreamFs</a>; +<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" title="g_mime_stream_fs_new ()">g_mime_stream_fs_new</a> (<em class="parameter"><code><span class="type">int</span> fd</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-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>); +<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>); +</pre> +</div> +<div class="refsect1"> +<a name="GMimeStreamFs.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----<a class="link" href="GMimeStream.html" title="GMimeStream">GMimeStream</a> + +----GMimeStreamFs +</pre> +</div> +<div class="refsect1"> +<a name="GMimeStreamFs.description"></a><h2>Description</h2> +<p> +A simple <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> implementation that sits on top of the +low-level UNIX file descriptor based I/O layer. +</p> +</div> +<div class="refsect1"> +<a name="GMimeStreamFs.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimeStreamFs-struct"></a><h3>struct GMimeStreamFs</h3> +<pre class="programlisting">struct GMimeStreamFs;</pre> +<p> +A <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> wrapper around POSIX file descriptors. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-fs-new"></a><h3>g_mime_stream_fs_new ()</h3> +<pre class="programlisting"><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> * g_mime_stream_fs_new (<em class="parameter"><code><span class="type">int</span> fd</code></em>);</pre> +<p> +Creates a new <a class="link" href="GMimeStreamFs.html" title="GMimeStreamFs"><span class="type">GMimeStreamFs</span></a> object around <em class="parameter"><code>fd</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>fd</code></em> :</span></p></td> +<td>a file descriptor</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a stream using <em class="parameter"><code>fd</code></em>.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-fs-new-with-bounds"></a><h3>g_mime_stream_fs_new_with_bounds ()</h3> +<pre class="programlisting"><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> * g_mime_stream_fs_new_with_bounds (<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>);</pre> +<p> +Creates a new <a class="link" href="GMimeStreamFs.html" title="GMimeStreamFs"><span class="type">GMimeStreamFs</span></a> object around <em class="parameter"><code>fd</code></em> with bounds <em class="parameter"><code>start</code></em> +and <em class="parameter"><code>end</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>fd</code></em> :</span></p></td> +<td>a file descriptor</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>start</code></em> :</span></p></td> +<td>start boundary</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>end</code></em> :</span></p></td> +<td>end boundary</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a stream using <em class="parameter"><code>fd</code></em> with bounds <em class="parameter"><code>start</code></em> and <em class="parameter"><code>end</code></em>.</td> +</tr> +</tbody> +</table></div> +</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> +Gets whether or not <em class="parameter"><code>stream</code></em> owns the backend file descriptor. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeStreamFs.html" title="GMimeStreamFs"><span class="type">GMimeStreamFs</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> if <em class="parameter"><code>stream</code></em> owns the backend file descriptor or <code class="literal">FALSE</code> +otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-fs-set-owner"></a><h3>g_mime_stream_fs_set_owner ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_stream_fs_set_owner (<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>);</pre> +<p> +Sets whether or not <em class="parameter"><code>stream</code></em> owns the backend file descriptor. +</p> +<p> +Note: <em class="parameter"><code>owner</code></em> should be <code class="literal">TRUE</code> if the stream should <code class="function">close()</code> the +backend file descriptor when destroyed or <code class="literal">FALSE</code> otherwise. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeStreamFs.html" title="GMimeStreamFs"><span class="type">GMimeStreamFs</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>owner</code></em> :</span></p></td> +<td> +<code class="literal">TRUE</code> if this stream should own the file descriptor or <code class="literal">FALSE</code> otherwise</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="GMimeStreamFs.see-also"></a><h2>See Also</h2> +<a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/GMimeStreamMem.html b/docs/reference/html/GMimeStreamMem.html new file mode 100644 index 0000000..6ffd166 --- /dev/null +++ b/docs/reference/html/GMimeStreamMem.html @@ -0,0 +1,259 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimeStreamMem</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="Streams.html" title="Streams"> +<link rel="prev" href="GMimeStreamFs.html" title="GMimeStreamFs"> +<link rel="next" href="GMimeStreamMmap.html" title="GMimeStreamMmap"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="GMimeStreamFs.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="Streams.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="GMimeStreamMmap.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GMimeStreamMem.synopsis" class="shortcut">Top</a> +  | + <a href="#GMimeStreamMem.description" class="shortcut">Description</a> +  | + <a href="#GMimeStreamMem.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GMimeStreamMem"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GMimeStreamMem.top_of_page"></a>GMimeStreamMem</span></h2> +<p>GMimeStreamMem — A memory-backed stream</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GMimeStreamMem.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">struct <a class="link" href="GMimeStreamMem.html#GMimeStreamMem-struct" title="struct GMimeStreamMem">GMimeStreamMem</a>; +<a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> * <a class="link" href="GMimeStreamMem.html#g-mime-stream-mem-new" title="g_mime_stream_mem_new ()">g_mime_stream_mem_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +<a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> * <a class="link" href="GMimeStreamMem.html#g-mime-stream-mem-new-with-byte-array" title="g_mime_stream_mem_new_with_byte_array ()">g_mime_stream_mem_new_with_byte_array</a> + (<em class="parameter"><code><span class="type">GByteArray</span> *array</code></em>); +<a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> * <a class="link" href="GMimeStreamMem.html#g-mime-stream-mem-new-with-buffer" title="g_mime_stream_mem_new_with_buffer ()">g_mime_stream_mem_new_with_buffer</a> (<em class="parameter"><code>const <span class="type">char</span> *buffer</code></em>, + <em class="parameter"><code><span class="type">size_t</span> len</code></em>); +<span class="returnvalue">GByteArray</span> * <a class="link" href="GMimeStreamMem.html#g-mime-stream-mem-get-byte-array" title="g_mime_stream_mem_get_byte_array ()">g_mime_stream_mem_get_byte_array</a> (<em class="parameter"><code><a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a> *mem</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeStreamMem.html#g-mime-stream-mem-set-byte-array" title="g_mime_stream_mem_set_byte_array ()">g_mime_stream_mem_set_byte_array</a> (<em class="parameter"><code><a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a> *mem</code></em>, + <em class="parameter"><code><span class="type">GByteArray</span> *array</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="GMimeStreamMem.html#g-mime-stream-mem-get-owner" title="g_mime_stream_mem_get_owner ()">g_mime_stream_mem_get_owner</a> (<em class="parameter"><code><a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a> *mem</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeStreamMem.html#g-mime-stream-mem-set-owner" title="g_mime_stream_mem_set_owner ()">g_mime_stream_mem_set_owner</a> (<em class="parameter"><code><a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a> *mem</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> owner</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GMimeStreamMem.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----<a class="link" href="GMimeStream.html" title="GMimeStream">GMimeStream</a> + +----GMimeStreamMem +</pre> +</div> +<div class="refsect1"> +<a name="GMimeStreamMem.description"></a><h2>Description</h2> +<p> +A simple <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> implementation that uses a memory buffer for +storage. +</p> +</div> +<div class="refsect1"> +<a name="GMimeStreamMem.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimeStreamMem-struct"></a><h3>struct GMimeStreamMem</h3> +<pre class="programlisting">struct GMimeStreamMem;</pre> +<p> +A memory-backed <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-mem-new"></a><h3>g_mime_stream_mem_new ()</h3> +<pre class="programlisting"><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> * g_mime_stream_mem_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Creates a new <a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a> object. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a new memory stream.</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-mem-new-with-byte-array"></a><h3>g_mime_stream_mem_new_with_byte_array ()</h3> +<pre class="programlisting"><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> * g_mime_stream_mem_new_with_byte_array + (<em class="parameter"><code><span class="type">GByteArray</span> *array</code></em>);</pre> +<p> +Creates a new <a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a> with data <em class="parameter"><code>array</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>array</code></em> :</span></p></td> +<td>source data</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a new memory stream using <em class="parameter"><code>array</code></em>.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-mem-new-with-buffer"></a><h3>g_mime_stream_mem_new_with_buffer ()</h3> +<pre class="programlisting"><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> * g_mime_stream_mem_new_with_buffer (<em class="parameter"><code>const <span class="type">char</span> *buffer</code></em>, + <em class="parameter"><code><span class="type">size_t</span> len</code></em>);</pre> +<p> +Creates a new <a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a> object and initializes the stream +contents with the first <em class="parameter"><code>len</code></em> bytes of <em class="parameter"><code>buffer</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>buffer</code></em> :</span></p></td> +<td>stream data</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>len</code></em> :</span></p></td> +<td>buffer length</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a new memory stream initialized with <em class="parameter"><code>buffer</code></em>.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-mem-get-byte-array"></a><h3>g_mime_stream_mem_get_byte_array ()</h3> +<pre class="programlisting"><span class="returnvalue">GByteArray</span> * g_mime_stream_mem_get_byte_array (<em class="parameter"><code><a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a> *mem</code></em>);</pre> +<p> +Gets the byte array from the memory stream. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>mem</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a> +</td> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-mem-set-byte-array"></a><h3>g_mime_stream_mem_set_byte_array ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_stream_mem_set_byte_array (<em class="parameter"><code><a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a> *mem</code></em>, + <em class="parameter"><code><span class="type">GByteArray</span> *array</code></em>);</pre> +<p> +Sets the byte array on the memory stream. +</p> +<p> +Note: The memory stream is not responsible for freeing the byte +array. Use <a class="link" href="GMimeStreamMem.html#g-mime-stream-mem-set-owner" title="g_mime_stream_mem_set_owner ()"><code class="function">g_mime_stream_mem_set_owner()</code></a> to change this behavior. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>mem</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>array</code></em> :</span></p></td> +<td>stream data</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-mem-get-owner"></a><h3>g_mime_stream_mem_get_owner ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_stream_mem_get_owner (<em class="parameter"><code><a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a> *mem</code></em>);</pre> +<p> +Gets whether or not <em class="parameter"><code>mem</code></em> owns the backend memory buffer. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>mem</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> if <em class="parameter"><code>mem</code></em> owns the backend memory buffer or <code class="literal">FALSE</code> +otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-mem-set-owner"></a><h3>g_mime_stream_mem_set_owner ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_stream_mem_set_owner (<em class="parameter"><code><a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a> *mem</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> owner</code></em>);</pre> +<p> +Sets whether or not <em class="parameter"><code>mem</code></em> owns the backend memory buffer. +</p> +<p> +Note: <em class="parameter"><code>owner</code></em> should be <code class="literal">TRUE</code> if the stream should free the backend +memory buffer when destroyed or <code class="literal">FALSE</code> otherwise. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>mem</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem"><span class="type">GMimeStreamMem</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>owner</code></em> :</span></p></td> +<td> +<code class="literal">TRUE</code> if this stream should own the <span class="type">GByteArray</span> or <code class="literal">FALSE</code> otherwise</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="GMimeStreamMem.see-also"></a><h2>See Also</h2> +<a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/GMimeStreamMmap.html b/docs/reference/html/GMimeStreamMmap.html new file mode 100644 index 0000000..881a700 --- /dev/null +++ b/docs/reference/html/GMimeStreamMmap.html @@ -0,0 +1,166 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimeStreamMmap</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="Streams.html" title="Streams"> +<link rel="prev" href="GMimeStreamMem.html" title="GMimeStreamMem"> +<link rel="next" href="GMimeStreamNull.html" title="GMimeStreamNull"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="GMimeStreamMem.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="Streams.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="GMimeStreamNull.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GMimeStreamMmap.synopsis" class="shortcut">Top</a> +  | + <a href="#GMimeStreamMmap.description" class="shortcut">Description</a> +  | + <a href="#GMimeStreamMmap.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GMimeStreamMmap"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GMimeStreamMmap.top_of_page"></a>GMimeStreamMmap</span></h2> +<p>GMimeStreamMmap — A memory-mapped file stream</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GMimeStreamMmap.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">struct <a class="link" href="GMimeStreamMmap.html#GMimeStreamMmap-struct" title="struct GMimeStreamMmap">GMimeStreamMmap</a>; +<a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> * <a class="link" href="GMimeStreamMmap.html#g-mime-stream-mmap-new" title="g_mime_stream_mmap_new ()">g_mime_stream_mmap_new</a> (<em class="parameter"><code><span class="type">int</span> fd</code></em>, + <em class="parameter"><code><span class="type">int</span> prot</code></em>, + <em class="parameter"><code><span class="type">int</span> flags</code></em>); +<a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> * <a class="link" href="GMimeStreamMmap.html#g-mime-stream-mmap-new-with-bounds" title="g_mime_stream_mmap_new_with_bounds ()">g_mime_stream_mmap_new_with_bounds</a> (<em class="parameter"><code><span class="type">int</span> fd</code></em>, + <em class="parameter"><code><span class="type">int</span> prot</code></em>, + <em class="parameter"><code><span class="type">int</span> flags</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>); +</pre> +</div> +<div class="refsect1"> +<a name="GMimeStreamMmap.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----<a class="link" href="GMimeStream.html" title="GMimeStream">GMimeStream</a> + +----GMimeStreamMmap +</pre> +</div> +<div class="refsect1"> +<a name="GMimeStreamMmap.description"></a><h2>Description</h2> +<p> +A <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> implementation using a memory-mapped file backing +store. This may be faster than <a class="link" href="GMimeStreamFs.html" title="GMimeStreamFs"><span class="type">GMimeStreamFs</span></a> or <a class="link" href="GMimeStreamFile.html" title="GMimeStreamFile"><span class="type">GMimeStreamFile</span></a> +but you'll have to do your own performance checking to be sure for +your particular application/platform. +</p> +</div> +<div class="refsect1"> +<a name="GMimeStreamMmap.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimeStreamMmap-struct"></a><h3>struct GMimeStreamMmap</h3> +<pre class="programlisting">struct GMimeStreamMmap;</pre> +<p> +A memory-mapped <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-mmap-new"></a><h3>g_mime_stream_mmap_new ()</h3> +<pre class="programlisting"><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> * g_mime_stream_mmap_new (<em class="parameter"><code><span class="type">int</span> fd</code></em>, + <em class="parameter"><code><span class="type">int</span> prot</code></em>, + <em class="parameter"><code><span class="type">int</span> flags</code></em>);</pre> +<p> +Creates a new <a class="link" href="GMimeStreamMmap.html" title="GMimeStreamMmap"><span class="type">GMimeStreamMmap</span></a> object around <em class="parameter"><code>fd</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>fd</code></em> :</span></p></td> +<td>file descriptor</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>prot</code></em> :</span></p></td> +<td>protection flags</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td> +<td>map flags</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a stream using <em class="parameter"><code>fd</code></em>.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-mmap-new-with-bounds"></a><h3>g_mime_stream_mmap_new_with_bounds ()</h3> +<pre class="programlisting"><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> * g_mime_stream_mmap_new_with_bounds (<em class="parameter"><code><span class="type">int</span> fd</code></em>, + <em class="parameter"><code><span class="type">int</span> prot</code></em>, + <em class="parameter"><code><span class="type">int</span> flags</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>);</pre> +<p> +Creates a new <a class="link" href="GMimeStreamMmap.html" title="GMimeStreamMmap"><span class="type">GMimeStreamMmap</span></a> object around <em class="parameter"><code>fd</code></em> with bounds <em class="parameter"><code>start</code></em> +and <em class="parameter"><code>end</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>fd</code></em> :</span></p></td> +<td>file descriptor</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>prot</code></em> :</span></p></td> +<td>protection flags</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td> +<td>map flags</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>start</code></em> :</span></p></td> +<td>start boundary</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>end</code></em> :</span></p></td> +<td>end boundary</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a stream using <em class="parameter"><code>fd</code></em> with bounds <em class="parameter"><code>start</code></em> and <em class="parameter"><code>end</code></em>.</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="GMimeStreamMmap.see-also"></a><h2>See Also</h2> +<a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/GMimeStreamNull.html b/docs/reference/html/GMimeStreamNull.html new file mode 100644 index 0000000..16acfeb --- /dev/null +++ b/docs/reference/html/GMimeStreamNull.html @@ -0,0 +1,102 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimeStreamNull</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="Streams.html" title="Streams"> +<link rel="prev" href="GMimeStreamMmap.html" title="GMimeStreamMmap"> +<link rel="next" href="GMimeStreamFilter.html" title="GMimeStreamFilter"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="GMimeStreamMmap.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="Streams.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="GMimeStreamFilter.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GMimeStreamNull.synopsis" class="shortcut">Top</a> +  | + <a href="#GMimeStreamNull.description" class="shortcut">Description</a> +  | + <a href="#GMimeStreamNull.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GMimeStreamNull"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GMimeStreamNull.top_of_page"></a>GMimeStreamNull</span></h2> +<p>GMimeStreamNull — A null stream</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GMimeStreamNull.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">struct <a class="link" href="GMimeStreamNull.html#GMimeStreamNull-struct" title="struct GMimeStreamNull">GMimeStreamNull</a>; +<a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> * <a class="link" href="GMimeStreamNull.html#g-mime-stream-null-new" title="g_mime_stream_null_new ()">g_mime_stream_null_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GMimeStreamNull.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----<a class="link" href="GMimeStream.html" title="GMimeStream">GMimeStream</a> + +----GMimeStreamNull +</pre> +</div> +<div class="refsect1"> +<a name="GMimeStreamNull.description"></a><h2>Description</h2> +<p> +A <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> which has no real backing storage at all. This +stream is useful for dry-runs and can also be useful for +determining statistics on source data which can be written to +streams but cannot be read as a stream itself (e.g. a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> +via <a class="link" href="GMimeObject.html#g-mime-object-write-to-stream" title="g_mime_object_write_to_stream ()"><code class="function">g_mime_object_write_to_stream()</code></a>). +</p> +</div> +<div class="refsect1"> +<a name="GMimeStreamNull.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimeStreamNull-struct"></a><h3>struct GMimeStreamNull</h3> +<pre class="programlisting">struct GMimeStreamNull;</pre> +<p> +A <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> which has no backing store. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-null-new"></a><h3>g_mime_stream_null_new ()</h3> +<pre class="programlisting"><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> * g_mime_stream_null_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Creates a new <a class="link" href="GMimeStreamNull.html" title="GMimeStreamNull"><span class="type">GMimeStreamNull</span></a> object. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a new null stream (similar to /dev/null on Unix).</td> +</tr></tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="GMimeStreamNull.see-also"></a><h2>See Also</h2> +<a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/GMimeStreamPipe.html b/docs/reference/html/GMimeStreamPipe.html new file mode 100644 index 0000000..10377c0 --- /dev/null +++ b/docs/reference/html/GMimeStreamPipe.html @@ -0,0 +1,159 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimeStreamPipe</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="Streams.html" title="Streams"> +<link rel="prev" href="GMimeStreamBuffer.html" title="GMimeStreamBuffer"> +<link rel="next" href="GMimeStreamCat.html" title="GMimeStreamCat"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="GMimeStreamBuffer.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="Streams.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="GMimeStreamCat.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#GMimeStreamPipe.synopsis" class="shortcut">Top</a> +  | + <a href="#GMimeStreamPipe.description" class="shortcut">Description</a> +  | + <a href="#GMimeStreamPipe.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="GMimeStreamPipe"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GMimeStreamPipe.top_of_page"></a>GMimeStreamPipe</span></h2> +<p>GMimeStreamPipe — A low-level pipe stream</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="GMimeStreamPipe.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">struct <a class="link" href="GMimeStreamPipe.html#GMimeStreamPipe-struct" title="struct GMimeStreamPipe">GMimeStreamPipe</a>; +<a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> * <a class="link" href="GMimeStreamPipe.html#g-mime-stream-pipe-new" title="g_mime_stream_pipe_new ()">g_mime_stream_pipe_new</a> (<em class="parameter"><code><span class="type">int</span> fd</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="GMimeStreamPipe.html#g-mime-stream-pipe-get-owner" title="g_mime_stream_pipe_get_owner ()">g_mime_stream_pipe_get_owner</a> (<em class="parameter"><code><a class="link" href="GMimeStreamPipe.html" title="GMimeStreamPipe"><span class="type">GMimeStreamPipe</span></a> *stream</code></em>); +<span class="returnvalue">void</span> <a class="link" href="GMimeStreamPipe.html#g-mime-stream-pipe-set-owner" title="g_mime_stream_pipe_set_owner ()">g_mime_stream_pipe_set_owner</a> (<em class="parameter"><code><a class="link" href="GMimeStreamPipe.html" title="GMimeStreamPipe"><span class="type">GMimeStreamPipe</span></a> *stream</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> owner</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="GMimeStreamPipe.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----<a class="link" href="GMimeStream.html" title="GMimeStream">GMimeStream</a> + +----GMimeStreamPipe +</pre> +</div> +<div class="refsect1"> +<a name="GMimeStreamPipe.description"></a><h2>Description</h2> +<p> +A simple <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> implementation that sits on top of low-level +POSIX pipes. +</p> +</div> +<div class="refsect1"> +<a name="GMimeStreamPipe.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimeStreamPipe-struct"></a><h3>struct GMimeStreamPipe</h3> +<pre class="programlisting">struct GMimeStreamPipe;</pre> +<p> +A <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> wrapper around pipes. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-pipe-new"></a><h3>g_mime_stream_pipe_new ()</h3> +<pre class="programlisting"><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> * g_mime_stream_pipe_new (<em class="parameter"><code><span class="type">int</span> fd</code></em>);</pre> +<p> +Creates a new <a class="link" href="GMimeStreamPipe.html" title="GMimeStreamPipe"><span class="type">GMimeStreamPipe</span></a> object around <em class="parameter"><code>fd</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>fd</code></em> :</span></p></td> +<td>a pipe descriptor</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a stream using <em class="parameter"><code>fd</code></em>.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-pipe-get-owner"></a><h3>g_mime_stream_pipe_get_owner ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_stream_pipe_get_owner (<em class="parameter"><code><a class="link" href="GMimeStreamPipe.html" title="GMimeStreamPipe"><span class="type">GMimeStreamPipe</span></a> *stream</code></em>);</pre> +<p> +Gets whether or not <em class="parameter"><code>stream</code></em> owns the backend pipe descriptor. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeStreamPipe.html" title="GMimeStreamPipe"><span class="type">GMimeStreamPipe</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> if <em class="parameter"><code>stream</code></em> owns the backend pipe descriptor or <code class="literal">FALSE</code> +otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-stream-pipe-set-owner"></a><h3>g_mime_stream_pipe_set_owner ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_stream_pipe_set_owner (<em class="parameter"><code><a class="link" href="GMimeStreamPipe.html" title="GMimeStreamPipe"><span class="type">GMimeStreamPipe</span></a> *stream</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> owner</code></em>);</pre> +<p> +Sets whether or not <em class="parameter"><code>stream</code></em> owns the backend pipe descriptor. +</p> +<p> +Note: <em class="parameter"><code>owner</code></em> should be <code class="literal">TRUE</code> if the stream should <code class="function">close()</code> the +backend pipe descriptor when destroyed or <code class="literal">FALSE</code> otherwise. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeStreamPipe.html" title="GMimeStreamPipe"><span class="type">GMimeStreamPipe</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>owner</code></em> :</span></p></td> +<td>owner</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="GMimeStreamPipe.see-also"></a><h2>See Also</h2> +<a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/Headers.html b/docs/reference/html/Headers.html new file mode 100644 index 0000000..e438844 --- /dev/null +++ b/docs/reference/html/Headers.html @@ -0,0 +1,44 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Message and MIME Headers</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="classes.html" title="Part IV. GMime Classes"> +<link rel="prev" href="GMimeDataWrapper.html" title="GMimeDataWrapper"> +<link rel="next" href="gmime-GMimeHeader.html" title="GMimeHeader"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="GMimeDataWrapper.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="classes.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="gmime-GMimeHeader.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="Headers"></a>Message and MIME Headers</h2></div></div></div> +<div class="toc"><dl> +<dt> +<span class="refentrytitle"><a href="gmime-GMimeHeader.html">GMimeHeader</a></span><span class="refpurpose"> — Message and MIME part headers</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeContentType.html">GMimeContentType</a></span><span class="refpurpose"> — Content-Type fields</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeContentDisposition.html">GMimeContentDisposition</a></span><span class="refpurpose"> — Content-Disposition fields</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gmime-GMimeParam.html">GMimeParam</a></span><span class="refpurpose"> — Content-Type and Content-Disposition parameters</span> +</dt> +</dl></div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/InternetAddress.html b/docs/reference/html/InternetAddress.html new file mode 100644 index 0000000..4166549 --- /dev/null +++ b/docs/reference/html/InternetAddress.html @@ -0,0 +1,163 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>InternetAddress</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="InternetAddresses.html" title="Internet Addresses"> +<link rel="prev" href="InternetAddresses.html" title="Internet Addresses"> +<link rel="next" href="InternetAddressGroup.html" title="InternetAddressGroup"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="InternetAddresses.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="InternetAddresses.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="InternetAddressGroup.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#InternetAddress.synopsis" class="shortcut">Top</a> +  | + <a href="#InternetAddress.description" class="shortcut">Description</a> +  | + <a href="#InternetAddress.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="InternetAddress"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="InternetAddress.top_of_page"></a>InternetAddress</span></h2> +<p>InternetAddress — Internet addresses</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="InternetAddress.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">struct <a class="link" href="InternetAddress.html#InternetAddress-struct" title="struct InternetAddress">InternetAddress</a>; +const <span class="returnvalue">char</span> * <a class="link" href="InternetAddress.html#internet-address-get-name" title="internet_address_get_name ()">internet_address_get_name</a> (<em class="parameter"><code><a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> *ia</code></em>); +<span class="returnvalue">void</span> <a class="link" href="InternetAddress.html#internet-address-set-name" title="internet_address_set_name ()">internet_address_set_name</a> (<em class="parameter"><code><a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> *ia</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *name</code></em>); +<span class="returnvalue">char</span> * <a class="link" href="InternetAddress.html#internet-address-to-string" title="internet_address_to_string ()">internet_address_to_string</a> (<em class="parameter"><code><a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> *ia</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> encode</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="InternetAddress.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----InternetAddress + +----<a class="link" href="InternetAddressGroup.html" title="InternetAddressGroup">InternetAddressGroup</a> + +----<a class="link" href="InternetAddressMailbox.html" title="InternetAddressMailbox">InternetAddressMailbox</a> +</pre> +</div> +<div class="refsect1"> +<a name="InternetAddress.description"></a><h2>Description</h2> +<p> +An <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> is the base class for <a class="link" href="InternetAddressGroup.html" title="InternetAddressGroup"><span class="type">InternetAddressGroup</span></a> and +<a class="link" href="InternetAddressMailbox.html" title="InternetAddressMailbox"><span class="type">InternetAddressMailbox</span></a>. +</p> +</div> +<div class="refsect1"> +<a name="InternetAddress.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="InternetAddress-struct"></a><h3>struct InternetAddress</h3> +<pre class="programlisting">struct InternetAddress;</pre> +<p> +An RFC 2822 Address object. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="internet-address-get-name"></a><h3>internet_address_get_name ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * internet_address_get_name (<em class="parameter"><code><a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> *ia</code></em>);</pre> +<p> +Gets the display name of the <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</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>ia</code></em> :</span></p></td> +<td>a <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> +</td> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="internet-address-set-name"></a><h3>internet_address_set_name ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> internet_address_set_name (<em class="parameter"><code><a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> *ia</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre> +<p> +Set the display name of the <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</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>ia</code></em> :</span></p></td> +<td>a <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> +<td>the display name for the address group or mailbox</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="internet-address-to-string"></a><h3>internet_address_to_string ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * internet_address_to_string (<em class="parameter"><code><a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> *ia</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> encode</code></em>);</pre> +<p> +Allocates a string containing the contents of the <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> +object. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>ia</code></em> :</span></p></td> +<td>Internet Address object</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>encode</code></em> :</span></p></td> +<td> +<code class="literal">TRUE</code> if the address should be rfc2047 encoded</td> +</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> object as an allocated string in +rfc822 format.</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="InternetAddress.see-also"></a><h2>See Also</h2> +<a class="link" href="InternetAddressGroup.html" title="InternetAddressGroup"><span class="type">InternetAddressGroup</span></a>, <a class="link" href="InternetAddressMailbox.html" title="InternetAddressMailbox"><span class="type">InternetAddressMailbox</span></a> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/InternetAddressGroup.html b/docs/reference/html/InternetAddressGroup.html new file mode 100644 index 0000000..e18cea5 --- /dev/null +++ b/docs/reference/html/InternetAddressGroup.html @@ -0,0 +1,187 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>InternetAddressGroup</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="InternetAddresses.html" title="Internet Addresses"> +<link rel="prev" href="InternetAddress.html" title="InternetAddress"> +<link rel="next" href="InternetAddressMailbox.html" title="InternetAddressMailbox"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="InternetAddress.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="InternetAddresses.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="InternetAddressMailbox.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#InternetAddressGroup.synopsis" class="shortcut">Top</a> +  | + <a href="#InternetAddressGroup.description" class="shortcut">Description</a> +  | + <a href="#InternetAddressGroup.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="InternetAddressGroup"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="InternetAddressGroup.top_of_page"></a>InternetAddressGroup</span></h2> +<p>InternetAddressGroup — rfc822 'group' address</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="InternetAddressGroup.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">struct <a class="link" href="InternetAddressGroup.html#InternetAddressGroup-struct" title="struct InternetAddressGroup">InternetAddressGroup</a>; +<a class="link" href="InternetAddress.html" title="InternetAddress"><span class="returnvalue">InternetAddress</span></a> * <a class="link" href="InternetAddressGroup.html#internet-address-group-new" title="internet_address_group_new ()">internet_address_group_new</a> (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>); +<a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="returnvalue">InternetAddressList</span></a> * <a class="link" href="InternetAddressGroup.html#internet-address-group-get-members" title="internet_address_group_get_members ()">internet_address_group_get_members</a> + (<em class="parameter"><code><a class="link" href="InternetAddressGroup.html" title="InternetAddressGroup"><span class="type">InternetAddressGroup</span></a> *group</code></em>); +<span class="returnvalue">void</span> <a class="link" href="InternetAddressGroup.html#internet-address-group-set-members" title="internet_address_group_set_members ()">internet_address_group_set_members</a> (<em class="parameter"><code><a class="link" href="InternetAddressGroup.html" title="InternetAddressGroup"><span class="type">InternetAddressGroup</span></a> *group</code></em>, + <em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *members</code></em>); +<span class="returnvalue">int</span> <a class="link" href="InternetAddressGroup.html#internet-address-group-add-member" title="internet_address_group_add_member ()">internet_address_group_add_member</a> (<em class="parameter"><code><a class="link" href="InternetAddressGroup.html" title="InternetAddressGroup"><span class="type">InternetAddressGroup</span></a> *group</code></em>, + <em class="parameter"><code><a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> *member</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="InternetAddressGroup.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----<a class="link" href="InternetAddress.html" title="InternetAddress">InternetAddress</a> + +----InternetAddressGroup +</pre> +</div> +<div class="refsect1"> +<a name="InternetAddressGroup.description"></a><h2>Description</h2> +<p> +An <a class="link" href="InternetAddressGroup.html" title="InternetAddressGroup"><span class="type">InternetAddressGroup</span></a> represents an rfc822 'group' address. +</p> +</div> +<div class="refsect1"> +<a name="InternetAddressGroup.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="InternetAddressGroup-struct"></a><h3>struct InternetAddressGroup</h3> +<pre class="programlisting">struct InternetAddressGroup;</pre> +<p> +An RFC 2822 Group address. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<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 +<em class="parameter"><code>name</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>name</code></em> :</span></p></td> +<td>group name</td> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="internet-address-group-get-members"></a><h3>internet_address_group_get_members ()</h3> +<pre class="programlisting"><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="returnvalue">InternetAddressList</span></a> * internet_address_group_get_members + (<em class="parameter"><code><a class="link" href="InternetAddressGroup.html" title="InternetAddressGroup"><span class="type">InternetAddressGroup</span></a> *group</code></em>);</pre> +<p> +Gets the <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> containing the group members of an +rfc822 group address. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td> +<td>a <a class="link" href="InternetAddressGroup.html" title="InternetAddressGroup"><span class="type">InternetAddressGroup</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="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> containing the members of <em class="parameter"><code>group</code></em>.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="internet-address-group-set-members"></a><h3>internet_address_group_set_members ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> internet_address_group_set_members (<em class="parameter"><code><a class="link" href="InternetAddressGroup.html" title="InternetAddressGroup"><span class="type">InternetAddressGroup</span></a> *group</code></em>, + <em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *members</code></em>);</pre> +<p> +Set the members of the internet address group. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td> +<td>a <a class="link" href="InternetAddressGroup.html" title="InternetAddressGroup"><span class="type">InternetAddressGroup</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>members</code></em> :</span></p></td> +<td>a <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="internet-address-group-add-member"></a><h3>internet_address_group_add_member ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> internet_address_group_add_member (<em class="parameter"><code><a class="link" href="InternetAddressGroup.html" title="InternetAddressGroup"><span class="type">InternetAddressGroup</span></a> *group</code></em>, + <em class="parameter"><code><a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> *member</code></em>);</pre> +<p> +Add a contact to the internet address group. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td> +<td>a <a class="link" href="InternetAddressGroup.html" title="InternetAddressGroup"><span class="type">InternetAddressGroup</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>member</code></em> :</span></p></td> +<td>a <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the index of the newly added member.</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="InternetAddressGroup.see-also"></a><h2>See Also</h2> +<a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/InternetAddressList.html b/docs/reference/html/InternetAddressList.html new file mode 100644 index 0000000..442f7b7 --- /dev/null +++ b/docs/reference/html/InternetAddressList.html @@ -0,0 +1,526 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>InternetAddressList</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="InternetAddresses.html" title="Internet Addresses"> +<link rel="prev" href="InternetAddressMailbox.html" title="InternetAddressMailbox"> +<link rel="next" href="MimeParts.html" title="MIME Messages and Parts"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="InternetAddressMailbox.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="InternetAddresses.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="MimeParts.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#InternetAddressList.synopsis" class="shortcut">Top</a> +  | + <a href="#InternetAddressList.description" class="shortcut">Description</a> +  | + <a href="#InternetAddressList.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="InternetAddressList"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="InternetAddressList.top_of_page"></a>InternetAddressList</span></h2> +<p>InternetAddressList — A list of internet addresses</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="InternetAddressList.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">struct <a class="link" href="InternetAddressList.html#InternetAddressList-struct" title="struct InternetAddressList">InternetAddressList</a>; +<a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="returnvalue">InternetAddressList</span></a> * <a class="link" href="InternetAddressList.html#internet-address-list-new" title="internet_address_list_new ()">internet_address_list_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +<span class="returnvalue">int</span> <a class="link" href="InternetAddressList.html#internet-address-list-length" title="internet_address_list_length ()">internet_address_list_length</a> (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>); +<span class="returnvalue">void</span> <a class="link" href="InternetAddressList.html#internet-address-list-clear" title="internet_address_list_clear ()">internet_address_list_clear</a> (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>); +<span class="returnvalue">int</span> <a class="link" href="InternetAddressList.html#internet-address-list-add" title="internet_address_list_add ()">internet_address_list_add</a> (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>, + <em class="parameter"><code><a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> *ia</code></em>); +<span class="returnvalue">void</span> <a class="link" href="InternetAddressList.html#internet-address-list-insert" title="internet_address_list_insert ()">internet_address_list_insert</a> (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>, + <em class="parameter"><code><span class="type">int</span> index</code></em>, + <em class="parameter"><code><a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> *ia</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="InternetAddressList.html#internet-address-list-remove" title="internet_address_list_remove ()">internet_address_list_remove</a> (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>, + <em class="parameter"><code><a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> *ia</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="InternetAddressList.html#internet-address-list-remove-at" title="internet_address_list_remove_at ()">internet_address_list_remove_at</a> (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>, + <em class="parameter"><code><span class="type">int</span> index</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="InternetAddressList.html#internet-address-list-contains" title="internet_address_list_contains ()">internet_address_list_contains</a> (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>, + <em class="parameter"><code><a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> *ia</code></em>); +<span class="returnvalue">int</span> <a class="link" href="InternetAddressList.html#internet-address-list-index-of" title="internet_address_list_index_of ()">internet_address_list_index_of</a> (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>, + <em class="parameter"><code><a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> *ia</code></em>); +<a class="link" href="InternetAddress.html" title="InternetAddress"><span class="returnvalue">InternetAddress</span></a> * <a class="link" href="InternetAddressList.html#internet-address-list-get-address" title="internet_address_list_get_address ()">internet_address_list_get_address</a> (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>, + <em class="parameter"><code><span class="type">int</span> index</code></em>); +<span class="returnvalue">void</span> <a class="link" href="InternetAddressList.html#internet-address-list-set-address" title="internet_address_list_set_address ()">internet_address_list_set_address</a> (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>, + <em class="parameter"><code><span class="type">int</span> index</code></em>, + <em class="parameter"><code><a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> *ia</code></em>); +<span class="returnvalue">void</span> <a class="link" href="InternetAddressList.html#internet-address-list-prepend" title="internet_address_list_prepend ()">internet_address_list_prepend</a> (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>, + <em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *prepend</code></em>); +<span class="returnvalue">void</span> <a class="link" href="InternetAddressList.html#internet-address-list-append" title="internet_address_list_append ()">internet_address_list_append</a> (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>, + <em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *append</code></em>); +<span class="returnvalue">char</span> * <a class="link" href="InternetAddressList.html#internet-address-list-to-string" title="internet_address_list_to_string ()">internet_address_list_to_string</a> (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> encode</code></em>); +<a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="returnvalue">InternetAddressList</span></a> * <a class="link" href="InternetAddressList.html#internet-address-list-parse-string" title="internet_address_list_parse_string ()">internet_address_list_parse_string</a> + (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>); +<span class="returnvalue">void</span> <a class="link" href="InternetAddressList.html#internet-address-list-writer" title="internet_address_list_writer ()">internet_address_list_writer</a> (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>, + <em class="parameter"><code><span class="type">GString</span> *str</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="InternetAddressList.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----InternetAddressList +</pre> +</div> +<div class="refsect1"> +<a name="InternetAddressList.description"></a><h2>Description</h2> +<p> +An <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> is a collection of <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> +objects. +</p> +</div> +<div class="refsect1"> +<a name="InternetAddressList.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="InternetAddressList-struct"></a><h3>struct InternetAddressList</h3> +<pre class="programlisting">struct InternetAddressList;</pre> +<p> +A collection of <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> objects. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="internet-address-list-new"></a><h3>internet_address_list_new ()</h3> +<pre class="programlisting"><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="returnvalue">InternetAddressList</span></a> * internet_address_list_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Creates a new <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a new <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a>.</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="internet-address-list-length"></a><h3>internet_address_list_length ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> internet_address_list_length (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>);</pre> +<p> +Gets the length of the list. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td> +<td>a <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the number of <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> objects in the list.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="internet-address-list-clear"></a><h3>internet_address_list_clear ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> internet_address_list_clear (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>);</pre> +<p> +Clears the list of addresses. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td> +<td>a <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="internet-address-list-add"></a><h3>internet_address_list_add ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> internet_address_list_add (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>, + <em class="parameter"><code><a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> *ia</code></em>);</pre> +<p> +Adds an <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> to the <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</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>list</code></em> :</span></p></td> +<td>a <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>ia</code></em> :</span></p></td> +<td>a <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the index of the added <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a>.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="internet-address-list-insert"></a><h3>internet_address_list_insert ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> internet_address_list_insert (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>, + <em class="parameter"><code><span class="type">int</span> index</code></em>, + <em class="parameter"><code><a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> *ia</code></em>);</pre> +<p> +Inserts an <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> into the <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> at the +specified index. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td> +<td>a <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td> +<td>index to insert at</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>ia</code></em> :</span></p></td> +<td>a <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="internet-address-list-remove"></a><h3>internet_address_list_remove ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> internet_address_list_remove (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>, + <em class="parameter"><code><a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> *ia</code></em>);</pre> +<p> +Removes an <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> from the <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</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>list</code></em> :</span></p></td> +<td>a <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>ia</code></em> :</span></p></td> +<td>a <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> if the specified <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> was removed or +<code class="literal">FALSE</code> otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="internet-address-list-remove-at"></a><h3>internet_address_list_remove_at ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> internet_address_list_remove_at (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>, + <em class="parameter"><code><span class="type">int</span> index</code></em>);</pre> +<p> +Removes an <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> from the <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> at the +specified index. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td> +<td>a <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td> +<td>index to remove</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> if an <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> was removed or <code class="literal">FALSE</code> +otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="internet-address-list-contains"></a><h3>internet_address_list_contains ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> internet_address_list_contains (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>, + <em class="parameter"><code><a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> *ia</code></em>);</pre> +<p> +Checks whether or not the specified <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> is contained +within the <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</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>list</code></em> :</span></p></td> +<td>a <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>ia</code></em> :</span></p></td> +<td>a <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> if the specified <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> is contained +within the specified <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> or <code class="literal">FALSE</code> otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="internet-address-list-index-of"></a><h3>internet_address_list_index_of ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> internet_address_list_index_of (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>, + <em class="parameter"><code><a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> *ia</code></em>);</pre> +<p> +Gets the index of the specified <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> inside the +<a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</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>list</code></em> :</span></p></td> +<td>a <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>ia</code></em> :</span></p></td> +<td>a <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the index of the requested <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> within the +<a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> or <code class="literal">-1</code> if it is not contained within the +<a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a>.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="internet-address-list-get-address"></a><h3>internet_address_list_get_address ()</h3> +<pre class="programlisting"><a class="link" href="InternetAddress.html" title="InternetAddress"><span class="returnvalue">InternetAddress</span></a> * internet_address_list_get_address (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>, + <em class="parameter"><code><span class="type">int</span> index</code></em>);</pre> +<p> +Gets the <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> at the specified index. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td> +<td>a <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td> +<td>index of <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> to get</td> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="internet-address-list-set-address"></a><h3>internet_address_list_set_address ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> internet_address_list_set_address (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>, + <em class="parameter"><code><span class="type">int</span> index</code></em>, + <em class="parameter"><code><a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> *ia</code></em>);</pre> +<p> +Sets the <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> at the specified index to <em class="parameter"><code>ia</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>list</code></em> :</span></p></td> +<td>a <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td> +<td>index of <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> to set</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>ia</code></em> :</span></p></td> +<td>a <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="internet-address-list-prepend"></a><h3>internet_address_list_prepend ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> internet_address_list_prepend (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>, + <em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *prepend</code></em>);</pre> +<p> +Inserts all of the addresses in <em class="parameter"><code>prepend</code></em> to the beginning of <em class="parameter"><code>list</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>list</code></em> :</span></p></td> +<td>a <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>prepend</code></em> :</span></p></td> +<td>a <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="internet-address-list-append"></a><h3>internet_address_list_append ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> internet_address_list_append (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>, + <em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *append</code></em>);</pre> +<p> +Adds all of the addresses in <em class="parameter"><code>append</code></em> to <em class="parameter"><code>list</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>list</code></em> :</span></p></td> +<td>a <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>append</code></em> :</span></p></td> +<td>a <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="internet-address-list-to-string"></a><h3>internet_address_list_to_string ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * internet_address_list_to_string (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> encode</code></em>);</pre> +<p> +Allocates a string buffer containing the rfc822 formatted addresses +in <em class="parameter"><code>list</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>list</code></em> :</span></p></td> +<td>list of internet addresses</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>encode</code></em> :</span></p></td> +<td> +<code class="literal">TRUE</code> if the address should be rfc2047 encoded</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a string containing the list of addresses in rfc822 format +or <code class="literal">NULL</code> if no addresses are contained in the list.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="internet-address-list-parse-string"></a><h3>internet_address_list_parse_string ()</h3> +<pre class="programlisting"><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="returnvalue">InternetAddressList</span></a> * internet_address_list_parse_string + (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>);</pre> +<p> +Construct a list of internet addresses from the given string. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td> +<td>a string containing internet addresses</td> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="internet-address-list-writer"></a><h3>internet_address_list_writer ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> internet_address_list_writer (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>, + <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. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td> +<td>list of internet addresses</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td> +<td>string to write to</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="InternetAddressList.see-also"></a><h2>See Also</h2> +<a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/InternetAddressMailbox.html b/docs/reference/html/InternetAddressMailbox.html new file mode 100644 index 0000000..bce838c --- /dev/null +++ b/docs/reference/html/InternetAddressMailbox.html @@ -0,0 +1,160 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>InternetAddressMailbox</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="InternetAddresses.html" title="Internet Addresses"> +<link rel="prev" href="InternetAddressGroup.html" title="InternetAddressGroup"> +<link rel="next" href="InternetAddressList.html" title="InternetAddressList"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="InternetAddressGroup.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="InternetAddresses.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="InternetAddressList.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#InternetAddressMailbox.synopsis" class="shortcut">Top</a> +  | + <a href="#InternetAddressMailbox.description" class="shortcut">Description</a> +  | + <a href="#InternetAddressMailbox.object-hierarchy" class="shortcut">Object Hierarchy</a> +</td></tr> +</table> +<div class="refentry"> +<a name="InternetAddressMailbox"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="InternetAddressMailbox.top_of_page"></a>InternetAddressMailbox</span></h2> +<p>InternetAddressMailbox — rfc822 'mailbox' address</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="InternetAddressMailbox.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">struct <a class="link" href="InternetAddressMailbox.html#InternetAddressMailbox-struct" title="struct InternetAddressMailbox">InternetAddressMailbox</a>; +<a class="link" href="InternetAddress.html" title="InternetAddress"><span class="returnvalue">InternetAddress</span></a> * <a class="link" href="InternetAddressMailbox.html#internet-address-mailbox-new" title="internet_address_mailbox_new ()">internet_address_mailbox_new</a> (<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>); +const <span class="returnvalue">char</span> * <a class="link" href="InternetAddressMailbox.html#internet-address-mailbox-get-addr" title="internet_address_mailbox_get_addr ()">internet_address_mailbox_get_addr</a> (<em class="parameter"><code><a class="link" href="InternetAddressMailbox.html" title="InternetAddressMailbox"><span class="type">InternetAddressMailbox</span></a> *mailbox</code></em>); +<span class="returnvalue">void</span> <a class="link" href="InternetAddressMailbox.html#internet-address-mailbox-set-addr" title="internet_address_mailbox_set_addr ()">internet_address_mailbox_set_addr</a> (<em class="parameter"><code><a class="link" href="InternetAddressMailbox.html" title="InternetAddressMailbox"><span class="type">InternetAddressMailbox</span></a> *mailbox</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *addr</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="InternetAddressMailbox.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GObject + +----<a class="link" href="InternetAddress.html" title="InternetAddress">InternetAddress</a> + +----InternetAddressMailbox +</pre> +</div> +<div class="refsect1"> +<a name="InternetAddressMailbox.description"></a><h2>Description</h2> +<p> +An <a class="link" href="InternetAddressMailbox.html" title="InternetAddressMailbox"><span class="type">InternetAddressMailbox</span></a> represents what is a typical "email +address". +</p> +</div> +<div class="refsect1"> +<a name="InternetAddressMailbox.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="InternetAddressMailbox-struct"></a><h3>struct InternetAddressMailbox</h3> +<pre class="programlisting">struct InternetAddressMailbox;</pre> +<p> +An RFC 2822 Mailbox address. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="internet-address-mailbox-new"></a><h3>internet_address_mailbox_new ()</h3> +<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 +<em class="parameter"><code>addr</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>name</code></em> :</span></p></td> +<td>person's name</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>addr</code></em> :</span></p></td> +<td>person's address</td> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="internet-address-mailbox-get-addr"></a><h3>internet_address_mailbox_get_addr ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * internet_address_mailbox_get_addr (<em class="parameter"><code><a class="link" href="InternetAddressMailbox.html" title="InternetAddressMailbox"><span class="type">InternetAddressMailbox</span></a> *mailbox</code></em>);</pre> +<p> +Gets the addr-spec of the internet address mailbox. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>mailbox</code></em> :</span></p></td> +<td>a <a class="link" href="InternetAddressMailbox.html" title="InternetAddressMailbox"><span class="type">InternetAddressMailbox</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the address of the mailbox.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="internet-address-mailbox-set-addr"></a><h3>internet_address_mailbox_set_addr ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> internet_address_mailbox_set_addr (<em class="parameter"><code><a class="link" href="InternetAddressMailbox.html" title="InternetAddressMailbox"><span class="type">InternetAddressMailbox</span></a> *mailbox</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *addr</code></em>);</pre> +<p> +Set the mailbox address. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>mailbox</code></em> :</span></p></td> +<td>a <a class="link" href="InternetAddressMailbox.html" title="InternetAddressMailbox"><span class="type">InternetAddressMailbox</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>addr</code></em> :</span></p></td> +<td>contact's email address</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="InternetAddressMailbox.see-also"></a><h2>See Also</h2> +<a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/InternetAddresses.html b/docs/reference/html/InternetAddresses.html new file mode 100644 index 0000000..34a8b7a --- /dev/null +++ b/docs/reference/html/InternetAddresses.html @@ -0,0 +1,44 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Internet Addresses</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="classes.html" title="Part IV. GMime Classes"> +<link rel="prev" href="gmime-GMimeParam.html" title="GMimeParam"> +<link rel="next" href="InternetAddress.html" title="InternetAddress"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="gmime-GMimeParam.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="classes.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="InternetAddress.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="InternetAddresses"></a>Internet Addresses</h2></div></div></div> +<div class="toc"><dl> +<dt> +<span class="refentrytitle"><a href="InternetAddress.html">InternetAddress</a></span><span class="refpurpose"> — Internet addresses</span> +</dt> +<dt> +<span class="refentrytitle"><a href="InternetAddressGroup.html">InternetAddressGroup</a></span><span class="refpurpose"> — rfc822 'group' address</span> +</dt> +<dt> +<span class="refentrytitle"><a href="InternetAddressMailbox.html">InternetAddressMailbox</a></span><span class="refpurpose"> — rfc822 'mailbox' address</span> +</dt> +<dt> +<span class="refentrytitle"><a href="InternetAddressList.html">InternetAddressList</a></span><span class="refpurpose"> — A list of internet addresses</span> +</dt> +</dl></div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/MimeParts.html b/docs/reference/html/MimeParts.html new file mode 100644 index 0000000..b6e7454 --- /dev/null +++ b/docs/reference/html/MimeParts.html @@ -0,0 +1,59 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>MIME Messages and Parts</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="classes.html" title="Part IV. GMime Classes"> +<link rel="prev" href="InternetAddressList.html" title="InternetAddressList"> +<link rel="next" href="GMimeObject.html" title="GMimeObject"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="InternetAddressList.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="classes.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="GMimeObject.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="MimeParts"></a>MIME Messages and Parts</h2></div></div></div> +<div class="toc"><dl> +<dt> +<span class="refentrytitle"><a href="GMimeObject.html">GMimeObject</a></span><span class="refpurpose"> — Abstract MIME objects</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeMessage.html">GMimeMessage</a></span><span class="refpurpose"> — Messages</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimePart.html">GMimePart</a></span><span class="refpurpose"> — MIME parts</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeMultipart.html">GMimeMultipart</a></span><span class="refpurpose"> — MIME multiparts</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeMultipartEncrypted.html">GMimeMultipartEncrypted</a></span><span class="refpurpose"> — Encrypted MIME multiparts</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeMultipartSigned.html">GMimeMultipartSigned</a></span><span class="refpurpose"> — Signed MIME multiparts</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeMessagePart.html">GMimeMessagePart</a></span><span class="refpurpose"> — Message parts</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeMessagePartial.html">GMimeMessagePartial</a></span><span class="refpurpose"> — Partial MIME parts</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gmime-GMimePartIter.html">GMimePartIter</a></span><span class="refpurpose"> — MIME part iterators</span> +</dt> +</dl></div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/Parsers.html b/docs/reference/html/Parsers.html new file mode 100644 index 0000000..662af1f --- /dev/null +++ b/docs/reference/html/Parsers.html @@ -0,0 +1,33 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Parsing Messages and MIME Parts</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="classes.html" title="Part IV. GMime Classes"> +<link rel="prev" href="gmime-GMimePartIter.html" title="GMimePartIter"> +<link rel="next" href="GMimeParser.html" title="GMimeParser"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="gmime-GMimePartIter.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="classes.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="GMimeParser.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="Parsers"></a>Parsing Messages and MIME Parts</h2></div></div></div> +<div class="toc"><dl><dt> +<span class="refentrytitle"><a href="GMimeParser.html">GMimeParser</a></span><span class="refpurpose"> — Message and MIME part parser</span> +</dt></dl></div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/Streams.html b/docs/reference/html/Streams.html new file mode 100644 index 0000000..bdb113d --- /dev/null +++ b/docs/reference/html/Streams.html @@ -0,0 +1,62 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Streams</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="classes.html" title="Part IV. GMime Classes"> +<link rel="prev" href="ch01.html" title="Class hierarchy"> +<link rel="next" href="GMimeStream.html" title="GMimeStream"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="ch01.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="classes.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="GMimeStream.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="Streams"></a>Streams</h2></div></div></div> +<div class="toc"><dl> +<dt> +<span class="refentrytitle"><a href="GMimeStream.html">GMimeStream</a></span><span class="refpurpose"> — Abstract stream class</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeStreamFile.html">GMimeStreamFile</a></span><span class="refpurpose"> — A Standard-C FILE-based stream</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeStreamFs.html">GMimeStreamFs</a></span><span class="refpurpose"> — A low-level FileSystem stream</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeStreamMem.html">GMimeStreamMem</a></span><span class="refpurpose"> — A memory-backed stream</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeStreamMmap.html">GMimeStreamMmap</a></span><span class="refpurpose"> — A memory-mapped file stream</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeStreamNull.html">GMimeStreamNull</a></span><span class="refpurpose"> — A null stream</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeStreamFilter.html">GMimeStreamFilter</a></span><span class="refpurpose"> — A filtering stream</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeStreamBuffer.html">GMimeStreamBuffer</a></span><span class="refpurpose"> — A buffered stream</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeStreamPipe.html">GMimeStreamPipe</a></span><span class="refpurpose"> — A low-level pipe stream</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeStreamCat.html">GMimeStreamCat</a></span><span class="refpurpose"> — A concatenated stream</span> +</dt> +</dl></div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/ch01.html b/docs/reference/html/ch01.html new file mode 100644 index 0000000..b21fd60 --- /dev/null +++ b/docs/reference/html/ch01.html @@ -0,0 +1,75 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Class hierarchy</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="classes.html" title="Part IV. GMime Classes"> +<link rel="prev" href="classes.html" title="Part IV. GMime Classes"> +<link rel="next" href="Streams.html" title="Streams"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="classes.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="classes.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="Streams.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="idp8457328"></a>Class hierarchy</h2></div></div></div> +<pre class="screen"> + GMimeHeader + <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam">GMimeParam</a> + GObject + <a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition">GMimeContentDisposition</a> + <a class="link" href="GMimeContentType.html" title="GMimeContentType">GMimeContentType</a> + <a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper">GMimeDataWrapper</a> + <a class="link" href="GMimeObject.html" title="GMimeObject">GMimeObject</a> + <a class="link" href="GMimeMessage.html" title="GMimeMessage">GMimeMessage</a> + <a class="link" href="GMimeMessagePart.html" title="GMimeMessagePart">GMimeMessagePart</a> + <a class="link" href="GMimeMessagePartial.html" title="GMimeMessagePartial">GMimeMessagePartial</a> + <a class="link" href="GMimeMultipart.html" title="GMimeMultipart">GMimeMultipart</a> + <a class="link" href="GMimeMultipartEncrypted.html" title="GMimeMultipartEncrypted">GMimeMultipartEncrypted</a> + <a class="link" href="GMimeMultipartSigned.html" title="GMimeMultipartSigned">GMimeMultipartSigned</a> + <a class="link" href="GMimePart.html" title="GMimePart">GMimePart</a> + <a class="link" href="GMimeParser.html" title="GMimeParser">GMimeParser</a> + <a class="link" href="GMimeStream.html" title="GMimeStream">GMimeStream</a> + <a class="link" href="GMimeStreamBuffer.html" title="GMimeStreamBuffer">GMimeStreamBuffer</a> + <a class="link" href="GMimeStreamCat.html" title="GMimeStreamCat">GMimeStreamCat</a> + <a class="link" href="GMimeStreamFile.html" title="GMimeStreamFile">GMimeStreamFile</a> + <a class="link" href="GMimeStreamFilter.html" title="GMimeStreamFilter">GMimeStreamFilter</a> + <a class="link" href="GMimeStreamFs.html" title="GMimeStreamFs">GMimeStreamFs</a> + <a class="link" href="GMimeStreamMem.html" title="GMimeStreamMem">GMimeStreamMem</a> + <a class="link" href="GMimeStreamMmap.html" title="GMimeStreamMmap">GMimeStreamMmap</a> + <a class="link" href="GMimeStreamNull.html" title="GMimeStreamNull">GMimeStreamNull</a> + <a class="link" href="GMimeFilter.html" title="GMimeFilter">GMimeFilter</a> + <a class="link" href="GMimeFilterBasic.html" title="GMimeFilterBasic">GMimeFilterBasic</a> + <a class="link" href="GMimeFilterBest.html" title="GMimeFilterBest">GMimeFilterBest</a> + <a class="link" href="GMimeFilterCharset.html" title="GMimeFilterCharset">GMimeFilterCharset</a> + <a class="link" href="GMimeFilterCRLF.html" title="GMimeFilterCRLF">GMimeFilterCRLF</a> + <a class="link" href="GMimeFilterFrom.html" title="GMimeFilterFrom">GMimeFilterFrom</a> + <a class="link" href="GMimeFilterGZip.html" title="GMimeFilterGZip">GMimeFilterGZip</a> + <a class="link" href="GMimeFilterHTML.html" title="GMimeFilterHTML">GMimeFilterHTML</a> + <a class="link" href="GMimeFilterMd5.html" title="GMimeFilterMd5">GMimeFilterMd5</a> + <a class="link" href="GMimeFilterStrip.html" title="GMimeFilterStrip">GMimeFilterStrip</a> + <a class="link" href="GMimeFilterYenc.html" title="GMimeFilterYenc">GMimeFilterYenc</a> + GMimeCipherContext + <a class="link" href="GMimeGpgContext.html" title="GMimeGpgContext">GMimeGpgContext</a> + GMimeSession + GMimeSessionSimple + <a class="link" href="InternetAddress.html" title="InternetAddress">InternetAddress</a> + <a class="link" href="InternetAddressGroup.html" title="InternetAddressGroup">InternetAddressGroup</a> + <a class="link" href="InternetAddressMailbox.html" title="InternetAddressMailbox">InternetAddressMailbox</a> + <a class="link" href="InternetAddressList.html" title="InternetAddressList">InternetAddressList</a> +</pre> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/classes.html b/docs/reference/html/classes.html new file mode 100644 index 0000000..6a51f85 --- /dev/null +++ b/docs/reference/html/classes.html @@ -0,0 +1,197 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Part IV. GMime Classes</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="prev" href="gmime-gmime-utils.html" title="gmime-utils"> +<link rel="next" href="ch01.html" title="Class hierarchy"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="gmime-gmime-utils.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td> </td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="ch01.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="part"> +<div class="titlepage"><div><div><h1 class="title"> +<a name="classes"></a>Part IV. GMime Classes</h1></div></div></div> +<div class="toc"> +<p><b>Table of Contents</b></p> +<dl> +<dt><span class="chapter"><a href="ch01.html">Class hierarchy</a></span></dt> +<dt><span class="chapter"><a href="Streams.html">Streams</a></span></dt> +<dd><dl> +<dt> +<span class="refentrytitle"><a href="GMimeStream.html">GMimeStream</a></span><span class="refpurpose"> — Abstract stream class</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeStreamFile.html">GMimeStreamFile</a></span><span class="refpurpose"> — A Standard-C FILE-based stream</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeStreamFs.html">GMimeStreamFs</a></span><span class="refpurpose"> — A low-level FileSystem stream</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeStreamMem.html">GMimeStreamMem</a></span><span class="refpurpose"> — A memory-backed stream</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeStreamMmap.html">GMimeStreamMmap</a></span><span class="refpurpose"> — A memory-mapped file stream</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeStreamNull.html">GMimeStreamNull</a></span><span class="refpurpose"> — A null stream</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeStreamFilter.html">GMimeStreamFilter</a></span><span class="refpurpose"> — A filtering stream</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeStreamBuffer.html">GMimeStreamBuffer</a></span><span class="refpurpose"> — A buffered stream</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeStreamPipe.html">GMimeStreamPipe</a></span><span class="refpurpose"> — A low-level pipe stream</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeStreamCat.html">GMimeStreamCat</a></span><span class="refpurpose"> — A concatenated stream</span> +</dt> +</dl></dd> +<dt><span class="chapter"><a href="Filters.html">Stream Filters</a></span></dt> +<dd><dl> +<dt> +<span class="refentrytitle"><a href="GMimeFilter.html">GMimeFilter</a></span><span class="refpurpose"> — Abstract filter class</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeFilterBasic.html">GMimeFilterBasic</a></span><span class="refpurpose"> — Basic transfer encoding filter</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeFilterBest.html">GMimeFilterBest</a></span><span class="refpurpose"> — Determine the best charset/encoding to use for a stream</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeFilterCharset.html">GMimeFilterCharset</a></span><span class="refpurpose"> — Charset-conversion filter</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeFilterCRLF.html">GMimeFilterCRLF</a></span><span class="refpurpose"> — Convert line-endings from LF to CRLF or vise versa</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeFilterEnriched.html">GMimeFilterEnriched</a></span><span class="refpurpose"> — Convert text/enriched or text/rtf to HTML</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeFilterFrom.html">GMimeFilterFrom</a></span><span class="refpurpose"> — Escape MBox From_ lines</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeFilterGZip.html">GMimeFilterGZip</a></span><span class="refpurpose"> — GNU Zip compression/decompression</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeFilterHTML.html">GMimeFilterHTML</a></span><span class="refpurpose"> — Convert plain text into HTML</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeFilterMd5.html">GMimeFilterMd5</a></span><span class="refpurpose"> — Calculate an md5sum</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeFilterStrip.html">GMimeFilterStrip</a></span><span class="refpurpose"> — Strip trailing whitespace from the end of lines</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeFilterWindows.html">GMimeFilterWindows</a></span><span class="refpurpose"> — Determine if text is in a Microsoft Windows codepage</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeFilterYenc.html">GMimeFilterYenc</a></span><span class="refpurpose"> — yEncode or yDecode</span> +</dt> +</dl></dd> +<dt><span class="chapter"><a href="DataWrappers.html">Data Wrappers</a></span></dt> +<dd><dl><dt> +<span class="refentrytitle"><a href="GMimeDataWrapper.html">GMimeDataWrapper</a></span><span class="refpurpose"> — Content objects</span> +</dt></dl></dd> +<dt><span class="chapter"><a href="Headers.html">Message and MIME Headers</a></span></dt> +<dd><dl> +<dt> +<span class="refentrytitle"><a href="gmime-GMimeHeader.html">GMimeHeader</a></span><span class="refpurpose"> — Message and MIME part headers</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeContentType.html">GMimeContentType</a></span><span class="refpurpose"> — Content-Type fields</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeContentDisposition.html">GMimeContentDisposition</a></span><span class="refpurpose"> — Content-Disposition fields</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gmime-GMimeParam.html">GMimeParam</a></span><span class="refpurpose"> — Content-Type and Content-Disposition parameters</span> +</dt> +</dl></dd> +<dt><span class="chapter"><a href="InternetAddresses.html">Internet Addresses</a></span></dt> +<dd><dl> +<dt> +<span class="refentrytitle"><a href="InternetAddress.html">InternetAddress</a></span><span class="refpurpose"> — Internet addresses</span> +</dt> +<dt> +<span class="refentrytitle"><a href="InternetAddressGroup.html">InternetAddressGroup</a></span><span class="refpurpose"> — rfc822 'group' address</span> +</dt> +<dt> +<span class="refentrytitle"><a href="InternetAddressMailbox.html">InternetAddressMailbox</a></span><span class="refpurpose"> — rfc822 'mailbox' address</span> +</dt> +<dt> +<span class="refentrytitle"><a href="InternetAddressList.html">InternetAddressList</a></span><span class="refpurpose"> — A list of internet addresses</span> +</dt> +</dl></dd> +<dt><span class="chapter"><a href="MimeParts.html">MIME Messages and Parts</a></span></dt> +<dd><dl> +<dt> +<span class="refentrytitle"><a href="GMimeObject.html">GMimeObject</a></span><span class="refpurpose"> — Abstract MIME objects</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeMessage.html">GMimeMessage</a></span><span class="refpurpose"> — Messages</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimePart.html">GMimePart</a></span><span class="refpurpose"> — MIME parts</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeMultipart.html">GMimeMultipart</a></span><span class="refpurpose"> — MIME multiparts</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeMultipartEncrypted.html">GMimeMultipartEncrypted</a></span><span class="refpurpose"> — Encrypted MIME multiparts</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeMultipartSigned.html">GMimeMultipartSigned</a></span><span class="refpurpose"> — Signed MIME multiparts</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeMessagePart.html">GMimeMessagePart</a></span><span class="refpurpose"> — Message parts</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeMessagePartial.html">GMimeMessagePartial</a></span><span class="refpurpose"> — Partial MIME parts</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gmime-GMimePartIter.html">GMimePartIter</a></span><span class="refpurpose"> — MIME part iterators</span> +</dt> +</dl></dd> +<dt><span class="chapter"><a href="Parsers.html">Parsing Messages and MIME Parts</a></span></dt> +<dd><dl><dt> +<span class="refentrytitle"><a href="GMimeParser.html">GMimeParser</a></span><span class="refpurpose"> — Message and MIME part parser</span> +</dt></dl></dd> +<dt><span class="chapter"><a href="CryptoContexts.html">Cryptography Contexts</a></span></dt> +<dd><dl> +<dt> +<span class="refentrytitle"><a href="GMimeCertificate.html">GMimeCertificate</a></span><span class="refpurpose"> — Digital certificates</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeSignature.html">GMimeSignature</a></span><span class="refpurpose"> — Digital signatures</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeCryptoContext.html">GMimeCryptoContext</a></span><span class="refpurpose"> — Encryption/signing contexts</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeGpgContext.html">GMimeGpgContext</a></span><span class="refpurpose"> — GnuPG crypto contexts</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimePkcs7Context.html">GMimePkcs7Context</a></span><span class="refpurpose"> — PKCS7 crypto contexts</span> +</dt> +</dl></dd> +</dl> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/core.html b/docs/reference/html/core.html new file mode 100644 index 0000000..4797ac0 --- /dev/null +++ b/docs/reference/html/core.html @@ -0,0 +1,53 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Part III. GMime Core Reference</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="prev" href="gmime-data-wrappers.html" title="GMime Data Wrappers"> +<link rel="next" href="gmime-gmime.html" title="gmime"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="gmime-data-wrappers.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td> </td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="gmime-gmime.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="part"> +<div class="titlepage"><div><div><h1 class="title"> +<a name="core"></a>Part III. GMime Core Reference</h1></div></div></div> +<div class="toc"> +<p><b>Table of Contents</b></p> +<dl> +<dt> +<span class="refentrytitle"><a href="gmime-gmime.html">gmime</a></span><span class="refpurpose"> — Initialization, shutdown and version-check routines</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gmime-gmime-charset.html">gmime-charset</a></span><span class="refpurpose"> — Charset helper functions</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gmime-gmime-iconv.html">gmime-iconv</a></span><span class="refpurpose"> — Low-level routines for converting text from one charset to another</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gmime-gmime-iconv-utils.html">gmime-iconv-utils</a></span><span class="refpurpose"> — High-level routines for converting text from one charset to another</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gmime-gmime-encodings.html">gmime-encodings</a></span><span class="refpurpose"> — MIME encoding functions</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gmime-gmime-utils.html">gmime-utils</a></span><span class="refpurpose"> — MIME utility functions</span> +</dt> +</dl> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/fundamentals.html b/docs/reference/html/fundamentals.html new file mode 100644 index 0000000..154609f --- /dev/null +++ b/docs/reference/html/fundamentals.html @@ -0,0 +1,44 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Part II. GMime Fundamentals</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="prev" href="gmime-question-index.html" title="Frequently Asked Questions"> +<link rel="next" href="gmime-streams.html" title="GMime Streams"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="gmime-question-index.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td> </td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="gmime-streams.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="part"> +<div class="titlepage"><div><div><h1 class="title"> +<a name="fundamentals"></a>Part II. GMime Fundamentals</h1></div></div></div> +<div class="toc"> +<p><b>Table of Contents</b></p> +<dl> +<dt> +<span class="refentrytitle"><a href="gmime-streams.html">GMime Streams</a></span><span class="refpurpose"> — How to use GMime Streams</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gmime-filters.html">GMime Stream Filters</a></span><span class="refpurpose"> — How to use GMime Stream Filters</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gmime-data-wrappers.html">GMime Data Wrappers</a></span><span class="refpurpose"> — How to use GMime Data Wrappers</span> +</dt> +</dl> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/gmime-GMimeHeader.html b/docs/reference/html/gmime-GMimeHeader.html new file mode 100644 index 0000000..59d3424 --- /dev/null +++ b/docs/reference/html/gmime-GMimeHeader.html @@ -0,0 +1,956 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimeHeader</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="Headers.html" title="Message and MIME Headers"> +<link rel="prev" href="Headers.html" title="Message and MIME Headers"> +<link rel="next" href="GMimeContentType.html" title="GMimeContentType"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="Headers.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="Headers.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="GMimeContentType.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#gmime-GMimeHeader.synopsis" class="shortcut">Top</a> +  | + <a href="#gmime-GMimeHeader.description" class="shortcut">Description</a> +</td></tr> +</table> +<div class="refentry"> +<a name="gmime-GMimeHeader"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="gmime-GMimeHeader.top_of_page"></a>GMimeHeader</span></h2> +<p>GMimeHeader — Message and MIME part headers</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="gmime-GMimeHeader.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">struct <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter">GMimeHeaderIter</a>; + <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList">GMimeHeaderList</a>; +<span class="returnvalue">ssize_t</span> (<a class="link" href="gmime-GMimeHeader.html#GMimeHeaderWriter" title="GMimeHeaderWriter ()">*GMimeHeaderWriter</a>) (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</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> *value</code></em>); +<span class="returnvalue">void</span> (<a class="link" href="gmime-GMimeHeader.html#GMimeHeaderForeachFunc" title="GMimeHeaderForeachFunc ()">*GMimeHeaderForeachFunc</a>) (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *value</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>); +<a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="returnvalue">GMimeHeaderIter</span></a> * <a class="link" href="gmime-GMimeHeader.html#g-mime-header-iter-new" title="g_mime_header_iter_new ()">g_mime_header_iter_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +<span class="returnvalue">void</span> <a class="link" href="gmime-GMimeHeader.html#g-mime-header-iter-free" title="g_mime_header_iter_free ()">g_mime_header_iter_free</a> (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter</code></em>); +<a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="returnvalue">GMimeHeaderIter</span></a> * <a class="link" href="gmime-GMimeHeader.html#g-mime-header-iter-copy" title="g_mime_header_iter_copy ()">g_mime_header_iter_copy</a> (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gmime-GMimeHeader.html#g-mime-header-iter-copy-to" title="g_mime_header_iter_copy_to ()">g_mime_header_iter_copy_to</a> (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *src</code></em>, + <em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *dest</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="gmime-GMimeHeader.html#g-mime-header-iter-equal" title="g_mime_header_iter_equal ()">g_mime_header_iter_equal</a> (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter1</code></em>, + <em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter2</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="gmime-GMimeHeader.html#g-mime-header-iter-first" title="g_mime_header_iter_first ()">g_mime_header_iter_first</a> (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="gmime-GMimeHeader.html#g-mime-header-iter-last" title="g_mime_header_iter_last ()">g_mime_header_iter_last</a> (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="gmime-GMimeHeader.html#g-mime-header-iter-next" title="g_mime_header_iter_next ()">g_mime_header_iter_next</a> (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="gmime-GMimeHeader.html#g-mime-header-iter-prev" title="g_mime_header_iter_prev ()">g_mime_header_iter_prev</a> (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="gmime-GMimeHeader.html#g-mime-header-iter-is-valid" title="g_mime_header_iter_is_valid ()">g_mime_header_iter_is_valid</a> (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="gmime-GMimeHeader.html#g-mime-header-iter-get-name" title="g_mime_header_iter_get_name ()">g_mime_header_iter_get_name</a> (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="gmime-GMimeHeader.html#g-mime-header-iter-get-value" title="g_mime_header_iter_get_value ()">g_mime_header_iter_get_value</a> (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="gmime-GMimeHeader.html#g-mime-header-iter-set-value" title="g_mime_header_iter_set_value ()">g_mime_header_iter_set_value</a> (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *value</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="gmime-GMimeHeader.html#g-mime-header-iter-remove" title="g_mime_header_iter_remove ()">g_mime_header_iter_remove</a> (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter</code></em>); +<a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="returnvalue">GMimeHeaderList</span></a> * <a class="link" href="gmime-GMimeHeader.html#g-mime-header-list-new" title="g_mime_header_list_new ()">g_mime_header_list_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +<span class="returnvalue">void</span> <a class="link" href="gmime-GMimeHeader.html#g-mime-header-list-destroy" title="g_mime_header_list_destroy ()">g_mime_header_list_destroy</a> (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gmime-GMimeHeader.html#g-mime-header-list-clear" title="g_mime_header_list_clear ()">g_mime_header_list_clear</a> (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="gmime-GMimeHeader.html#g-mime-header-list-contains" title="g_mime_header_list_contains ()">g_mime_header_list_contains</a> (<em class="parameter"><code>const <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *name</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gmime-GMimeHeader.html#g-mime-header-list-prepend" title="g_mime_header_list_prepend ()">g_mime_header_list_prepend</a> (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</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> *value</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gmime-GMimeHeader.html#g-mime-header-list-append" title="g_mime_header_list_append ()">g_mime_header_list_append</a> (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</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> *value</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="gmime-GMimeHeader.html#g-mime-header-list-remove" title="g_mime_header_list_remove ()">g_mime_header_list_remove</a> (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *name</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gmime-GMimeHeader.html#g-mime-header-list-set" title="g_mime_header_list_set ()">g_mime_header_list_set</a> (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</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> *value</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="gmime-GMimeHeader.html#g-mime-header-list-get" title="g_mime_header_list_get ()">g_mime_header_list_get</a> (<em class="parameter"><code>const <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *name</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="gmime-GMimeHeader.html#g-mime-header-list-get-iter" title="g_mime_header_list_get_iter ()">g_mime_header_list_get_iter</a> (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>, + <em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gmime-GMimeHeader.html#g-mime-header-list-foreach" title="g_mime_header_list_foreach ()">g_mime_header_list_foreach</a> (<em class="parameter"><code>const <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>, + <em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderForeachFunc" title="GMimeHeaderForeachFunc ()"><span class="type">GMimeHeaderForeachFunc</span></a> func</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gmime-GMimeHeader.html#g-mime-header-list-register-writer" title="g_mime_header_list_register_writer ()">g_mime_header_list_register_writer</a> (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *name</code></em>, + <em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderWriter" title="GMimeHeaderWriter ()"><span class="type">GMimeHeaderWriter</span></a> writer</code></em>); +<span class="returnvalue">ssize_t</span> <a class="link" href="gmime-GMimeHeader.html#g-mime-header-list-write-to-stream" title="g_mime_header_list_write_to_stream ()">g_mime_header_list_write_to_stream</a> (<em class="parameter"><code>const <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>); +<span class="returnvalue">char</span> * <a class="link" href="gmime-GMimeHeader.html#g-mime-header-list-to-string" title="g_mime_header_list_to_string ()">g_mime_header_list_to_string</a> (<em class="parameter"><code>const <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>); +<a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> * <a class="link" href="gmime-GMimeHeader.html#g-mime-header-list-get-stream" title="g_mime_header_list_get_stream ()">g_mime_header_list_get_stream</a> (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gmime-GMimeHeader.html#g-mime-header-list-set-stream" title="g_mime_header_list_set_stream ()">g_mime_header_list_set_stream</a> (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="gmime-GMimeHeader.description"></a><h2>Description</h2> +<p> +A <span class="type">GMimeHeader</span> is a collection of rfc822 header fields and their +values. +</p> +</div> +<div class="refsect1"> +<a name="gmime-GMimeHeader.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimeHeaderIter"></a><h3>struct GMimeHeaderIter</h3> +<pre class="programlisting">struct GMimeHeaderIter { + GMimeHeaderList *hdrlist; + GMimeHeader *cursor; + guint32 version; +}; +</pre> +<p> +A message or mime-part header iterator. All members should be +considered private. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *<em class="structfield"><code><a name="GMimeHeaderIter.hdrlist"></a>hdrlist</code></em>;</span></p></td> +<td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="type">GMimeHeader</span> *<em class="structfield"><code><a name="GMimeHeaderIter.cursor"></a>cursor</code></em>;</span></p></td> +<td>a <span class="type">GMimeHeader</span> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="type">guint32</span> <em class="structfield"><code><a name="GMimeHeaderIter.version"></a>version</code></em>;</span></p></td> +<td>the version of <em class="parameter"><code>hdrlist</code></em> when initialized</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="GMimeHeaderList"></a><h3>GMimeHeaderList</h3> +<pre class="programlisting">typedef struct _GMimeHeaderList GMimeHeaderList;</pre> +<p> +A message or mime-part header. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GMimeHeaderWriter"></a><h3>GMimeHeaderWriter ()</h3> +<pre class="programlisting"><span class="returnvalue">ssize_t</span> (*GMimeHeaderWriter) (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</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> *value</code></em>);</pre> +<p> +Function signature for the callback to +<a class="link" href="gmime-GMimeHeader.html#g-mime-header-list-register-writer" title="g_mime_header_list_register_writer ()"><code class="function">g_mime_header_list_register_writer()</code></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td> +<td>The output stream.</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> +<td>The field name.</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> +<td>The field value.</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the number of bytes written or <code class="literal">-1</code> on error.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="GMimeHeaderForeachFunc"></a><h3>GMimeHeaderForeachFunc ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> (*GMimeHeaderForeachFunc) (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *value</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> +<p> +Function signature for the callback to <a class="link" href="gmime-GMimeHeader.html#g-mime-header-list-foreach" title="g_mime_header_list_foreach ()"><code class="function">g_mime_header_list_foreach()</code></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> +<td>The field name.</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> +<td>The field value.</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> +<td>The user-supplied callback data.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-header-iter-new"></a><h3>g_mime_header_iter_new ()</h3> +<pre class="programlisting"><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="returnvalue">GMimeHeaderIter</span></a> * g_mime_header_iter_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Dynamically allocates a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> on the heap. This is +intended for use in language bindings but may also be useful in +applications as well. You must free this iter with +<a class="link" href="gmime-GMimeHeader.html#g-mime-header-iter-free" title="g_mime_header_iter_free ()"><code class="function">g_mime_header_iter_free()</code></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a newly-allocated <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a>.</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-header-iter-free"></a><h3>g_mime_header_iter_free ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_header_iter_free (<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> +Frees a dynamically-allocated <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> as created by +<a class="link" href="gmime-GMimeHeader.html#g-mime-header-iter-new" title="g_mime_header_iter_new ()"><code class="function">g_mime_header_iter_new()</code></a> or <a class="link" href="gmime-GMimeHeader.html#g-mime-header-iter-copy" title="g_mime_header_iter_copy ()"><code class="function">g_mime_header_iter_copy()</code></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><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> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-header-iter-copy"></a><h3>g_mime_header_iter_copy ()</h3> +<pre class="programlisting"><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="returnvalue">GMimeHeaderIter</span></a> * g_mime_header_iter_copy (<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> +Creates a dynamically allocated header iterator as a copy of +<em class="parameter"><code>iter</code></em>. You must free this iter with <a class="link" href="gmime-GMimeHeader.html#g-mime-header-iter-free" title="g_mime_header_iter_free ()"><code class="function">g_mime_header_iter_free()</code></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<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> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a newly-allocated copy of <em class="parameter"><code>iter</code></em>.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-header-iter-copy-to"></a><h3>g_mime_header_iter_copy_to ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_header_iter_copy_to (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *src</code></em>, + <em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *dest</code></em>);</pre> +<p> +Copies <em class="parameter"><code>src</code></em> to <em class="parameter"><code>dest</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>src</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> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>dest</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-header-iter-equal"></a><h3>g_mime_header_iter_equal ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_header_iter_equal (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter1</code></em>, + <em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter2</code></em>);</pre> +<p> +Check that <em class="parameter"><code>iter1</code></em> and <em class="parameter"><code>iter2</code></em> reference the same header. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>iter1</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> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>iter2</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> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> if <em class="parameter"><code>iter1</code></em> and <em class="parameter"><code>iter2</code></em> refer to the same header or +<code class="literal">FALSE</code> otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-header-iter-first"></a><h3>g_mime_header_iter_first ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_header_iter_first (<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> +Updates <em class="parameter"><code>iter</code></em> to point to the first header. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<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> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> on success or <code class="literal">FALSE</code> otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-header-iter-last"></a><h3>g_mime_header_iter_last ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_header_iter_last (<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> +Updates <em class="parameter"><code>iter</code></em> to point to the last header. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<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> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> on success or <code class="literal">FALSE</code> otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-header-iter-next"></a><h3>g_mime_header_iter_next ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_header_iter_next (<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> +Advances to the next header. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<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> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> on success or <code class="literal">FALSE</code> otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-header-iter-prev"></a><h3>g_mime_header_iter_prev ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_header_iter_prev (<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> +Advances to the previous header. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<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> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> on success or <code class="literal">FALSE</code> otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-header-iter-is-valid"></a><h3>g_mime_header_iter_is_valid ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_header_iter_is_valid (<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> +Checks if a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> is valid. An iterator may become +invalid if the <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> that the iterator refers to +changes. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<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> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> if <em class="parameter"><code>iter</code></em> is still valid or <code class="literal">FALSE</code> otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-header-iter-get-name"></a><h3>g_mime_header_iter_get_name ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_header_iter_get_name (<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. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<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> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<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. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<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> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-header-iter-set-value"></a><h3>g_mime_header_iter_set_value ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_header_iter_set_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>, + <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);</pre> +<p> +Sets the current header's value to the new value. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<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> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> +<td>new header value</td> +</tr> +<tr> +<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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-header-iter-remove"></a><h3>g_mime_header_iter_remove ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_header_iter_remove (<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> +Removes the current header and advances to the next header. +</p> +<p> +Note: If you remove the last header in the list, then <em class="parameter"><code>iter</code></em> will +become invalid regardless of whether or not other headers remain. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<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> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> on success or <code class="literal">FALSE</code> otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-header-list-new"></a><h3>g_mime_header_list_new ()</h3> +<pre class="programlisting"><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="returnvalue">GMimeHeaderList</span></a> * g_mime_header_list_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Creates a new <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> object. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a new header list object.</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-header-list-destroy"></a><h3>g_mime_header_list_destroy ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_header_list_destroy (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>);</pre> +<p> +Destroy the header list. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><em class="parameter"><code>headers</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-header-list-clear"></a><h3>g_mime_header_list_clear ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_header_list_clear (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>);</pre> +<p> +Removes all of the headers from the <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</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>headers</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-header-list-contains"></a><h3>g_mime_header_list_contains ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_header_list_contains (<em class="parameter"><code>const <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre> +<p> +Checks whether or not a header exists. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>headers</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> +<td>header name</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> if the specified header exists or <code class="literal">FALSE</code> otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-header-list-prepend"></a><h3>g_mime_header_list_prepend ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_header_list_prepend (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</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> *value</code></em>);</pre> +<p> +Prepends a header. If <em class="parameter"><code>value</code></em> is <code class="literal">NULL</code>, a space will be set aside +for it (useful for setting the order of headers before values can +be obtained for them) otherwise the header will be unset. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>headers</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> +<td>header name</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> +<td>header value</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-header-list-append"></a><h3>g_mime_header_list_append ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_header_list_append (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</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> *value</code></em>);</pre> +<p> +Appends a header. If <em class="parameter"><code>value</code></em> is <code class="literal">NULL</code>, a space will be set aside for it +(useful for setting the order of headers before values can be +obtained for them) otherwise the header will be unset. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>headers</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> +<td>header name</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> +<td>header value</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-header-list-remove"></a><h3>g_mime_header_list_remove ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_header_list_remove (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre> +<p> +Remove the specified header. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>headers</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> +<td>header name</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> if the header was successfully removed or <code class="literal">FALSE</code> if +the specified header could not be found.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-header-list-set"></a><h3>g_mime_header_list_set ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_header_list_set (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</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> *value</code></em>);</pre> +<p> +Set the value of the specified header. If <em class="parameter"><code>value</code></em> is <code class="literal">NULL</code> and the +header, <em class="parameter"><code>name</code></em>, had not been previously set, a space will be set +aside 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: 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> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>headers</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> +<td>header name</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> +<td>header value</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-header-list-get"></a><h3>g_mime_header_list_get ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_header_list_get (<em class="parameter"><code>const <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre> +<p> +Gets the value of the first header with the name requested. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>headers</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> +<td>header name</td> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-header-list-get-iter"></a><h3>g_mime_header_list_get_iter ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_header_list_get_iter (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>, + <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> +Initializes an iterator for traversing <em class="parameter"><code>headers</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>headers</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> +</td> +</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> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a <code class="literal">TRUE</code> if successful or <code class="literal">FALSE</code> if there are no headers to +traverse.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-header-list-foreach"></a><h3>g_mime_header_list_foreach ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_header_list_foreach (<em class="parameter"><code>const <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>, + <em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderForeachFunc" title="GMimeHeaderForeachFunc ()"><span class="type">GMimeHeaderForeachFunc</span></a> func</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> +<p> +Calls <em class="parameter"><code>func</code></em> for each header name/value pair. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>headers</code></em> :</span></p></td> +<td>A <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> +</td> +</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> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> +<td>User data to be passed to the func.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-header-list-register-writer"></a><h3>g_mime_header_list_register_writer ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_header_list_register_writer (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *name</code></em>, + <em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderWriter" title="GMimeHeaderWriter ()"><span class="type">GMimeHeaderWriter</span></a> writer</code></em>);</pre> +<p> +Changes the function used to write <em class="parameter"><code>name</code></em> headers to <em class="parameter"><code>writer</code></em> (or the +default if <em class="parameter"><code>writer</code></em> is <code class="literal">NULL</code>). This is useful if you want to change +the default header folding style for a particular header. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>headers</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> +<td>header name</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>writer</code></em> :</span></p></td> +<td>writer function</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-header-list-write-to-stream"></a><h3>g_mime_header_list_write_to_stream ()</h3> +<pre class="programlisting"><span class="returnvalue">ssize_t</span> g_mime_header_list_write_to_stream (<em class="parameter"><code>const <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>);</pre> +<p> +Write the headers to a stream. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>headers</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td> +<td>output stream</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the number of bytes written or <code class="literal">-1</code> on fail.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-header-list-to-string"></a><h3>g_mime_header_list_to_string ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * g_mime_header_list_to_string (<em class="parameter"><code>const <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>);</pre> +<p> +Allocates a string buffer containing the raw rfc822 headers +contained in <em class="parameter"><code>headers</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>headers</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a string containing the header block.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-header-list-get-stream"></a><h3>g_mime_header_list_get_stream ()</h3> +<pre class="programlisting"><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> * g_mime_header_list_get_stream (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>);</pre> +<p> +Gets the raw stream representing <em class="parameter"><code>headers</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>headers</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</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="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> if set or <code class="literal">NULL</code> otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-header-list-set-stream"></a><h3>g_mime_header_list_set_stream ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_header_list_set_stream (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>, + <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>);</pre> +<p> +Set the raw header stream. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>headers</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> +</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="gmime-GMimeHeader.see-also"></a><h2>See Also</h2> +<a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/gmime-GMimeParam.html b/docs/reference/html/gmime-GMimeParam.html new file mode 100644 index 0000000..df61193 --- /dev/null +++ b/docs/reference/html/gmime-GMimeParam.html @@ -0,0 +1,325 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimeParam</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="Headers.html" title="Message and MIME Headers"> +<link rel="prev" href="GMimeContentDisposition.html" title="GMimeContentDisposition"> +<link rel="next" href="InternetAddresses.html" title="Internet Addresses"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="GMimeContentDisposition.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="Headers.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="InternetAddresses.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#gmime-GMimeParam.synopsis" class="shortcut">Top</a> +  | + <a href="#gmime-GMimeParam.description" class="shortcut">Description</a> +</td></tr> +</table> +<div class="refentry"> +<a name="gmime-GMimeParam"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="gmime-GMimeParam.top_of_page"></a>GMimeParam</span></h2> +<p>GMimeParam — Content-Type and Content-Disposition parameters</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="gmime-GMimeParam.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">struct <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam">GMimeParam</a>; +<a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="returnvalue">GMimeParam</span></a> * <a class="link" href="gmime-GMimeParam.html#g-mime-param-new" title="g_mime_param_new ()">g_mime_param_new</a> (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *value</code></em>); +<a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="returnvalue">GMimeParam</span></a> * <a class="link" href="gmime-GMimeParam.html#g-mime-param-new-from-string" title="g_mime_param_new_from_string ()">g_mime_param_new_from_string</a> (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gmime-GMimeParam.html#g-mime-param-destroy" title="g_mime_param_destroy ()">g_mime_param_destroy</a> (<em class="parameter"><code><a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> *param</code></em>); +const <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="returnvalue">GMimeParam</span></a> * <a class="link" href="gmime-GMimeParam.html#g-mime-param-next" title="g_mime_param_next ()">g_mime_param_next</a> (<em class="parameter"><code>const <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> *param</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="gmime-GMimeParam.html#g-mime-param-get-name" title="g_mime_param_get_name ()">g_mime_param_get_name</a> (<em class="parameter"><code>const <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> *param</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="gmime-GMimeParam.html#g-mime-param-get-value" title="g_mime_param_get_value ()">g_mime_param_get_value</a> (<em class="parameter"><code>const <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> *param</code></em>); +<a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="returnvalue">GMimeParam</span></a> * <a class="link" href="gmime-GMimeParam.html#g-mime-param-append" title="g_mime_param_append ()">g_mime_param_append</a> (<em class="parameter"><code><a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> *params</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> *value</code></em>); +<a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="returnvalue">GMimeParam</span></a> * <a class="link" href="gmime-GMimeParam.html#g-mime-param-append-param" title="g_mime_param_append_param ()">g_mime_param_append_param</a> (<em class="parameter"><code><a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> *params</code></em>, + <em class="parameter"><code><a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> *param</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gmime-GMimeParam.html#g-mime-param-write-to-string" title="g_mime_param_write_to_string ()">g_mime_param_write_to_string</a> (<em class="parameter"><code>const <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> *param</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> fold</code></em>, + <em class="parameter"><code><span class="type">GString</span> *str</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="gmime-GMimeParam.description"></a><h2>Description</h2> +<p> +A <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> is a parameter name/value pair as found on MIME +header fields such as Content-Type and Content-Disposition. +</p> +</div> +<div class="refsect1"> +<a name="gmime-GMimeParam.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimeParam"></a><h3>struct GMimeParam</h3> +<pre class="programlisting">struct GMimeParam { + GMimeParam *next; + char *name; + char *value; +}; +</pre> +<p> +A parameter name/value pair as used for some Content header fields. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> *<em class="structfield"><code><a name="GMimeParam.next"></a>next</code></em>;</span></p></td> +<td>Pointer to the next param.</td> +</tr> +<tr> +<td><p><span class="term"><span class="type">char</span> *<em class="structfield"><code><a name="GMimeParam.name"></a>name</code></em>;</span></p></td> +<td>Parameter name.</td> +</tr> +<tr> +<td><p><span class="term"><span class="type">char</span> *<em class="structfield"><code><a name="GMimeParam.value"></a>value</code></em>;</span></p></td> +<td>Parameter value.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-param-new"></a><h3>g_mime_param_new ()</h3> +<pre class="programlisting"><a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="returnvalue">GMimeParam</span></a> * g_mime_param_new (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);</pre> +<p> +Creates a new <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> node with name <em class="parameter"><code>name</code></em> and value <em class="parameter"><code>value</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>name</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> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a new paramter structure.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-param-new-from-string"></a><h3>g_mime_param_new_from_string ()</h3> +<pre class="programlisting"><a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="returnvalue">GMimeParam</span></a> * g_mime_param_new_from_string (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>);</pre> +<p> +Creates a parameter list based on the input string. +</p> +<div class="variablelist"><table border="0"> +<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> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> structure based on <em class="parameter"><code>string</code></em>.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-param-destroy"></a><h3>g_mime_param_destroy ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_param_destroy (<em class="parameter"><code><a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> *param</code></em>);</pre> +<p> +Releases all memory used by this mime param back to the Operating +System. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><em class="parameter"><code>param</code></em> :</span></p></td> +<td>Mime param list to destroy</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-param-next"></a><h3>g_mime_param_next ()</h3> +<pre class="programlisting">const <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="returnvalue">GMimeParam</span></a> * g_mime_param_next (<em class="parameter"><code>const <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> *param</code></em>);</pre> +<p> +Gets the next <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> node in the list. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>param</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> node</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the next <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> node in the list.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-param-get-name"></a><h3>g_mime_param_get_name ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_param_get_name (<em class="parameter"><code>const <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> *param</code></em>);</pre> +<p> +Gets the name of the parameter. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>param</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the name of the parameter.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-param-get-value"></a><h3>g_mime_param_get_value ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_param_get_value (<em class="parameter"><code>const <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> *param</code></em>);</pre> +<p> +Gets the value of the parameter. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>param</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the value of the parameter.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-param-append"></a><h3>g_mime_param_append ()</h3> +<pre class="programlisting"><a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="returnvalue">GMimeParam</span></a> * g_mime_param_append (<em class="parameter"><code><a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> *params</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> *value</code></em>);</pre> +<p> +Appends a new parameter with name <em class="parameter"><code>name</code></em> and value <em class="parameter"><code>value</code></em> to the +parameter list <em class="parameter"><code>params</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>params</code></em> :</span></p></td> +<td>param list</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> +<td>new param name</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> +<td>new param value</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a param list with the new param of name <em class="parameter"><code>name</code></em> and value +<em class="parameter"><code>value</code></em> appended to the list of params <em class="parameter"><code>params</code></em>.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-param-append-param"></a><h3>g_mime_param_append_param ()</h3> +<pre class="programlisting"><a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="returnvalue">GMimeParam</span></a> * g_mime_param_append_param (<em class="parameter"><code><a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> *params</code></em>, + <em class="parameter"><code><a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> *param</code></em>);</pre> +<p> +Appends <em class="parameter"><code>param</code></em> to the param list <em class="parameter"><code>params</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>params</code></em> :</span></p></td> +<td>param list</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>param</code></em> :</span></p></td> +<td>param to append</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a param list with the new param <em class="parameter"><code>param</code></em> appended to the list +of params <em class="parameter"><code>params</code></em>.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-param-write-to-string"></a><h3>g_mime_param_write_to_string ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_param_write_to_string (<em class="parameter"><code>const <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> *param</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> fold</code></em>, + <em class="parameter"><code><span class="type">GString</span> *str</code></em>);</pre> +<p> +Assumes the output string contains only the Content-* header and +it's immediate value. +</p> +<p> +Writes the params out to the string <em class="parameter"><code>string</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>param</code></em> :</span></p></td> +<td>MIME Param list</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>fold</code></em> :</span></p></td> +<td>specifies whether or not to fold headers</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td> +<td>output string</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="gmime-GMimeParam.see-also"></a><h2>See Also</h2> +<a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/gmime-GMimePartIter.html b/docs/reference/html/gmime-GMimePartIter.html new file mode 100644 index 0000000..3e949c6 --- /dev/null +++ b/docs/reference/html/gmime-GMimePartIter.html @@ -0,0 +1,388 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMimePartIter</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="MimeParts.html" title="MIME Messages and Parts"> +<link rel="prev" href="GMimeMessagePartial.html" title="GMimeMessagePartial"> +<link rel="next" href="Parsers.html" title="Parsing Messages and MIME Parts"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="GMimeMessagePartial.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="MimeParts.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="Parsers.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#gmime-GMimePartIter.synopsis" class="shortcut">Top</a> +  | + <a href="#gmime-GMimePartIter.description" class="shortcut">Description</a> +</td></tr> +</table> +<div class="refentry"> +<a name="gmime-GMimePartIter"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="gmime-GMimePartIter.top_of_page"></a>GMimePartIter</span></h2> +<p>GMimePartIter — MIME part iterators</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="gmime-GMimePartIter.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis"> <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter">GMimePartIter</a>; +<a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="returnvalue">GMimePartIter</span></a> * <a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-new" title="g_mime_part_iter_new ()">g_mime_part_iter_new</a> (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *toplevel</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-free" title="g_mime_part_iter_free ()">g_mime_part_iter_free</a> (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-reset" title="g_mime_part_iter_reset ()">g_mime_part_iter_reset</a> (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-jump-to" title="g_mime_part_iter_jump_to ()">g_mime_part_iter_jump_to</a> (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *path</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-is-valid" title="g_mime_part_iter_is_valid ()">g_mime_part_iter_is_valid</a> (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-next" title="g_mime_part_iter_next ()">g_mime_part_iter_next</a> (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-prev" title="g_mime_part_iter_prev ()">g_mime_part_iter_prev</a> (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>); +<a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> * <a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-get-toplevel" title="g_mime_part_iter_get_toplevel ()">g_mime_part_iter_get_toplevel</a> (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>); +<a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> * <a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-get-current" title="g_mime_part_iter_get_current ()">g_mime_part_iter_get_current</a> (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>); +<a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> * <a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-get-parent" title="g_mime_part_iter_get_parent ()">g_mime_part_iter_get_parent</a> (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>); +<span class="returnvalue">char</span> * <a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-get-path" title="g_mime_part_iter_get_path ()">g_mime_part_iter_get_path</a> (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-replace" title="g_mime_part_iter_replace ()">g_mime_part_iter_replace</a> (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>, + <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *replacement</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-remove" title="g_mime_part_iter_remove ()">g_mime_part_iter_remove</a> (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="gmime-GMimePartIter.description"></a><h2>Description</h2> +<p> +<a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> is an iterator for traversing a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> tree in +Depth-First order. +</p> +</div> +<div class="refsect1"> +<a name="gmime-GMimePartIter.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimePartIter"></a><h3>GMimePartIter</h3> +<pre class="programlisting">typedef struct _GMimePartIter GMimePartIter;</pre> +<p> +A MIME part iterator. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-part-iter-new"></a><h3>g_mime_part_iter_new ()</h3> +<pre class="programlisting"><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="returnvalue">GMimePartIter</span></a> * g_mime_part_iter_new (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *toplevel</code></em>);</pre> +<p> +Creates a new <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> for iterating over <em class="parameter"><code>toplevel</code></em>'s subparts. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>toplevel</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> to use as the toplevel</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="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> which should be freed +using <a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-free" title="g_mime_part_iter_free ()"><code class="function">g_mime_part_iter_free()</code></a> when finished with it.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-part-iter-free"></a><h3>g_mime_part_iter_free ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_part_iter_free (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>);</pre> +<p> +Frees the memory allocated by <a class="link" href="gmime-GMimePartIter.html#g-mime-part-iter-new" title="g_mime_part_iter_new ()"><code class="function">g_mime_part_iter_new()</code></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-part-iter-reset"></a><h3>g_mime_part_iter_reset ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_part_iter_reset (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>);</pre> +<p> +Resets the state of <em class="parameter"><code>iter</code></em> to its initial state. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-part-iter-jump-to"></a><h3>g_mime_part_iter_jump_to ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_part_iter_jump_to (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *path</code></em>);</pre> +<p> +Updates the state of <em class="parameter"><code>iter</code></em> to point to the <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> specified +by <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>iter</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td> +<td>a string representing the path to jump to</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> if the <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> specified by <em class="parameter"><code>path</code></em> exists or +<code class="literal">FALSE</code> otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-part-iter-is-valid"></a><h3>g_mime_part_iter_is_valid ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_part_iter_is_valid (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>);</pre> +<p> +Checks that the current state of <em class="parameter"><code>iter</code></em> is valid. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> if <em class="parameter"><code>iter</code></em> is valid or <code class="literal">FALSE</code> otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-part-iter-next"></a><h3>g_mime_part_iter_next ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_part_iter_next (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>);</pre> +<p> +Advances to the next part in the MIME structure used to initialize +<em class="parameter"><code>iter</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>iter</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> if successful or <code class="literal">FALSE</code> otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-part-iter-prev"></a><h3>g_mime_part_iter_prev ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_part_iter_prev (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>);</pre> +<p> +Rewinds to the previous part in the MIME structure used to +initialize <em class="parameter"><code>iter</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>iter</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> if successful or <code class="literal">FALSE</code> otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-part-iter-get-toplevel"></a><h3>g_mime_part_iter_get_toplevel ()</h3> +<pre class="programlisting"><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> * g_mime_part_iter_get_toplevel (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>);</pre> +<p> +Gets the toplevel <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> used to initialize <em class="parameter"><code>iter</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>iter</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> +</td> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-part-iter-get-current"></a><h3>g_mime_part_iter_get_current ()</h3> +<pre class="programlisting"><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> * g_mime_part_iter_get_current (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>);</pre> +<p> +Gets the <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> at the current <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> position. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> +</td> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-part-iter-get-parent"></a><h3>g_mime_part_iter_get_parent ()</h3> +<pre class="programlisting"><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> * g_mime_part_iter_get_parent (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>);</pre> +<p> +Gets the parent of the <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> at the current <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> +position. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> +</td> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-part-iter-get-path"></a><h3>g_mime_part_iter_get_path ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * g_mime_part_iter_get_path (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>);</pre> +<p> +Gets the path of the current <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> in the MIME structure +used to initialize <em class="parameter"><code>iter</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>iter</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a newly allocated string representation of the path to the +<a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> at the current <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> position.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-part-iter-replace"></a><h3>g_mime_part_iter_replace ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_part_iter_replace (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>, + <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *replacement</code></em>);</pre> +<p> +Replaces the <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> at the current position with <em class="parameter"><code>replacement</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>iter</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>replacement</code></em> :</span></p></td> +<td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> if the part at the current position was replaced or +<code class="literal">FALSE</code> otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-part-iter-remove"></a><h3>g_mime_part_iter_remove ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_part_iter_remove (<em class="parameter"><code><a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> *iter</code></em>);</pre> +<p> +Removes the <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> at the current position from its +parent. If successful, <em class="parameter"><code>iter</code></em> is advanced to the next position +(since the current position will become invalid). +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-GMimePartIter.html#GMimePartIter" title="GMimePartIter"><span class="type">GMimePartIter</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> if the part at the current position was removed or +<code class="literal">FALSE</code> otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="gmime-GMimePartIter.see-also"></a><h2>See Also</h2> +<a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/gmime-building.html b/docs/reference/html/gmime-building.html new file mode 100644 index 0000000..977ebf4 --- /dev/null +++ b/docs/reference/html/gmime-building.html @@ -0,0 +1,284 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Compiling the GMime libraries</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="gmime.html" title="Part I. GMime Overview"> +<link rel="prev" href="gmime.html" title="Part I. GMime Overview"> +<link rel="next" href="gmime-compiling.html" title="Compiling GMime Applications"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="gmime.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="gmime.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="gmime-compiling.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="gmime-building"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle">Compiling the GMime libraries</span></h2> +<p>Compiling the GMime Libraries — How to compile GMime itself</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="overview"></a><h2>Building GMime on UNIX-like systems</h2> +<p> + This chapter covers building and installing GMime on UNIX and + UNIX-like systems such as Linux. Compiling GMime on Microsoft + Windows is not a goal of the project, however if you are able + build on a Microsoft Windows platform, do send me building and + installing instructions and I will add them to this document. + </p> +<p> + Before we get into the details of how to compile GMime, I should + mention that binary packages of GMime prebuilt for your operating + system may be available either from your operating system vendor + or from independent sources such as http://rpmfind.net. If you + can find them, it may be the easiest way of getting started + developing GMime. + </p> +<p> + On UNIX-like systems GMime uses the standard GNU build system, + using <span class="application">autoconf</span> for package + configuration and resolving portability issues, + <span class="application">automake</span> for building makefiles that + comply with the GNU Coding Standards, and + <span class="application">libtool</span> for building shared libraries + on multiple platforms. + </p> +<p> + If you are building GMime from the distributed source packages, + then you won't need these tools installed; the necessary pieces + of the tools are already included in the source packages. But + it's useful to know a bit about how packages that use these + tools work. A source package is distributed as a + <code class="literal">tar.gz</code> file which you unpack into a + directory full of the source files as follows: + </p> +<pre class="programlisting"> + tar -zxvf gmime-2.6.x.tar.gz + </pre> +<p> + In the toplevel of the directory that is created, there will be + a shell script called <code class="filename">configure</code> which + you then run to take the template makefiles called + <code class="filename">Makefile.in</code> in the package and create + makefiles customized for your operating system. The + <code class="filename">configure</code> script can be passed various + command line arguments to determine how the package is built and + installed. The most commonly useful argument is the + <code class="systemitem">--prefix</code> argument which specifies where + the package is installed. To install a package into + <code class="filename">/opt/gmime</code> you would run configure as: + </p> +<pre class="programlisting"> + ./configure --prefix=/opt/gmime + </pre> +<p> + A full list of options can be found by running + <code class="filename">configure</code> with the + <code class="systemitem">--help</code> argument. In general, the defaults + are right and should be trusted. After you've run + <code class="filename">configure</code>, you then run the + <span class="command"><strong>make</strong></span> command to build the package and install + it. + </p> +<pre class="programlisting"> + make + make install + </pre> +<p> + If you don't have permission to write to the directory you are + installing in, you may have to change to root temporarily before + running <code class="literal">make install</code>. A quick way to do this is + to use the <span class="command"><strong>su</strong></span> command with the + <code class="systemitem">-c</code> option + (ex. <code class="literal">su -c "make install"</code>). Also, if you are + installing in a system directory, on some systems (such as + Linux), you will need to run <span class="command"><strong>ldconfig</strong></span> after + <code class="literal">make install</code> so that the newly installed + libraries will be found. + </p> +<p> + Several environment variables are useful to pass to set before + running configure. <code class="envar">CPPFLAGS</code> contains options to + pass to the C compiler, and is used to tell the compiler where + to look for include files. The <code class="envar">LDFLAGS</code> variable + is used in a similar fashion for the linker. Finally the + <code class="envar">PKG_CONFIG_PATH</code> environment variable contains + a search path that <span class="command"><strong>pkg-config</strong></span> (see below) + uses when looking for a file describing how to compile + programs using different libraries. If you were installing GMime + and it's dependencies into <code class="filename">/opt/gmime</code>, you + might want to set these variables as: + </p> +<pre class="programlisting"> + CPPFLAGS="-I/opt/gmime/include" + LDFLAGS="-L/opt/gmime/lib" + PKG_CONFIG_PATH="/opt/gmime/lib/pkgconfig" + export CPPFLAGS LDFLAGS PKG_CONFIG_PATH + </pre> +<p> + You may also need to set the <code class="envar">LD_LIBRARY_PATH</code> + environment variable so the systems dynamic linker can find + the newly installed libraries, and the <code class="envar">PATH</code> + environment program so that utility binaries installed by + the various libraries will be found. + </p> +<pre class="programlisting"> + LD_LIBRARY_PATH="/opt/gmime/lib" + PATH="/opt/gmime/bin:$PATH" + export LD_LIBRARY_PATH PATH + </pre> +</div> +<div class="refsect1"> +<a name="dependencies"></a><h2>Dependencies</h2> +<p> + Before you can compile the GMime library, you need to have + various other tools and libraries installed on your + system. The two tools needed during the build process (as + differentiated from the tools used in when creating GMime + mentioned above such as <span class="application">autoconf</span>) + are <span class="command"><strong>pkg-config</strong></span> and GNU make. + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"><p><a class="ulink" href="http://www.freedesktop.org/software/pkgconfig/" target="_top">pkg-config</a> + is a tool for tracking the compilation flags needed for + libraries that are used by the GMime libraries. (For each + library, a small <code class="literal">.pc</code> text file is installed in a standard + location that contains the compilation flags needed for that + library along with version number information.) The version + of <span class="command"><strong>pkg-config</strong></span> needed to build GMime is + mirrored in the <code class="filename">dependencies</code> directory + on the <a class="ulink" href="ftp://ftp.gtk.org/pub/gtk/v2.0/" target="_top">GTK+ FTP + site.</a></p></li> +<li class="listitem"><p> + The GMime makefiles will mostly work with different versions + of <span class="command"><strong>make</strong></span>, however, there tends to be + a few incompatibilities, so the GMime team recommends + installing <a class="ulink" href="http://www.gnu.org/software/make" target="_top">GNU + make</a> if you don't already have it on your system + and using it. (It may be called <span class="command"><strong>gmake</strong></span> + rather than <span class="command"><strong>make</strong></span>.) + </p></li> +</ul></div> +<p> + GMime depends on the existance of two (2) libraries: GLib and iconv. + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"><p> + The GLib library provides core non-graphical functionality + such as high level data types, Unicode manipulation, and + a object and type system to C programs. It is available + from the <a class="ulink" href="ftp://ftp.gtk.org/pub/gtk/v2.0/" target="_top">GTK+ + FTP site.</a> + </p></li> +<li class="listitem"><p> + The <a class="ulink" href="http://www.gnu.org/software/libiconv/" target="_top">GNU + libiconv library</a> is needed to build GLib and GMime + if your system doesn't already have the + <code class="function">iconv()</code> function for doing conversion + between character encodings. Most modern systems should have + <code class="function">iconv()</code>. + </p></li> +</ul></div> +</div> +<div class="refsect1"> +<a name="building"></a><h2>Building and testing GMime</h2> +<p> + First make sure that you have the necessary external + dependencies installed: <span class="command"><strong>pkg-config</strong></span>, GNU make, + and, if necessary, libiconv. To get detailed information about + building these packages, see the documentation provided with the + individual packages. On a newer Linux system, it's quite likely + that you'll have all of these installed already. + </p> +<p> + Then build and install the GMime libraries in the order: + libiconv, GLib, then GMime. For each library, follow the + steps of <code class="literal">configure</code>, <code class="literal">make</code>, + <code class="literal">make install</code> mentioned above. If you're + lucky, this will all go smoothly, and you'll be ready to + <a class="link" href="gmime-compiling.html" title="Compiling GMime Applications">start compiling your own GMime + applications</a>. You can test your GMime installation + by running <span class="command"><strong>pkg-config --modversion gmime-2.6</strong></span> + and making sure that it can both find GMime and reports the + correct version. + </p> +<p> + If one of the <code class="filename">configure</code> scripts fails or running + <span class="command"><strong>make</strong></span> fails, look closely at the error + messages printed; these will often provide useful information + as to what went wrong. When <code class="filename">configure</code> + fails, extra information, such as errors that a test compilation + ran into, is found in the file <code class="filename">config.log</code>. + Looking at the last couple of hundred lines in this file will + frequently make clear what went wrong. If all else fails, you + can ask for help by emailing me, fejj@gnome.org + </p> +</div> +<div class="refsect1"> +<a name="extra-configuration-options"></a><h2>Extra Configuration Options</h2> +<p> + In addition to the normal options, the + <span class="command"><strong>configure</strong></span> script for the GMime library + supports a number of additional arguments. (Command line + arguments for the other GMime libraries are described in + the documentation distributed with those libraries.) + + </p> +<div class="cmdsynopsis"><p><code class="command">./configure</code> [[--enable-profiling] | [--enable-warnings] | [--enable-mono] | [--enable-gtk-doc] | [--enable-largfile]]</p></div> +<p> + </p> +<p><b> + <code class="systemitem">--enable-profiling</code> + . </b> + Normally GMime will not pass the <code class="literal">-pg</code> flag to + <span class="command"><strong>gcc</strong></span> when building. This option will enable + the use of that flag thus building profiling information into + the GMime libraries for use with the GNU Profiler, gprof. Odds + are you do not care about this option unless you are either me + or desire to profile GMime and/or your program. + </p> +<p><b> + <code class="systemitem">--enable-warnings</code> + . </b> + This option enables parser warnings about invalid MIME to be + logged to stderr at runtime. Again, it is unlikely you will + care to use this option. + </p> +<p><b> + <code class="systemitem">--enable-mono</code> + . </b> + This option will include the Mono .NET bindings as part of + the build. + </p> +<p><b> + <code class="systemitem">--enable-gtk-doc</code> + . </b> + This option will enable the building of the reference + documentation for GMime (e.g. the html pages you are + reading now). + </p> +<p><b> + <code class="systemitem">--enable-largefile</code> + . </b> + This option will enable large file support (e.g. files larger + than 2GB) on 32bit systems. This flag is enabled by default + starting with GMime 2.4.5. + </p> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/gmime-changes-2-0.html b/docs/reference/html/gmime-changes-2-0.html new file mode 100644 index 0000000..7eea5ff --- /dev/null +++ b/docs/reference/html/gmime-changes-2-0.html @@ -0,0 +1,135 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Changes from 1.0 to 2.0</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="gmime.html" title="Part I. GMime Overview"> +<link rel="prev" href="gmime-compiling.html" title="Compiling GMime Applications"> +<link rel="next" href="gmime-changes-2-2.html" title="Changes from 2.0 to 2.2"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="gmime-compiling.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="gmime.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="gmime-changes-2-2.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="gmime-changes-2-0"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle">Changes from 1.0 to 2.0</span></h2> +<p>Changes from 1.0 to 2.0 — +Incompatible changes made between version 1.0 and version 2.0 +</p> +</td> +<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> +<p> +See also the PORTING document in the toplevel GMime source directory. +</p> +<p> +The major change here is that I've dropped my own base object class +and have replaced it with GObject from glib-2.0. This should be a +pleasant change since you (the developer) will now be able to do many +more things such as setting arbitrary data on all GMime objects. For +additional information about GObject, please see the GObject Reference +Manual at http://developer.gnome.org/doc/API/2.0/gobject/ +</p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"><p> +The first thing you need to know is that any function returning a +non-const pointer to any object /must/ be unref'd when you are done +with it. Since all objects in GMime now subclass GObject, you may +safely use <code class="function">g_object_unref()</code> +(<span class="structname">GMimeStream</span>'s may also be unref'd using +<code class="function">g_mime_stream_unref()</code>, but either way is fine). + +Don't forget that +<code class="function">g_mime_part_get_content_object()</code> returns a +ref-counted <span class="structname">GMimeDataWrapper</span> object now, and +so you /must/ unref it when you have finished using it. You must also +remember to unref any GMimeDataWrapper object that you /set/ on a +GMimePart using <code class="function">g_mime_part_set_content_object()</code> +as the GMimePart will now ref the content object that you set on it. +</p></li> +<li class="listitem"><p><span class="structname">GMimeMultipart</span> is a new class which is to be +used for all multipart MIME parts rather than GMimePart (as in +1.0). There are also some subclasses of GMimeMultipart for other +things. +</p></li> +<li class="listitem"><p><code class="function">g_mime_part_[g,s]et_boundary()</code> have been removed +(see above). You must now create a GMimeMultipart object and use +<code class="function">g_mime_multipart_[g,s]et_boundary()</code>. +</p></li> +<li class="listitem"><p><code class="function">g_mime_part_add_subpart()</code> has been replaced with +<code class="function">g_mime_multipart_add_part()</code>. +</p></li> +<li class="listitem"><p><code class="function">g_mime_part_foreach()</code> has been replaced with +<code class="function">g_mime_multipart_foreach()</code> and/or +<code class="function">g_mime_message_foreach_part()</code>. +</p></li> +<li class="listitem"><p><code class="function">g_mime_part_get_subpart_from_content_id()</code> has +been replaced with +<code class="function">g_mime_multipart_get_subpart_from_content_id()</code>. +</p></li> +<li class="listitem"><p> +Another new class is <span class="structname">GMimeMessagePart</span> which +is to be used for all MIME parts containing an rfc822 message. All 1.0 +GMimePart's representing message/rfc822 parts (as well as message/news +parts?) need to be migrated over to be GMimeMessagePart objects. +</p></li> +<li class="listitem"><p><span class="structname">GMimeMessagePartial</span> is another class meant +for handling the message/partial MIME type. All 1.0 GMimePart's +holding data of this type should be replaced with GMimeMessagePartial +objects. +</p></li> +<li class="listitem"><p><code class="function">g_mime_message_write_to_stream()</code> and +<code class="function">g_mime_part_write_to_stream()</code> functions have been +consolidated into a virtual method. Replace calls to these functions +with <code class="function">g_mime_object_write_to_stream()</code>. Note: while +<code class="function">g_mime_part_write_to_stream()</code> and +<code class="function">g_mime_message_write_to_stream()</code> still exist, it +is suggested you migrate to +<code class="function">g_mime_object_write_to_stream()</code>. Same goes for +<code class="function">g_mime_part_to_string()</code> and +<code class="function">g_mime_message_to_string()</code>. +</p></li> +<li class="listitem"><p><span class="structname">GMimeMessage</span>'s structure has changed a +bit. You will not be able to do <code class="literal">message->header</code>, +instead you want to do <code class="literal">((GMimeObject *) +message)->header</code>. +</p></li> +<li class="listitem"><p><code class="function">g_mime_message_set_message_id()</code> now takes a +message_id argument without the encapsulating < and >'s (it now +just takes the addr-spec portion of the msg-id). +</p></li> +<li class="listitem"><p><span class="structname">GMimeFilterFrom</span> has changed slightly, you +will want to replace all calls to +<code class="function">g_mime_filter_from_new()</code> with +<code class="function">g_mime_filter_from_new +(GMIME_FILTER_FROM_MODE_DEFAULT)</code> +(<code class="literal">GMIME_FILTER_FROM_MODE_DEFAULT</code> is equivalent to (<span class="type">int</span>) 0). +</p></li> +<li class="listitem"><p><span class="structname">GMimeParser</span> is a brand new class and +<code class="filename">gmime-parser.h</code> has had a number of API additions. +<code class="function">g_mime_parser_construct_part()</code> and +<code class="function">g_mime_parser_construct_message()</code> still exist, +however they no longer take a GMimeStream argument. Instead, they take +a GMimeParser object. +</p></li> +</ul></div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/gmime-changes-2-2.html b/docs/reference/html/gmime-changes-2-2.html new file mode 100644 index 0000000..b433704 --- /dev/null +++ b/docs/reference/html/gmime-changes-2-2.html @@ -0,0 +1,91 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Changes from 2.0 to 2.2</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="gmime.html" title="Part I. GMime Overview"> +<link rel="prev" href="gmime-changes-2-0.html" title="Changes from 1.0 to 2.0"> +<link rel="next" href="gmime-changes-2-4.html" title="Changes from 2.2 to 2.4"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="gmime-changes-2-0.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="gmime.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="gmime-changes-2-4.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="gmime-changes-2-2"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle">Changes from 2.0 to 2.2</span></h2> +<p>Changes from 2.0 to 2.2 — Incompatible changes made between version 2.0 and version 2.2</p> +</td> +<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> +<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 +that any program written for GMime 2.0 will compile fine with GMime +2.2 and any program linked against GMime 2.0's libraries will also +work with GMime 2.2's libraries.</p> +<p>Most of the changes made between 2.0 and 2.2 were internal but there +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> +<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 +into 2 functions. We now have +<code class="function">g_mime_utils_header_decode_text()</code> and +<code class="function">g_mime_utils_header_decode_phrase()</code>. +<code class="function">g_mime_utils_header_decode_text()</code> no longer +requires encoded-words to be rfc822 atoms. +<code class="function">g_mime_utils_header_decode_phrase()</code> is +still strict in that encoded-words MUST be valid rfc822 atoms.</p></li> +<li class="listitem"><p> +<code class="function">g_mime_utils_8bit_header_encode()</code> has been +renamed to <code class="function">g_mime_utils_header_encode_text()</code> to +be more clear as to what type of header this is supposed to encode. If +you haven't guessed, this function is for encoding rfc822 'text' +headers (such as Subject).</p></li> +<li class="listitem"><p> +<code class="function">g_mime_utils_8bit_header_encode_phrase()</code> has been +renamed to <code class="function">g_mime_utils_header_encode_phrase()</code> +mostly for consistancy with the previous 2 changes.</p></li> +<li class="listitem"><p> +<code class="function">g_mime_charset_name()</code> has been renamed to +<code class="function">g_mime_charset_iconv_name()</code> for clarity.</p></li> +<li class="listitem"><p> +<code class="function">g_mime_charset_locale_name()</code> has been renamed to +<code class="function">g_mime_locale_charset()</code>.</p></li> +<li class="listitem"><p> +<code class="function">g_mime_cipher_context_verify()</code> no longer returns +a <span class="structname">GMimeCipherValidity</span>, instead it returns a +<span class="structname">GMimeSignatureValidity</span> which is far more +useful. Never fear, you may still use the +<span class="structname">GMimeCipherValidity</span> APIs for the time being - +they work fine given a <span class="structname">GMimeSignatureValidity</span> +structure.</p></li> +<li class="listitem"><p> +<code class="function">g_mime_multipart_signed_verify()</code> also now returns +a <span class="structname">GMimeSignatureValidity</span> structure rather than +a <span class="structname">GMimeCipherValidity</span> structure. See changes to +<code class="function">g_mime_cipher_context_verify()</code> for details.</p></li> +</ul></div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/gmime-changes-2-4.html b/docs/reference/html/gmime-changes-2-4.html new file mode 100644 index 0000000..4ae5345 --- /dev/null +++ b/docs/reference/html/gmime-changes-2-4.html @@ -0,0 +1,82 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Changes from 2.2 to 2.4</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="gmime.html" title="Part I. GMime Overview"> +<link rel="prev" href="gmime-changes-2-2.html" title="Changes from 2.0 to 2.2"> +<link rel="next" href="gmime-changes-2-6.html" title="Changes from 2.4 to 2.6"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="gmime-changes-2-2.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="gmime.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="gmime-changes-2-6.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="gmime-changes-2-4"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle">Changes from 2.2 to 2.4</span></h2> +<p>Changes from 2.2 to 2.4 — Changes made between version 2.2 and version 2.4</p> +</td> +<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> +<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 +not large file support is enabled.</p> +<p>In addition, all of the functions marked as deprecated in +2.0 and 2.2 were removed (usually they had equivalent functionality in +a parent class).</p> +<p>Many functions have also been renamed for better clarity +and/or consistency. For convenience, GMime 2.4 source packages include +a shell-script to aid in porting applications using GMime 2.2 (should +work for most GMime 2.0 applications as well) to the 2.4 API. You can +find this script under the tools/ directory, named +`gmime-port-2-2-to-2-4.sh'.</p> +<p>This script won't fix everything, but it should help quite a +bit.</p> +<p>Beyond that, a few methods have changed in other ways:</p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"><p><code class="function">g_mime_cipher_context_sign()</code> + still returns int, but if the value isn't -1 (failure), then it will + represent a GMimeCipherHash that it used for signing. This is + useful, for example, when the requested hash was + GMIME_CIPHER_HASH_DEFAULT.</p></li> +<li class="listitem"><p><code class="function">g_mime_cipher_context_decrypt()</code> + now returns a GMimeSignatureValidty on success and NULL on + failure. This is needed in case the encrypted stream was also + signed.</p></li> +<li class="listitem"><p><code class="function">g_mime_multipart_encrypted_encrypt()</code> + now takes a boolean 'sign' argument to allow the caller to request + encrypting and signing in a single pass.</p></li> +</ul></div> +<p>Several structs have also been rewritten to subclass GObject like +GMimeContentType and GMimeContentDisposition as well as +InternetAddress and InternetAddressList.</p> +<p>Not only have InternetAddress and InternetAddressList been ported to +GObject, but they have also undergone other design +changes. InternetAddress is now a base class for +InternetAddressMailbox and InternetAddressGroup, meaning that +InternetAddress no longer contains a union for group/addr fields.</p> +<p>All functions that return a GObject have been changed to not add a ref +to the object returned, meaning that it is no longer necessary to call +g_object_unref() on MIME parts returned from functions like +g_mime_message_get_mime_part() or g_mime_multipart_get_part(). This +was done to be more consistent with the Gtk+ API.</p> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/gmime-changes-2-6.html b/docs/reference/html/gmime-changes-2-6.html new file mode 100644 index 0000000..6e65fb2 --- /dev/null +++ b/docs/reference/html/gmime-changes-2-6.html @@ -0,0 +1,90 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Changes from 2.4 to 2.6</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="gmime.html" title="Part I. GMime Overview"> +<link rel="prev" href="gmime-changes-2-4.html" title="Changes from 2.2 to 2.4"> +<link rel="next" href="gmime-resources.html" title="Mailing lists and bug reports"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="gmime-changes-2-4.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="gmime.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="gmime-resources.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="gmime-changes-2-6"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle">Changes from 2.4 to 2.6</span></h2> +<p>Changes from 2.4 to 2.6 — Changes made between version 2.4 and version 2.6</p> +</td> +<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> +<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 +than 2GB (which could happen if GMime was built with large file +support).</p> +<p>As I fixed this, I also found some API inconsistencies which I felt I +might as well fix up since I had to break API/ABI compatibility with +2.4 anyway.</p> +<p>Most notable in GMime 2.6 is the lack of GMimeSession which has been +dropped in favor of a much simpler callback +mechanism. GMimeCipherContexts constructors now take a +password_request callback function rather than forcing you to subclass +GMimeSession to get this functionality.</p> +<p>Other API changes include:</p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"><p>GMimeBestEncoding has been renamed to + GMimeEncodingConstraint</p></li> +<li class="listitem"><p>GMimeSignatureValidity has been dropped in favor + of GMimeSignatureList which is simply a collection of + signatures. + </p></li> +<li class="listitem"><p>GMimeSigner has been replaced by GMimeSignature + and GMimeCertificate which added a number of new fields and + accessors making it much more complete. + </p></li> +<li class="listitem"><p>GMimeCipherContext has been renamed to + GMimeCryptoContext and the method names for this class have also + been renamed in a similar fashion. + </p></li> +<li class="listitem"><p><code class="function">g_mime_crypto_context_encrypt()</code> + now takes a digest algorithm argument which is used when the + 'sign' argument is TRUE. + </p></li> +<li class="listitem"><p><code class="function">g_mime_multipart_encrypted_encrypt()</code> + also now takes a digest algorithm argument which it passes along + to <code class="function">g_mime_crypto_context_encrypt()</code>. + </p></li> +<li class="listitem"><p><code class="function">g_mime_crypto_context_decrypt()</code> + now returns a GMimeDecryptResult which contains a list of + signatures (if signed), a list of recipients that the stream had + been encrypted to, and also the cipher and digest algorithms + used. + </p></li> +<li class="listitem"><p><code class="function">g_mime_multipart_encrypted_decrypt()</code> + no longer caches the decrypted part and also now takes a + GMimeSignatureList** output argument which it sets in place of + having to call + <code class="function">g_mime_multipart_encrypted_get_signature_validity()</code> + afterward. + </p></li> +</ul></div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/gmime-compiling.html b/docs/reference/html/gmime-compiling.html new file mode 100644 index 0000000..e5aee65 --- /dev/null +++ b/docs/reference/html/gmime-compiling.html @@ -0,0 +1,70 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Compiling GMime Applications</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="gmime.html" title="Part I. GMime Overview"> +<link rel="prev" href="gmime-building.html" title="Compiling the GMime libraries"> +<link rel="next" href="gmime-changes-2-0.html" title="Changes from 1.0 to 2.0"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="gmime-building.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="gmime.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="gmime-changes-2-0.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="gmime-compiling"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle">Compiling GMime Applications</span></h2> +<p>Compiling GMime Applications — +How to compile your GMime application +</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="idp4948864"></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 +<code class="literal">pkg-config</code> utility. +</p> +<p> +The following interactive shell session demonstrates how +<code class="literal">pkg-config</code> is used: +</p> +<pre class="programlisting"> +$ pkg-config --cflags gmime-2.4 + -I/usr/include/gmime-2.4 -I/usr/include/glib-2.0 -I/usr/lib/glib-2.0/include +$ pkg-config --libs gmime-2.4 + -L/opt/gnome2/lib -lgmime-2.4 -lnsl -lgobject-2.0 -lglib-2.0 +</pre> +<p> +</p> +<p> +The simplest way to compile a program is to use the "backticks" +feature of the shell. If you enclose a command in backticks +(<span class="emphasis"><em>not single quotes</em></span>), then its output will be +substituted into the command line before execution. So to compile +a GTK+ Hello, World, you would type the following: +</p> +<pre class="programlisting"> +$ cc `pkg-config --cflags --libs gmime-2.4` hello.c -o hello +</pre> +<p> +</p> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/gmime-data-wrappers.html b/docs/reference/html/gmime-data-wrappers.html new file mode 100644 index 0000000..01ab340 --- /dev/null +++ b/docs/reference/html/gmime-data-wrappers.html @@ -0,0 +1,46 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMime Data Wrappers</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="fundamentals.html" title="Part II. GMime Fundamentals"> +<link rel="prev" href="gmime-filters.html" title="GMime Stream Filters"> +<link rel="next" href="core.html" title="Part III. GMime Core Reference"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="gmime-filters.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="fundamentals.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="core.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="gmime-data-wrappers"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle">GMime Data Wrappers</span></h2> +<p>GMime Data Wrappers — How to use GMime Data Wrappers</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="data-wrapper-overview"></a><h2>Overview of Data Wrappers</h2> +<p>Data wrappers are very simple. A GMimeDataWrapper object + contains both a stream and an encoding-type. The encoding-type + (such as GMIME_PART_ENCODING_BASE64) is used by + g_mime_data_wrapper_write_to_stream() in order to decode the data + into its unencoded form. This means that you, the application + programmer, do not need to worry about decoding the content stream + yourself.</p> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/gmime-filters.html b/docs/reference/html/gmime-filters.html new file mode 100644 index 0000000..8600097 --- /dev/null +++ b/docs/reference/html/gmime-filters.html @@ -0,0 +1,72 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMime Stream Filters</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="fundamentals.html" title="Part II. GMime Fundamentals"> +<link rel="prev" href="gmime-streams.html" title="GMime Streams"> +<link rel="next" href="gmime-data-wrappers.html" title="GMime Data Wrappers"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="gmime-streams.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="fundamentals.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="gmime-data-wrappers.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="gmime-filters"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle">GMime Stream Filters</span></h2> +<p>GMime Stream Filters — How to use GMime Stream Filters</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="filter-overview"></a><h2>Overview of Filters</h2> +<p>Stream filters are an efficient way of converting data from + one format to another. To use a stream filter, you must first + construct a GMimeStreamFilter stream and then add the desired + filters to it.</p> +<p>GMime comes equipped with some basic filters such as + GMimeFilterBasic, GMimeFilterCharset, GMimeFilterCRLF, + GMimeFilterFrom and GMimeFilterHTML.</p> +<p>The GMimeFilterBasic filter is actually a collection of + filters for common transfer encodings used by MIME. So far, it is + able to handle encoding and decoding of base64, quoted-printable + and (x-)uuencode.</p> +<p>For internationalization support, GMime also includes a + filter for converting between any 2 charsets, + GMimeFilterCharset. With this filter, mail user agents can allow + the user to read the message content in his or her own + charset.</p> +<p>A common conversion needed for text is CRLF -> LF and LF -> + CRLF which is needed for most (all?) internet protocols. Luckily, + GMime comes equipped with a filter to handle this for you, + GMimeFilterCRLF. You'll notice that GMimeFilterCRLF can also + handle dot-escaping, which is especially useful for SMTP + (rfc821).</p> +<p>On Unix systems, mail often resides in spools in mbox + format. Mbox uses a line that starts with "From " to delimit + messages which means that message bodies are forbidden to contain + lines starting with "From ". The common way to escape these from + lines in message bodies is to prepend the line with a greater-than + character ('>') producing ">From ". You'll find GMimeFilterFrom + handy when dealing with this.</p> +<p>The GMimeFilterHTML filter converts a normal text stream + into an html stream. This is especially useful if you are using a + widget such as GtkHTML to display the contents of an email + message.</p> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/gmime-gmime-charset.html b/docs/reference/html/gmime-gmime-charset.html new file mode 100644 index 0000000..918f546 --- /dev/null +++ b/docs/reference/html/gmime-gmime-charset.html @@ -0,0 +1,465 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>gmime-charset</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="core.html" title="Part III. GMime Core Reference"> +<link rel="prev" href="gmime-gmime.html" title="gmime"> +<link rel="next" href="gmime-gmime-iconv.html" title="gmime-iconv"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="gmime-gmime.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="core.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="gmime-gmime-iconv.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#gmime-gmime-charset.synopsis" class="shortcut">Top</a> +  | + <a href="#gmime-gmime-charset.description" class="shortcut">Description</a> +</td></tr> +</table> +<div class="refentry"> +<a name="gmime-gmime-charset"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="gmime-gmime-charset.top_of_page"></a>gmime-charset</span></h2> +<p>gmime-charset — Charset helper functions</p> +</td> +<td valign="top" align="right"></td> +</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>; +<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>); +const <span class="returnvalue">char</span> * <a class="link" href="gmime-gmime-charset.html#g-mime-locale-language" title="g_mime_locale_language ()">g_mime_locale_language</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-language" title="g_mime_charset_language ()">g_mime_charset_language</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-canon-name" title="g_mime_charset_canon_name ()">g_mime_charset_canon_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-iconv-name" title="g_mime_charset_iconv_name ()">g_mime_charset_iconv_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-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>, + <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" 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>, + <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>); +<span class="returnvalue">void</span> <a class="link" href="gmime-gmime-charset.html#g-mime-set-user-charsets" title="g_mime_set_user_charsets ()">g_mime_set_user_charsets</a> (<em class="parameter"><code>const <span class="type">char</span> **charsets</code></em>); +const <span class="returnvalue">char</span> ** <a class="link" href="gmime-gmime-charset.html#g-mime-user-charsets" title="g_mime_user_charsets ()">g_mime_user_charsets</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="gmime-gmime-charset.description"></a><h2>Description</h2> +<p> +Charset utility functions. +</p> +</div> +<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 { + 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>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">unsigned <span class="type">int</span> <em class="structfield"><code><a name="GMimeCharset.mask"></a>mask</code></em>;</span></p></td> +<td>charset mask</td> +</tr> +<tr> +<td><p><span class="term">unsigned <span class="type">int</span> <em class="structfield"><code><a name="GMimeCharset.level"></a>level</code></em>;</span></p></td> +<td>charset level</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-charset-map-init"></a><h3>g_mime_charset_map_init ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_charset_map_init (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Initializes character set maps. +</p> +<p> +Note: <a class="link" href="gmime-gmime.html#g-mime-init" title="g_mime_init ()"><code class="function">g_mime_init()</code></a> calls this routine for you. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-charset-map-shutdown"></a><h3>g_mime_charset_map_shutdown ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_charset_map_shutdown (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Frees internal lookup tables created in <a class="link" href="gmime-gmime-charset.html#g-mime-charset-map-init" title="g_mime_charset_map_init ()"><code class="function">g_mime_charset_map_init()</code></a>. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-locale-charset"></a><h3>g_mime_locale_charset ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_locale_charset (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Gets the user's locale charset (or iso-8859-1 by default). +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the user's locale charset (or iso-8859-1 by default).</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-locale-language"></a><h3>g_mime_locale_language ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_locale_language (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Gets the user's locale language code (or <code class="literal">NULL</code> by default). +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the user's locale language code (or <code class="literal">NULL</code> by default).</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-charset-language"></a><h3>g_mime_charset_language ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_charset_language (<em class="parameter"><code>const <span class="type">char</span> *charset</code></em>);</pre> +<p> +Attempts to find a specific language code that is specific to +<em class="parameter"><code>charset</code></em>. Currently only handles CJK and Russian/Ukranian +charset->lang mapping. Everything else will return <code class="literal">NULL</code>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>charset</code></em> :</span></p></td> +<td>charset name</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a language code that is specific to <em class="parameter"><code>charset</code></em>, or <code class="literal">NULL</code> on +fail.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-charset-canon-name"></a><h3>g_mime_charset_canon_name ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_charset_canon_name (<em class="parameter"><code>const <span class="type">char</span> *charset</code></em>);</pre> +<p> +Attempts to find a canonical charset name for <em class="parameter"><code>charset</code></em>. +</p> +<p> +Note: Will normally return the same value as +<a class="link" href="gmime-gmime-charset.html#g-mime-charset-iconv-name" title="g_mime_charset_iconv_name ()"><code class="function">g_mime_charset_iconv_name()</code></a> unless the system iconv does not use +the canonical ISO charset names (such as using ISO8859-1 rather +than the canonical form ISO-8859-1). +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>charset</code></em> :</span></p></td> +<td>charset name</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a canonical charset name for <em class="parameter"><code>charset</code></em>.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-charset-iconv-name"></a><h3>g_mime_charset_iconv_name ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_charset_iconv_name (<em class="parameter"><code>const <span class="type">char</span> *charset</code></em>);</pre> +<p> +Attempts to find an iconv-friendly charset name for <em class="parameter"><code>charset</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>charset</code></em> :</span></p></td> +<td>charset name</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>an iconv-friendly charset name for <em class="parameter"><code>charset</code></em>.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-charset-name"></a><h3>g_mime_charset_name ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_charset_name (<em class="parameter"><code>const <span class="type">char</span> *charset</code></em>);</pre> +<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"> +<h3 class="title">Warning</h3> +<p><code class="literal">g_mime_charset_name</code> is deprecated and should not be used in newly-written code.</p> +</div> +<p> +Attempts to find an iconv-friendly charset name for <em class="parameter"><code>charset</code></em>. +</p> +<p> +Note: This function is deprecated. Use <a class="link" href="gmime-gmime-charset.html#g-mime-charset-iconv-name" title="g_mime_charset_iconv_name ()"><code class="function">g_mime_charset_iconv_name()</code></a> +instead. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>charset</code></em> :</span></p></td> +<td>charset name</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>an iconv-friendly charset name for <em class="parameter"><code>charset</code></em>.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-charset-locale-name"></a><h3>g_mime_charset_locale_name ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_charset_locale_name (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"> +<h3 class="title">Warning</h3> +<p><code class="literal">g_mime_charset_locale_name</code> is deprecated and should not be used in newly-written code.</p> +</div> +<p> +Gets the user's locale charset (or iso-8859-1 by default). +</p> +<p> +Note: This function is deprecated. Use <a class="link" href="gmime-gmime-charset.html#g-mime-locale-charset" title="g_mime_locale_charset ()"><code class="function">g_mime_locale_charset()</code></a> +instead. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the user's locale charset (or iso-8859-1 by default).</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-charset-iso-to-windows"></a><h3>g_mime_charset_iso_to_windows ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_charset_iso_to_windows (<em class="parameter"><code>const <span class="type">char</span> *isocharset</code></em>);</pre> +<p> +Maps the ISO-8859-# charset to the equivalent Windows-CP125# +charset. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>isocharset</code></em> :</span></p></td> +<td>ISO-8859-# charset</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>equivalent Windows charset.</td> +</tr> +</tbody> +</table></div> +</div> +<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> +<p> +Initializes a charset mask structure. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><em class="parameter"><code>charset</code></em> :</span></p></td> +<td>charset mask</td> +</tr></tbody> +</table></div> +</div> +<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>, + <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> +Steps through the input buffer 1 unicode character (glyph) at a +time (ie, not necessarily 1 byte at a time). Bitwise 'and' our +<em class="parameter"><code>charset->mask</code></em> with the mask for each glyph. This has the effect of +limiting what charsets our <em class="parameter"><code>charset->mask</code></em> can match. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>charset</code></em> :</span></p></td> +<td>charset structure</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>inbuf</code></em> :</span></p></td> +<td>input text buffer (must be in UTF-8)</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>inlen</code></em> :</span></p></td> +<td>input buffer length</td> +</tr> +</tbody> +</table></div> +</div> +<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> +<p> +Gets the best charset name based on the charset mask <em class="parameter"><code>charset</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>charset</code></em> :</span></p></td> +<td>charset mask</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a pointer to a string containing the best charset name that +can represent the charset mask <em class="parameter"><code>charset</code></em>.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-charset-best"></a><h3>g_mime_charset_best ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_charset_best (<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> +Computes the best charset to use to encode this text buffer. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>inbuf</code></em> :</span></p></td> +<td>a UTF-8 text buffer</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>inlen</code></em> :</span></p></td> +<td>input buffer length</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the charset name best suited for the input text or <code class="literal">NULL</code> if +it is US-ASCII safe.</td> +</tr> +</tbody> +</table></div> +</div> +<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>, + <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> +<p> +Check to see if the UTF-8 <em class="parameter"><code>text</code></em> will fit safely within <em class="parameter"><code>charset</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>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> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>charset</code></em> :</span></p></td> +<td>a charset</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td> +<td>utf-8 text to check</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>len</code></em> :</span></p></td> +<td>length of <em class="parameter"><code>text</code></em> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> if it is safe to encode <em class="parameter"><code>text</code></em> into <em class="parameter"><code>charset</code></em> or <code class="literal">FALSE</code> +otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-set-user-charsets"></a><h3>g_mime_set_user_charsets ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_set_user_charsets (<em class="parameter"><code>const <span class="type">char</span> **charsets</code></em>);</pre> +<p> +Set a list of charsets for GMime to use as a hint for encoding and +decoding headers. The charset list should be in order of preference +(e.g. most preferred first, least preferred last). +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><em class="parameter"><code>charsets</code></em> :</span></p></td> +<td>an array of user-preferred charsets</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-user-charsets"></a><h3>g_mime_user_charsets ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> ** g_mime_user_charsets (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Get the list of user-preferred charsets set with +<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>. +</p> +<div class="variablelist"><table border="0"> +<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> +</tr></tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/gmime-gmime-encodings.html b/docs/reference/html/gmime-gmime-encodings.html new file mode 100644 index 0000000..47c2475 --- /dev/null +++ b/docs/reference/html/gmime-gmime-encodings.html @@ -0,0 +1,992 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>gmime-encodings</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="core.html" title="Part III. GMime Core Reference"> +<link rel="prev" href="gmime-gmime-iconv-utils.html" title="gmime-iconv-utils"> +<link rel="next" href="gmime-gmime-utils.html" title="gmime-utils"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="gmime-gmime-iconv-utils.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="core.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="gmime-gmime-utils.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#gmime-gmime-encodings.synopsis" class="shortcut">Top</a> +  | + <a href="#gmime-gmime-encodings.description" class="shortcut">Description</a> +</td></tr> +</table> +<div class="refentry"> +<a name="gmime-gmime-encodings"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="gmime-gmime-encodings.top_of_page"></a>gmime-encodings</span></h2> +<p>gmime-encodings — MIME encoding functions</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="gmime-gmime-encodings.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">enum <a class="link" href="gmime-gmime-encodings.html#GMimeContentEncoding" title="enum GMimeContentEncoding">GMimeContentEncoding</a>; +<a class="link" href="gmime-gmime-encodings.html#GMimeContentEncoding" title="enum GMimeContentEncoding"><span class="returnvalue">GMimeContentEncoding</span></a> <a class="link" href="gmime-gmime-encodings.html#g-mime-content-encoding-from-string" title="g_mime_content_encoding_from_string ()">g_mime_content_encoding_from_string</a> + (<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>, + <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>, + <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>, + <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>, + <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>, + <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>); +#define <a class="link" href="gmime-gmime-encodings.html#GMIME-BASE64-ENCODE-LEN:CAPS" title="GMIME_BASE64_ENCODE_LEN()">GMIME_BASE64_ENCODE_LEN</a> (x) +<span class="returnvalue">size_t</span> <a class="link" href="gmime-gmime-encodings.html#g-mime-encoding-base64-decode-step" title="g_mime_encoding_base64_decode_step ()">g_mime_encoding_base64_decode_step</a> (<em class="parameter"><code>const unsigned <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>unsigned <span class="type">char</span> *outbuf</code></em>, + <em class="parameter"><code><span class="type">int</span> *state</code></em>, + <em class="parameter"><code><span class="type">guint32</span> *save</code></em>); +<span class="returnvalue">size_t</span> <a class="link" href="gmime-gmime-encodings.html#g-mime-encoding-base64-encode-step" title="g_mime_encoding_base64_encode_step ()">g_mime_encoding_base64_encode_step</a> (<em class="parameter"><code>const unsigned <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>unsigned <span class="type">char</span> *outbuf</code></em>, + <em class="parameter"><code><span class="type">int</span> *state</code></em>, + <em class="parameter"><code><span class="type">guint32</span> *save</code></em>); +<span class="returnvalue">size_t</span> <a class="link" href="gmime-gmime-encodings.html#g-mime-encoding-base64-encode-close" title="g_mime_encoding_base64_encode_close ()">g_mime_encoding_base64_encode_close</a> (<em class="parameter"><code>const unsigned <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>unsigned <span class="type">char</span> *outbuf</code></em>, + <em class="parameter"><code><span class="type">int</span> *state</code></em>, + <em class="parameter"><code><span class="type">guint32</span> *save</code></em>); +#define <a class="link" href="gmime-gmime-encodings.html#GMIME-UUDECODE-STATE-INIT:CAPS" title="GMIME_UUDECODE_STATE_INIT">GMIME_UUDECODE_STATE_INIT</a> +#define <a class="link" href="gmime-gmime-encodings.html#GMIME-UUDECODE-STATE-BEGIN:CAPS" title="GMIME_UUDECODE_STATE_BEGIN">GMIME_UUDECODE_STATE_BEGIN</a> +#define <a class="link" href="gmime-gmime-encodings.html#GMIME-UUDECODE-STATE-END:CAPS" title="GMIME_UUDECODE_STATE_END">GMIME_UUDECODE_STATE_END</a> +#define <a class="link" href="gmime-gmime-encodings.html#GMIME-UUENCODE-LEN:CAPS" title="GMIME_UUENCODE_LEN()">GMIME_UUENCODE_LEN</a> (x) +<span class="returnvalue">size_t</span> <a class="link" href="gmime-gmime-encodings.html#g-mime-encoding-uudecode-step" title="g_mime_encoding_uudecode_step ()">g_mime_encoding_uudecode_step</a> (<em class="parameter"><code>const unsigned <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>unsigned <span class="type">char</span> *outbuf</code></em>, + <em class="parameter"><code><span class="type">int</span> *state</code></em>, + <em class="parameter"><code><span class="type">guint32</span> *save</code></em>); +<span class="returnvalue">size_t</span> <a class="link" href="gmime-gmime-encodings.html#g-mime-encoding-uuencode-step" title="g_mime_encoding_uuencode_step ()">g_mime_encoding_uuencode_step</a> (<em class="parameter"><code>const unsigned <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>unsigned <span class="type">char</span> *outbuf</code></em>, + <em class="parameter"><code>unsigned <span class="type">char</span> *uubuf</code></em>, + <em class="parameter"><code><span class="type">int</span> *state</code></em>, + <em class="parameter"><code><span class="type">guint32</span> *save</code></em>); +<span class="returnvalue">size_t</span> <a class="link" href="gmime-gmime-encodings.html#g-mime-encoding-uuencode-close" title="g_mime_encoding_uuencode_close ()">g_mime_encoding_uuencode_close</a> (<em class="parameter"><code>const unsigned <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>unsigned <span class="type">char</span> *outbuf</code></em>, + <em class="parameter"><code>unsigned <span class="type">char</span> *uubuf</code></em>, + <em class="parameter"><code><span class="type">int</span> *state</code></em>, + <em class="parameter"><code><span class="type">guint32</span> *save</code></em>); +#define <a class="link" href="gmime-gmime-encodings.html#GMIME-QP-ENCODE-LEN:CAPS" title="GMIME_QP_ENCODE_LEN()">GMIME_QP_ENCODE_LEN</a> (x) +<span class="returnvalue">size_t</span> <a class="link" href="gmime-gmime-encodings.html#g-mime-encoding-quoted-decode-step" title="g_mime_encoding_quoted_decode_step ()">g_mime_encoding_quoted_decode_step</a> (<em class="parameter"><code>const unsigned <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>unsigned <span class="type">char</span> *outbuf</code></em>, + <em class="parameter"><code><span class="type">int</span> *state</code></em>, + <em class="parameter"><code><span class="type">guint32</span> *save</code></em>); +<span class="returnvalue">size_t</span> <a class="link" href="gmime-gmime-encodings.html#g-mime-encoding-quoted-encode-step" title="g_mime_encoding_quoted_encode_step ()">g_mime_encoding_quoted_encode_step</a> (<em class="parameter"><code>const unsigned <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>unsigned <span class="type">char</span> *outbuf</code></em>, + <em class="parameter"><code><span class="type">int</span> *state</code></em>, + <em class="parameter"><code><span class="type">guint32</span> *save</code></em>); +<span class="returnvalue">size_t</span> <a class="link" href="gmime-gmime-encodings.html#g-mime-encoding-quoted-encode-close" title="g_mime_encoding_quoted_encode_close ()">g_mime_encoding_quoted_encode_close</a> (<em class="parameter"><code>const unsigned <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>unsigned <span class="type">char</span> *outbuf</code></em>, + <em class="parameter"><code><span class="type">int</span> *state</code></em>, + <em class="parameter"><code><span class="type">guint32</span> *save</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="gmime-gmime-encodings.description"></a><h2>Description</h2> +<p> +Utility functions to encode or decode MIME +Content-Transfer-Encodings. +</p> +</div> +<div class="refsect1"> +<a name="gmime-gmime-encodings.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimeContentEncoding"></a><h3>enum GMimeContentEncoding</h3> +<pre class="programlisting">typedef enum { + GMIME_CONTENT_ENCODING_DEFAULT, + GMIME_CONTENT_ENCODING_7BIT, + GMIME_CONTENT_ENCODING_8BIT, + GMIME_CONTENT_ENCODING_BINARY, + GMIME_CONTENT_ENCODING_BASE64, + GMIME_CONTENT_ENCODING_QUOTEDPRINTABLE, + GMIME_CONTENT_ENCODING_UUENCODE +} GMimeContentEncoding; +</pre> +<p> +A Content-Transfer-Encoding enumeration. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><a name="GMIME-CONTENT-ENCODING-DEFAULT:CAPS"></a><span class="term"><code class="literal">GMIME_CONTENT_ENCODING_DEFAULT</code></span></p></td> +<td>Default transfer encoding. +</td> +</tr> +<tr> +<td><p><a name="GMIME-CONTENT-ENCODING-7BIT:CAPS"></a><span class="term"><code class="literal">GMIME_CONTENT_ENCODING_7BIT</code></span></p></td> +<td>7bit text transfer encoding. +</td> +</tr> +<tr> +<td><p><a name="GMIME-CONTENT-ENCODING-8BIT:CAPS"></a><span class="term"><code class="literal">GMIME_CONTENT_ENCODING_8BIT</code></span></p></td> +<td>8bit text transfer encoding. +</td> +</tr> +<tr> +<td><p><a name="GMIME-CONTENT-ENCODING-BINARY:CAPS"></a><span class="term"><code class="literal">GMIME_CONTENT_ENCODING_BINARY</code></span></p></td> +<td>Binary transfer encoding. +</td> +</tr> +<tr> +<td><p><a name="GMIME-CONTENT-ENCODING-BASE64:CAPS"></a><span class="term"><code class="literal">GMIME_CONTENT_ENCODING_BASE64</code></span></p></td> +<td>Base64 transfer encoding. +</td> +</tr> +<tr> +<td><p><a name="GMIME-CONTENT-ENCODING-QUOTEDPRINTABLE:CAPS"></a><span class="term"><code class="literal">GMIME_CONTENT_ENCODING_QUOTEDPRINTABLE</code></span></p></td> +<td>Quoted-printable transfer encoding. +</td> +</tr> +<tr> +<td><p><a name="GMIME-CONTENT-ENCODING-UUENCODE:CAPS"></a><span class="term"><code class="literal">GMIME_CONTENT_ENCODING_UUENCODE</code></span></p></td> +<td>Uuencode transfer encoding. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-content-encoding-from-string"></a><h3>g_mime_content_encoding_from_string ()</h3> +<pre class="programlisting"><a class="link" href="gmime-gmime-encodings.html#GMimeContentEncoding" title="enum GMimeContentEncoding"><span class="returnvalue">GMimeContentEncoding</span></a> g_mime_content_encoding_from_string + (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>);</pre> +<p> +Gets the appropriate <a class="link" href="gmime-gmime-encodings.html#GMimeContentEncoding" title="enum GMimeContentEncoding"><span class="type">GMimeContentEncoding</span></a> enumeration value based +on the input string. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td> +<td>a string representing a Content-Transfer-Encoding value</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the <a class="link" href="gmime-gmime-encodings.html#GMimeContentEncoding" title="enum GMimeContentEncoding"><span class="type">GMimeContentEncoding</span></a> specified by <em class="parameter"><code>str</code></em> or +<a class="link" href="gmime-gmime-encodings.html#GMIME-CONTENT-ENCODING-DEFAULT:CAPS"><span class="type">GMIME_CONTENT_ENCODING_DEFAULT</span></a> on error.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-content-encoding-to-string"></a><h3>g_mime_content_encoding_to_string ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_content_encoding_to_string (<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> +Gets the string value of the content encoding. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>encoding</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-gmime-encodings.html#GMimeContentEncoding" title="enum GMimeContentEncoding"><span class="type">GMimeContentEncoding</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the encoding type as a string or <code class="literal">NULL</code> on error. Available +values for the encoding are: <a class="link" href="gmime-gmime-encodings.html#GMIME-CONTENT-ENCODING-DEFAULT:CAPS"><span class="type">GMIME_CONTENT_ENCODING_DEFAULT</span></a>, +<a class="link" href="gmime-gmime-encodings.html#GMIME-CONTENT-ENCODING-7BIT:CAPS"><span class="type">GMIME_CONTENT_ENCODING_7BIT</span></a>, <a class="link" href="gmime-gmime-encodings.html#GMIME-CONTENT-ENCODING-8BIT:CAPS"><span class="type">GMIME_CONTENT_ENCODING_8BIT</span></a>, +<a class="link" href="gmime-gmime-encodings.html#GMIME-CONTENT-ENCODING-BINARY:CAPS"><span class="type">GMIME_CONTENT_ENCODING_BINARY</span></a>, <a class="link" href="gmime-gmime-encodings.html#GMIME-CONTENT-ENCODING-BASE64:CAPS"><span class="type">GMIME_CONTENT_ENCODING_BASE64</span></a>, +<a class="link" href="gmime-gmime-encodings.html#GMIME-CONTENT-ENCODING-QUOTEDPRINTABLE:CAPS"><span class="type">GMIME_CONTENT_ENCODING_QUOTEDPRINTABLE</span></a> and +<a class="link" href="gmime-gmime-encodings.html#GMIME-CONTENT-ENCODING-UUENCODE:CAPS"><span class="type">GMIME_CONTENT_ENCODING_UUENCODE</span></a>.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="GMimeEncodingConstraint"></a><h3>enum GMimeEncodingConstraint</h3> +<pre class="programlisting">typedef enum { + GMIME_ENCODING_CONSTRAINT_7BIT, + GMIME_ENCODING_CONSTRAINT_8BIT, + GMIME_ENCODING_CONSTRAINT_BINARY +} GMimeEncodingConstraint; +</pre> +<p> +Used with functions like <a class="link" href="GMimeFilterBest.html#g-mime-filter-best-encoding" title="g_mime_filter_best_encoding ()"><code class="function">g_mime_filter_best_encoding()</code></a> and +<a class="link" href="GMimeObject.html#g-mime-object-encode" title="g_mime_object_encode ()"><code class="function">g_mime_object_encode()</code></a> as the 'constraint' argument. These values +provide a means of letting the filter know what the encoding +constraints are for the stream. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><a name="GMIME-ENCODING-CONSTRAINT-7BIT:CAPS"></a><span class="term"><code class="literal">GMIME_ENCODING_CONSTRAINT_7BIT</code></span></p></td> +<td>The stream data must fit within the 7bit ASCII range. +</td> +</tr> +<tr> +<td><p><a name="GMIME-ENCODING-CONSTRAINT-8BIT:CAPS"></a><span class="term"><code class="literal">GMIME_ENCODING_CONSTRAINT_8BIT</code></span></p></td> +<td>The stream data may have bytes with the high bit set, but no null bytes. +</td> +</tr> +<tr> +<td><p><a name="GMIME-ENCODING-CONSTRAINT-BINARY:CAPS"></a><span class="term"><code class="literal">GMIME_ENCODING_CONSTRAINT_BINARY</code></span></p></td> +<td>The stream may contain any binary data. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="GMimeEncoding"></a><h3>GMimeEncoding</h3> +<pre class="programlisting">typedef struct { + GMimeContentEncoding encoding; + unsigned char uubuf[60]; + gboolean encode; + guint32 save; + int state; +} GMimeEncoding; +</pre> +<p> +A context used for encoding or decoding data. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><a class="link" href="gmime-gmime-encodings.html#GMimeContentEncoding" title="enum GMimeContentEncoding"><span class="type">GMimeContentEncoding</span></a> <em class="structfield"><code><a name="GMimeEncoding.encoding"></a>encoding</code></em>;</span></p></td> +<td>the type of encoding</td> +</tr> +<tr> +<td><p><span class="term">unsigned <span class="type">char</span> <em class="structfield"><code><a name="GMimeEncoding.uubuf"></a>uubuf</code></em>[60];</span></p></td> +<td>a temporary buffer needed when uuencoding data</td> +</tr> +<tr> +<td><p><span class="term"><span class="type">gboolean</span> <em class="structfield"><code><a name="GMimeEncoding.encode"></a>encode</code></em>;</span></p></td> +<td> +<code class="literal">TRUE</code> if encoding or <code class="literal">FALSE</code> if decoding</td> +</tr> +<tr> +<td><p><span class="term"><span class="type">guint32</span> <em class="structfield"><code><a name="GMimeEncoding.save"></a>save</code></em>;</span></p></td> +<td>saved bytes from the previous step</td> +</tr> +<tr> +<td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="GMimeEncoding.state"></a>state</code></em>;</span></p></td> +<td>current encder/decoder state</td> +</tr> +</tbody> +</table></div> +</div> +<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>, + <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 +<em class="parameter"><code>encoding</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>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> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>encoding</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-gmime-encodings.html#GMimeContentEncoding" title="enum GMimeContentEncoding"><span class="type">GMimeContentEncoding</span></a> to use</td> +</tr> +</tbody> +</table></div> +</div> +<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>, + <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 +<em class="parameter"><code>encoding</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>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> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>encoding</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-gmime-encodings.html#GMimeContentEncoding" title="enum GMimeContentEncoding"><span class="type">GMimeContentEncoding</span></a> to use</td> +</tr> +</tbody> +</table></div> +</div> +<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> +<p> +Resets the state of the <a class="link" href="gmime-gmime-encodings.html#GMimeEncoding" title="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> +</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>, + <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 +to perform an encoding or decoding step. +</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> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>inlen</code></em> :</span></p></td> +<td>an input length</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the maximum number of bytes needed to encode or decode a +buffer of <em class="parameter"><code>inlen</code></em> bytes.</td> +</tr> +</tbody> +</table></div> +</div> +<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>, + <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> +<p> +Incrementally encodes or decodes (depending on <em class="parameter"><code>state</code></em>) an input +stream by 'stepping' through a block of input at a time. +</p> +<p> +You should make sure <em class="parameter"><code>outbuf</code></em> is large enough by calling +<a class="link" href="gmime-gmime-encodings.html#g-mime-encoding-outlen" title="g_mime_encoding_outlen ()"><code class="function">g_mime_encoding_outlen()</code></a> to find out how large <em class="parameter"><code>outbuf</code></em> might need +to be. +</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> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>inbuf</code></em> :</span></p></td> +<td>an input buffer to encode or decode</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>inlen</code></em> :</span></p></td> +<td>input buffer length</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>outbuf</code></em> :</span></p></td> +<td>an output buffer</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the number of bytes written to <em class="parameter"><code>outbuf</code></em>.</td> +</tr> +</tbody> +</table></div> +</div> +<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>, + <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> +<p> +Completes the incremental encode or decode of the input stream (see +<a class="link" href="gmime-gmime-encodings.html#g-mime-encoding-step" title="g_mime_encoding_step ()"><code class="function">g_mime_encoding_step()</code></a> for details). +</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> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>inbuf</code></em> :</span></p></td> +<td>an input buffer to encode or decode</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>inlen</code></em> :</span></p></td> +<td>input buffer length</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>outbuf</code></em> :</span></p></td> +<td>an output buffer</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the number of bytes written to <em class="parameter"><code>outbuf</code></em>.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="GMIME-BASE64-ENCODE-LEN:CAPS"></a><h3>GMIME_BASE64_ENCODE_LEN()</h3> +<pre class="programlisting">#define GMIME_BASE64_ENCODE_LEN(x) ((size_t) (((((x) + 2) / 57) * 77) + 77)) +</pre> +<p> +Calculates the maximum number of bytes needed to base64 encode the +full input buffer of length <em class="parameter"><code>x</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>x</code></em> :</span></p></td> +<td>Length of the input data to encode</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the number of output bytes needed to base64 encode an input +buffer of size <em class="parameter"><code>x</code></em>.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-encoding-base64-decode-step"></a><h3>g_mime_encoding_base64_decode_step ()</h3> +<pre class="programlisting"><span class="returnvalue">size_t</span> g_mime_encoding_base64_decode_step (<em class="parameter"><code>const unsigned <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>unsigned <span class="type">char</span> *outbuf</code></em>, + <em class="parameter"><code><span class="type">int</span> *state</code></em>, + <em class="parameter"><code><span class="type">guint32</span> *save</code></em>);</pre> +<p> +Decodes a chunk of base64 encoded data. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>inbuf</code></em> :</span></p></td> +<td>input buffer</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>inlen</code></em> :</span></p></td> +<td>input buffer length</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>outbuf</code></em> :</span></p></td> +<td>output buffer</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td> +<td>holds the number of bits that are stored in <em class="parameter"><code>save</code></em> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>save</code></em> :</span></p></td> +<td>leftover bits that have not yet been decoded</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the number of bytes decoded (which have been dumped in +<em class="parameter"><code>outbuf</code></em>).</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-encoding-base64-encode-step"></a><h3>g_mime_encoding_base64_encode_step ()</h3> +<pre class="programlisting"><span class="returnvalue">size_t</span> g_mime_encoding_base64_encode_step (<em class="parameter"><code>const unsigned <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>unsigned <span class="type">char</span> *outbuf</code></em>, + <em class="parameter"><code><span class="type">int</span> *state</code></em>, + <em class="parameter"><code><span class="type">guint32</span> *save</code></em>);</pre> +<p> +Base64 encodes a chunk of data. Performs an 'encode step', only +encodes blocks of 3 characters to the output at a time, saves +left-over state in state and save (initialise to 0 on first +invocation). +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>inbuf</code></em> :</span></p></td> +<td>input buffer</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>inlen</code></em> :</span></p></td> +<td>input buffer length</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>outbuf</code></em> :</span></p></td> +<td>output buffer</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td> +<td>holds the number of bits that are stored in <em class="parameter"><code>save</code></em> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>save</code></em> :</span></p></td> +<td>leftover bits that have not yet been encoded</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the number of bytes encoded.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-encoding-base64-encode-close"></a><h3>g_mime_encoding_base64_encode_close ()</h3> +<pre class="programlisting"><span class="returnvalue">size_t</span> g_mime_encoding_base64_encode_close (<em class="parameter"><code>const unsigned <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>unsigned <span class="type">char</span> *outbuf</code></em>, + <em class="parameter"><code><span class="type">int</span> *state</code></em>, + <em class="parameter"><code><span class="type">guint32</span> *save</code></em>);</pre> +<p> +Base64 encodes the input stream to the output stream. Call this +when finished encoding data with <a class="link" href="gmime-gmime-encodings.html#g-mime-encoding-base64-encode-step" title="g_mime_encoding_base64_encode_step ()"><code class="function">g_mime_encoding_base64_encode_step()</code></a> +to flush off the last little bit. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>inbuf</code></em> :</span></p></td> +<td>input buffer</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>inlen</code></em> :</span></p></td> +<td>input buffer length</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>outbuf</code></em> :</span></p></td> +<td>output buffer</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td> +<td>holds the number of bits that are stored in <em class="parameter"><code>save</code></em> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>save</code></em> :</span></p></td> +<td>leftover bits that have not yet been encoded</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the number of bytes encoded.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="GMIME-UUDECODE-STATE-INIT:CAPS"></a><h3>GMIME_UUDECODE_STATE_INIT</h3> +<pre class="programlisting">#define GMIME_UUDECODE_STATE_INIT (0) +</pre> +<p> +Initial state for the <a class="link" href="gmime-gmime-encodings.html#g-mime-encoding-uudecode-step" title="g_mime_encoding_uudecode_step ()"><code class="function">g_mime_encoding_uudecode_step()</code></a> function. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GMIME-UUDECODE-STATE-BEGIN:CAPS"></a><h3>GMIME_UUDECODE_STATE_BEGIN</h3> +<pre class="programlisting">#define GMIME_UUDECODE_STATE_BEGIN (1 << 16) +</pre> +<p> +State for the <a class="link" href="gmime-gmime-encodings.html#g-mime-encoding-uudecode-step" title="g_mime_encoding_uudecode_step ()"><code class="function">g_mime_encoding_uudecode_step()</code></a> function, denoting that +the 'begin' line has been found. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GMIME-UUDECODE-STATE-END:CAPS"></a><h3>GMIME_UUDECODE_STATE_END</h3> +<pre class="programlisting">#define GMIME_UUDECODE_STATE_END (1 << 17) +</pre> +<p> +State for the <a class="link" href="gmime-gmime-encodings.html#g-mime-encoding-uudecode-step" title="g_mime_encoding_uudecode_step ()"><code class="function">g_mime_encoding_uudecode_step()</code></a> function, denoting that +the end of the UU encoded block has been found. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GMIME-UUENCODE-LEN:CAPS"></a><h3>GMIME_UUENCODE_LEN()</h3> +<pre class="programlisting">#define GMIME_UUENCODE_LEN(x) ((size_t) (((((x) + 2) / 45) * 62) + 64)) +</pre> +<p> +Calculates the maximum number of bytes needed to uuencode the full +input buffer of length <em class="parameter"><code>x</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>x</code></em> :</span></p></td> +<td>Length of the input data to encode</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the number of output bytes needed to uuencode an input +buffer of size <em class="parameter"><code>x</code></em>.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-encoding-uudecode-step"></a><h3>g_mime_encoding_uudecode_step ()</h3> +<pre class="programlisting"><span class="returnvalue">size_t</span> g_mime_encoding_uudecode_step (<em class="parameter"><code>const unsigned <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>unsigned <span class="type">char</span> *outbuf</code></em>, + <em class="parameter"><code><span class="type">int</span> *state</code></em>, + <em class="parameter"><code><span class="type">guint32</span> *save</code></em>);</pre> +<p> +Uudecodes a chunk of data. Performs a 'decode step' on a chunk of +uuencoded data. Assumes the "begin mode filename" line has +been stripped off. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>inbuf</code></em> :</span></p></td> +<td>input buffer</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>inlen</code></em> :</span></p></td> +<td>input buffer length</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>outbuf</code></em> :</span></p></td> +<td>output buffer</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td> +<td>holds the number of bits that are stored in <em class="parameter"><code>save</code></em> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>save</code></em> :</span></p></td> +<td>leftover bits that have not yet been decoded</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the number of bytes decoded.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-encoding-uuencode-step"></a><h3>g_mime_encoding_uuencode_step ()</h3> +<pre class="programlisting"><span class="returnvalue">size_t</span> g_mime_encoding_uuencode_step (<em class="parameter"><code>const unsigned <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>unsigned <span class="type">char</span> *outbuf</code></em>, + <em class="parameter"><code>unsigned <span class="type">char</span> *uubuf</code></em>, + <em class="parameter"><code><span class="type">int</span> *state</code></em>, + <em class="parameter"><code><span class="type">guint32</span> *save</code></em>);</pre> +<p> +Uuencodes a chunk of data. Performs an 'encode step', only encodes +blocks of 45 characters to the output at a time, saves left-over +state in <em class="parameter"><code>uubuf</code></em>, <em class="parameter"><code>state</code></em> and <em class="parameter"><code>save</code></em> (initialize to 0 on first +invocation). +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>inbuf</code></em> :</span></p></td> +<td>input buffer</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>inlen</code></em> :</span></p></td> +<td>input buffer length</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>outbuf</code></em> :</span></p></td> +<td>output stream</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>uubuf</code></em> :</span></p></td> +<td>temporary buffer of 60 bytes</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td> +<td>holds the number of bits that are stored in <em class="parameter"><code>save</code></em> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>save</code></em> :</span></p></td> +<td>leftover bits that have not yet been encoded</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the number of bytes encoded.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-encoding-uuencode-close"></a><h3>g_mime_encoding_uuencode_close ()</h3> +<pre class="programlisting"><span class="returnvalue">size_t</span> g_mime_encoding_uuencode_close (<em class="parameter"><code>const unsigned <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>unsigned <span class="type">char</span> *outbuf</code></em>, + <em class="parameter"><code>unsigned <span class="type">char</span> *uubuf</code></em>, + <em class="parameter"><code><span class="type">int</span> *state</code></em>, + <em class="parameter"><code><span class="type">guint32</span> *save</code></em>);</pre> +<p> +Uuencodes a chunk of data. Call this when finished encoding data +with <a class="link" href="gmime-gmime-encodings.html#g-mime-encoding-uuencode-step" title="g_mime_encoding_uuencode_step ()"><code class="function">g_mime_encoding_uuencode_step()</code></a> to flush off the last little bit. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>inbuf</code></em> :</span></p></td> +<td>input buffer</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>inlen</code></em> :</span></p></td> +<td>input buffer length</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>outbuf</code></em> :</span></p></td> +<td>output buffer</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>uubuf</code></em> :</span></p></td> +<td>temporary buffer of 60 bytes</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td> +<td>holds the number of bits that are stored in <em class="parameter"><code>save</code></em> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>save</code></em> :</span></p></td> +<td>leftover bits that have not yet been encoded</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the number of bytes encoded.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="GMIME-QP-ENCODE-LEN:CAPS"></a><h3>GMIME_QP_ENCODE_LEN()</h3> +<pre class="programlisting">#define GMIME_QP_ENCODE_LEN(x) ((size_t) ((((x) / 24) * 74) + 74)) +</pre> +<p> +Calculates the maximum number of bytes needed to encode the full +input buffer of length <em class="parameter"><code>x</code></em> using the quoted-printable encoding. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td> +<td>Length of the input data to encode</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the number of output bytes needed to encode an input buffer +of size <em class="parameter"><code>x</code></em> using the quoted-printable encoding.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-encoding-quoted-decode-step"></a><h3>g_mime_encoding_quoted_decode_step ()</h3> +<pre class="programlisting"><span class="returnvalue">size_t</span> g_mime_encoding_quoted_decode_step (<em class="parameter"><code>const unsigned <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>unsigned <span class="type">char</span> *outbuf</code></em>, + <em class="parameter"><code><span class="type">int</span> *state</code></em>, + <em class="parameter"><code><span class="type">guint32</span> *save</code></em>);</pre> +<p> +Decodes a block of quoted-printable encoded data. Performs a +'decode step' on a chunk of QP encoded data. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>inbuf</code></em> :</span></p></td> +<td>input buffer</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>inlen</code></em> :</span></p></td> +<td>input buffer length</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>outbuf</code></em> :</span></p></td> +<td>output buffer</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td> +<td>holds the number of bits that are stored in <em class="parameter"><code>save</code></em> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>save</code></em> :</span></p></td> +<td>leftover bits that have not yet been decoded</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the number of bytes decoded.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-encoding-quoted-encode-step"></a><h3>g_mime_encoding_quoted_encode_step ()</h3> +<pre class="programlisting"><span class="returnvalue">size_t</span> g_mime_encoding_quoted_encode_step (<em class="parameter"><code>const unsigned <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>unsigned <span class="type">char</span> *outbuf</code></em>, + <em class="parameter"><code><span class="type">int</span> *state</code></em>, + <em class="parameter"><code><span class="type">guint32</span> *save</code></em>);</pre> +<p> +Quoted-printable encodes a block of text. Performs an 'encode +step', saves left-over state in state and save (initialise to -1 on +first invocation). +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>inbuf</code></em> :</span></p></td> +<td>input buffer</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>inlen</code></em> :</span></p></td> +<td>input buffer length</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>outbuf</code></em> :</span></p></td> +<td>output buffer</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td> +<td>holds the number of bits that are stored in <em class="parameter"><code>save</code></em> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>save</code></em> :</span></p></td> +<td>leftover bits that have not yet been encoded</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the number of bytes encoded.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-encoding-quoted-encode-close"></a><h3>g_mime_encoding_quoted_encode_close ()</h3> +<pre class="programlisting"><span class="returnvalue">size_t</span> g_mime_encoding_quoted_encode_close (<em class="parameter"><code>const unsigned <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>unsigned <span class="type">char</span> *outbuf</code></em>, + <em class="parameter"><code><span class="type">int</span> *state</code></em>, + <em class="parameter"><code><span class="type">guint32</span> *save</code></em>);</pre> +<p> +Quoted-printable encodes a block of text. Call this when finished +encoding data with <a class="link" href="gmime-gmime-encodings.html#g-mime-encoding-quoted-encode-step" title="g_mime_encoding_quoted_encode_step ()"><code class="function">g_mime_encoding_quoted_encode_step()</code></a> to flush off +the last little bit. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>inbuf</code></em> :</span></p></td> +<td>input buffer</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>inlen</code></em> :</span></p></td> +<td>input buffer length</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>outbuf</code></em> :</span></p></td> +<td>output buffer</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td> +<td>holds the number of bits that are stored in <em class="parameter"><code>save</code></em> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>save</code></em> :</span></p></td> +<td>leftover bits that have not yet been encoded</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the number of bytes encoded.</td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/gmime-gmime-iconv-utils.html b/docs/reference/html/gmime-gmime-iconv-utils.html new file mode 100644 index 0000000..1bec9fb --- /dev/null +++ b/docs/reference/html/gmime-gmime-iconv-utils.html @@ -0,0 +1,229 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>gmime-iconv-utils</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="core.html" title="Part III. GMime Core Reference"> +<link rel="prev" href="gmime-gmime-iconv.html" title="gmime-iconv"> +<link rel="next" href="gmime-gmime-encodings.html" title="gmime-encodings"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="gmime-gmime-iconv.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="core.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="gmime-gmime-encodings.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#gmime-gmime-iconv-utils.synopsis" class="shortcut">Top</a> +  | + <a href="#gmime-gmime-iconv-utils.description" class="shortcut">Description</a> +</td></tr> +</table> +<div class="refentry"> +<a name="gmime-gmime-iconv-utils"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="gmime-gmime-iconv-utils.top_of_page"></a>gmime-iconv-utils</span></h2> +<p>gmime-iconv-utils — High-level routines for converting text from one charset to another</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="gmime-gmime-iconv-utils.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis"><span class="returnvalue">char</span> * <a class="link" href="gmime-gmime-iconv-utils.html#g-mime-iconv-strdup" title="g_mime_iconv_strdup ()">g_mime_iconv_strdup</a> (<em class="parameter"><code><span class="type">iconv_t</span> cd</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *str</code></em>); +<span class="returnvalue">char</span> * <a class="link" href="gmime-gmime-iconv-utils.html#g-mime-iconv-strndup" title="g_mime_iconv_strndup ()">g_mime_iconv_strndup</a> (<em class="parameter"><code><span class="type">iconv_t</span> cd</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *str</code></em>, + <em class="parameter"><code><span class="type">size_t</span> n</code></em>); +<span class="returnvalue">char</span> * <a class="link" href="gmime-gmime-iconv-utils.html#g-mime-iconv-utf8-to-locale" title="g_mime_iconv_utf8_to_locale ()">g_mime_iconv_utf8_to_locale</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-iconv-utils.html#g-mime-iconv-utf8-to-locale-length" title="g_mime_iconv_utf8_to_locale_length ()">g_mime_iconv_utf8_to_locale_length</a> (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>, + <em class="parameter"><code><span class="type">size_t</span> n</code></em>); +<span class="returnvalue">char</span> * <a class="link" href="gmime-gmime-iconv-utils.html#g-mime-iconv-locale-to-utf8" title="g_mime_iconv_locale_to_utf8 ()">g_mime_iconv_locale_to_utf8</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-iconv-utils.html#g-mime-iconv-locale-to-utf8-length" title="g_mime_iconv_locale_to_utf8_length ()">g_mime_iconv_locale_to_utf8_length</a> (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>, + <em class="parameter"><code><span class="type">size_t</span> n</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="gmime-gmime-iconv-utils.description"></a><h2>Description</h2> +<p> +Charset conversion utility functions. +</p> +</div> +<div class="refsect1"> +<a name="gmime-gmime-iconv-utils.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="g-mime-iconv-strdup"></a><h3>g_mime_iconv_strdup ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * g_mime_iconv_strdup (<em class="parameter"><code><span class="type">iconv_t</span> cd</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *str</code></em>);</pre> +<p> +Allocates a new string buffer containing <em class="parameter"><code>str</code></em> converted to the +destination charset described in <em class="parameter"><code>cd</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>cd</code></em> :</span></p></td> +<td>conversion descriptor</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td> +<td>string in source charset</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a new string buffer containing the original string +converted to the new charset.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-iconv-strndup"></a><h3>g_mime_iconv_strndup ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * g_mime_iconv_strndup (<em class="parameter"><code><span class="type">iconv_t</span> cd</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *str</code></em>, + <em class="parameter"><code><span class="type">size_t</span> n</code></em>);</pre> +<p> +Allocates a new string buffer containing the first <em class="parameter"><code>n</code></em> bytes of <em class="parameter"><code>str</code></em> +converted to the destination charset as described by the conversion +descriptor <em class="parameter"><code>cd</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>cd</code></em> :</span></p></td> +<td>conversion descriptor</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td> +<td>string in source charset</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>n</code></em> :</span></p></td> +<td>number of bytes to convert</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a new string buffer containing the first <em class="parameter"><code>n</code></em> bytes of +<em class="parameter"><code>str</code></em> converted to the destination charset as described by the +conversion descriptor <em class="parameter"><code>cd</code></em>.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-iconv-utf8-to-locale"></a><h3>g_mime_iconv_utf8_to_locale ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * g_mime_iconv_utf8_to_locale (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>);</pre> +<p> +Allocates a new string buffer containing <em class="parameter"><code>str</code></em> converted to the +user's locale charset. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td> +<td>string in UTF-8 charset</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a new string buffer containing <em class="parameter"><code>str</code></em> converted to the +user's locale charset.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-iconv-utf8-to-locale-length"></a><h3>g_mime_iconv_utf8_to_locale_length ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * g_mime_iconv_utf8_to_locale_length (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>, + <em class="parameter"><code><span class="type">size_t</span> n</code></em>);</pre> +<p> +Allocates a new string buffer containing the first <em class="parameter"><code>n</code></em> bytes of +<em class="parameter"><code>str</code></em> converted to the user's locale charset. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td> +<td>string in UTF-8 charset</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>n</code></em> :</span></p></td> +<td>number of bytes to convert</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a new string buffer containing the first <em class="parameter"><code>n</code></em> bytes of +<em class="parameter"><code>str</code></em> converted to the user's locale charset.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-iconv-locale-to-utf8"></a><h3>g_mime_iconv_locale_to_utf8 ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * g_mime_iconv_locale_to_utf8 (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>);</pre> +<p> +Allocates a new string buffer containing <em class="parameter"><code>str</code></em> 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>str</code></em> :</span></p></td> +<td>string in locale charset</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a new string buffer containing <em class="parameter"><code>str</code></em> converted to UTF-8.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-iconv-locale-to-utf8-length"></a><h3>g_mime_iconv_locale_to_utf8_length ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * g_mime_iconv_locale_to_utf8_length (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>, + <em class="parameter"><code><span class="type">size_t</span> n</code></em>);</pre> +<p> +Allocates a new string buffer containing the first <em class="parameter"><code>n</code></em> bytes of +<em class="parameter"><code>str</code></em> converted to 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>str</code></em> :</span></p></td> +<td>string in locale charset</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>n</code></em> :</span></p></td> +<td>number of bytes to convert</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a new string buffer containing the first <em class="parameter"><code>n</code></em> bytes of +<em class="parameter"><code>str</code></em> converted to UTF-8.</td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/gmime-gmime-iconv.html b/docs/reference/html/gmime-gmime-iconv.html new file mode 100644 index 0000000..2a76909 --- /dev/null +++ b/docs/reference/html/gmime-gmime-iconv.html @@ -0,0 +1,258 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>gmime-iconv</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="core.html" title="Part III. GMime Core Reference"> +<link rel="prev" href="gmime-gmime-charset.html" title="gmime-charset"> +<link rel="next" href="gmime-gmime-iconv-utils.html" title="gmime-iconv-utils"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="gmime-gmime-charset.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="core.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="gmime-gmime-iconv-utils.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#gmime-gmime-iconv.synopsis" class="shortcut">Top</a> +  | + <a href="#gmime-gmime-iconv.description" class="shortcut">Description</a> +</td></tr> +</table> +<div class="refentry"> +<a name="gmime-gmime-iconv"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="gmime-gmime-iconv.top_of_page"></a>gmime-iconv</span></h2> +<p>gmime-iconv — Low-level routines for converting text from one charset to another</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="gmime-gmime-iconv.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis"><span class="returnvalue">void</span> <a class="link" href="gmime-gmime-iconv.html#g-mime-iconv-init" title="g_mime_iconv_init ()">g_mime_iconv_init</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +<span class="returnvalue">void</span> <a class="link" href="gmime-gmime-iconv.html#g-mime-iconv-shutdown" title="g_mime_iconv_shutdown ()">g_mime_iconv_shutdown</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +<span class="returnvalue">iconv_t</span> <a class="link" href="gmime-gmime-iconv.html#g-mime-iconv-open" title="g_mime_iconv_open ()">g_mime_iconv_open</a> (<em class="parameter"><code>const <span class="type">char</span> *to</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *from</code></em>); +#define <a class="link" href="gmime-gmime-iconv.html#g-mime-iconv" title="g_mime_iconv()">g_mime_iconv</a> (cd, + inbuf, + inleft, + outbuf, + outleft) +<span class="returnvalue">int</span> <a class="link" href="gmime-gmime-iconv.html#g-mime-iconv-close" title="g_mime_iconv_close ()">g_mime_iconv_close</a> (<em class="parameter"><code><span class="type">iconv_t</span> cd</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="gmime-gmime-iconv.description"></a><h2>Description</h2> +<p> +These functions are wrappers around the system iconv(3) +routines. The purpose of these wrappers are two-fold: +</p> +<p> +1. Cache iconv_t descriptors for you in order to optimize +opening/closing many descriptors frequently +</p> +<p> +and +</p> +<p> +2. To use the appropriate system charset alias for the MIME charset +names given as arguments. +</p> +</div> +<div class="refsect1"> +<a name="gmime-gmime-iconv.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="g-mime-iconv-init"></a><h3>g_mime_iconv_init ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_iconv_init (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Initialize GMime's iconv cache. This *MUST* be called before any +gmime-iconv interfaces will work correctly. +</p> +<p> +Note: this function is called for you by <a class="link" href="gmime-gmime.html#g-mime-init" title="g_mime_init ()"><code class="function">g_mime_init()</code></a>. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-iconv-shutdown"></a><h3>g_mime_iconv_shutdown ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_iconv_shutdown (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Frees internal iconv caches created in <a class="link" href="gmime-gmime-iconv.html#g-mime-iconv-init" title="g_mime_iconv_init ()"><code class="function">g_mime_iconv_init()</code></a>. +</p> +<p> +Note: this function is called for you by <a class="link" href="gmime-gmime.html#g-mime-shutdown" title="g_mime_shutdown ()"><code class="function">g_mime_shutdown()</code></a>. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-iconv-open"></a><h3>g_mime_iconv_open ()</h3> +<pre class="programlisting"><span class="returnvalue">iconv_t</span> g_mime_iconv_open (<em class="parameter"><code>const <span class="type">char</span> *to</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *from</code></em>);</pre> +<p> +Allocates a coversion descriptor suitable for converting byte +sequences from charset <em class="parameter"><code>from</code></em> to charset <em class="parameter"><code>to</code></em>. The resulting +descriptor can be used with <code class="function">iconv()</code> (or the <a class="link" href="gmime-gmime-iconv.html#g-mime-iconv" title="g_mime_iconv()"><code class="function">g_mime_iconv()</code></a> wrapper) any +number of times until closed using <a class="link" href="gmime-gmime-iconv.html#g-mime-iconv-close" title="g_mime_iconv_close ()"><code class="function">g_mime_iconv_close()</code></a>. +</p> +<p> +See the manual page for iconv_open(3) for further details. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>to</code></em> :</span></p></td> +<td>charset to convert to</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>from</code></em> :</span></p></td> +<td>charset to convert from</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a new conversion descriptor for use with <a class="link" href="gmime-gmime-iconv.html#g-mime-iconv" title="g_mime_iconv()"><code class="function">g_mime_iconv()</code></a> on +success or (iconv_t) <code class="literal">-1</code> on fail as well as setting an appropriate +errno value.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-iconv"></a><h3>g_mime_iconv()</h3> +<pre class="programlisting">#define g_mime_iconv(cd,inbuf,inleft,outbuf,outleft)</pre> +<p> +The argument <em class="parameter"><code>cd</code></em> must be a conversion descriptor created using the +function <a class="link" href="gmime-gmime-iconv.html#g-mime-iconv-open" title="g_mime_iconv_open ()"><span class="type">g_mime_iconv_open</span></a>. +</p> +<p> +The main case is when <em class="parameter"><code>inbuf</code></em> is not <code class="literal">NULL</code> and *inbuf is not +<code class="literal">NULL</code>. In this case, the <a class="link" href="gmime-gmime-iconv.html#g-mime-iconv" title="g_mime_iconv()"><span class="type">g_mime_iconv</span></a> function converts the +multibyte sequence starting at *inbuf to a multibyte sequence +starting at *outbuf. At most *inleft bytes, starting at *inbuf, +will be read. At most *outleft bytes, starting at *outbuf, will +be written. +</p> +<p> +The <a class="link" href="gmime-gmime-iconv.html#g-mime-iconv" title="g_mime_iconv()"><span class="type">g_mime_iconv</span></a> function converts one multibyte character at a +time, and for each character conversion it increments *inbuf and +decrements *inleft by the number of converted input bytes, it +increments *outbuf and decrements *outleft by the number of +converted output bytes, and it updates the conversion state +contained in <em class="parameter"><code>cd</code></em>. The conversion can stop for four reasons: +</p> +<p> +1. An invalid multibyte sequence is encountered in the input. In +this case it sets errno to <code class="literal">EILSEQ</code> and returns (size_t)(-1). +*inbuf is left pointing to the beginning of the invalid multibyte +sequence. +</p> +<p> +2. The input byte sequence has been entirely converted, i.e. +*inleft has gone down to <code class="literal">0</code>. In this case <a class="link" href="gmime-gmime-iconv.html#g-mime-iconv" title="g_mime_iconv()"><span class="type">g_mime_iconv</span></a> returns +the number of non-reversible conversions performed during this +call. +</p> +<p> +3. An incomplete multibyte sequence is encountered in the input, +and the input byte sequence terminates after it. In this case it +sets errno to <code class="literal">EINVAL</code> and returns (size_t)(-1). *inbuf is left +pointing to the beginning of the incomplete multibyte sequence. +</p> +<p> +4. The output buffer has no more room for the next converted +character. In this case it sets errno to <code class="literal">E2BIG</code> and returns +(size_t)(-1). +</p> +<p> +A different case is when <em class="parameter"><code>inbuf</code></em> is <code class="literal">NULL</code> or *inbuf is <code class="literal">NULL</code>, but +<em class="parameter"><code>outbuf</code></em> is not <code class="literal">NULL</code> and *outbuf is not <code class="literal">NULL</code>. In this case, the +<a class="link" href="gmime-gmime-iconv.html#g-mime-iconv" title="g_mime_iconv()"><span class="type">g_mime_iconv</span></a> function attempts to set <em class="parameter"><code>cd</code></em>'s conversion state to +the initial state and store a corresponding shift sequence at +*outbuf. At most *outleft bytes, starting at *outbuf, will be +written. If the output buffer has no more room for this reset +sequence, it sets errno to <code class="literal">E2BIG</code> and returns (size_t)(-1). +Otherwise it increments *outbuf and decrements *outleft by the +number of bytes written. +</p> +<p> +A third case is when <em class="parameter"><code>inbuf</code></em> is <code class="literal">NULL</code> or *inbuf is <code class="literal">NULL</code>, and +<em class="parameter"><code>outbuf</code></em> is <code class="literal">NULL</code> or *outbuf is <code class="literal">NULL</code>. In this case, the +<a class="link" href="gmime-gmime-iconv.html#g-mime-iconv" title="g_mime_iconv()"><span class="type">g_mime_iconv</span></a> function sets <em class="parameter"><code>cd</code></em>'s conversion state to the initial +state. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>cd</code></em> :</span></p></td> +<td>iconv_t conversion descriptor</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>inbuf</code></em> :</span></p></td> +<td>input buffer</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>inleft</code></em> :</span></p></td> +<td>number of bytes left in <em class="parameter"><code>inbuf</code></em> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>outbuf</code></em> :</span></p></td> +<td>output buffer</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>outleft</code></em> :</span></p></td> +<td>number of bytes left in <em class="parameter"><code>outbuf</code></em> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the number of characters converted in a nonreversible way +during this call; reversible conversions are not counted. In case +of error, it sets errno and returns (size_t)(-1).</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-iconv-close"></a><h3>g_mime_iconv_close ()</h3> +<pre class="programlisting"><span class="returnvalue">int</span> g_mime_iconv_close (<em class="parameter"><code><span class="type">iconv_t</span> cd</code></em>);</pre> +<p> +Closes the iconv descriptor <em class="parameter"><code>cd</code></em>. +</p> +<p> +See the manual page for iconv_close(3) for further details. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>cd</code></em> :</span></p></td> +<td>iconv conversion descriptor</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">0</code> on success or <code class="literal">-1</code> on fail as well as setting an +appropriate errno value.</td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/gmime-gmime-utils.html b/docs/reference/html/gmime-gmime-utils.html new file mode 100644 index 0000000..30607e7 --- /dev/null +++ b/docs/reference/html/gmime-gmime-utils.html @@ -0,0 +1,642 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>gmime-utils</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="core.html" title="Part III. GMime Core Reference"> +<link rel="prev" href="gmime-gmime-encodings.html" title="gmime-encodings"> +<link rel="next" href="classes.html" title="Part IV. GMime Classes"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="gmime-gmime-encodings.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="core.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="classes.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#gmime-gmime-utils.synopsis" class="shortcut">Top</a> +  | + <a href="#gmime-gmime-utils.description" class="shortcut">Description</a> +</td></tr> +</table> +<div class="refentry"> +<a name="gmime-gmime-utils"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="gmime-gmime-utils.top_of_page"></a>gmime-utils</span></h2> +<p>gmime-utils — MIME utility functions</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="gmime-gmime-utils.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">struct <a class="link" href="gmime-gmime-utils.html#GMimeReferences" title="struct GMimeReferences">GMimeReferences</a>; +<span class="returnvalue">time_t</span> <a class="link" href="gmime-gmime-utils.html#g-mime-utils-header-decode-date" title="g_mime_utils_header_decode_date ()">g_mime_utils_header_decode_date</a> (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>, + <em class="parameter"><code><span class="type">int</span> *tz_offset</code></em>); +<span class="returnvalue">char</span> * <a class="link" href="gmime-gmime-utils.html#g-mime-utils-header-format-date" title="g_mime_utils_header_format_date ()">g_mime_utils_header_format_date</a> (<em class="parameter"><code><span class="type">time_t</span> date</code></em>, + <em class="parameter"><code><span class="type">int</span> tz_offset</code></em>); +<span class="returnvalue">char</span> * <a class="link" href="gmime-gmime-utils.html#g-mime-utils-generate-message-id" title="g_mime_utils_generate_message_id ()">g_mime_utils_generate_message_id</a> (<em class="parameter"><code>const <span class="type">char</span> *fqdn</code></em>); +<span class="returnvalue">char</span> * <a class="link" href="gmime-gmime-utils.html#g-mime-utils-decode-message-id" title="g_mime_utils_decode_message_id ()">g_mime_utils_decode_message_id</a> (<em class="parameter"><code>const <span class="type">char</span> *message_id</code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="gmime-gmime-utils.html#g-mime-references-get-message-id" title="g_mime_references_get_message_id ()">g_mime_references_get_message_id</a> (<em class="parameter"><code>const <a class="link" href="gmime-gmime-utils.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a> *ref</code></em>); +const <a class="link" href="gmime-gmime-utils.html#GMimeReferences" title="struct GMimeReferences"><span class="returnvalue">GMimeReferences</span></a> * <a class="link" href="gmime-gmime-utils.html#g-mime-references-get-next" title="g_mime_references_get_next ()">g_mime_references_get_next</a> (<em class="parameter"><code>const <a class="link" href="gmime-gmime-utils.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a> *ref</code></em>); +<a class="link" href="gmime-gmime-utils.html#GMimeReferences" title="struct GMimeReferences"><span class="returnvalue">GMimeReferences</span></a> * <a class="link" href="gmime-gmime-utils.html#g-mime-references-decode" title="g_mime_references_decode ()">g_mime_references_decode</a> (<em class="parameter"><code>const <span class="type">char</span> *text</code></em>); +<span class="returnvalue">void</span> <a class="link" href="gmime-gmime-utils.html#g-mime-references-append" title="g_mime_references_append ()">g_mime_references_append</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>, + <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-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>); +<span class="returnvalue">void</span> <a class="link" href="gmime-gmime-utils.html#g-mime-utils-unquote-string" title="g_mime_utils_unquote_string ()">g_mime_utils_unquote_string</a> (<em class="parameter"><code><span class="type">char</span> *str</code></em>); +<span class="returnvalue">gboolean</span> <a class="link" href="gmime-gmime-utils.html#g-mime-utils-text-is-8bit" title="g_mime_utils_text_is_8bit ()">g_mime_utils_text_is_8bit</a> (<em class="parameter"><code>const unsigned <span class="type">char</span> *text</code></em>, + <em class="parameter"><code><span class="type">size_t</span> len</code></em>); +<a class="link" href="gmime-gmime-encodings.html#GMimeContentEncoding" title="enum GMimeContentEncoding"><span class="returnvalue">GMimeContentEncoding</span></a> <a class="link" href="gmime-gmime-utils.html#g-mime-utils-best-encoding" title="g_mime_utils_best_encoding ()">g_mime_utils_best_encoding</a> (<em class="parameter"><code>const unsigned <span class="type">char</span> *text</code></em>, + <em class="parameter"><code><span class="type">size_t</span> len</code></em>); +<span class="returnvalue">char</span> * <a class="link" href="gmime-gmime-utils.html#g-mime-utils-decode-8bit" title="g_mime_utils_decode_8bit ()">g_mime_utils_decode_8bit</a> (<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>); +<span class="returnvalue">char</span> * <a class="link" href="gmime-gmime-utils.html#g-mime-utils-header-decode-text" title="g_mime_utils_header_decode_text ()">g_mime_utils_header_decode_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-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-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>); +</pre> +</div> +<div class="refsect1"> +<a name="gmime-gmime-utils.description"></a><h2>Description</h2> +<p> +Utility functions to parse, encode and decode various MIME tokens +and encodings. +</p> +</div> +<div class="refsect1"> +<a name="gmime-gmime-utils.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMimeReferences"></a><h3>struct GMimeReferences</h3> +<pre class="programlisting">struct GMimeReferences { + GMimeReferences *next; + char *msgid; +}; +</pre> +<p> +A List of references, as per the References or In-Reply-To header +fields. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><a class="link" href="gmime-gmime-utils.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a> *<em class="structfield"><code><a name="GMimeReferences.next"></a>next</code></em>;</span></p></td> +<td>Pointer to the next reference.</td> +</tr> +<tr> +<td><p><span class="term"><span class="type">char</span> *<em class="structfield"><code><a name="GMimeReferences.msgid"></a>msgid</code></em>;</span></p></td> +<td>Reference message-id.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-utils-header-decode-date"></a><h3>g_mime_utils_header_decode_date ()</h3> +<pre class="programlisting"><span class="returnvalue">time_t</span> g_mime_utils_header_decode_date (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>, + <em class="parameter"><code><span class="type">int</span> *tz_offset</code></em>);</pre> +<p> +Decodes the rfc822 date string and saves the GMT offset into +<em class="parameter"><code>tz_offset</code></em> if non-NULL. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td> +<td>input date string</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>tz_offset</code></em> :</span></p></td> +<td>timezone offset</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the time_t representation of the date string specified by +<em class="parameter"><code>str</code></em> or (time_t) <code class="literal">0</code> on error. If <em class="parameter"><code>tz_offset</code></em> is non-NULL, the value +of the timezone offset will be stored.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-utils-header-format-date"></a><h3>g_mime_utils_header_format_date ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * g_mime_utils_header_format_date (<em class="parameter"><code><span class="type">time_t</span> date</code></em>, + <em class="parameter"><code><span class="type">int</span> tz_offset</code></em>);</pre> +<p> +Allocates a string buffer containing the rfc822 formatted date +string represented by <em class="parameter"><code>time</code></em> and <em class="parameter"><code>tz_offset</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>date</code></em> :</span></p></td> +<td>time_t date representation</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>tz_offset</code></em> :</span></p></td> +<td>Timezone offset</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a valid string representation of the date.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-utils-generate-message-id"></a><h3>g_mime_utils_generate_message_id ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * g_mime_utils_generate_message_id (<em class="parameter"><code>const <span class="type">char</span> *fqdn</code></em>);</pre> +<p> +Generates a unique Message-Id. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>fqdn</code></em> :</span></p></td> +<td>Fully qualified domain name</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a unique string in an addr-spec format suitable for use as +a Message-Id.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-utils-decode-message-id"></a><h3>g_mime_utils_decode_message_id ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * g_mime_utils_decode_message_id (<em class="parameter"><code>const <span class="type">char</span> *message_id</code></em>);</pre> +<p> +Decodes a msg-id as defined by rfc822. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>message_id</code></em> :</span></p></td> +<td>string containing a message-id</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the addr-spec portion of the msg-id.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-references-get-message-id"></a><h3>g_mime_references_get_message_id ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_references_get_message_id (<em class="parameter"><code>const <a class="link" href="gmime-gmime-utils.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a> *ref</code></em>);</pre> +<p> +Gets the Message-Id reference from the <a class="link" href="gmime-gmime-utils.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a> node. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>ref</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-gmime-utils.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a> list</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the Message-Id reference from the <a class="link" href="gmime-gmime-utils.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a> node.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-references-get-next"></a><h3>g_mime_references_get_next ()</h3> +<pre class="programlisting">const <a class="link" href="gmime-gmime-utils.html#GMimeReferences" title="struct GMimeReferences"><span class="returnvalue">GMimeReferences</span></a> * g_mime_references_get_next (<em class="parameter"><code>const <a class="link" href="gmime-gmime-utils.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a> *ref</code></em>);</pre> +<p> +Advances to the next reference node in the <a class="link" href="gmime-gmime-utils.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a> list. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>ref</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-gmime-utils.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a> list</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the next reference node in the <a class="link" href="gmime-gmime-utils.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a> list.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-references-decode"></a><h3>g_mime_references_decode ()</h3> +<pre class="programlisting"><a class="link" href="gmime-gmime-utils.html#GMimeReferences" title="struct GMimeReferences"><span class="returnvalue">GMimeReferences</span></a> * g_mime_references_decode (<em class="parameter"><code>const <span class="type">char</span> *text</code></em>);</pre> +<p> +Decodes a list of msg-ids as in the References and/or In-Reply-To +headers defined in rfc822. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td> +<td>string containing a list of msg-ids</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a list of referenced msg-ids.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-references-append"></a><h3>g_mime_references_append ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_references_append (<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>, + <em class="parameter"><code>const <span class="type">char</span> *msgid</code></em>);</pre> +<p> +Appends a reference to msgid to the list of references. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>refs</code></em> :</span></p></td> +<td>the address of a <a class="link" href="gmime-gmime-utils.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a> list</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>msgid</code></em> :</span></p></td> +<td>a message-id string</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-references-clear"></a><h3>g_mime_references_clear ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_references_clear (<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>);</pre> +<p> +Clears the <a class="link" href="gmime-gmime-utils.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a> list and resets it to <code class="literal">NULL</code>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><em class="parameter"><code>refs</code></em> :</span></p></td> +<td>address of a <a class="link" href="gmime-gmime-utils.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a> list</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-references-free"></a><h3>g_mime_references_free ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_references_free (<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>);</pre> +<p> +Frees the <a class="link" href="gmime-gmime-utils.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a> list. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><em class="parameter"><code>refs</code></em> :</span></p></td> +<td>a <a class="link" href="gmime-gmime-utils.html#GMimeReferences" title="struct GMimeReferences"><span class="type">GMimeReferences</span></a> list</td> +</tr></tbody> +</table></div> +</div> +<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> +<p> +Folds a structured header according to the rules in rfc822. +</p> +<div class="variablelist"><table border="0"> +<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> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-utils-header-printf"></a><h3>g_mime_utils_header_printf ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * g_mime_utils_header_printf (<em class="parameter"><code>const <span class="type">char</span> *format</code></em>, + <em class="parameter"><code>...</code></em>);</pre> +<p> +Allocates a buffer containing a formatted header specified by the +<em class="parameter"><code>Varargs</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>format</code></em> :</span></p></td> +<td>string format</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 specified +by <em class="parameter"><code>format</code></em> and the following arguments.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-utils-quote-string"></a><h3>g_mime_utils_quote_string ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * g_mime_utils_quote_string (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>);</pre> +<p> +Quotes <em class="parameter"><code>string</code></em> as needed according to the rules in rfc2045. +</p> +<div class="variablelist"><table border="0"> +<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> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>an allocated string containing the escaped and quoted (if +needed to be) input string. The decision to quote the string is +based on whether or not the input string contains any 'tspecials' +as defined by rfc2045.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-utils-unquote-string"></a><h3>g_mime_utils_unquote_string ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_utils_unquote_string (<em class="parameter"><code><span class="type">char</span> *str</code></em>);</pre> +<p> +Unquotes and unescapes a string. +</p> +<div class="variablelist"><table border="0"> +<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> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-utils-text-is-8bit"></a><h3>g_mime_utils_text_is_8bit ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_utils_text_is_8bit (<em class="parameter"><code>const unsigned <span class="type">char</span> *text</code></em>, + <em class="parameter"><code><span class="type">size_t</span> len</code></em>);</pre> +<p> +Determines if <em class="parameter"><code>text</code></em> contains 8bit characters within the first <em class="parameter"><code>len</code></em> +bytes. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td> +<td>text to check for 8bit chars</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>len</code></em> :</span></p></td> +<td>text length</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> if the text contains 8bit characters or <code class="literal">FALSE</code> +otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-utils-best-encoding"></a><h3>g_mime_utils_best_encoding ()</h3> +<pre class="programlisting"><a class="link" href="gmime-gmime-encodings.html#GMimeContentEncoding" title="enum GMimeContentEncoding"><span class="returnvalue">GMimeContentEncoding</span></a> g_mime_utils_best_encoding (<em class="parameter"><code>const unsigned <span class="type">char</span> *text</code></em>, + <em class="parameter"><code><span class="type">size_t</span> len</code></em>);</pre> +<p> +Determines the best content encoding for the first <em class="parameter"><code>len</code></em> bytes of +<em class="parameter"><code>text</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>text</code></em> :</span></p></td> +<td>text to encode</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>len</code></em> :</span></p></td> +<td>text length</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a <a class="link" href="gmime-gmime-encodings.html#GMimeContentEncoding" title="enum GMimeContentEncoding"><span class="type">GMimeContentEncoding</span></a> that is determined to be the best +encoding type for the specified block of text. ("best" in this +particular case means smallest output size)</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-utils-decode-8bit"></a><h3>g_mime_utils_decode_8bit ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * g_mime_utils_decode_8bit (<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> +<p> +Attempts to convert text in an unknown 8bit/multibyte charset into +UTF-8 by finding the charset which will convert the most bytes into +valid UTF-8 characters as possible. If no exact match can be found, +it will choose the best match and convert invalid byte sequences +into question-marks (?) in the returned string buffer. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<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> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>len</code></em> :</span></p></td> +<td>input text length</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a UTF-8 string representation of <em class="parameter"><code>text</code></em>.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-utils-header-decode-text"></a><h3>g_mime_utils_header_decode_text ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * g_mime_utils_header_decode_text (<em class="parameter"><code>const <span class="type">char</span> *text</code></em>);</pre> +<p> +Decodes an rfc2047 encoded 'text' header. +</p> +<p> +Note: See <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> for details on how charset +conversion is handled for unencoded 8bit text and/or wrongly +specified rfc2047 encoded-word tokens. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td> +<td>header text to decode</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a newly allocated UTF-8 string representing the the decoded +header.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-utils-header-encode-text"></a><h3>g_mime_utils_header_encode_text ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * g_mime_utils_header_encode_text (<em class="parameter"><code>const <span class="type">char</span> *text</code></em>);</pre> +<p> +Encodes a 'text' header according to the rules in rfc2047. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td> +<td>text to encode</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the encoded header. Useful for encoding +headers like "Subject".</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-utils-header-decode-phrase"></a><h3>g_mime_utils_header_decode_phrase ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * g_mime_utils_header_decode_phrase (<em class="parameter"><code>const <span class="type">char</span> *phrase</code></em>);</pre> +<p> +Decodes an rfc2047 encoded 'phrase' header. +</p> +<p> +Note: See <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> for details on how charset +conversion is handled for unencoded 8bit text and/or wrongly +specified rfc2047 encoded-word tokens. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>phrase</code></em> :</span></p></td> +<td>header to decode</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>a newly allocated UTF-8 string representing the the decoded +header.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-utils-header-encode-phrase"></a><h3>g_mime_utils_header_encode_phrase ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * g_mime_utils_header_encode_phrase (<em class="parameter"><code>const <span class="type">char</span> *phrase</code></em>);</pre> +<p> +Encodes a 'phrase' header according to the rules in rfc2047. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>phrase</code></em> :</span></p></td> +<td>phrase to encode</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the encoded 'phrase'. Useful for encoding internet +addresses.</td> +</tr> +</tbody> +</table></div> +</div> +<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> +<p> +Folds a structured header according to the rules in rfc822. +</p> +<div class="variablelist"><table border="0"> +<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> +</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> +</tr> +</tbody> +</table></div> +</div> +<hr> +<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> +<p> +Folds an unstructured header according to the rules in rfc822. +</p> +<div class="variablelist"><table border="0"> +<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> +</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> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/gmime-gmime.html b/docs/reference/html/gmime-gmime.html new file mode 100644 index 0000000..f354443 --- /dev/null +++ b/docs/reference/html/gmime-gmime.html @@ -0,0 +1,261 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>gmime</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="core.html" title="Part III. GMime Core Reference"> +<link rel="prev" href="core.html" title="Part III. GMime Core Reference"> +<link rel="next" href="gmime-gmime-charset.html" title="gmime-charset"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="core.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="core.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="gmime-gmime-charset.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#gmime-gmime.synopsis" class="shortcut">Top</a> +  | + <a href="#gmime-gmime.description" class="shortcut">Description</a> +</td></tr> +</table> +<div class="refentry"> +<a name="gmime-gmime"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="gmime-gmime.top_of_page"></a>gmime</span></h2> +<p>gmime — Initialization, shutdown and version-check routines</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="gmime-gmime.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">#define <a class="link" href="gmime-gmime.html#GMIME-MAJOR-VERSION:CAPS" title="GMIME_MAJOR_VERSION">GMIME_MAJOR_VERSION</a> +#define <a class="link" href="gmime-gmime.html#GMIME-MICRO-VERSION:CAPS" title="GMIME_MICRO_VERSION">GMIME_MICRO_VERSION</a> +#define <a class="link" href="gmime-gmime.html#GMIME-MINOR-VERSION:CAPS" title="GMIME_MINOR_VERSION">GMIME_MINOR_VERSION</a> +#define <a class="link" href="gmime-gmime.html#GMIME-BINARY-AGE:CAPS" title="GMIME_BINARY_AGE">GMIME_BINARY_AGE</a> +#define <a class="link" href="gmime-gmime.html#GMIME-INTERFACE-AGE:CAPS" title="GMIME_INTERFACE_AGE">GMIME_INTERFACE_AGE</a> +#define <a class="link" href="gmime-gmime.html#GMIME-CHECK-VERSION:CAPS" title="GMIME_CHECK_VERSION()">GMIME_CHECK_VERSION</a> (major, + 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> +<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>; +extern const guint <a class="link" href="gmime-gmime.html#gmime-minor-version" title="gmime_minor_version">gmime_minor_version</a>; +extern const guint <a class="link" href="gmime-gmime.html#gmime-micro-version" title="gmime_micro_version">gmime_micro_version</a>; +extern const guint <a class="link" href="gmime-gmime.html#gmime-binary-age" title="gmime_binary_age">gmime_binary_age</a>; +extern const guint <a class="link" href="gmime-gmime.html#gmime-interface-age" title="gmime_interface_age">gmime_interface_age</a>; +<span class="returnvalue">gboolean</span> <a class="link" href="gmime-gmime.html#g-mime-check-version" title="g_mime_check_version ()">g_mime_check_version</a> (<em class="parameter"><code><span class="type">guint</span> major</code></em>, + <em class="parameter"><code><span class="type">guint</span> minor</code></em>, + <em class="parameter"><code><span class="type">guint</span> micro</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="gmime-gmime.description"></a><h2>Description</h2> +<p> +Initialization, shutdown, and version-check functions. +</p> +</div> +<div class="refsect1"> +<a name="gmime-gmime.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="GMIME-MAJOR-VERSION:CAPS"></a><h3>GMIME_MAJOR_VERSION</h3> +<pre class="programlisting">#define GMIME_MAJOR_VERSION (2) +</pre> +<p> +GMime's major version. +</p> +</div> +<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> +<p> +GMime's micro version. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GMIME-MINOR-VERSION:CAPS"></a><h3>GMIME_MINOR_VERSION</h3> +<pre class="programlisting">#define GMIME_MINOR_VERSION (6) +</pre> +<p> +GMime's minor version. +</p> +</div> +<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> +<p> +GMime's binary age. +</p> +</div> +<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> +<p> +GMime's interface age. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="GMIME-CHECK-VERSION:CAPS"></a><h3>GMIME_CHECK_VERSION()</h3> +<pre class="programlisting">#define GMIME_CHECK_VERSION(major,minor,micro)</pre> +<p> +Check whether a GMime version equal to or greater than +<em class="parameter"><code>major</code></em>.<em class="parameter"><code>minor</code></em>.<em class="parameter"><code>micro</code></em> is present. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>major</code></em> :</span></p></td> +<td>Minimum major version</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>minor</code></em> :</span></p></td> +<td>Minimum minor version</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>micro</code></em> :</span></p></td> +<td>Minimum micro version</td> +</tr> +</tbody> +</table></div> +</div> +<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> +<p> +Initialization flag to enable workarounds for badly formed rfc2047 +encoded-words. +</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> +Initializes GMime. +</p> +<p> +Note: Calls <a class="link" href="gmime-gmime-charset.html#g-mime-charset-map-init" title="g_mime_charset_map_init ()"><code class="function">g_mime_charset_map_init()</code></a> and <a class="link" href="gmime-gmime-iconv.html#g-mime-iconv-init" title="g_mime_iconv_init ()"><code class="function">g_mime_iconv_init()</code></a> as +well. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td> +<td>initialization flags</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-shutdown"></a><h3>g_mime_shutdown ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> g_mime_shutdown (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Frees internally allocated tables created in <a class="link" href="gmime-gmime.html#g-mime-init" title="g_mime_init ()"><code class="function">g_mime_init()</code></a>. Also +calls <a class="link" href="gmime-gmime-charset.html#g-mime-charset-map-shutdown" title="g_mime_charset_map_shutdown ()"><code class="function">g_mime_charset_map_shutdown()</code></a> and <a class="link" href="gmime-gmime-iconv.html#g-mime-iconv-shutdown" title="g_mime_iconv_shutdown ()"><code class="function">g_mime_iconv_shutdown()</code></a>. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="gmime-major-version"></a><h3>gmime_major_version</h3> +<pre class="programlisting">extern const guint gmime_major_version; +</pre> +<p> +GMime's major version. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="gmime-minor-version"></a><h3>gmime_minor_version</h3> +<pre class="programlisting">extern const guint gmime_minor_version; +</pre> +<p> +GMime's minor version. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="gmime-micro-version"></a><h3>gmime_micro_version</h3> +<pre class="programlisting">extern const guint gmime_micro_version; +</pre> +<p> +GMime's micro version. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="gmime-binary-age"></a><h3>gmime_binary_age</h3> +<pre class="programlisting">extern const guint gmime_binary_age; +</pre> +<p> +GMime's binary age. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="gmime-interface-age"></a><h3>gmime_interface_age</h3> +<pre class="programlisting">extern const guint gmime_interface_age; +</pre> +<p> +GMime's interface age. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="g-mime-check-version"></a><h3>g_mime_check_version ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_check_version (<em class="parameter"><code><span class="type">guint</span> major</code></em>, + <em class="parameter"><code><span class="type">guint</span> minor</code></em>, + <em class="parameter"><code><span class="type">guint</span> micro</code></em>);</pre> +<p> +Checks that the GMime library version meets the requirements of the +required version. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>major</code></em> :</span></p></td> +<td>Minimum major version</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>minor</code></em> :</span></p></td> +<td>Minimum minor version</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>micro</code></em> :</span></p></td> +<td>Minimum micro version</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +<code class="literal">TRUE</code> if the requirement is met or <code class="literal">FALSE</code> otherwise.</td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/gmime-question-index.html b/docs/reference/html/gmime-question-index.html new file mode 100644 index 0000000..4c198ed --- /dev/null +++ b/docs/reference/html/gmime-question-index.html @@ -0,0 +1,132 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Frequently Asked Questions</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="gmime.html" title="Part I. GMime Overview"> +<link rel="prev" href="gmime-resources.html" title="Mailing lists and bug reports"> +<link rel="next" href="fundamentals.html" title="Part II. GMime Fundamentals"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="gmime-resources.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="gmime.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="fundamentals.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="gmime-question-index"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle">Frequently Asked Questions</span></h2> +<p>Frequently Asked Questions — +Find answers to common questions in the GMime manual +</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="idp5189120"></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"> +<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> +<tr class="question"> +<td align="left" valign="top"> +<a name="idp5201872"></a><a name="idp5202128"></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> +<tr class="answer"> +<td align="left" valign="top"></td> +<td align="left" valign="top"><p>See the <a class="link" href="gmime-resources.html" title="Mailing lists and bug reports">documentation on this + topic</a>.</p></td> +</tr> +<tr class="question"> +<td align="left" valign="top"> +<a name="idp5204368"></a><a name="idp5204624"></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> +</tr> +<tr class="question"> +<td align="left" valign="top"> +<a name="idp5237584"></a><a name="idp5237840"></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> +<tr class="answer"> +<td align="left" valign="top"></td> +<td align="left" valign="top"> +<p>Most accessor functions return a pointer to internal + members. When these internal members are objects + themselves (e.g. subclasses + of <a class="ulink" href="http://developer.gnome.org/doc/API/2.0/gobject/gobject-The-Base-Object-Type.html" target="_top">GObject</a>), + there is no need to unref them unless otherwise stated in + the documentation for that particular function.</p> +<p>For accessor functions that return strings, they will be + declared "const" if they should not be freed. Non-const + strings should be freed with <a class="ulink" href="http://developer.gnome.org/doc/API/2.0/glib/glib-Memory-Allocation.html#g-free" target="_top">g_free()</a>.</p> +</td> +</tr> +<tr class="question"> +<td align="left" valign="top"> +<a name="idp5241536"></a><a name="idp5241792"></a><p><b>1.4.</b></p> +</td> +<td align="left" valign="top"><p>How do I use GMime with threads?</p></td> +</tr> +<tr class="answer"> +<td align="left" valign="top"></td> +<td align="left" valign="top"> +<p>First, read the <a class="ulink" href="http://developer.gnome.org/doc/API/2.0/glib/glib-Threads.html" target="_top">GThread</a> documentation for + portable threading primitives.</p> +<p>Secondly, all functions + in gmime-charset, gmime-iconv + and gmime-utils should + be thread-safe. Objects subclassing + <a class="ulink" href="http://developer.gnome.org/doc/API/2.0/gobject/gobject-The-Base-Object-Type.html" target="_top">GObject</a> + are not. This means that you'll have to do your own mutex + locking if you want to access the same GObjects from + multiple threads. + </p> +</td> +</tr> +<tr class="question"> +<td align="left" valign="top"> +<a name="idp5247232"></a><a name="idp5247488"></a><p><b>1.5.</b></p> +</td> +<td align="left" valign="top"><p>How do I use GMime with C++?</p></td> +</tr> +<tr class="answer"> +<td align="left" valign="top"></td> +<td align="left" valign="top"><p>The GMime header files use the subset of C that's + also valid C++, so you can simply use the normal GMime API + in a C++ program.</p></td> +</tr> +</tbody> +</table> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/gmime-resources.html b/docs/reference/html/gmime-resources.html new file mode 100644 index 0000000..fe05221 --- /dev/null +++ b/docs/reference/html/gmime-resources.html @@ -0,0 +1,82 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Mailing lists and bug reports</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="gmime.html" title="Part I. GMime Overview"> +<link rel="prev" href="gmime-changes-2-6.html" title="Changes from 2.4 to 2.6"> +<link rel="next" href="gmime-question-index.html" title="Frequently Asked Questions"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="gmime-changes-2-6.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="gmime.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="gmime-question-index.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="gmime-resources"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle">Mailing lists and bug reports</span></h2> +<p>Mailing lists and bug reports — +Getting help with GMime +</p> +</td> +<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> +<p> +If you encounter a bug, misfeature, or missing feature in GMime, please +file a bug report at +<a class="ulink" href="http://bugzilla.gnome.org" target="_top">http://bugzilla.gnome.org</a>. +We'd also appreciate reports of incomplete or misleading information in +the GMime documentation; file those against the "docs" component of the +"gmime" product in Bugzilla. +</p> +<p> +The bug tracker should definitely be used for feature requests, it's +not only for bugs. We track all GMime development in Bugzilla, so it's +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> +<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 +patch generated by the <span class="command"><strong>diff</strong></span> utility, using the +<code class="option">-u</code> option to make the patch more readable. All +patches must be offered under the terms of +the <a class="ulink" href="http://www.gnu.org/licenses/lgpl-2.1.txt" target="_top">LGPLv2.1</a> +license, so be sure you are authorized to give us the patch under +those terms. +</p> +<p> +If you want to discuss your patch before or after developing it, mail +<a class="ulink" href="mailto:gmime-devel-list@gnome.org" target="_top">gmime-devel-list@gnome.org</a>, +but be sure to file +the <a class="ulink" href="http://bugzilla.gnome.org" target="_top">Bugzilla</a> report as +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> +<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 + at <a class="ulink" href="http://mail.gnome.org/mailman/listinfo/gmime-devel-list" target="_top">http://mail.gnome.org/mailman/listinfo/gmime-devel-list</a>. +</p> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/gmime-streams.html b/docs/reference/html/gmime-streams.html new file mode 100644 index 0000000..fabe368 --- /dev/null +++ b/docs/reference/html/gmime-streams.html @@ -0,0 +1,90 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMime Streams</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="fundamentals.html" title="Part II. GMime Fundamentals"> +<link rel="prev" href="fundamentals.html" title="Part II. GMime Fundamentals"> +<link rel="next" href="gmime-filters.html" title="GMime Stream Filters"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="fundamentals.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="fundamentals.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="gmime-filters.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="gmime-streams"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle">GMime Streams</span></h2> +<p>GMime Streams — How to use GMime Streams</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="stream-overview"></a><h2>Overview of Streams</h2> +<p>Streams are the fundamental method for reading and writing + data used by GMime. You'll probably notice that the basic API is + similar to that of the low-level Unix I/O layer (read(), write(), + lseek(), etc) with some additional nicities such as a printf-like + function.</p> +<p>The three (3) basic stream types are: GMimeStreamFile, + GMimeStreamFs and GMimeStreamMem. You can manipulate all three + streams using the GMimeStream interfaces. In addition, some of + these streams have extended interfaces to allow more fine grained + manipulation.</p> +<p>GMimeStreamFile and GMimeStreamFs are very similar in that + they are both meant for reading and writing data to the file + system (in the form of files). Since GMimeStreamFile is an + abstracted layer above the standard libc FILE type, one of the + added benefits is buffered I/O. GMimeStreamFs, on the other hand, + is an abstracted layer above Unix file descriptors. While a + GMimeStreamFs can be used on top of a UNIX socket or pipe, you + must be careful because sockets and pipes are not seekable.</p> +<p>Unlike the previous 2 stream types, GMimeStreamMem does not + interact with the file system at all (except maybe the swap + partition/file indirectly). Memory streams are handy when you want + reads and writes to be nearly instantaneous and/or if you don't + want to create a temporary file on disk.</p> +<p>The four (4) advanced stream types are GMimeStreamMmap, + GMimeStreamNull, GMimeStreamBuffer and GMimeStreamFilter.</p> +<p>Our most simple stream, GMimeStreamNull, is the stream + equivalent of /dev/null on Unix systems. The main difference is + that GMimeStreamNull records the number of bytes written to it - + you may find this useful if you need to know the number of bytes a + GMimeObject (for example) will require.</p> +<p>GMimeStreamMmap is a memory-mapped stream. This isn't + guarenteed to work on all systems since not all systems support + the POSIX mmap system call, but for those that do - this might + present a faster stream than GMimeStreamFs and/or + GMimeStreamFile. You'll have to do some experimentation to know + for sure.</p> +<p>The GMimeStreamBuffer can be used on top of any other type + of stream and has 3 modes: block reads, block writes, and cached + reads. Block reads are especially useful if you will be making a + lot of small reads from a stream that accesses the file + system. Block writes are useful for very much the same reason. The + final mode, cached reads, can become memory intensive but can be + very helpful when inheriting from a stream that does not support + seeking (Note: this mode is the least tested so be careful using + it).</p> +<p>Our final stream type, GMimeStreamFilter, can also be used + on top of another stream. This stream, as you may have guessed, + filters reads and writes to its inherited stream. For example, one + could write a compression filter and apply it to a + GMimeStreamFilter and any further reads or writes would be + (un)compressed.</p> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/gmime.devhelp2 b/docs/reference/html/gmime.devhelp2 new file mode 100644 index 0000000..64e4687 --- /dev/null +++ b/docs/reference/html/gmime.devhelp2 @@ -0,0 +1,738 @@ +<?xml version="1.0" encoding="utf-8" standalone="no"?> +<!DOCTYPE book PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" ""> +<book xmlns="http://www.devhelp.net/book" title="GMime 2.6 Reference Manual" link="index.html" author="Jeffrey Stedfast" name="gmime" version="2" language="c"> + <chapters> + <sub name="GMime Overview" link="gmime.html"> + <sub name="Compiling the GMime libraries" link="gmime-building.html"/> + <sub name="Compiling GMime Applications" link="gmime-compiling.html"/> + <sub name="Changes from 1.0 to 2.0" link="gmime-changes-2-0.html"/> + <sub name="Changes from 2.0 to 2.2" link="gmime-changes-2-2.html"/> + <sub name="Changes from 2.2 to 2.4" link="gmime-changes-2-4.html"/> + <sub name="Changes from 2.4 to 2.6" link="gmime-changes-2-6.html"/> + <sub name="Mailing lists and bug reports" link="gmime-resources.html"/> + <sub name="Frequently Asked Questions" link="gmime-question-index.html"/> + </sub> + <sub name="GMime Fundamentals" link="fundamentals.html"> + <sub name="GMime Streams" link="gmime-streams.html"/> + <sub name="GMime Stream Filters" link="gmime-filters.html"/> + <sub name="GMime Data Wrappers" link="gmime-data-wrappers.html"/> + </sub> + <sub name="GMime Core Reference" link="core.html"> + <sub name="gmime" link="gmime-gmime.html"/> + <sub name="gmime-charset" link="gmime-gmime-charset.html"/> + <sub name="gmime-iconv" link="gmime-gmime-iconv.html"/> + <sub name="gmime-iconv-utils" link="gmime-gmime-iconv-utils.html"/> + <sub name="gmime-encodings" link="gmime-gmime-encodings.html"/> + <sub name="gmime-utils" link="gmime-gmime-utils.html"/> + </sub> + <sub name="GMime Classes" link="classes.html"> + <sub name="Class hierarchy" link="ch01.html"/> + <sub name="Streams" link="Streams.html"> + <sub name="GMimeStream" link="GMimeStream.html"/> + <sub name="GMimeStreamFile" link="GMimeStreamFile.html"/> + <sub name="GMimeStreamFs" link="GMimeStreamFs.html"/> + <sub name="GMimeStreamMem" link="GMimeStreamMem.html"/> + <sub name="GMimeStreamMmap" link="GMimeStreamMmap.html"/> + <sub name="GMimeStreamNull" link="GMimeStreamNull.html"/> + <sub name="GMimeStreamFilter" link="GMimeStreamFilter.html"/> + <sub name="GMimeStreamBuffer" link="GMimeStreamBuffer.html"/> + <sub name="GMimeStreamPipe" link="GMimeStreamPipe.html"/> + <sub name="GMimeStreamCat" link="GMimeStreamCat.html"/> + </sub> + <sub name="Stream Filters" link="Filters.html"> + <sub name="GMimeFilter" link="GMimeFilter.html"/> + <sub name="GMimeFilterBasic" link="GMimeFilterBasic.html"/> + <sub name="GMimeFilterBest" link="GMimeFilterBest.html"/> + <sub name="GMimeFilterCharset" link="GMimeFilterCharset.html"/> + <sub name="GMimeFilterCRLF" link="GMimeFilterCRLF.html"/> + <sub name="GMimeFilterEnriched" link="GMimeFilterEnriched.html"/> + <sub name="GMimeFilterFrom" link="GMimeFilterFrom.html"/> + <sub name="GMimeFilterGZip" link="GMimeFilterGZip.html"/> + <sub name="GMimeFilterHTML" link="GMimeFilterHTML.html"/> + <sub name="GMimeFilterMd5" link="GMimeFilterMd5.html"/> + <sub name="GMimeFilterStrip" link="GMimeFilterStrip.html"/> + <sub name="GMimeFilterWindows" link="GMimeFilterWindows.html"/> + <sub name="GMimeFilterYenc" link="GMimeFilterYenc.html"/> + </sub> + <sub name="Data Wrappers" link="DataWrappers.html"> + <sub name="GMimeDataWrapper" link="GMimeDataWrapper.html"/> + </sub> + <sub name="Message and MIME Headers" link="Headers.html"> + <sub name="GMimeHeader" link="gmime-GMimeHeader.html"/> + <sub name="GMimeContentType" link="GMimeContentType.html"/> + <sub name="GMimeContentDisposition" link="GMimeContentDisposition.html"/> + <sub name="GMimeParam" link="gmime-GMimeParam.html"/> + </sub> + <sub name="Internet Addresses" link="InternetAddresses.html"> + <sub name="InternetAddress" link="InternetAddress.html"/> + <sub name="InternetAddressGroup" link="InternetAddressGroup.html"/> + <sub name="InternetAddressMailbox" link="InternetAddressMailbox.html"/> + <sub name="InternetAddressList" link="InternetAddressList.html"/> + </sub> + <sub name="MIME Messages and Parts" link="MimeParts.html"> + <sub name="GMimeObject" link="GMimeObject.html"/> + <sub name="GMimeMessage" link="GMimeMessage.html"/> + <sub name="GMimePart" link="GMimePart.html"/> + <sub name="GMimeMultipart" link="GMimeMultipart.html"/> + <sub name="GMimeMultipartEncrypted" link="GMimeMultipartEncrypted.html"/> + <sub name="GMimeMultipartSigned" link="GMimeMultipartSigned.html"/> + <sub name="GMimeMessagePart" link="GMimeMessagePart.html"/> + <sub name="GMimeMessagePartial" link="GMimeMessagePartial.html"/> + <sub name="GMimePartIter" link="gmime-GMimePartIter.html"/> + </sub> + <sub name="Parsing Messages and MIME Parts" link="Parsers.html"> + <sub name="GMimeParser" link="GMimeParser.html"/> + </sub> + <sub name="Cryptography Contexts" link="CryptoContexts.html"> + <sub name="GMimeCertificate" link="GMimeCertificate.html"/> + <sub name="GMimeSignature" link="GMimeSignature.html"/> + <sub name="GMimeCryptoContext" link="GMimeCryptoContext.html"/> + <sub name="GMimeGpgContext" link="GMimeGpgContext.html"/> + <sub name="GMimePkcs7Context" link="GMimePkcs7Context.html"/> + </sub> + </sub> + </chapters> + <functions> + <keyword type="macro" name="GMIME_MAJOR_VERSION" link="gmime-gmime.html#GMIME-MAJOR-VERSION:CAPS"/> + <keyword type="macro" name="GMIME_MICRO_VERSION" link="gmime-gmime.html#GMIME-MICRO-VERSION:CAPS"/> + <keyword type="macro" name="GMIME_MINOR_VERSION" link="gmime-gmime.html#GMIME-MINOR-VERSION:CAPS"/> + <keyword type="macro" name="GMIME_BINARY_AGE" link="gmime-gmime.html#GMIME-BINARY-AGE:CAPS"/> + <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="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"/> + <keyword type="variable" name="gmime_minor_version" link="gmime-gmime.html#gmime-minor-version"/> + <keyword type="variable" name="gmime_micro_version" link="gmime-gmime.html#gmime-micro-version"/> + <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="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"/> + <keyword type="function" name="g_mime_locale_language ()" link="gmime-gmime-charset.html#g-mime-locale-language"/> + <keyword type="function" name="g_mime_charset_language ()" link="gmime-gmime-charset.html#g-mime-charset-language"/> + <keyword type="function" name="g_mime_charset_canon_name ()" link="gmime-gmime-charset.html#g-mime-charset-canon-name"/> + <keyword type="function" name="g_mime_charset_iconv_name ()" link="gmime-gmime-charset.html#g-mime-charset-iconv-name"/> + <keyword type="function" name="g_mime_charset_name ()" link="gmime-gmime-charset.html#g-mime-charset-name" deprecated=""/> + <keyword type="function" name="g_mime_charset_locale_name ()" link="gmime-gmime-charset.html#g-mime-charset-locale-name" deprecated=""/> + <keyword type="function" name="g_mime_charset_iso_to_windows ()" link="gmime-gmime-charset.html#g-mime-charset-iso-to-windows"/> + <keyword type="function" name="g_mime_charset_init ()" link="gmime-gmime-charset.html#g-mime-charset-init"/> + <keyword type="function" name="g_mime_charset_step ()" link="gmime-gmime-charset.html#g-mime-charset-step"/> + <keyword type="function" name="g_mime_charset_best_name ()" link="gmime-gmime-charset.html#g-mime-charset-best-name"/> + <keyword type="function" name="g_mime_charset_best ()" link="gmime-gmime-charset.html#g-mime-charset-best"/> + <keyword type="function" name="g_mime_charset_can_encode ()" link="gmime-gmime-charset.html#g-mime-charset-can-encode"/> + <keyword type="function" name="g_mime_set_user_charsets ()" link="gmime-gmime-charset.html#g-mime-set-user-charsets"/> + <keyword type="function" name="g_mime_user_charsets ()" link="gmime-gmime-charset.html#g-mime-user-charsets"/> + <keyword type="function" name="g_mime_iconv_init ()" link="gmime-gmime-iconv.html#g-mime-iconv-init"/> + <keyword type="function" name="g_mime_iconv_shutdown ()" link="gmime-gmime-iconv.html#g-mime-iconv-shutdown"/> + <keyword type="function" name="g_mime_iconv_open ()" link="gmime-gmime-iconv.html#g-mime-iconv-open"/> + <keyword type="macro" name="g_mime_iconv()" link="gmime-gmime-iconv.html#g-mime-iconv"/> + <keyword type="function" name="g_mime_iconv_close ()" link="gmime-gmime-iconv.html#g-mime-iconv-close"/> + <keyword type="function" name="g_mime_iconv_strdup ()" link="gmime-gmime-iconv-utils.html#g-mime-iconv-strdup"/> + <keyword type="function" name="g_mime_iconv_strndup ()" link="gmime-gmime-iconv-utils.html#g-mime-iconv-strndup"/> + <keyword type="function" name="g_mime_iconv_utf8_to_locale ()" link="gmime-gmime-iconv-utils.html#g-mime-iconv-utf8-to-locale"/> + <keyword type="function" name="g_mime_iconv_utf8_to_locale_length ()" link="gmime-gmime-iconv-utils.html#g-mime-iconv-utf8-to-locale-length"/> + <keyword type="function" name="g_mime_iconv_locale_to_utf8 ()" link="gmime-gmime-iconv-utils.html#g-mime-iconv-locale-to-utf8"/> + <keyword type="function" name="g_mime_iconv_locale_to_utf8_length ()" link="gmime-gmime-iconv-utils.html#g-mime-iconv-locale-to-utf8-length"/> + <keyword type="enum" name="enum GMimeContentEncoding" link="gmime-gmime-encodings.html#GMimeContentEncoding"/> + <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="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"/> + <keyword type="function" name="g_mime_encoding_outlen ()" link="gmime-gmime-encodings.html#g-mime-encoding-outlen"/> + <keyword type="function" name="g_mime_encoding_step ()" link="gmime-gmime-encodings.html#g-mime-encoding-step"/> + <keyword type="function" name="g_mime_encoding_flush ()" link="gmime-gmime-encodings.html#g-mime-encoding-flush"/> + <keyword type="macro" name="GMIME_BASE64_ENCODE_LEN()" link="gmime-gmime-encodings.html#GMIME-BASE64-ENCODE-LEN:CAPS"/> + <keyword type="function" name="g_mime_encoding_base64_decode_step ()" link="gmime-gmime-encodings.html#g-mime-encoding-base64-decode-step"/> + <keyword type="function" name="g_mime_encoding_base64_encode_step ()" link="gmime-gmime-encodings.html#g-mime-encoding-base64-encode-step"/> + <keyword type="function" name="g_mime_encoding_base64_encode_close ()" link="gmime-gmime-encodings.html#g-mime-encoding-base64-encode-close"/> + <keyword type="macro" name="GMIME_UUDECODE_STATE_INIT" link="gmime-gmime-encodings.html#GMIME-UUDECODE-STATE-INIT:CAPS"/> + <keyword type="macro" name="GMIME_UUDECODE_STATE_BEGIN" link="gmime-gmime-encodings.html#GMIME-UUDECODE-STATE-BEGIN:CAPS"/> + <keyword type="macro" name="GMIME_UUDECODE_STATE_END" link="gmime-gmime-encodings.html#GMIME-UUDECODE-STATE-END:CAPS"/> + <keyword type="macro" name="GMIME_UUENCODE_LEN()" link="gmime-gmime-encodings.html#GMIME-UUENCODE-LEN:CAPS"/> + <keyword type="function" name="g_mime_encoding_uudecode_step ()" link="gmime-gmime-encodings.html#g-mime-encoding-uudecode-step"/> + <keyword type="function" name="g_mime_encoding_uuencode_step ()" link="gmime-gmime-encodings.html#g-mime-encoding-uuencode-step"/> + <keyword type="function" name="g_mime_encoding_uuencode_close ()" link="gmime-gmime-encodings.html#g-mime-encoding-uuencode-close"/> + <keyword type="macro" name="GMIME_QP_ENCODE_LEN()" link="gmime-gmime-encodings.html#GMIME-QP-ENCODE-LEN:CAPS"/> + <keyword type="function" name="g_mime_encoding_quoted_decode_step ()" link="gmime-gmime-encodings.html#g-mime-encoding-quoted-decode-step"/> + <keyword type="function" name="g_mime_encoding_quoted_encode_step ()" link="gmime-gmime-encodings.html#g-mime-encoding-quoted-encode-step"/> + <keyword type="function" name="g_mime_encoding_quoted_encode_close ()" link="gmime-gmime-encodings.html#g-mime-encoding-quoted-encode-close"/> + <keyword type="struct" name="struct GMimeReferences" link="gmime-gmime-utils.html#GMimeReferences"/> + <keyword type="function" name="g_mime_utils_header_decode_date ()" link="gmime-gmime-utils.html#g-mime-utils-header-decode-date"/> + <keyword type="function" name="g_mime_utils_header_format_date ()" link="gmime-gmime-utils.html#g-mime-utils-header-format-date"/> + <keyword type="function" name="g_mime_utils_generate_message_id ()" link="gmime-gmime-utils.html#g-mime-utils-generate-message-id"/> + <keyword type="function" name="g_mime_utils_decode_message_id ()" link="gmime-gmime-utils.html#g-mime-utils-decode-message-id"/> + <keyword type="function" name="g_mime_references_get_message_id ()" link="gmime-gmime-utils.html#g-mime-references-get-message-id"/> + <keyword type="function" name="g_mime_references_get_next ()" link="gmime-gmime-utils.html#g-mime-references-get-next"/> + <keyword type="function" name="g_mime_references_decode ()" link="gmime-gmime-utils.html#g-mime-references-decode"/> + <keyword type="function" name="g_mime_references_append ()" link="gmime-gmime-utils.html#g-mime-references-append"/> + <keyword type="function" name="g_mime_references_clear ()" link="gmime-gmime-utils.html#g-mime-references-clear"/> + <keyword type="function" name="g_mime_references_free ()" link="gmime-gmime-utils.html#g-mime-references-free"/> + <keyword type="function" name="g_mime_utils_header_fold ()" link="gmime-gmime-utils.html#g-mime-utils-header-fold"/> + <keyword type="function" name="g_mime_utils_header_printf ()" link="gmime-gmime-utils.html#g-mime-utils-header-printf"/> + <keyword type="function" name="g_mime_utils_quote_string ()" link="gmime-gmime-utils.html#g-mime-utils-quote-string"/> + <keyword type="function" name="g_mime_utils_unquote_string ()" link="gmime-gmime-utils.html#g-mime-utils-unquote-string"/> + <keyword type="function" name="g_mime_utils_text_is_8bit ()" link="gmime-gmime-utils.html#g-mime-utils-text-is-8bit"/> + <keyword type="function" name="g_mime_utils_best_encoding ()" link="gmime-gmime-utils.html#g-mime-utils-best-encoding"/> + <keyword type="function" name="g_mime_utils_decode_8bit ()" link="gmime-gmime-utils.html#g-mime-utils-decode-8bit"/> + <keyword type="function" name="g_mime_utils_header_decode_text ()" link="gmime-gmime-utils.html#g-mime-utils-header-decode-text"/> + <keyword type="function" name="g_mime_utils_header_encode_text ()" link="gmime-gmime-utils.html#g-mime-utils-header-encode-text"/> + <keyword type="function" name="g_mime_utils_header_decode_phrase ()" link="gmime-gmime-utils.html#g-mime-utils-header-decode-phrase"/> + <keyword type="function" name="g_mime_utils_header_encode_phrase ()" link="gmime-gmime-utils.html#g-mime-utils-header-encode-phrase"/> + <keyword type="function" name="g_mime_utils_structured_header_fold ()" link="gmime-gmime-utils.html#g-mime-utils-structured-header-fold"/> + <keyword type="function" name="g_mime_utils_unstructured_header_fold ()" link="gmime-gmime-utils.html#g-mime-utils-unstructured-header-fold"/> + <keyword type="enum" name="enum GMimeSeekWhence" link="GMimeStream.html#GMimeSeekWhence"/> + <keyword type="struct" name="GMimeStreamIOVector" link="GMimeStream.html#GMimeStreamIOVector"/> + <keyword type="struct" name="struct GMimeStream" link="GMimeStream.html#GMimeStream-struct"/> + <keyword type="function" name="g_mime_stream_construct ()" link="GMimeStream.html#g-mime-stream-construct"/> + <keyword type="function" name="g_mime_stream_read ()" link="GMimeStream.html#g-mime-stream-read"/> + <keyword type="function" name="g_mime_stream_write ()" link="GMimeStream.html#g-mime-stream-write"/> + <keyword type="function" name="g_mime_stream_flush ()" link="GMimeStream.html#g-mime-stream-flush"/> + <keyword type="function" name="g_mime_stream_seek ()" link="GMimeStream.html#g-mime-stream-seek"/> + <keyword type="function" name="g_mime_stream_tell ()" link="GMimeStream.html#g-mime-stream-tell"/> + <keyword type="function" name="g_mime_stream_reset ()" link="GMimeStream.html#g-mime-stream-reset"/> + <keyword type="function" name="g_mime_stream_eos ()" link="GMimeStream.html#g-mime-stream-eos"/> + <keyword type="function" name="g_mime_stream_close ()" link="GMimeStream.html#g-mime-stream-close"/> + <keyword type="function" name="g_mime_stream_length ()" link="GMimeStream.html#g-mime-stream-length"/> + <keyword type="function" name="g_mime_stream_substream ()" link="GMimeStream.html#g-mime-stream-substream"/> + <keyword type="function" name="g_mime_stream_set_bounds ()" link="GMimeStream.html#g-mime-stream-set-bounds"/> + <keyword type="function" name="g_mime_stream_write_string ()" link="GMimeStream.html#g-mime-stream-write-string"/> + <keyword type="function" name="g_mime_stream_printf ()" link="GMimeStream.html#g-mime-stream-printf"/> + <keyword type="function" name="g_mime_stream_write_to_stream ()" link="GMimeStream.html#g-mime-stream-write-to-stream"/> + <keyword type="function" name="g_mime_stream_writev ()" link="GMimeStream.html#g-mime-stream-writev"/> + <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_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_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"/> + <keyword type="function" name="g_mime_stream_mem_new ()" link="GMimeStreamMem.html#g-mime-stream-mem-new"/> + <keyword type="function" name="g_mime_stream_mem_new_with_byte_array ()" link="GMimeStreamMem.html#g-mime-stream-mem-new-with-byte-array"/> + <keyword type="function" name="g_mime_stream_mem_new_with_buffer ()" link="GMimeStreamMem.html#g-mime-stream-mem-new-with-buffer"/> + <keyword type="function" name="g_mime_stream_mem_get_byte_array ()" link="GMimeStreamMem.html#g-mime-stream-mem-get-byte-array"/> + <keyword type="function" name="g_mime_stream_mem_set_byte_array ()" link="GMimeStreamMem.html#g-mime-stream-mem-set-byte-array"/> + <keyword type="function" name="g_mime_stream_mem_get_owner ()" link="GMimeStreamMem.html#g-mime-stream-mem-get-owner"/> + <keyword type="function" name="g_mime_stream_mem_set_owner ()" link="GMimeStreamMem.html#g-mime-stream-mem-set-owner"/> + <keyword type="struct" name="struct GMimeStreamMmap" link="GMimeStreamMmap.html#GMimeStreamMmap-struct"/> + <keyword type="function" name="g_mime_stream_mmap_new ()" link="GMimeStreamMmap.html#g-mime-stream-mmap-new"/> + <keyword type="function" name="g_mime_stream_mmap_new_with_bounds ()" link="GMimeStreamMmap.html#g-mime-stream-mmap-new-with-bounds"/> + <keyword type="struct" name="struct GMimeStreamNull" link="GMimeStreamNull.html#GMimeStreamNull-struct"/> + <keyword type="function" name="g_mime_stream_null_new ()" link="GMimeStreamNull.html#g-mime-stream-null-new"/> + <keyword type="struct" name="struct GMimeStreamFilter" link="GMimeStreamFilter.html#GMimeStreamFilter-struct"/> + <keyword type="function" name="g_mime_stream_filter_new ()" link="GMimeStreamFilter.html#g-mime-stream-filter-new"/> + <keyword type="function" name="g_mime_stream_filter_add ()" link="GMimeStreamFilter.html#g-mime-stream-filter-add"/> + <keyword type="function" name="g_mime_stream_filter_remove ()" link="GMimeStreamFilter.html#g-mime-stream-filter-remove"/> + <keyword type="enum" name="enum GMimeStreamBufferMode" link="GMimeStreamBuffer.html#GMimeStreamBufferMode"/> + <keyword type="struct" name="struct GMimeStreamBuffer" link="GMimeStreamBuffer.html#GMimeStreamBuffer-struct"/> + <keyword type="function" name="g_mime_stream_buffer_new ()" link="GMimeStreamBuffer.html#g-mime-stream-buffer-new"/> + <keyword type="function" name="g_mime_stream_buffer_gets ()" link="GMimeStreamBuffer.html#g-mime-stream-buffer-gets"/> + <keyword type="function" name="g_mime_stream_buffer_readln ()" link="GMimeStreamBuffer.html#g-mime-stream-buffer-readln"/> + <keyword type="struct" name="struct GMimeStreamPipe" link="GMimeStreamPipe.html#GMimeStreamPipe-struct"/> + <keyword type="function" name="g_mime_stream_pipe_new ()" link="GMimeStreamPipe.html#g-mime-stream-pipe-new"/> + <keyword type="function" name="g_mime_stream_pipe_get_owner ()" link="GMimeStreamPipe.html#g-mime-stream-pipe-get-owner"/> + <keyword type="function" name="g_mime_stream_pipe_set_owner ()" link="GMimeStreamPipe.html#g-mime-stream-pipe-set-owner"/> + <keyword type="struct" name="struct GMimeStreamCat" link="GMimeStreamCat.html#GMimeStreamCat-struct"/> + <keyword type="function" name="g_mime_stream_cat_new ()" link="GMimeStreamCat.html#g-mime-stream-cat-new"/> + <keyword type="function" name="g_mime_stream_cat_add_source ()" link="GMimeStreamCat.html#g-mime-stream-cat-add-source"/> + <keyword type="struct" name="struct GMimeFilter" link="GMimeFilter.html#GMimeFilter-struct"/> + <keyword type="function" name="g_mime_filter_copy ()" link="GMimeFilter.html#g-mime-filter-copy"/> + <keyword type="function" name="g_mime_filter_filter ()" link="GMimeFilter.html#g-mime-filter-filter"/> + <keyword type="function" name="g_mime_filter_complete ()" link="GMimeFilter.html#g-mime-filter-complete"/> + <keyword type="function" name="g_mime_filter_reset ()" link="GMimeFilter.html#g-mime-filter-reset"/> + <keyword type="function" name="g_mime_filter_backup ()" link="GMimeFilter.html#g-mime-filter-backup"/> + <keyword type="function" name="g_mime_filter_set_size ()" link="GMimeFilter.html#g-mime-filter-set-size"/> + <keyword type="struct" name="struct GMimeFilterBasic" link="GMimeFilterBasic.html#GMimeFilterBasic-struct"/> + <keyword type="function" name="g_mime_filter_basic_new ()" link="GMimeFilterBasic.html#g-mime-filter-basic-new"/> + <keyword type="struct" name="struct GMimeFilterBest" link="GMimeFilterBest.html#GMimeFilterBest-struct"/> + <keyword type="enum" name="enum GMimeFilterBestFlags" link="GMimeFilterBest.html#GMimeFilterBestFlags"/> + <keyword type="function" name="g_mime_filter_best_new ()" link="GMimeFilterBest.html#g-mime-filter-best-new"/> + <keyword type="function" name="g_mime_filter_best_charset ()" link="GMimeFilterBest.html#g-mime-filter-best-charset"/> + <keyword type="function" name="g_mime_filter_best_encoding ()" link="GMimeFilterBest.html#g-mime-filter-best-encoding"/> + <keyword type="struct" name="struct GMimeFilterCharset" link="GMimeFilterCharset.html#GMimeFilterCharset-struct"/> + <keyword type="function" name="g_mime_filter_charset_new ()" link="GMimeFilterCharset.html#g-mime-filter-charset-new"/> + <keyword type="struct" name="struct GMimeFilterCRLF" link="GMimeFilterCRLF.html#GMimeFilterCRLF-struct"/> + <keyword type="function" name="g_mime_filter_crlf_new ()" link="GMimeFilterCRLF.html#g-mime-filter-crlf-new"/> + <keyword type="macro" name="GMIME_FILTER_ENRICHED_IS_RICHTEXT" link="GMimeFilterEnriched.html#GMIME-FILTER-ENRICHED-IS-RICHTEXT:CAPS"/> + <keyword type="struct" name="struct GMimeFilterEnriched" link="GMimeFilterEnriched.html#GMimeFilterEnriched-struct"/> + <keyword type="function" name="g_mime_filter_enriched_new ()" link="GMimeFilterEnriched.html#g-mime-filter-enriched-new"/> + <keyword type="struct" name="struct GMimeFilterFrom" link="GMimeFilterFrom.html#GMimeFilterFrom-struct"/> + <keyword type="enum" name="enum GMimeFilterFromMode" link="GMimeFilterFrom.html#GMimeFilterFromMode"/> + <keyword type="function" name="g_mime_filter_from_new ()" link="GMimeFilterFrom.html#g-mime-filter-from-new"/> + <keyword type="struct" name="struct GMimeFilterGZip" link="GMimeFilterGZip.html#GMimeFilterGZip-struct"/> + <keyword type="enum" name="enum GMimeFilterGZipMode" link="GMimeFilterGZip.html#GMimeFilterGZipMode"/> + <keyword type="function" name="g_mime_filter_gzip_new ()" link="GMimeFilterGZip.html#g-mime-filter-gzip-new"/> + <keyword type="struct" name="struct GMimeFilterHTML" link="GMimeFilterHTML.html#GMimeFilterHTML-struct"/> + <keyword type="macro" name="GMIME_FILTER_HTML_PRE" link="GMimeFilterHTML.html#GMIME-FILTER-HTML-PRE:CAPS"/> + <keyword type="macro" name="GMIME_FILTER_HTML_CONVERT_NL" link="GMimeFilterHTML.html#GMIME-FILTER-HTML-CONVERT-NL:CAPS"/> + <keyword type="macro" name="GMIME_FILTER_HTML_CONVERT_SPACES" link="GMimeFilterHTML.html#GMIME-FILTER-HTML-CONVERT-SPACES:CAPS"/> + <keyword type="macro" name="GMIME_FILTER_HTML_CONVERT_URLS" link="GMimeFilterHTML.html#GMIME-FILTER-HTML-CONVERT-URLS:CAPS"/> + <keyword type="macro" name="GMIME_FILTER_HTML_MARK_CITATION" link="GMimeFilterHTML.html#GMIME-FILTER-HTML-MARK-CITATION:CAPS"/> + <keyword type="macro" name="GMIME_FILTER_HTML_CONVERT_ADDRESSES" link="GMimeFilterHTML.html#GMIME-FILTER-HTML-CONVERT-ADDRESSES:CAPS"/> + <keyword type="macro" name="GMIME_FILTER_HTML_ESCAPE_8BIT" link="GMimeFilterHTML.html#GMIME-FILTER-HTML-ESCAPE-8BIT:CAPS"/> + <keyword type="macro" name="GMIME_FILTER_HTML_CITE" link="GMimeFilterHTML.html#GMIME-FILTER-HTML-CITE:CAPS"/> + <keyword type="function" name="g_mime_filter_html_new ()" link="GMimeFilterHTML.html#g-mime-filter-html-new"/> + <keyword type="struct" name="struct GMimeFilterMd5" link="GMimeFilterMd5.html#GMimeFilterMd5-struct"/> + <keyword type="function" name="g_mime_filter_md5_new ()" link="GMimeFilterMd5.html#g-mime-filter-md5-new"/> + <keyword type="function" name="g_mime_filter_md5_get_digest ()" link="GMimeFilterMd5.html#g-mime-filter-md5-get-digest"/> + <keyword type="struct" name="struct GMimeFilterStrip" link="GMimeFilterStrip.html#GMimeFilterStrip-struct"/> + <keyword type="function" name="g_mime_filter_strip_new ()" link="GMimeFilterStrip.html#g-mime-filter-strip-new"/> + <keyword type="struct" name="struct GMimeFilterWindows" link="GMimeFilterWindows.html#GMimeFilterWindows-struct"/> + <keyword type="function" name="g_mime_filter_windows_new ()" link="GMimeFilterWindows.html#g-mime-filter-windows-new"/> + <keyword type="function" name="g_mime_filter_windows_is_windows_charset ()" link="GMimeFilterWindows.html#g-mime-filter-windows-is-windows-charset"/> + <keyword type="function" name="g_mime_filter_windows_real_charset ()" link="GMimeFilterWindows.html#g-mime-filter-windows-real-charset"/> + <keyword type="struct" name="struct GMimeFilterYenc" link="GMimeFilterYenc.html#GMimeFilterYenc-struct"/> + <keyword type="function" name="g_mime_filter_yenc_new ()" link="GMimeFilterYenc.html#g-mime-filter-yenc-new"/> + <keyword type="function" name="g_mime_filter_yenc_set_state ()" link="GMimeFilterYenc.html#g-mime-filter-yenc-set-state"/> + <keyword type="function" name="g_mime_filter_yenc_set_crc ()" link="GMimeFilterYenc.html#g-mime-filter-yenc-set-crc"/> + <keyword type="function" name="g_mime_filter_yenc_get_crc ()" link="GMimeFilterYenc.html#g-mime-filter-yenc-get-crc"/> + <keyword type="function" name="g_mime_filter_yenc_get_pcrc ()" link="GMimeFilterYenc.html#g-mime-filter-yenc-get-pcrc"/> + <keyword type="macro" name="GMIME_YENCODE_CRC_INIT" link="GMimeFilterYenc.html#GMIME-YENCODE-CRC-INIT:CAPS"/> + <keyword type="macro" name="GMIME_YENCODE_CRC_FINAL()" link="GMimeFilterYenc.html#GMIME-YENCODE-CRC-FINAL:CAPS"/> + <keyword type="macro" name="GMIME_YENCODE_STATE_INIT" link="GMimeFilterYenc.html#GMIME-YENCODE-STATE-INIT:CAPS"/> + <keyword type="macro" name="GMIME_YDECODE_STATE_INIT" link="GMimeFilterYenc.html#GMIME-YDECODE-STATE-INIT:CAPS"/> + <keyword type="macro" name="GMIME_YDECODE_STATE_EOLN" link="GMimeFilterYenc.html#GMIME-YDECODE-STATE-EOLN:CAPS"/> + <keyword type="macro" name="GMIME_YDECODE_STATE_ESCAPE" link="GMimeFilterYenc.html#GMIME-YDECODE-STATE-ESCAPE:CAPS"/> + <keyword type="macro" name="GMIME_YDECODE_STATE_END" link="GMimeFilterYenc.html#GMIME-YDECODE-STATE-END:CAPS"/> + <keyword type="macro" name="GMIME_YDECODE_STATE_BEGIN" link="GMimeFilterYenc.html#GMIME-YDECODE-STATE-BEGIN:CAPS"/> + <keyword type="macro" name="GMIME_YDECODE_STATE_DECODE" link="GMimeFilterYenc.html#GMIME-YDECODE-STATE-DECODE:CAPS"/> + <keyword type="macro" name="GMIME_YDECODE_STATE_PART" link="GMimeFilterYenc.html#GMIME-YDECODE-STATE-PART:CAPS"/> + <keyword type="function" name="g_mime_ydecode_step ()" link="GMimeFilterYenc.html#g-mime-ydecode-step"/> + <keyword type="function" name="g_mime_yencode_step ()" link="GMimeFilterYenc.html#g-mime-yencode-step"/> + <keyword type="function" name="g_mime_yencode_close ()" link="GMimeFilterYenc.html#g-mime-yencode-close"/> + <keyword type="struct" name="struct GMimeDataWrapper" link="GMimeDataWrapper.html#GMimeDataWrapper-struct"/> + <keyword type="function" name="g_mime_data_wrapper_new ()" link="GMimeDataWrapper.html#g-mime-data-wrapper-new"/> + <keyword type="function" name="g_mime_data_wrapper_new_with_stream ()" link="GMimeDataWrapper.html#g-mime-data-wrapper-new-with-stream"/> + <keyword type="function" name="g_mime_data_wrapper_set_stream ()" link="GMimeDataWrapper.html#g-mime-data-wrapper-set-stream"/> + <keyword type="function" name="g_mime_data_wrapper_get_stream ()" link="GMimeDataWrapper.html#g-mime-data-wrapper-get-stream"/> + <keyword type="function" name="g_mime_data_wrapper_set_encoding ()" link="GMimeDataWrapper.html#g-mime-data-wrapper-set-encoding"/> + <keyword type="function" name="g_mime_data_wrapper_get_encoding ()" link="GMimeDataWrapper.html#g-mime-data-wrapper-get-encoding"/> + <keyword type="function" name="g_mime_data_wrapper_write_to_stream ()" link="GMimeDataWrapper.html#g-mime-data-wrapper-write-to-stream"/> + <keyword type="struct" name="struct GMimeHeaderIter" link="gmime-GMimeHeader.html#GMimeHeaderIter"/> + <keyword type="struct" name="GMimeHeaderList" link="gmime-GMimeHeader.html#GMimeHeaderList"/> + <keyword type="function" name="GMimeHeaderWriter ()" link="gmime-GMimeHeader.html#GMimeHeaderWriter"/> + <keyword type="function" name="GMimeHeaderForeachFunc ()" link="gmime-GMimeHeader.html#GMimeHeaderForeachFunc"/> + <keyword type="function" name="g_mime_header_iter_new ()" link="gmime-GMimeHeader.html#g-mime-header-iter-new"/> + <keyword type="function" name="g_mime_header_iter_free ()" link="gmime-GMimeHeader.html#g-mime-header-iter-free"/> + <keyword type="function" name="g_mime_header_iter_copy ()" link="gmime-GMimeHeader.html#g-mime-header-iter-copy"/> + <keyword type="function" name="g_mime_header_iter_copy_to ()" link="gmime-GMimeHeader.html#g-mime-header-iter-copy-to"/> + <keyword type="function" name="g_mime_header_iter_equal ()" link="gmime-GMimeHeader.html#g-mime-header-iter-equal"/> + <keyword type="function" name="g_mime_header_iter_first ()" link="gmime-GMimeHeader.html#g-mime-header-iter-first"/> + <keyword type="function" name="g_mime_header_iter_last ()" link="gmime-GMimeHeader.html#g-mime-header-iter-last"/> + <keyword type="function" name="g_mime_header_iter_next ()" link="gmime-GMimeHeader.html#g-mime-header-iter-next"/> + <keyword type="function" name="g_mime_header_iter_prev ()" link="gmime-GMimeHeader.html#g-mime-header-iter-prev"/> + <keyword type="function" name="g_mime_header_iter_is_valid ()" link="gmime-GMimeHeader.html#g-mime-header-iter-is-valid"/> + <keyword type="function" name="g_mime_header_iter_get_name ()" link="gmime-GMimeHeader.html#g-mime-header-iter-get-name"/> + <keyword type="function" name="g_mime_header_iter_get_value ()" link="gmime-GMimeHeader.html#g-mime-header-iter-get-value"/> + <keyword type="function" name="g_mime_header_iter_set_value ()" link="gmime-GMimeHeader.html#g-mime-header-iter-set-value"/> + <keyword type="function" name="g_mime_header_iter_remove ()" link="gmime-GMimeHeader.html#g-mime-header-iter-remove"/> + <keyword type="function" name="g_mime_header_list_new ()" link="gmime-GMimeHeader.html#g-mime-header-list-new"/> + <keyword type="function" name="g_mime_header_list_destroy ()" link="gmime-GMimeHeader.html#g-mime-header-list-destroy"/> + <keyword type="function" name="g_mime_header_list_clear ()" link="gmime-GMimeHeader.html#g-mime-header-list-clear"/> + <keyword type="function" name="g_mime_header_list_contains ()" link="gmime-GMimeHeader.html#g-mime-header-list-contains"/> + <keyword type="function" name="g_mime_header_list_prepend ()" link="gmime-GMimeHeader.html#g-mime-header-list-prepend"/> + <keyword type="function" name="g_mime_header_list_append ()" link="gmime-GMimeHeader.html#g-mime-header-list-append"/> + <keyword type="function" name="g_mime_header_list_remove ()" link="gmime-GMimeHeader.html#g-mime-header-list-remove"/> + <keyword type="function" name="g_mime_header_list_set ()" link="gmime-GMimeHeader.html#g-mime-header-list-set"/> + <keyword type="function" name="g_mime_header_list_get ()" link="gmime-GMimeHeader.html#g-mime-header-list-get"/> + <keyword type="function" name="g_mime_header_list_get_iter ()" link="gmime-GMimeHeader.html#g-mime-header-list-get-iter"/> + <keyword type="function" name="g_mime_header_list_foreach ()" link="gmime-GMimeHeader.html#g-mime-header-list-foreach"/> + <keyword type="function" name="g_mime_header_list_register_writer ()" link="gmime-GMimeHeader.html#g-mime-header-list-register-writer"/> + <keyword type="function" name="g_mime_header_list_write_to_stream ()" link="gmime-GMimeHeader.html#g-mime-header-list-write-to-stream"/> + <keyword type="function" name="g_mime_header_list_to_string ()" link="gmime-GMimeHeader.html#g-mime-header-list-to-string"/> + <keyword type="function" name="g_mime_header_list_get_stream ()" link="gmime-GMimeHeader.html#g-mime-header-list-get-stream"/> + <keyword type="function" name="g_mime_header_list_set_stream ()" link="gmime-GMimeHeader.html#g-mime-header-list-set-stream"/> + <keyword type="struct" name="struct GMimeContentType" link="GMimeContentType.html#GMimeContentType-struct"/> + <keyword type="function" name="g_mime_content_type_new ()" link="GMimeContentType.html#g-mime-content-type-new"/> + <keyword type="function" name="g_mime_content_type_new_from_string ()" link="GMimeContentType.html#g-mime-content-type-new-from-string"/> + <keyword type="function" name="g_mime_content_type_to_string ()" link="GMimeContentType.html#g-mime-content-type-to-string"/> + <keyword type="function" name="g_mime_content_type_is_type ()" link="GMimeContentType.html#g-mime-content-type-is-type"/> + <keyword type="function" name="g_mime_content_type_get_media_type ()" link="GMimeContentType.html#g-mime-content-type-get-media-type"/> + <keyword type="function" name="g_mime_content_type_set_media_type ()" link="GMimeContentType.html#g-mime-content-type-set-media-type"/> + <keyword type="function" name="g_mime_content_type_get_media_subtype ()" link="GMimeContentType.html#g-mime-content-type-get-media-subtype"/> + <keyword type="function" name="g_mime_content_type_set_media_subtype ()" link="GMimeContentType.html#g-mime-content-type-set-media-subtype"/> + <keyword type="function" name="g_mime_content_type_get_params ()" link="GMimeContentType.html#g-mime-content-type-get-params"/> + <keyword type="function" name="g_mime_content_type_set_params ()" link="GMimeContentType.html#g-mime-content-type-set-params"/> + <keyword type="function" name="g_mime_content_type_get_parameter ()" link="GMimeContentType.html#g-mime-content-type-get-parameter"/> + <keyword type="function" name="g_mime_content_type_set_parameter ()" link="GMimeContentType.html#g-mime-content-type-set-parameter"/> + <keyword type="macro" name="GMIME_DISPOSITION_ATTACHMENT" link="GMimeContentDisposition.html#GMIME-DISPOSITION-ATTACHMENT:CAPS"/> + <keyword type="macro" name="GMIME_DISPOSITION_INLINE" link="GMimeContentDisposition.html#GMIME-DISPOSITION-INLINE:CAPS"/> + <keyword type="struct" name="struct GMimeContentDisposition" link="GMimeContentDisposition.html#GMimeContentDisposition-struct"/> + <keyword type="function" name="g_mime_content_disposition_new ()" link="GMimeContentDisposition.html#g-mime-content-disposition-new"/> + <keyword type="function" name="g_mime_content_disposition_new_from_string ()" link="GMimeContentDisposition.html#g-mime-content-disposition-new-from-string"/> + <keyword type="function" name="g_mime_content_disposition_set_disposition ()" link="GMimeContentDisposition.html#g-mime-content-disposition-set-disposition"/> + <keyword type="function" name="g_mime_content_disposition_get_disposition ()" link="GMimeContentDisposition.html#g-mime-content-disposition-get-disposition"/> + <keyword type="function" name="g_mime_content_disposition_get_params ()" link="GMimeContentDisposition.html#g-mime-content-disposition-get-params"/> + <keyword type="function" name="g_mime_content_disposition_set_params ()" link="GMimeContentDisposition.html#g-mime-content-disposition-set-params"/> + <keyword type="function" name="g_mime_content_disposition_set_parameter ()" link="GMimeContentDisposition.html#g-mime-content-disposition-set-parameter"/> + <keyword type="function" name="g_mime_content_disposition_get_parameter ()" link="GMimeContentDisposition.html#g-mime-content-disposition-get-parameter"/> + <keyword type="function" name="g_mime_content_disposition_to_string ()" link="GMimeContentDisposition.html#g-mime-content-disposition-to-string"/> + <keyword type="struct" name="struct GMimeParam" link="gmime-GMimeParam.html#GMimeParam"/> + <keyword type="function" name="g_mime_param_new ()" link="gmime-GMimeParam.html#g-mime-param-new"/> + <keyword type="function" name="g_mime_param_new_from_string ()" link="gmime-GMimeParam.html#g-mime-param-new-from-string"/> + <keyword type="function" name="g_mime_param_destroy ()" link="gmime-GMimeParam.html#g-mime-param-destroy"/> + <keyword type="function" name="g_mime_param_next ()" link="gmime-GMimeParam.html#g-mime-param-next"/> + <keyword type="function" name="g_mime_param_get_name ()" link="gmime-GMimeParam.html#g-mime-param-get-name"/> + <keyword type="function" name="g_mime_param_get_value ()" link="gmime-GMimeParam.html#g-mime-param-get-value"/> + <keyword type="function" name="g_mime_param_append ()" link="gmime-GMimeParam.html#g-mime-param-append"/> + <keyword type="function" name="g_mime_param_append_param ()" link="gmime-GMimeParam.html#g-mime-param-append-param"/> + <keyword type="function" name="g_mime_param_write_to_string ()" link="gmime-GMimeParam.html#g-mime-param-write-to-string"/> + <keyword type="struct" name="struct InternetAddress" link="InternetAddress.html#InternetAddress-struct"/> + <keyword type="function" name="internet_address_get_name ()" link="InternetAddress.html#internet-address-get-name"/> + <keyword type="function" name="internet_address_set_name ()" link="InternetAddress.html#internet-address-set-name"/> + <keyword type="function" name="internet_address_to_string ()" link="InternetAddress.html#internet-address-to-string"/> + <keyword type="struct" name="struct InternetAddressGroup" link="InternetAddressGroup.html#InternetAddressGroup-struct"/> + <keyword type="function" name="internet_address_group_new ()" link="InternetAddressGroup.html#internet-address-group-new"/> + <keyword type="function" name="internet_address_group_get_members ()" link="InternetAddressGroup.html#internet-address-group-get-members"/> + <keyword type="function" name="internet_address_group_set_members ()" link="InternetAddressGroup.html#internet-address-group-set-members"/> + <keyword type="function" name="internet_address_group_add_member ()" link="InternetAddressGroup.html#internet-address-group-add-member"/> + <keyword type="struct" name="struct InternetAddressMailbox" link="InternetAddressMailbox.html#InternetAddressMailbox-struct"/> + <keyword type="function" name="internet_address_mailbox_new ()" link="InternetAddressMailbox.html#internet-address-mailbox-new"/> + <keyword type="function" name="internet_address_mailbox_get_addr ()" link="InternetAddressMailbox.html#internet-address-mailbox-get-addr"/> + <keyword type="function" name="internet_address_mailbox_set_addr ()" link="InternetAddressMailbox.html#internet-address-mailbox-set-addr"/> + <keyword type="struct" name="struct InternetAddressList" link="InternetAddressList.html#InternetAddressList-struct"/> + <keyword type="function" name="internet_address_list_new ()" link="InternetAddressList.html#internet-address-list-new"/> + <keyword type="function" name="internet_address_list_length ()" link="InternetAddressList.html#internet-address-list-length"/> + <keyword type="function" name="internet_address_list_clear ()" link="InternetAddressList.html#internet-address-list-clear"/> + <keyword type="function" name="internet_address_list_add ()" link="InternetAddressList.html#internet-address-list-add"/> + <keyword type="function" name="internet_address_list_insert ()" link="InternetAddressList.html#internet-address-list-insert"/> + <keyword type="function" name="internet_address_list_remove ()" link="InternetAddressList.html#internet-address-list-remove"/> + <keyword type="function" name="internet_address_list_remove_at ()" link="InternetAddressList.html#internet-address-list-remove-at"/> + <keyword type="function" name="internet_address_list_contains ()" link="InternetAddressList.html#internet-address-list-contains"/> + <keyword type="function" name="internet_address_list_index_of ()" link="InternetAddressList.html#internet-address-list-index-of"/> + <keyword type="function" name="internet_address_list_get_address ()" link="InternetAddressList.html#internet-address-list-get-address"/> + <keyword type="function" name="internet_address_list_set_address ()" link="InternetAddressList.html#internet-address-list-set-address"/> + <keyword type="function" name="internet_address_list_prepend ()" link="InternetAddressList.html#internet-address-list-prepend"/> + <keyword type="function" name="internet_address_list_append ()" link="InternetAddressList.html#internet-address-list-append"/> + <keyword type="function" name="internet_address_list_to_string ()" link="InternetAddressList.html#internet-address-list-to-string"/> + <keyword type="function" name="internet_address_list_parse_string ()" link="InternetAddressList.html#internet-address-list-parse-string"/> + <keyword type="function" name="internet_address_list_writer ()" link="InternetAddressList.html#internet-address-list-writer"/> + <keyword type="struct" name="struct GMimeObject" link="GMimeObject.html#GMimeObject-struct"/> + <keyword type="function" name="GMimeObjectForeachFunc ()" link="GMimeObject.html#GMimeObjectForeachFunc"/> + <keyword type="function" name="g_mime_object_register_type ()" link="GMimeObject.html#g-mime-object-register-type"/> + <keyword type="function" name="g_mime_object_new ()" link="GMimeObject.html#g-mime-object-new"/> + <keyword type="function" name="g_mime_object_new_type ()" link="GMimeObject.html#g-mime-object-new-type"/> + <keyword type="function" name="g_mime_object_set_content_type ()" link="GMimeObject.html#g-mime-object-set-content-type"/> + <keyword type="function" name="g_mime_object_get_content_type ()" link="GMimeObject.html#g-mime-object-get-content-type"/> + <keyword type="function" name="g_mime_object_set_content_type_parameter ()" link="GMimeObject.html#g-mime-object-set-content-type-parameter"/> + <keyword type="function" name="g_mime_object_get_content_type_parameter ()" link="GMimeObject.html#g-mime-object-get-content-type-parameter"/> + <keyword type="function" name="g_mime_object_set_disposition ()" link="GMimeObject.html#g-mime-object-set-disposition"/> + <keyword type="function" name="g_mime_object_get_disposition ()" link="GMimeObject.html#g-mime-object-get-disposition"/> + <keyword type="function" name="g_mime_object_set_content_disposition ()" link="GMimeObject.html#g-mime-object-set-content-disposition"/> + <keyword type="function" name="g_mime_object_get_content_disposition ()" link="GMimeObject.html#g-mime-object-get-content-disposition"/> + <keyword type="function" name="g_mime_object_set_content_disposition_parameter ()" link="GMimeObject.html#g-mime-object-set-content-disposition-parameter"/> + <keyword type="function" name="g_mime_object_get_content_disposition_parameter ()" link="GMimeObject.html#g-mime-object-get-content-disposition-parameter"/> + <keyword type="function" name="g_mime_object_set_content_id ()" link="GMimeObject.html#g-mime-object-set-content-id"/> + <keyword type="function" name="g_mime_object_get_content_id ()" link="GMimeObject.html#g-mime-object-get-content-id"/> + <keyword type="function" name="g_mime_object_prepend_header ()" link="GMimeObject.html#g-mime-object-prepend-header"/> + <keyword type="function" name="g_mime_object_append_header ()" link="GMimeObject.html#g-mime-object-append-header"/> + <keyword type="function" name="g_mime_object_remove_header ()" link="GMimeObject.html#g-mime-object-remove-header"/> + <keyword type="function" name="g_mime_object_set_header ()" link="GMimeObject.html#g-mime-object-set-header"/> + <keyword type="function" name="g_mime_object_get_header ()" link="GMimeObject.html#g-mime-object-get-header"/> + <keyword type="function" name="g_mime_object_get_headers ()" link="GMimeObject.html#g-mime-object-get-headers"/> + <keyword type="function" name="g_mime_object_get_header_list ()" link="GMimeObject.html#g-mime-object-get-header-list"/> + <keyword type="function" name="g_mime_object_write_to_stream ()" link="GMimeObject.html#g-mime-object-write-to-stream"/> + <keyword type="function" name="g_mime_object_to_string ()" link="GMimeObject.html#g-mime-object-to-string"/> + <keyword type="function" name="g_mime_object_encode ()" link="GMimeObject.html#g-mime-object-encode"/> + <keyword type="enum" name="enum GMimeRecipientType" link="GMimeMessage.html#GMimeRecipientType"/> + <keyword type="struct" name="struct GMimeMessage" link="GMimeMessage.html#GMimeMessage-struct"/> + <keyword type="function" name="g_mime_message_new ()" link="GMimeMessage.html#g-mime-message-new"/> + <keyword type="function" name="g_mime_message_set_sender ()" link="GMimeMessage.html#g-mime-message-set-sender"/> + <keyword type="function" name="g_mime_message_get_sender ()" link="GMimeMessage.html#g-mime-message-get-sender"/> + <keyword type="function" name="g_mime_message_set_reply_to ()" link="GMimeMessage.html#g-mime-message-set-reply-to"/> + <keyword type="function" name="g_mime_message_get_reply_to ()" link="GMimeMessage.html#g-mime-message-get-reply-to"/> + <keyword type="function" name="g_mime_message_add_recipient ()" link="GMimeMessage.html#g-mime-message-add-recipient"/> + <keyword type="function" name="g_mime_message_get_recipients ()" link="GMimeMessage.html#g-mime-message-get-recipients"/> + <keyword type="function" name="g_mime_message_get_all_recipients ()" link="GMimeMessage.html#g-mime-message-get-all-recipients"/> + <keyword type="function" name="g_mime_message_set_subject ()" link="GMimeMessage.html#g-mime-message-set-subject"/> + <keyword type="function" name="g_mime_message_get_subject ()" link="GMimeMessage.html#g-mime-message-get-subject"/> + <keyword type="function" name="g_mime_message_set_date ()" link="GMimeMessage.html#g-mime-message-set-date"/> + <keyword type="function" name="g_mime_message_get_date ()" link="GMimeMessage.html#g-mime-message-get-date"/> + <keyword type="function" name="g_mime_message_set_date_as_string ()" link="GMimeMessage.html#g-mime-message-set-date-as-string"/> + <keyword type="function" name="g_mime_message_get_date_as_string ()" link="GMimeMessage.html#g-mime-message-get-date-as-string"/> + <keyword type="function" name="g_mime_message_set_message_id ()" link="GMimeMessage.html#g-mime-message-set-message-id"/> + <keyword type="function" name="g_mime_message_get_message_id ()" link="GMimeMessage.html#g-mime-message-get-message-id"/> + <keyword type="function" name="g_mime_message_set_mime_part ()" link="GMimeMessage.html#g-mime-message-set-mime-part"/> + <keyword type="function" name="g_mime_message_get_mime_part ()" link="GMimeMessage.html#g-mime-message-get-mime-part"/> + <keyword type="function" name="g_mime_message_foreach ()" link="GMimeMessage.html#g-mime-message-foreach"/> + <keyword type="function" name="g_mime_message_get_body ()" link="GMimeMessage.html#g-mime-message-get-body"/> + <keyword type="struct" name="struct GMimePart" link="GMimePart.html#GMimePart-struct"/> + <keyword type="function" name="g_mime_part_new ()" link="GMimePart.html#g-mime-part-new"/> + <keyword type="function" name="g_mime_part_new_with_type ()" link="GMimePart.html#g-mime-part-new-with-type"/> + <keyword type="function" name="g_mime_part_set_content_description ()" link="GMimePart.html#g-mime-part-set-content-description"/> + <keyword type="function" name="g_mime_part_get_content_description ()" link="GMimePart.html#g-mime-part-get-content-description"/> + <keyword type="function" name="g_mime_part_set_content_id ()" link="GMimePart.html#g-mime-part-set-content-id"/> + <keyword type="function" name="g_mime_part_get_content_id ()" link="GMimePart.html#g-mime-part-get-content-id"/> + <keyword type="function" name="g_mime_part_set_content_md5 ()" link="GMimePart.html#g-mime-part-set-content-md5"/> + <keyword type="function" name="g_mime_part_get_content_md5 ()" link="GMimePart.html#g-mime-part-get-content-md5"/> + <keyword type="function" name="g_mime_part_verify_content_md5 ()" link="GMimePart.html#g-mime-part-verify-content-md5"/> + <keyword type="function" name="g_mime_part_set_content_location ()" link="GMimePart.html#g-mime-part-set-content-location"/> + <keyword type="function" name="g_mime_part_get_content_location ()" link="GMimePart.html#g-mime-part-get-content-location"/> + <keyword type="function" name="g_mime_part_set_content_encoding ()" link="GMimePart.html#g-mime-part-set-content-encoding"/> + <keyword type="function" name="g_mime_part_get_content_encoding ()" link="GMimePart.html#g-mime-part-get-content-encoding"/> + <keyword type="function" name="g_mime_part_get_best_content_encoding ()" link="GMimePart.html#g-mime-part-get-best-content-encoding"/> + <keyword type="function" name="g_mime_part_set_filename ()" link="GMimePart.html#g-mime-part-set-filename"/> + <keyword type="function" name="g_mime_part_get_filename ()" link="GMimePart.html#g-mime-part-get-filename"/> + <keyword type="function" name="g_mime_part_get_content_object ()" link="GMimePart.html#g-mime-part-get-content-object"/> + <keyword type="function" name="g_mime_part_set_content_object ()" link="GMimePart.html#g-mime-part-set-content-object"/> + <keyword type="struct" name="struct GMimeMultipart" link="GMimeMultipart.html#GMimeMultipart-struct"/> + <keyword type="function" name="g_mime_multipart_new ()" link="GMimeMultipart.html#g-mime-multipart-new"/> + <keyword type="function" name="g_mime_multipart_new_with_subtype ()" link="GMimeMultipart.html#g-mime-multipart-new-with-subtype"/> + <keyword type="function" name="g_mime_multipart_set_preface ()" link="GMimeMultipart.html#g-mime-multipart-set-preface"/> + <keyword type="function" name="g_mime_multipart_get_preface ()" link="GMimeMultipart.html#g-mime-multipart-get-preface"/> + <keyword type="function" name="g_mime_multipart_set_postface ()" link="GMimeMultipart.html#g-mime-multipart-set-postface"/> + <keyword type="function" name="g_mime_multipart_get_postface ()" link="GMimeMultipart.html#g-mime-multipart-get-postface"/> + <keyword type="function" name="g_mime_multipart_set_boundary ()" link="GMimeMultipart.html#g-mime-multipart-set-boundary"/> + <keyword type="function" name="g_mime_multipart_get_boundary ()" link="GMimeMultipart.html#g-mime-multipart-get-boundary"/> + <keyword type="function" name="g_mime_multipart_get_count ()" link="GMimeMultipart.html#g-mime-multipart-get-count"/> + <keyword type="function" name="g_mime_multipart_contains ()" link="GMimeMultipart.html#g-mime-multipart-contains"/> + <keyword type="function" name="g_mime_multipart_index_of ()" link="GMimeMultipart.html#g-mime-multipart-index-of"/> + <keyword type="function" name="g_mime_multipart_add ()" link="GMimeMultipart.html#g-mime-multipart-add"/> + <keyword type="function" name="g_mime_multipart_clear ()" link="GMimeMultipart.html#g-mime-multipart-clear"/> + <keyword type="function" name="g_mime_multipart_insert ()" link="GMimeMultipart.html#g-mime-multipart-insert"/> + <keyword type="function" name="g_mime_multipart_remove ()" link="GMimeMultipart.html#g-mime-multipart-remove"/> + <keyword type="function" name="g_mime_multipart_remove_at ()" link="GMimeMultipart.html#g-mime-multipart-remove-at"/> + <keyword type="function" name="g_mime_multipart_replace ()" link="GMimeMultipart.html#g-mime-multipart-replace"/> + <keyword type="function" name="g_mime_multipart_get_part ()" link="GMimeMultipart.html#g-mime-multipart-get-part"/> + <keyword type="function" name="g_mime_multipart_foreach ()" link="GMimeMultipart.html#g-mime-multipart-foreach"/> + <keyword type="function" name="g_mime_multipart_get_subpart_from_content_id ()" link="GMimeMultipart.html#g-mime-multipart-get-subpart-from-content-id"/> + <keyword type="struct" name="struct GMimeMultipartEncrypted" link="GMimeMultipartEncrypted.html#GMimeMultipartEncrypted-struct"/> + <keyword type="function" name="g_mime_multipart_encrypted_new ()" link="GMimeMultipartEncrypted.html#g-mime-multipart-encrypted-new"/> + <keyword type="function" name="g_mime_multipart_encrypted_encrypt ()" link="GMimeMultipartEncrypted.html#g-mime-multipart-encrypted-encrypt"/> + <keyword type="function" name="g_mime_multipart_encrypted_decrypt ()" link="GMimeMultipartEncrypted.html#g-mime-multipart-encrypted-decrypt"/> + <keyword type="struct" name="struct GMimeMultipartSigned" link="GMimeMultipartSigned.html#GMimeMultipartSigned-struct"/> + <keyword type="function" name="g_mime_multipart_signed_new ()" link="GMimeMultipartSigned.html#g-mime-multipart-signed-new"/> + <keyword type="function" name="g_mime_multipart_signed_sign ()" link="GMimeMultipartSigned.html#g-mime-multipart-signed-sign"/> + <keyword type="function" name="g_mime_multipart_signed_verify ()" link="GMimeMultipartSigned.html#g-mime-multipart-signed-verify"/> + <keyword type="struct" name="struct GMimeMessagePart" link="GMimeMessagePart.html#GMimeMessagePart-struct"/> + <keyword type="function" name="g_mime_message_part_new ()" link="GMimeMessagePart.html#g-mime-message-part-new"/> + <keyword type="function" name="g_mime_message_part_new_with_message ()" link="GMimeMessagePart.html#g-mime-message-part-new-with-message"/> + <keyword type="function" name="g_mime_message_part_get_message ()" link="GMimeMessagePart.html#g-mime-message-part-get-message"/> + <keyword type="function" name="g_mime_message_part_set_message ()" link="GMimeMessagePart.html#g-mime-message-part-set-message"/> + <keyword type="struct" name="struct GMimeMessagePartial" link="GMimeMessagePartial.html#GMimeMessagePartial-struct"/> + <keyword type="function" name="g_mime_message_partial_new ()" link="GMimeMessagePartial.html#g-mime-message-partial-new"/> + <keyword type="function" name="g_mime_message_partial_get_id ()" link="GMimeMessagePartial.html#g-mime-message-partial-get-id"/> + <keyword type="function" name="g_mime_message_partial_get_number ()" link="GMimeMessagePartial.html#g-mime-message-partial-get-number"/> + <keyword type="function" name="g_mime_message_partial_get_total ()" link="GMimeMessagePartial.html#g-mime-message-partial-get-total"/> + <keyword type="function" name="g_mime_message_partial_reconstruct_message ()" link="GMimeMessagePartial.html#g-mime-message-partial-reconstruct-message"/> + <keyword type="function" name="g_mime_message_partial_split_message ()" link="GMimeMessagePartial.html#g-mime-message-partial-split-message"/> + <keyword type="struct" name="GMimePartIter" link="gmime-GMimePartIter.html#GMimePartIter"/> + <keyword type="function" name="g_mime_part_iter_new ()" link="gmime-GMimePartIter.html#g-mime-part-iter-new"/> + <keyword type="function" name="g_mime_part_iter_free ()" link="gmime-GMimePartIter.html#g-mime-part-iter-free"/> + <keyword type="function" name="g_mime_part_iter_reset ()" link="gmime-GMimePartIter.html#g-mime-part-iter-reset"/> + <keyword type="function" name="g_mime_part_iter_jump_to ()" link="gmime-GMimePartIter.html#g-mime-part-iter-jump-to"/> + <keyword type="function" name="g_mime_part_iter_is_valid ()" link="gmime-GMimePartIter.html#g-mime-part-iter-is-valid"/> + <keyword type="function" name="g_mime_part_iter_next ()" link="gmime-GMimePartIter.html#g-mime-part-iter-next"/> + <keyword type="function" name="g_mime_part_iter_prev ()" link="gmime-GMimePartIter.html#g-mime-part-iter-prev"/> + <keyword type="function" name="g_mime_part_iter_get_toplevel ()" link="gmime-GMimePartIter.html#g-mime-part-iter-get-toplevel"/> + <keyword type="function" name="g_mime_part_iter_get_current ()" link="gmime-GMimePartIter.html#g-mime-part-iter-get-current"/> + <keyword type="function" name="g_mime_part_iter_get_parent ()" link="gmime-GMimePartIter.html#g-mime-part-iter-get-parent"/> + <keyword type="function" name="g_mime_part_iter_get_path ()" link="gmime-GMimePartIter.html#g-mime-part-iter-get-path"/> + <keyword type="function" name="g_mime_part_iter_replace ()" link="gmime-GMimePartIter.html#g-mime-part-iter-replace"/> + <keyword type="function" name="g_mime_part_iter_remove ()" link="gmime-GMimePartIter.html#g-mime-part-iter-remove"/> + <keyword type="struct" name="struct GMimeParser" link="GMimeParser.html#GMimeParser-struct"/> + <keyword type="function" name="GMimeParserHeaderRegexFunc ()" link="GMimeParser.html#GMimeParserHeaderRegexFunc"/> + <keyword type="function" name="g_mime_parser_new ()" link="GMimeParser.html#g-mime-parser-new"/> + <keyword type="function" name="g_mime_parser_new_with_stream ()" link="GMimeParser.html#g-mime-parser-new-with-stream"/> + <keyword type="function" name="g_mime_parser_init_with_stream ()" link="GMimeParser.html#g-mime-parser-init-with-stream"/> + <keyword type="function" name="g_mime_parser_get_persist_stream ()" link="GMimeParser.html#g-mime-parser-get-persist-stream"/> + <keyword type="function" name="g_mime_parser_set_persist_stream ()" link="GMimeParser.html#g-mime-parser-set-persist-stream"/> + <keyword type="function" name="g_mime_parser_get_scan_from ()" link="GMimeParser.html#g-mime-parser-get-scan-from"/> + <keyword type="function" name="g_mime_parser_set_scan_from ()" link="GMimeParser.html#g-mime-parser-set-scan-from"/> + <keyword type="function" name="g_mime_parser_get_respect_content_length ()" link="GMimeParser.html#g-mime-parser-get-respect-content-length"/> + <keyword type="function" name="g_mime_parser_set_respect_content_length ()" link="GMimeParser.html#g-mime-parser-set-respect-content-length"/> + <keyword type="function" name="g_mime_parser_set_header_regex ()" link="GMimeParser.html#g-mime-parser-set-header-regex"/> + <keyword type="function" name="g_mime_parser_tell ()" link="GMimeParser.html#g-mime-parser-tell"/> + <keyword type="function" name="g_mime_parser_eos ()" link="GMimeParser.html#g-mime-parser-eos"/> + <keyword type="function" name="g_mime_parser_construct_part ()" link="GMimeParser.html#g-mime-parser-construct-part"/> + <keyword type="function" name="g_mime_parser_construct_message ()" link="GMimeParser.html#g-mime-parser-construct-message"/> + <keyword type="function" name="g_mime_parser_get_from ()" link="GMimeParser.html#g-mime-parser-get-from"/> + <keyword type="function" name="g_mime_parser_get_from_offset ()" link="GMimeParser.html#g-mime-parser-get-from-offset"/> + <keyword type="function" name="g_mime_parser_get_headers_begin ()" link="GMimeParser.html#g-mime-parser-get-headers-begin"/> + <keyword type="function" name="g_mime_parser_get_headers_end ()" link="GMimeParser.html#g-mime-parser-get-headers-end"/> + <keyword type="enum" name="enum GMimePubKeyAlgo" link="GMimeCertificate.html#GMimePubKeyAlgo"/> + <keyword type="enum" name="enum GMimeDigestAlgo" link="GMimeCertificate.html#GMimeDigestAlgo"/> + <keyword type="enum" name="enum GMimeCertificateTrust" link="GMimeCertificate.html#GMimeCertificateTrust"/> + <keyword type="struct" name="struct GMimeCertificate" link="GMimeCertificate.html#GMimeCertificate-struct"/> + <keyword type="function" name="g_mime_certificate_new ()" link="GMimeCertificate.html#g-mime-certificate-new"/> + <keyword type="function" name="g_mime_certificate_get_pubkey_algo ()" link="GMimeCertificate.html#g-mime-certificate-get-pubkey-algo"/> + <keyword type="function" name="g_mime_certificate_set_pubkey_algo ()" link="GMimeCertificate.html#g-mime-certificate-set-pubkey-algo"/> + <keyword type="function" name="g_mime_certificate_get_digest_algo ()" link="GMimeCertificate.html#g-mime-certificate-get-digest-algo"/> + <keyword type="function" name="g_mime_certificate_set_digest_algo ()" link="GMimeCertificate.html#g-mime-certificate-set-digest-algo"/> + <keyword type="function" name="g_mime_certificate_get_issuer_serial ()" link="GMimeCertificate.html#g-mime-certificate-get-issuer-serial"/> + <keyword type="function" name="g_mime_certificate_set_issuer_serial ()" link="GMimeCertificate.html#g-mime-certificate-set-issuer-serial"/> + <keyword type="function" name="g_mime_certificate_get_issuer_name ()" link="GMimeCertificate.html#g-mime-certificate-get-issuer-name"/> + <keyword type="function" name="g_mime_certificate_set_issuer_name ()" link="GMimeCertificate.html#g-mime-certificate-set-issuer-name"/> + <keyword type="function" name="g_mime_certificate_get_fingerprint ()" link="GMimeCertificate.html#g-mime-certificate-get-fingerprint"/> + <keyword type="function" name="g_mime_certificate_set_fingerprint ()" link="GMimeCertificate.html#g-mime-certificate-set-fingerprint"/> + <keyword type="function" name="g_mime_certificate_get_created ()" link="GMimeCertificate.html#g-mime-certificate-get-created"/> + <keyword type="function" name="g_mime_certificate_set_created ()" link="GMimeCertificate.html#g-mime-certificate-set-created"/> + <keyword type="function" name="g_mime_certificate_get_expires ()" link="GMimeCertificate.html#g-mime-certificate-get-expires"/> + <keyword type="function" name="g_mime_certificate_set_expires ()" link="GMimeCertificate.html#g-mime-certificate-set-expires"/> + <keyword type="function" name="g_mime_certificate_get_key_id ()" link="GMimeCertificate.html#g-mime-certificate-get-key-id"/> + <keyword type="function" name="g_mime_certificate_set_key_id ()" link="GMimeCertificate.html#g-mime-certificate-set-key-id"/> + <keyword type="function" name="g_mime_certificate_get_trust ()" link="GMimeCertificate.html#g-mime-certificate-get-trust"/> + <keyword type="function" name="g_mime_certificate_set_trust ()" link="GMimeCertificate.html#g-mime-certificate-set-trust"/> + <keyword type="function" name="g_mime_certificate_get_email ()" link="GMimeCertificate.html#g-mime-certificate-get-email"/> + <keyword type="function" name="g_mime_certificate_set_email ()" link="GMimeCertificate.html#g-mime-certificate-set-email"/> + <keyword type="function" name="g_mime_certificate_get_name ()" link="GMimeCertificate.html#g-mime-certificate-get-name"/> + <keyword type="function" name="g_mime_certificate_set_name ()" link="GMimeCertificate.html#g-mime-certificate-set-name"/> + <keyword type="struct" name="struct GMimeCertificateList" link="GMimeCertificate.html#GMimeCertificateList-struct"/> + <keyword type="function" name="g_mime_certificate_list_new ()" link="GMimeCertificate.html#g-mime-certificate-list-new"/> + <keyword type="function" name="g_mime_certificate_list_length ()" link="GMimeCertificate.html#g-mime-certificate-list-length"/> + <keyword type="function" name="g_mime_certificate_list_clear ()" link="GMimeCertificate.html#g-mime-certificate-list-clear"/> + <keyword type="function" name="g_mime_certificate_list_add ()" link="GMimeCertificate.html#g-mime-certificate-list-add"/> + <keyword type="function" name="g_mime_certificate_list_insert ()" link="GMimeCertificate.html#g-mime-certificate-list-insert"/> + <keyword type="function" name="g_mime_certificate_list_remove ()" link="GMimeCertificate.html#g-mime-certificate-list-remove"/> + <keyword type="function" name="g_mime_certificate_list_remove_at ()" link="GMimeCertificate.html#g-mime-certificate-list-remove-at"/> + <keyword type="function" name="g_mime_certificate_list_contains ()" link="GMimeCertificate.html#g-mime-certificate-list-contains"/> + <keyword type="function" name="g_mime_certificate_list_index_of ()" link="GMimeCertificate.html#g-mime-certificate-list-index-of"/> + <keyword type="function" name="g_mime_certificate_list_get_certificate ()" link="GMimeCertificate.html#g-mime-certificate-list-get-certificate"/> + <keyword type="function" name="g_mime_certificate_list_set_certificate ()" link="GMimeCertificate.html#g-mime-certificate-list-set-certificate"/> + <keyword type="enum" name="enum GMimeSignatureStatus" link="GMimeSignature.html#GMimeSignatureStatus"/> + <keyword type="enum" name="enum GMimeSignatureError" link="GMimeSignature.html#GMimeSignatureError"/> + <keyword type="struct" name="struct GMimeSignature" link="GMimeSignature.html#GMimeSignature-struct"/> + <keyword type="function" name="g_mime_signature_new ()" link="GMimeSignature.html#g-mime-signature-new"/> + <keyword type="function" name="g_mime_signature_get_certificate ()" link="GMimeSignature.html#g-mime-signature-get-certificate"/> + <keyword type="function" name="g_mime_signature_set_certificate ()" link="GMimeSignature.html#g-mime-signature-set-certificate"/> + <keyword type="function" name="g_mime_signature_get_status ()" link="GMimeSignature.html#g-mime-signature-get-status"/> + <keyword type="function" name="g_mime_signature_set_status ()" link="GMimeSignature.html#g-mime-signature-set-status"/> + <keyword type="function" name="g_mime_signature_get_errors ()" link="GMimeSignature.html#g-mime-signature-get-errors"/> + <keyword type="function" name="g_mime_signature_set_errors ()" link="GMimeSignature.html#g-mime-signature-set-errors"/> + <keyword type="function" name="g_mime_signature_get_created ()" link="GMimeSignature.html#g-mime-signature-get-created"/> + <keyword type="function" name="g_mime_signature_set_created ()" link="GMimeSignature.html#g-mime-signature-set-created"/> + <keyword type="function" name="g_mime_signature_get_expires ()" link="GMimeSignature.html#g-mime-signature-get-expires"/> + <keyword type="function" name="g_mime_signature_set_expires ()" link="GMimeSignature.html#g-mime-signature-set-expires"/> + <keyword type="struct" name="struct GMimeSignatureList" link="GMimeSignature.html#GMimeSignatureList-struct"/> + <keyword type="function" name="g_mime_signature_list_new ()" link="GMimeSignature.html#g-mime-signature-list-new"/> + <keyword type="function" name="g_mime_signature_list_length ()" link="GMimeSignature.html#g-mime-signature-list-length"/> + <keyword type="function" name="g_mime_signature_list_clear ()" link="GMimeSignature.html#g-mime-signature-list-clear"/> + <keyword type="function" name="g_mime_signature_list_add ()" link="GMimeSignature.html#g-mime-signature-list-add"/> + <keyword type="function" name="g_mime_signature_list_insert ()" link="GMimeSignature.html#g-mime-signature-list-insert"/> + <keyword type="function" name="g_mime_signature_list_remove ()" link="GMimeSignature.html#g-mime-signature-list-remove"/> + <keyword type="function" name="g_mime_signature_list_remove_at ()" link="GMimeSignature.html#g-mime-signature-list-remove-at"/> + <keyword type="function" name="g_mime_signature_list_contains ()" link="GMimeSignature.html#g-mime-signature-list-contains"/> + <keyword type="function" name="g_mime_signature_list_index_of ()" link="GMimeSignature.html#g-mime-signature-list-index-of"/> + <keyword type="function" name="g_mime_signature_list_get_signature ()" link="GMimeSignature.html#g-mime-signature-list-get-signature"/> + <keyword type="function" name="g_mime_signature_list_set_signature ()" link="GMimeSignature.html#g-mime-signature-list-set-signature"/> + <keyword type="function" name="GMimePasswordRequestFunc ()" link="GMimeCryptoContext.html#GMimePasswordRequestFunc"/> + <keyword type="struct" name="struct GMimeCryptoContext" link="GMimeCryptoContext.html#GMimeCryptoContext-struct"/> + <keyword type="function" name="g_mime_crypto_context_set_request_password ()" link="GMimeCryptoContext.html#g-mime-crypto-context-set-request-password"/> + <keyword type="function" name="g_mime_crypto_context_get_signature_protocol ()" link="GMimeCryptoContext.html#g-mime-crypto-context-get-signature-protocol"/> + <keyword type="function" name="g_mime_crypto_context_get_encryption_protocol ()" link="GMimeCryptoContext.html#g-mime-crypto-context-get-encryption-protocol"/> + <keyword type="function" name="g_mime_crypto_context_get_key_exchange_protocol ()" link="GMimeCryptoContext.html#g-mime-crypto-context-get-key-exchange-protocol"/> + <keyword type="function" name="g_mime_crypto_context_digest_id ()" link="GMimeCryptoContext.html#g-mime-crypto-context-digest-id"/> + <keyword type="function" name="g_mime_crypto_context_digest_name ()" link="GMimeCryptoContext.html#g-mime-crypto-context-digest-name"/> + <keyword type="function" name="g_mime_crypto_context_sign ()" link="GMimeCryptoContext.html#g-mime-crypto-context-sign"/> + <keyword type="function" name="g_mime_crypto_context_verify ()" link="GMimeCryptoContext.html#g-mime-crypto-context-verify"/> + <keyword type="function" name="g_mime_crypto_context_encrypt ()" link="GMimeCryptoContext.html#g-mime-crypto-context-encrypt"/> + <keyword type="function" name="g_mime_crypto_context_decrypt ()" link="GMimeCryptoContext.html#g-mime-crypto-context-decrypt"/> + <keyword type="function" name="g_mime_crypto_context_import_keys ()" link="GMimeCryptoContext.html#g-mime-crypto-context-import-keys"/> + <keyword type="function" name="g_mime_crypto_context_export_keys ()" link="GMimeCryptoContext.html#g-mime-crypto-context-export-keys"/> + <keyword type="enum" name="enum GMimeCipherAlgo" link="GMimeCryptoContext.html#GMimeCipherAlgo"/> + <keyword type="struct" name="struct GMimeDecryptResult" link="GMimeCryptoContext.html#GMimeDecryptResult"/> + <keyword type="function" name="g_mime_decrypt_result_new ()" link="GMimeCryptoContext.html#g-mime-decrypt-result-new"/> + <keyword type="function" name="g_mime_decrypt_result_get_recipients ()" link="GMimeCryptoContext.html#g-mime-decrypt-result-get-recipients"/> + <keyword type="function" name="g_mime_decrypt_result_set_recipients ()" link="GMimeCryptoContext.html#g-mime-decrypt-result-set-recipients"/> + <keyword type="function" name="g_mime_decrypt_result_get_signatures ()" link="GMimeCryptoContext.html#g-mime-decrypt-result-get-signatures"/> + <keyword type="function" name="g_mime_decrypt_result_set_signatures ()" link="GMimeCryptoContext.html#g-mime-decrypt-result-set-signatures"/> + <keyword type="function" name="g_mime_decrypt_result_get_cipher ()" link="GMimeCryptoContext.html#g-mime-decrypt-result-get-cipher"/> + <keyword type="function" name="g_mime_decrypt_result_set_cipher ()" link="GMimeCryptoContext.html#g-mime-decrypt-result-set-cipher"/> + <keyword type="function" name="g_mime_decrypt_result_get_mdc ()" link="GMimeCryptoContext.html#g-mime-decrypt-result-get-mdc"/> + <keyword type="function" name="g_mime_decrypt_result_set_mdc ()" link="GMimeCryptoContext.html#g-mime-decrypt-result-set-mdc"/> + <keyword type="struct" name="struct GMimeGpgContext" link="GMimeGpgContext.html#GMimeGpgContext-struct"/> + <keyword type="function" name="g_mime_gpg_context_new ()" link="GMimeGpgContext.html#g-mime-gpg-context-new"/> + <keyword type="function" name="g_mime_gpg_context_get_always_trust ()" link="GMimeGpgContext.html#g-mime-gpg-context-get-always-trust"/> + <keyword type="function" name="g_mime_gpg_context_set_always_trust ()" link="GMimeGpgContext.html#g-mime-gpg-context-set-always-trust"/> + <keyword type="function" name="g_mime_gpg_context_get_auto_key_retrieve ()" link="GMimeGpgContext.html#g-mime-gpg-context-get-auto-key-retrieve"/> + <keyword type="function" name="g_mime_gpg_context_set_auto_key_retrieve ()" link="GMimeGpgContext.html#g-mime-gpg-context-set-auto-key-retrieve"/> + <keyword type="function" name="g_mime_gpg_context_get_use_agent ()" link="GMimeGpgContext.html#g-mime-gpg-context-get-use-agent"/> + <keyword type="function" name="g_mime_gpg_context_set_use_agent ()" link="GMimeGpgContext.html#g-mime-gpg-context-set-use-agent"/> + <keyword type="struct" name="struct GMimePkcs7Context" link="GMimePkcs7Context.html#GMimePkcs7Context-struct"/> + <keyword type="function" name="g_mime_pkcs7_context_new ()" link="GMimePkcs7Context.html#g-mime-pkcs7-context-new"/> + <keyword type="function" name="g_mime_pkcs7_context_get_always_trust ()" link="GMimePkcs7Context.html#g-mime-pkcs7-context-get-always-trust"/> + <keyword type="function" name="g_mime_pkcs7_context_set_always_trust ()" link="GMimePkcs7Context.html#g-mime-pkcs7-context-set-always-trust"/> + <keyword type="constant" name="GMIME_CONTENT_ENCODING_DEFAULT" link="gmime-gmime-encodings.html#GMIME-CONTENT-ENCODING-DEFAULT:CAPS"/> + <keyword type="constant" name="GMIME_CONTENT_ENCODING_7BIT" link="gmime-gmime-encodings.html#GMIME-CONTENT-ENCODING-7BIT:CAPS"/> + <keyword type="constant" name="GMIME_CONTENT_ENCODING_8BIT" link="gmime-gmime-encodings.html#GMIME-CONTENT-ENCODING-8BIT:CAPS"/> + <keyword type="constant" name="GMIME_CONTENT_ENCODING_BINARY" link="gmime-gmime-encodings.html#GMIME-CONTENT-ENCODING-BINARY:CAPS"/> + <keyword type="constant" name="GMIME_CONTENT_ENCODING_BASE64" link="gmime-gmime-encodings.html#GMIME-CONTENT-ENCODING-BASE64:CAPS"/> + <keyword type="constant" name="GMIME_CONTENT_ENCODING_QUOTEDPRINTABLE" link="gmime-gmime-encodings.html#GMIME-CONTENT-ENCODING-QUOTEDPRINTABLE:CAPS"/> + <keyword type="constant" name="GMIME_CONTENT_ENCODING_UUENCODE" link="gmime-gmime-encodings.html#GMIME-CONTENT-ENCODING-UUENCODE:CAPS"/> + <keyword type="constant" name="GMIME_ENCODING_CONSTRAINT_7BIT" link="gmime-gmime-encodings.html#GMIME-ENCODING-CONSTRAINT-7BIT:CAPS"/> + <keyword type="constant" name="GMIME_ENCODING_CONSTRAINT_8BIT" link="gmime-gmime-encodings.html#GMIME-ENCODING-CONSTRAINT-8BIT:CAPS"/> + <keyword type="constant" name="GMIME_ENCODING_CONSTRAINT_BINARY" link="gmime-gmime-encodings.html#GMIME-ENCODING-CONSTRAINT-BINARY:CAPS"/> + <keyword type="constant" name="GMIME_STREAM_SEEK_SET" link="GMimeStream.html#GMIME-STREAM-SEEK-SET:CAPS"/> + <keyword type="constant" name="GMIME_STREAM_SEEK_CUR" link="GMimeStream.html#GMIME-STREAM-SEEK-CUR:CAPS"/> + <keyword type="constant" name="GMIME_STREAM_SEEK_END" link="GMimeStream.html#GMIME-STREAM-SEEK-END:CAPS"/> + <keyword type="constant" name="GMIME_STREAM_BUFFER_CACHE_READ" link="GMimeStreamBuffer.html#GMIME-STREAM-BUFFER-CACHE-READ:CAPS"/> + <keyword type="constant" name="GMIME_STREAM_BUFFER_BLOCK_READ" link="GMimeStreamBuffer.html#GMIME-STREAM-BUFFER-BLOCK-READ:CAPS"/> + <keyword type="constant" name="GMIME_STREAM_BUFFER_BLOCK_WRITE" link="GMimeStreamBuffer.html#GMIME-STREAM-BUFFER-BLOCK-WRITE:CAPS"/> + <keyword type="constant" name="GMIME_FILTER_BEST_CHARSET" link="GMimeFilterBest.html#GMIME-FILTER-BEST-CHARSET:CAPS"/> + <keyword type="constant" name="GMIME_FILTER_BEST_ENCODING" link="GMimeFilterBest.html#GMIME-FILTER-BEST-ENCODING:CAPS"/> + <keyword type="constant" name="GMIME_FILTER_FROM_MODE_DEFAULT" link="GMimeFilterFrom.html#GMIME-FILTER-FROM-MODE-DEFAULT:CAPS"/> + <keyword type="constant" name="GMIME_FILTER_FROM_MODE_ESCAPE" link="GMimeFilterFrom.html#GMIME-FILTER-FROM-MODE-ESCAPE:CAPS"/> + <keyword type="constant" name="GMIME_FILTER_FROM_MODE_ARMOR" link="GMimeFilterFrom.html#GMIME-FILTER-FROM-MODE-ARMOR:CAPS"/> + <keyword type="constant" name="GMIME_FILTER_GZIP_MODE_ZIP" link="GMimeFilterGZip.html#GMIME-FILTER-GZIP-MODE-ZIP:CAPS"/> + <keyword type="constant" name="GMIME_FILTER_GZIP_MODE_UNZIP" link="GMimeFilterGZip.html#GMIME-FILTER-GZIP-MODE-UNZIP:CAPS"/> + <keyword type="constant" name="GMIME_RECIPIENT_TYPE_TO" link="GMimeMessage.html#GMIME-RECIPIENT-TYPE-TO:CAPS"/> + <keyword type="constant" name="GMIME_RECIPIENT_TYPE_CC" link="GMimeMessage.html#GMIME-RECIPIENT-TYPE-CC:CAPS"/> + <keyword type="constant" name="GMIME_RECIPIENT_TYPE_BCC" link="GMimeMessage.html#GMIME-RECIPIENT-TYPE-BCC:CAPS"/> + <keyword type="constant" name="GMIME_PUBKEY_ALGO_DEFAULT" link="GMimeCertificate.html#GMIME-PUBKEY-ALGO-DEFAULT:CAPS"/> + <keyword type="constant" name="GMIME_PUBKEY_ALGO_RSA" link="GMimeCertificate.html#GMIME-PUBKEY-ALGO-RSA:CAPS"/> + <keyword type="constant" name="GMIME_PUBKEY_ALGO_RSA_E" link="GMimeCertificate.html#GMIME-PUBKEY-ALGO-RSA-E:CAPS"/> + <keyword type="constant" name="GMIME_PUBKEY_ALGO_RSA_S" link="GMimeCertificate.html#GMIME-PUBKEY-ALGO-RSA-S:CAPS"/> + <keyword type="constant" name="GMIME_PUBKEY_ALGO_ELG_E" link="GMimeCertificate.html#GMIME-PUBKEY-ALGO-ELG-E:CAPS"/> + <keyword type="constant" name="GMIME_PUBKEY_ALGO_DSA" link="GMimeCertificate.html#GMIME-PUBKEY-ALGO-DSA:CAPS"/> + <keyword type="constant" name="GMIME_PUBKEY_ALGO_ELG" link="GMimeCertificate.html#GMIME-PUBKEY-ALGO-ELG:CAPS"/> + <keyword type="constant" name="GMIME_DIGEST_ALGO_DEFAULT" link="GMimeCertificate.html#GMIME-DIGEST-ALGO-DEFAULT:CAPS"/> + <keyword type="constant" name="GMIME_DIGEST_ALGO_MD5" link="GMimeCertificate.html#GMIME-DIGEST-ALGO-MD5:CAPS"/> + <keyword type="constant" name="GMIME_DIGEST_ALGO_SHA1" link="GMimeCertificate.html#GMIME-DIGEST-ALGO-SHA1:CAPS"/> + <keyword type="constant" name="GMIME_DIGEST_ALGO_RIPEMD160" link="GMimeCertificate.html#GMIME-DIGEST-ALGO-RIPEMD160:CAPS"/> + <keyword type="constant" name="GMIME_DIGEST_ALGO_MD2" link="GMimeCertificate.html#GMIME-DIGEST-ALGO-MD2:CAPS"/> + <keyword type="constant" name="GMIME_DIGEST_ALGO_TIGER192" link="GMimeCertificate.html#GMIME-DIGEST-ALGO-TIGER192:CAPS"/> + <keyword type="constant" name="GMIME_DIGEST_ALGO_HAVAL5160" link="GMimeCertificate.html#GMIME-DIGEST-ALGO-HAVAL5160:CAPS"/> + <keyword type="constant" name="GMIME_DIGEST_ALGO_SHA256" link="GMimeCertificate.html#GMIME-DIGEST-ALGO-SHA256:CAPS"/> + <keyword type="constant" name="GMIME_DIGEST_ALGO_SHA384" link="GMimeCertificate.html#GMIME-DIGEST-ALGO-SHA384:CAPS"/> + <keyword type="constant" name="GMIME_DIGEST_ALGO_SHA512" link="GMimeCertificate.html#GMIME-DIGEST-ALGO-SHA512:CAPS"/> + <keyword type="constant" name="GMIME_DIGEST_ALGO_SHA224" link="GMimeCertificate.html#GMIME-DIGEST-ALGO-SHA224:CAPS"/> + <keyword type="constant" name="GMIME_DIGEST_ALGO_MD4" link="GMimeCertificate.html#GMIME-DIGEST-ALGO-MD4:CAPS"/> + <keyword type="constant" name="GMIME_CERTIFICATE_TRUST_NONE" link="GMimeCertificate.html#GMIME-CERTIFICATE-TRUST-NONE:CAPS"/> + <keyword type="constant" name="GMIME_CERTIFICATE_TRUST_NEVER" link="GMimeCertificate.html#GMIME-CERTIFICATE-TRUST-NEVER:CAPS"/> + <keyword type="constant" name="GMIME_CERTIFICATE_TRUST_UNDEFINED" link="GMimeCertificate.html#GMIME-CERTIFICATE-TRUST-UNDEFINED:CAPS"/> + <keyword type="constant" name="GMIME_CERTIFICATE_TRUST_MARGINAL" link="GMimeCertificate.html#GMIME-CERTIFICATE-TRUST-MARGINAL:CAPS"/> + <keyword type="constant" name="GMIME_CERTIFICATE_TRUST_FULLY" link="GMimeCertificate.html#GMIME-CERTIFICATE-TRUST-FULLY:CAPS"/> + <keyword type="constant" name="GMIME_CERTIFICATE_TRUST_ULTIMATE" link="GMimeCertificate.html#GMIME-CERTIFICATE-TRUST-ULTIMATE:CAPS"/> + <keyword type="constant" name="GMIME_SIGNATURE_STATUS_GOOD" link="GMimeSignature.html#GMIME-SIGNATURE-STATUS-GOOD:CAPS"/> + <keyword type="constant" name="GMIME_SIGNATURE_STATUS_ERROR" link="GMimeSignature.html#GMIME-SIGNATURE-STATUS-ERROR:CAPS"/> + <keyword type="constant" name="GMIME_SIGNATURE_STATUS_BAD" link="GMimeSignature.html#GMIME-SIGNATURE-STATUS-BAD:CAPS"/> + <keyword type="constant" name="GMIME_SIGNATURE_ERROR_NONE" link="GMimeSignature.html#GMIME-SIGNATURE-ERROR-NONE:CAPS"/> + <keyword type="constant" name="GMIME_SIGNATURE_ERROR_EXPSIG" link="GMimeSignature.html#GMIME-SIGNATURE-ERROR-EXPSIG:CAPS"/> + <keyword type="constant" name="GMIME_SIGNATURE_ERROR_NO_PUBKEY" link="GMimeSignature.html#GMIME-SIGNATURE-ERROR-NO-PUBKEY:CAPS"/> + <keyword type="constant" name="GMIME_SIGNATURE_ERROR_EXPKEYSIG" link="GMimeSignature.html#GMIME-SIGNATURE-ERROR-EXPKEYSIG:CAPS"/> + <keyword type="constant" name="GMIME_SIGNATURE_ERROR_REVKEYSIG" link="GMimeSignature.html#GMIME-SIGNATURE-ERROR-REVKEYSIG:CAPS"/> + <keyword type="constant" name="GMIME_SIGNATURE_ERROR_UNSUPP_ALGO" link="GMimeSignature.html#GMIME-SIGNATURE-ERROR-UNSUPP-ALGO:CAPS"/> + <keyword type="constant" name="GMIME_CIPHER_ALGO_DEFAULT" link="GMimeCryptoContext.html#GMIME-CIPHER-ALGO-DEFAULT:CAPS"/> + <keyword type="constant" name="GMIME_CIPHER_ALGO_IDEA" link="GMimeCryptoContext.html#GMIME-CIPHER-ALGO-IDEA:CAPS"/> + <keyword type="constant" name="GMIME_CIPHER_ALGO_3DES" link="GMimeCryptoContext.html#GMIME-CIPHER-ALGO-3DES:CAPS"/> + <keyword type="constant" name="GMIME_CIPHER_ALGO_CAST5" link="GMimeCryptoContext.html#GMIME-CIPHER-ALGO-CAST5:CAPS"/> + <keyword type="constant" name="GMIME_CIPHER_ALGO_BLOWFISH" link="GMimeCryptoContext.html#GMIME-CIPHER-ALGO-BLOWFISH:CAPS"/> + <keyword type="constant" name="GMIME_CIPHER_ALGO_AES" link="GMimeCryptoContext.html#GMIME-CIPHER-ALGO-AES:CAPS"/> + <keyword type="constant" name="GMIME_CIPHER_ALGO_AES192" link="GMimeCryptoContext.html#GMIME-CIPHER-ALGO-AES192:CAPS"/> + <keyword type="constant" name="GMIME_CIPHER_ALGO_AES256" link="GMimeCryptoContext.html#GMIME-CIPHER-ALGO-AES256:CAPS"/> + <keyword type="constant" name="GMIME_CIPHER_ALGO_TWOFISH" link="GMimeCryptoContext.html#GMIME-CIPHER-ALGO-TWOFISH:CAPS"/> + <keyword type="constant" name="GMIME_CIPHER_ALGO_CAMELLIA128" link="GMimeCryptoContext.html#GMIME-CIPHER-ALGO-CAMELLIA128:CAPS"/> + <keyword type="constant" name="GMIME_CIPHER_ALGO_CAMELLIA192" link="GMimeCryptoContext.html#GMIME-CIPHER-ALGO-CAMELLIA192:CAPS"/> + <keyword type="constant" name="GMIME_CIPHER_ALGO_CAMELLIA256" link="GMimeCryptoContext.html#GMIME-CIPHER-ALGO-CAMELLIA256:CAPS"/> + </functions> +</book> diff --git a/docs/reference/html/gmime.html b/docs/reference/html/gmime.html new file mode 100644 index 0000000..4da04f5 --- /dev/null +++ b/docs/reference/html/gmime.html @@ -0,0 +1,93 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Part I. GMime Overview</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="up" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="prev" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="next" href="gmime-building.html" title="Compiling the GMime libraries"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="index.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td> </td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">GMime 2.6 Reference Manual</th> +<td><a accesskey="n" href="gmime-building.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="part"> +<div class="titlepage"><div><div><h1 class="title"> +<a name="gmime"></a>Part I. GMime Overview</h1></div></div></div> +<div class="partintro"> +<div></div> +<p> +GMime is a powerful MIME (Multipurpose Internet Mail Extension) +utility library. It is meant for creating, editing, and parsing MIME +messages and structures. GMime is released under the 2.1 version of +the GNU Lesser General Public License. GMime is based on GLib 2.0's +GObject system allowing for a lot of flexibility. + </p> +<p> +GMime depends on the following libraries: + </p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">GLib</span></p></td> +<td><p> +A general-purpose utility library, not specific to graphical user interfaces. +GLib provides many useful data types, macros, type conversions, +string utilities, file utilities, a main loop abstraction, and so on. + </p></td> +</tr></tbody> +</table></div> +<p> + </p> +<div class="toc"> +<p><b>Table of Contents</b></p> +<dl> +<dt> +<span class="refentrytitle"><a href="gmime-building.html">Compiling the GMime libraries</a></span><span class="refpurpose"> — How to compile GMime itself</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gmime-compiling.html">Compiling GMime Applications</a></span><span class="refpurpose"> — +How to compile your GMime application +</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gmime-changes-2-0.html">Changes from 1.0 to 2.0</a></span><span class="refpurpose"> — +Incompatible changes made between version 1.0 and version 2.0 +</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gmime-changes-2-2.html">Changes from 2.0 to 2.2</a></span><span class="refpurpose"> — Incompatible changes made between version 2.0 and version 2.2</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gmime-changes-2-4.html">Changes from 2.2 to 2.4</a></span><span class="refpurpose"> — Changes made between version 2.2 and version 2.4</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gmime-changes-2-6.html">Changes from 2.4 to 2.6</a></span><span class="refpurpose"> — Changes made between version 2.4 and version 2.6</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gmime-resources.html">Mailing lists and bug reports</a></span><span class="refpurpose"> — +Getting help with GMime +</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gmime-question-index.html">Frequently Asked Questions</a></span><span class="refpurpose"> — +Find answers to common questions in the GMime manual +</span> +</dt> +</dl> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/home.png b/docs/reference/html/home.png Binary files differnew file mode 100644 index 0000000..fb60b55 --- /dev/null +++ b/docs/reference/html/home.png diff --git a/docs/reference/html/index.html b/docs/reference/html/index.html new file mode 100644 index 0000000..c3da4ad --- /dev/null +++ b/docs/reference/html/index.html @@ -0,0 +1,296 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GMime 2.6 Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<meta name="description" content="This manual documents the interfaces of the GMime library and has some short notes to help get you up to speed with using the library."> +<link rel="home" href="index.html" title="GMime 2.6 Reference Manual"> +<link rel="next" href="gmime.html" title="Part I. GMime Overview"> +<meta name="generator" content="GTK-Doc V1.18 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<div class="book"> +<div class="titlepage"> +<div> +<div><table class="navigation" id="top" width="100%" cellpadding="2" cellspacing="0"><tr><th valign="middle"><p class="title">GMime 2.6 Reference Manual</p></th></tr></table></div> +<div><div class="authorgroup"><div class="author"> +<h3 class="author"> +<span class="firstname">Jeffrey</span> <span class="surname">Stedfast</span> +</h3> +<div class="affiliation"><div class="address"><p><br> +            <code class="email"><<a class="email" href="mailto:fejj@gnome.org">fejj@gnome.org</a>></code><br> +          </p></div></div> +</div></div></div> +<div><p class="copyright">Copyright © 2000-2011 Jeffrey Stedfast</p></div> +<div><div class="legalnotice"> +<a name="idp251088"></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 + version 2.1 of the License, or (at your option) any later version. + </p> +<p> + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + </p> +<p> + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA + 02110-1301, USA. + </p> +</div></div> +<div><div class="abstract"> +<p class="title"><b>Abstract</b></p> +<p>This manual documents the interfaces of the GMime + library and has some short notes to help get you up to speed + with using the library.</p> +</div></div> +</div> +<hr> +</div> +<div class="toc"><dl> +<dt><span class="part"><a href="gmime.html">I. GMime Overview</a></span></dt> +<dd><dl> +<dt> +<span class="refentrytitle"><a href="gmime-building.html">Compiling the GMime libraries</a></span><span class="refpurpose"> — How to compile GMime itself</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gmime-compiling.html">Compiling GMime Applications</a></span><span class="refpurpose"> — +How to compile your GMime application +</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gmime-changes-2-0.html">Changes from 1.0 to 2.0</a></span><span class="refpurpose"> — +Incompatible changes made between version 1.0 and version 2.0 +</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gmime-changes-2-2.html">Changes from 2.0 to 2.2</a></span><span class="refpurpose"> — Incompatible changes made between version 2.0 and version 2.2</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gmime-changes-2-4.html">Changes from 2.2 to 2.4</a></span><span class="refpurpose"> — Changes made between version 2.2 and version 2.4</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gmime-changes-2-6.html">Changes from 2.4 to 2.6</a></span><span class="refpurpose"> — Changes made between version 2.4 and version 2.6</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gmime-resources.html">Mailing lists and bug reports</a></span><span class="refpurpose"> — +Getting help with GMime +</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gmime-question-index.html">Frequently Asked Questions</a></span><span class="refpurpose"> — +Find answers to common questions in the GMime manual +</span> +</dt> +</dl></dd> +<dt><span class="part"><a href="fundamentals.html">II. GMime Fundamentals</a></span></dt> +<dd><dl> +<dt> +<span class="refentrytitle"><a href="gmime-streams.html">GMime Streams</a></span><span class="refpurpose"> — How to use GMime Streams</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gmime-filters.html">GMime Stream Filters</a></span><span class="refpurpose"> — How to use GMime Stream Filters</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gmime-data-wrappers.html">GMime Data Wrappers</a></span><span class="refpurpose"> — How to use GMime Data Wrappers</span> +</dt> +</dl></dd> +<dt><span class="part"><a href="core.html">III. GMime Core Reference</a></span></dt> +<dd><dl> +<dt> +<span class="refentrytitle"><a href="gmime-gmime.html">gmime</a></span><span class="refpurpose"> — Initialization, shutdown and version-check routines</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gmime-gmime-charset.html">gmime-charset</a></span><span class="refpurpose"> — Charset helper functions</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gmime-gmime-iconv.html">gmime-iconv</a></span><span class="refpurpose"> — Low-level routines for converting text from one charset to another</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gmime-gmime-iconv-utils.html">gmime-iconv-utils</a></span><span class="refpurpose"> — High-level routines for converting text from one charset to another</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gmime-gmime-encodings.html">gmime-encodings</a></span><span class="refpurpose"> — MIME encoding functions</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gmime-gmime-utils.html">gmime-utils</a></span><span class="refpurpose"> — MIME utility functions</span> +</dt> +</dl></dd> +<dt><span class="part"><a href="classes.html">IV. GMime Classes</a></span></dt> +<dd><dl> +<dt><span class="chapter"><a href="ch01.html">Class hierarchy</a></span></dt> +<dt><span class="chapter"><a href="Streams.html">Streams</a></span></dt> +<dd><dl> +<dt> +<span class="refentrytitle"><a href="GMimeStream.html">GMimeStream</a></span><span class="refpurpose"> — Abstract stream class</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeStreamFile.html">GMimeStreamFile</a></span><span class="refpurpose"> — A Standard-C FILE-based stream</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeStreamFs.html">GMimeStreamFs</a></span><span class="refpurpose"> — A low-level FileSystem stream</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeStreamMem.html">GMimeStreamMem</a></span><span class="refpurpose"> — A memory-backed stream</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeStreamMmap.html">GMimeStreamMmap</a></span><span class="refpurpose"> — A memory-mapped file stream</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeStreamNull.html">GMimeStreamNull</a></span><span class="refpurpose"> — A null stream</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeStreamFilter.html">GMimeStreamFilter</a></span><span class="refpurpose"> — A filtering stream</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeStreamBuffer.html">GMimeStreamBuffer</a></span><span class="refpurpose"> — A buffered stream</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeStreamPipe.html">GMimeStreamPipe</a></span><span class="refpurpose"> — A low-level pipe stream</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeStreamCat.html">GMimeStreamCat</a></span><span class="refpurpose"> — A concatenated stream</span> +</dt> +</dl></dd> +<dt><span class="chapter"><a href="Filters.html">Stream Filters</a></span></dt> +<dd><dl> +<dt> +<span class="refentrytitle"><a href="GMimeFilter.html">GMimeFilter</a></span><span class="refpurpose"> — Abstract filter class</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeFilterBasic.html">GMimeFilterBasic</a></span><span class="refpurpose"> — Basic transfer encoding filter</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeFilterBest.html">GMimeFilterBest</a></span><span class="refpurpose"> — Determine the best charset/encoding to use for a stream</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeFilterCharset.html">GMimeFilterCharset</a></span><span class="refpurpose"> — Charset-conversion filter</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeFilterCRLF.html">GMimeFilterCRLF</a></span><span class="refpurpose"> — Convert line-endings from LF to CRLF or vise versa</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeFilterEnriched.html">GMimeFilterEnriched</a></span><span class="refpurpose"> — Convert text/enriched or text/rtf to HTML</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeFilterFrom.html">GMimeFilterFrom</a></span><span class="refpurpose"> — Escape MBox From_ lines</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeFilterGZip.html">GMimeFilterGZip</a></span><span class="refpurpose"> — GNU Zip compression/decompression</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeFilterHTML.html">GMimeFilterHTML</a></span><span class="refpurpose"> — Convert plain text into HTML</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeFilterMd5.html">GMimeFilterMd5</a></span><span class="refpurpose"> — Calculate an md5sum</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeFilterStrip.html">GMimeFilterStrip</a></span><span class="refpurpose"> — Strip trailing whitespace from the end of lines</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeFilterWindows.html">GMimeFilterWindows</a></span><span class="refpurpose"> — Determine if text is in a Microsoft Windows codepage</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeFilterYenc.html">GMimeFilterYenc</a></span><span class="refpurpose"> — yEncode or yDecode</span> +</dt> +</dl></dd> +<dt><span class="chapter"><a href="DataWrappers.html">Data Wrappers</a></span></dt> +<dd><dl><dt> +<span class="refentrytitle"><a href="GMimeDataWrapper.html">GMimeDataWrapper</a></span><span class="refpurpose"> — Content objects</span> +</dt></dl></dd> +<dt><span class="chapter"><a href="Headers.html">Message and MIME Headers</a></span></dt> +<dd><dl> +<dt> +<span class="refentrytitle"><a href="gmime-GMimeHeader.html">GMimeHeader</a></span><span class="refpurpose"> — Message and MIME part headers</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeContentType.html">GMimeContentType</a></span><span class="refpurpose"> — Content-Type fields</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeContentDisposition.html">GMimeContentDisposition</a></span><span class="refpurpose"> — Content-Disposition fields</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gmime-GMimeParam.html">GMimeParam</a></span><span class="refpurpose"> — Content-Type and Content-Disposition parameters</span> +</dt> +</dl></dd> +<dt><span class="chapter"><a href="InternetAddresses.html">Internet Addresses</a></span></dt> +<dd><dl> +<dt> +<span class="refentrytitle"><a href="InternetAddress.html">InternetAddress</a></span><span class="refpurpose"> — Internet addresses</span> +</dt> +<dt> +<span class="refentrytitle"><a href="InternetAddressGroup.html">InternetAddressGroup</a></span><span class="refpurpose"> — rfc822 'group' address</span> +</dt> +<dt> +<span class="refentrytitle"><a href="InternetAddressMailbox.html">InternetAddressMailbox</a></span><span class="refpurpose"> — rfc822 'mailbox' address</span> +</dt> +<dt> +<span class="refentrytitle"><a href="InternetAddressList.html">InternetAddressList</a></span><span class="refpurpose"> — A list of internet addresses</span> +</dt> +</dl></dd> +<dt><span class="chapter"><a href="MimeParts.html">MIME Messages and Parts</a></span></dt> +<dd><dl> +<dt> +<span class="refentrytitle"><a href="GMimeObject.html">GMimeObject</a></span><span class="refpurpose"> — Abstract MIME objects</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeMessage.html">GMimeMessage</a></span><span class="refpurpose"> — Messages</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimePart.html">GMimePart</a></span><span class="refpurpose"> — MIME parts</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeMultipart.html">GMimeMultipart</a></span><span class="refpurpose"> — MIME multiparts</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeMultipartEncrypted.html">GMimeMultipartEncrypted</a></span><span class="refpurpose"> — Encrypted MIME multiparts</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeMultipartSigned.html">GMimeMultipartSigned</a></span><span class="refpurpose"> — Signed MIME multiparts</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeMessagePart.html">GMimeMessagePart</a></span><span class="refpurpose"> — Message parts</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeMessagePartial.html">GMimeMessagePartial</a></span><span class="refpurpose"> — Partial MIME parts</span> +</dt> +<dt> +<span class="refentrytitle"><a href="gmime-GMimePartIter.html">GMimePartIter</a></span><span class="refpurpose"> — MIME part iterators</span> +</dt> +</dl></dd> +<dt><span class="chapter"><a href="Parsers.html">Parsing Messages and MIME Parts</a></span></dt> +<dd><dl><dt> +<span class="refentrytitle"><a href="GMimeParser.html">GMimeParser</a></span><span class="refpurpose"> — Message and MIME part parser</span> +</dt></dl></dd> +<dt><span class="chapter"><a href="CryptoContexts.html">Cryptography Contexts</a></span></dt> +<dd><dl> +<dt> +<span class="refentrytitle"><a href="GMimeCertificate.html">GMimeCertificate</a></span><span class="refpurpose"> — Digital certificates</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeSignature.html">GMimeSignature</a></span><span class="refpurpose"> — Digital signatures</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeCryptoContext.html">GMimeCryptoContext</a></span><span class="refpurpose"> — Encryption/signing contexts</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimeGpgContext.html">GMimeGpgContext</a></span><span class="refpurpose"> — GnuPG crypto contexts</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GMimePkcs7Context.html">GMimePkcs7Context</a></span><span class="refpurpose"> — PKCS7 crypto contexts</span> +</dt> +</dl></dd> +</dl></dd> +</dl></div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.18</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/index.sgml b/docs/reference/html/index.sgml new file mode 100644 index 0000000..1b70661 --- /dev/null +++ b/docs/reference/html/index.sgml @@ -0,0 +1,949 @@ +<ANCHOR id="gmime-building" href="gmime/gmime-building.html"> +<ANCHOR id="overview" href="gmime/gmime-building.html#overview"> +<ANCHOR id="dependencies" href="gmime/gmime-building.html#dependencies"> +<ANCHOR id="building" href="gmime/gmime-building.html#building"> +<ANCHOR id="extra-configuration-options" href="gmime/gmime-building.html#extra-configuration-options"> +<ANCHOR id="gmime-compiling" href="gmime/gmime-compiling.html"> +<ANCHOR id="gmime-changes-2-0" href="gmime/gmime-changes-2-0.html"> +<ANCHOR id="gmime-changes-2-2" href="gmime/gmime-changes-2-2.html"> +<ANCHOR id="gmime-changes-2-4" href="gmime/gmime-changes-2-4.html"> +<ANCHOR id="gmime-changes-2-6" href="gmime/gmime-changes-2-6.html"> +<ANCHOR id="gmime-resources" href="gmime/gmime-resources.html"> +<ANCHOR id="gmime-question-index" href="gmime/gmime-question-index.html"> +<ANCHOR id="gmime-streams" href="gmime/gmime-streams.html"> +<ANCHOR id="stream-overview" href="gmime/gmime-streams.html#stream-overview"> +<ANCHOR id="gmime-filters" href="gmime/gmime-filters.html"> +<ANCHOR id="filter-overview" href="gmime/gmime-filters.html#filter-overview"> +<ANCHOR id="gmime-data-wrappers" href="gmime/gmime-data-wrappers.html"> +<ANCHOR id="data-wrapper-overview" href="gmime/gmime-data-wrappers.html#data-wrapper-overview"> +<ANCHOR id="gmime-gmime" href="gmime/gmime-gmime.html"> +<ANCHOR id="gmime-gmime.synopsis" href="gmime/gmime-gmime.html#gmime-gmime.synopsis"> +<ANCHOR id="gmime-gmime.description" href="gmime/gmime-gmime.html#gmime-gmime.description"> +<ANCHOR id="gmime-gmime.details" href="gmime/gmime-gmime.html#gmime-gmime.details"> +<ANCHOR id="GMIME-MAJOR-VERSION:CAPS" href="gmime/gmime-gmime.html#GMIME-MAJOR-VERSION:CAPS"> +<ANCHOR id="GMIME-MICRO-VERSION:CAPS" href="gmime/gmime-gmime.html#GMIME-MICRO-VERSION:CAPS"> +<ANCHOR id="GMIME-MINOR-VERSION:CAPS" href="gmime/gmime-gmime.html#GMIME-MINOR-VERSION:CAPS"> +<ANCHOR id="GMIME-BINARY-AGE:CAPS" href="gmime/gmime-gmime.html#GMIME-BINARY-AGE:CAPS"> +<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="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"> +<ANCHOR id="gmime-minor-version" href="gmime/gmime-gmime.html#gmime-minor-version"> +<ANCHOR id="gmime-micro-version" href="gmime/gmime-gmime.html#gmime-micro-version"> +<ANCHOR id="gmime-binary-age" href="gmime/gmime-gmime.html#gmime-binary-age"> +<ANCHOR id="gmime-interface-age" href="gmime/gmime-gmime.html#gmime-interface-age"> +<ANCHOR id="g-mime-check-version" href="gmime/gmime-gmime.html#g-mime-check-version"> +<ANCHOR id="gmime-gmime-charset" href="gmime/gmime-gmime-charset.html"> +<ANCHOR id="gmime-gmime-charset.synopsis" href="gmime/gmime-gmime-charset.html#gmime-gmime-charset.synopsis"> +<ANCHOR id="gmime-gmime-charset.description" href="gmime/gmime-gmime-charset.html#gmime-gmime-charset.description"> +<ANCHOR id="gmime-gmime-charset.details" href="gmime/gmime-gmime-charset.html#gmime-gmime-charset.details"> +<ANCHOR id="GMimeCharset" href="gmime/gmime-gmime-charset.html#GMimeCharset"> +<ANCHOR id="g-mime-charset-map-init" href="gmime/gmime-gmime-charset.html#g-mime-charset-map-init"> +<ANCHOR id="g-mime-charset-map-shutdown" href="gmime/gmime-gmime-charset.html#g-mime-charset-map-shutdown"> +<ANCHOR id="g-mime-locale-charset" href="gmime/gmime-gmime-charset.html#g-mime-locale-charset"> +<ANCHOR id="g-mime-locale-language" href="gmime/gmime-gmime-charset.html#g-mime-locale-language"> +<ANCHOR id="g-mime-charset-language" href="gmime/gmime-gmime-charset.html#g-mime-charset-language"> +<ANCHOR id="g-mime-charset-canon-name" href="gmime/gmime-gmime-charset.html#g-mime-charset-canon-name"> +<ANCHOR id="g-mime-charset-iconv-name" href="gmime/gmime-gmime-charset.html#g-mime-charset-iconv-name"> +<ANCHOR id="g-mime-charset-name" href="gmime/gmime-gmime-charset.html#g-mime-charset-name"> +<ANCHOR id="g-mime-charset-locale-name" href="gmime/gmime-gmime-charset.html#g-mime-charset-locale-name"> +<ANCHOR id="g-mime-charset-iso-to-windows" href="gmime/gmime-gmime-charset.html#g-mime-charset-iso-to-windows"> +<ANCHOR id="g-mime-charset-init" href="gmime/gmime-gmime-charset.html#g-mime-charset-init"> +<ANCHOR id="g-mime-charset-step" href="gmime/gmime-gmime-charset.html#g-mime-charset-step"> +<ANCHOR id="g-mime-charset-best-name" href="gmime/gmime-gmime-charset.html#g-mime-charset-best-name"> +<ANCHOR id="g-mime-charset-best" href="gmime/gmime-gmime-charset.html#g-mime-charset-best"> +<ANCHOR id="g-mime-charset-can-encode" href="gmime/gmime-gmime-charset.html#g-mime-charset-can-encode"> +<ANCHOR id="g-mime-set-user-charsets" href="gmime/gmime-gmime-charset.html#g-mime-set-user-charsets"> +<ANCHOR id="g-mime-user-charsets" href="gmime/gmime-gmime-charset.html#g-mime-user-charsets"> +<ANCHOR id="gmime-gmime-iconv" href="gmime/gmime-gmime-iconv.html"> +<ANCHOR id="gmime-gmime-iconv.synopsis" href="gmime/gmime-gmime-iconv.html#gmime-gmime-iconv.synopsis"> +<ANCHOR id="gmime-gmime-iconv.description" href="gmime/gmime-gmime-iconv.html#gmime-gmime-iconv.description"> +<ANCHOR id="gmime-gmime-iconv.details" href="gmime/gmime-gmime-iconv.html#gmime-gmime-iconv.details"> +<ANCHOR id="g-mime-iconv-init" href="gmime/gmime-gmime-iconv.html#g-mime-iconv-init"> +<ANCHOR id="g-mime-iconv-shutdown" href="gmime/gmime-gmime-iconv.html#g-mime-iconv-shutdown"> +<ANCHOR id="g-mime-iconv-open" href="gmime/gmime-gmime-iconv.html#g-mime-iconv-open"> +<ANCHOR id="g-mime-iconv" href="gmime/gmime-gmime-iconv.html#g-mime-iconv"> +<ANCHOR id="g-mime-iconv-close" href="gmime/gmime-gmime-iconv.html#g-mime-iconv-close"> +<ANCHOR id="gmime-gmime-iconv-utils" href="gmime/gmime-gmime-iconv-utils.html"> +<ANCHOR id="gmime-gmime-iconv-utils.synopsis" href="gmime/gmime-gmime-iconv-utils.html#gmime-gmime-iconv-utils.synopsis"> +<ANCHOR id="gmime-gmime-iconv-utils.description" href="gmime/gmime-gmime-iconv-utils.html#gmime-gmime-iconv-utils.description"> +<ANCHOR id="gmime-gmime-iconv-utils.details" href="gmime/gmime-gmime-iconv-utils.html#gmime-gmime-iconv-utils.details"> +<ANCHOR id="g-mime-iconv-strdup" href="gmime/gmime-gmime-iconv-utils.html#g-mime-iconv-strdup"> +<ANCHOR id="g-mime-iconv-strndup" href="gmime/gmime-gmime-iconv-utils.html#g-mime-iconv-strndup"> +<ANCHOR id="g-mime-iconv-utf8-to-locale" href="gmime/gmime-gmime-iconv-utils.html#g-mime-iconv-utf8-to-locale"> +<ANCHOR id="g-mime-iconv-utf8-to-locale-length" href="gmime/gmime-gmime-iconv-utils.html#g-mime-iconv-utf8-to-locale-length"> +<ANCHOR id="g-mime-iconv-locale-to-utf8" href="gmime/gmime-gmime-iconv-utils.html#g-mime-iconv-locale-to-utf8"> +<ANCHOR id="g-mime-iconv-locale-to-utf8-length" href="gmime/gmime-gmime-iconv-utils.html#g-mime-iconv-locale-to-utf8-length"> +<ANCHOR id="gmime-gmime-encodings" href="gmime/gmime-gmime-encodings.html"> +<ANCHOR id="gmime-gmime-encodings.synopsis" href="gmime/gmime-gmime-encodings.html#gmime-gmime-encodings.synopsis"> +<ANCHOR id="gmime-gmime-encodings.description" href="gmime/gmime-gmime-encodings.html#gmime-gmime-encodings.description"> +<ANCHOR id="gmime-gmime-encodings.details" href="gmime/gmime-gmime-encodings.html#gmime-gmime-encodings.details"> +<ANCHOR id="GMimeContentEncoding" href="gmime/gmime-gmime-encodings.html#GMimeContentEncoding"> +<ANCHOR id="GMIME-CONTENT-ENCODING-DEFAULT:CAPS" href="gmime/gmime-gmime-encodings.html#GMIME-CONTENT-ENCODING-DEFAULT:CAPS"> +<ANCHOR id="GMIME-CONTENT-ENCODING-7BIT:CAPS" href="gmime/gmime-gmime-encodings.html#GMIME-CONTENT-ENCODING-7BIT:CAPS"> +<ANCHOR id="GMIME-CONTENT-ENCODING-8BIT:CAPS" href="gmime/gmime-gmime-encodings.html#GMIME-CONTENT-ENCODING-8BIT:CAPS"> +<ANCHOR id="GMIME-CONTENT-ENCODING-BINARY:CAPS" href="gmime/gmime-gmime-encodings.html#GMIME-CONTENT-ENCODING-BINARY:CAPS"> +<ANCHOR id="GMIME-CONTENT-ENCODING-BASE64:CAPS" href="gmime/gmime-gmime-encodings.html#GMIME-CONTENT-ENCODING-BASE64:CAPS"> +<ANCHOR id="GMIME-CONTENT-ENCODING-QUOTEDPRINTABLE:CAPS" href="gmime/gmime-gmime-encodings.html#GMIME-CONTENT-ENCODING-QUOTEDPRINTABLE:CAPS"> +<ANCHOR id="GMIME-CONTENT-ENCODING-UUENCODE:CAPS" href="gmime/gmime-gmime-encodings.html#GMIME-CONTENT-ENCODING-UUENCODE:CAPS"> +<ANCHOR id="g-mime-content-encoding-from-string" href="gmime/gmime-gmime-encodings.html#g-mime-content-encoding-from-string"> +<ANCHOR id="g-mime-content-encoding-to-string" href="gmime/gmime-gmime-encodings.html#g-mime-content-encoding-to-string"> +<ANCHOR id="GMimeEncodingConstraint" href="gmime/gmime-gmime-encodings.html#GMimeEncodingConstraint"> +<ANCHOR id="GMIME-ENCODING-CONSTRAINT-7BIT:CAPS" href="gmime/gmime-gmime-encodings.html#GMIME-ENCODING-CONSTRAINT-7BIT:CAPS"> +<ANCHOR id="GMIME-ENCODING-CONSTRAINT-8BIT:CAPS" href="gmime/gmime-gmime-encodings.html#GMIME-ENCODING-CONSTRAINT-8BIT:CAPS"> +<ANCHOR id="GMIME-ENCODING-CONSTRAINT-BINARY:CAPS" href="gmime/gmime-gmime-encodings.html#GMIME-ENCODING-CONSTRAINT-BINARY:CAPS"> +<ANCHOR id="GMimeEncoding" href="gmime/gmime-gmime-encodings.html#GMimeEncoding"> +<ANCHOR id="g-mime-encoding-init-encode" href="gmime/gmime-gmime-encodings.html#g-mime-encoding-init-encode"> +<ANCHOR id="g-mime-encoding-init-decode" href="gmime/gmime-gmime-encodings.html#g-mime-encoding-init-decode"> +<ANCHOR id="g-mime-encoding-reset" href="gmime/gmime-gmime-encodings.html#g-mime-encoding-reset"> +<ANCHOR id="g-mime-encoding-outlen" href="gmime/gmime-gmime-encodings.html#g-mime-encoding-outlen"> +<ANCHOR id="g-mime-encoding-step" href="gmime/gmime-gmime-encodings.html#g-mime-encoding-step"> +<ANCHOR id="g-mime-encoding-flush" href="gmime/gmime-gmime-encodings.html#g-mime-encoding-flush"> +<ANCHOR id="GMIME-BASE64-ENCODE-LEN:CAPS" href="gmime/gmime-gmime-encodings.html#GMIME-BASE64-ENCODE-LEN:CAPS"> +<ANCHOR id="g-mime-encoding-base64-decode-step" href="gmime/gmime-gmime-encodings.html#g-mime-encoding-base64-decode-step"> +<ANCHOR id="g-mime-encoding-base64-encode-step" href="gmime/gmime-gmime-encodings.html#g-mime-encoding-base64-encode-step"> +<ANCHOR id="g-mime-encoding-base64-encode-close" href="gmime/gmime-gmime-encodings.html#g-mime-encoding-base64-encode-close"> +<ANCHOR id="GMIME-UUDECODE-STATE-INIT:CAPS" href="gmime/gmime-gmime-encodings.html#GMIME-UUDECODE-STATE-INIT:CAPS"> +<ANCHOR id="GMIME-UUDECODE-STATE-BEGIN:CAPS" href="gmime/gmime-gmime-encodings.html#GMIME-UUDECODE-STATE-BEGIN:CAPS"> +<ANCHOR id="GMIME-UUDECODE-STATE-END:CAPS" href="gmime/gmime-gmime-encodings.html#GMIME-UUDECODE-STATE-END:CAPS"> +<ANCHOR id="GMIME-UUENCODE-LEN:CAPS" href="gmime/gmime-gmime-encodings.html#GMIME-UUENCODE-LEN:CAPS"> +<ANCHOR id="g-mime-encoding-uudecode-step" href="gmime/gmime-gmime-encodings.html#g-mime-encoding-uudecode-step"> +<ANCHOR id="g-mime-encoding-uuencode-step" href="gmime/gmime-gmime-encodings.html#g-mime-encoding-uuencode-step"> +<ANCHOR id="g-mime-encoding-uuencode-close" href="gmime/gmime-gmime-encodings.html#g-mime-encoding-uuencode-close"> +<ANCHOR id="GMIME-QP-ENCODE-LEN:CAPS" href="gmime/gmime-gmime-encodings.html#GMIME-QP-ENCODE-LEN:CAPS"> +<ANCHOR id="g-mime-encoding-quoted-decode-step" href="gmime/gmime-gmime-encodings.html#g-mime-encoding-quoted-decode-step"> +<ANCHOR id="g-mime-encoding-quoted-encode-step" href="gmime/gmime-gmime-encodings.html#g-mime-encoding-quoted-encode-step"> +<ANCHOR id="g-mime-encoding-quoted-encode-close" href="gmime/gmime-gmime-encodings.html#g-mime-encoding-quoted-encode-close"> +<ANCHOR id="gmime-gmime-utils" href="gmime/gmime-gmime-utils.html"> +<ANCHOR id="gmime-gmime-utils.synopsis" href="gmime/gmime-gmime-utils.html#gmime-gmime-utils.synopsis"> +<ANCHOR id="gmime-gmime-utils.description" href="gmime/gmime-gmime-utils.html#gmime-gmime-utils.description"> +<ANCHOR id="gmime-gmime-utils.details" href="gmime/gmime-gmime-utils.html#gmime-gmime-utils.details"> +<ANCHOR id="GMimeReferences" href="gmime/gmime-gmime-utils.html#GMimeReferences"> +<ANCHOR id="g-mime-utils-header-decode-date" href="gmime/gmime-gmime-utils.html#g-mime-utils-header-decode-date"> +<ANCHOR id="g-mime-utils-header-format-date" href="gmime/gmime-gmime-utils.html#g-mime-utils-header-format-date"> +<ANCHOR id="g-mime-utils-generate-message-id" href="gmime/gmime-gmime-utils.html#g-mime-utils-generate-message-id"> +<ANCHOR id="g-mime-utils-decode-message-id" href="gmime/gmime-gmime-utils.html#g-mime-utils-decode-message-id"> +<ANCHOR id="g-mime-references-get-message-id" href="gmime/gmime-gmime-utils.html#g-mime-references-get-message-id"> +<ANCHOR id="g-mime-references-get-next" href="gmime/gmime-gmime-utils.html#g-mime-references-get-next"> +<ANCHOR id="g-mime-references-decode" href="gmime/gmime-gmime-utils.html#g-mime-references-decode"> +<ANCHOR id="g-mime-references-append" href="gmime/gmime-gmime-utils.html#g-mime-references-append"> +<ANCHOR id="g-mime-references-clear" href="gmime/gmime-gmime-utils.html#g-mime-references-clear"> +<ANCHOR id="g-mime-references-free" href="gmime/gmime-gmime-utils.html#g-mime-references-free"> +<ANCHOR id="g-mime-utils-header-fold" href="gmime/gmime-gmime-utils.html#g-mime-utils-header-fold"> +<ANCHOR id="g-mime-utils-header-printf" href="gmime/gmime-gmime-utils.html#g-mime-utils-header-printf"> +<ANCHOR id="g-mime-utils-quote-string" href="gmime/gmime-gmime-utils.html#g-mime-utils-quote-string"> +<ANCHOR id="g-mime-utils-unquote-string" href="gmime/gmime-gmime-utils.html#g-mime-utils-unquote-string"> +<ANCHOR id="g-mime-utils-text-is-8bit" href="gmime/gmime-gmime-utils.html#g-mime-utils-text-is-8bit"> +<ANCHOR id="g-mime-utils-best-encoding" href="gmime/gmime-gmime-utils.html#g-mime-utils-best-encoding"> +<ANCHOR id="g-mime-utils-decode-8bit" href="gmime/gmime-gmime-utils.html#g-mime-utils-decode-8bit"> +<ANCHOR id="g-mime-utils-header-decode-text" href="gmime/gmime-gmime-utils.html#g-mime-utils-header-decode-text"> +<ANCHOR id="g-mime-utils-header-encode-text" href="gmime/gmime-gmime-utils.html#g-mime-utils-header-encode-text"> +<ANCHOR id="g-mime-utils-header-decode-phrase" href="gmime/gmime-gmime-utils.html#g-mime-utils-header-decode-phrase"> +<ANCHOR id="g-mime-utils-header-encode-phrase" href="gmime/gmime-gmime-utils.html#g-mime-utils-header-encode-phrase"> +<ANCHOR id="g-mime-utils-structured-header-fold" href="gmime/gmime-gmime-utils.html#g-mime-utils-structured-header-fold"> +<ANCHOR id="g-mime-utils-unstructured-header-fold" href="gmime/gmime-gmime-utils.html#g-mime-utils-unstructured-header-fold"> +<ANCHOR id="GMimeStream" href="gmime/GMimeStream.html"> +<ANCHOR id="GMimeStream.synopsis" href="gmime/GMimeStream.html#GMimeStream.synopsis"> +<ANCHOR id="GMimeStream.object-hierarchy" href="gmime/GMimeStream.html#GMimeStream.object-hierarchy"> +<ANCHOR id="GMimeStream.description" href="gmime/GMimeStream.html#GMimeStream.description"> +<ANCHOR id="GMimeStream.details" href="gmime/GMimeStream.html#GMimeStream.details"> +<ANCHOR id="GMimeSeekWhence" href="gmime/GMimeStream.html#GMimeSeekWhence"> +<ANCHOR id="GMIME-STREAM-SEEK-SET:CAPS" href="gmime/GMimeStream.html#GMIME-STREAM-SEEK-SET:CAPS"> +<ANCHOR id="GMIME-STREAM-SEEK-CUR:CAPS" href="gmime/GMimeStream.html#GMIME-STREAM-SEEK-CUR:CAPS"> +<ANCHOR id="GMIME-STREAM-SEEK-END:CAPS" href="gmime/GMimeStream.html#GMIME-STREAM-SEEK-END:CAPS"> +<ANCHOR id="GMimeStreamIOVector" href="gmime/GMimeStream.html#GMimeStreamIOVector"> +<ANCHOR id="GMimeStream-struct" href="gmime/GMimeStream.html#GMimeStream-struct"> +<ANCHOR id="g-mime-stream-construct" href="gmime/GMimeStream.html#g-mime-stream-construct"> +<ANCHOR id="g-mime-stream-read" href="gmime/GMimeStream.html#g-mime-stream-read"> +<ANCHOR id="g-mime-stream-write" href="gmime/GMimeStream.html#g-mime-stream-write"> +<ANCHOR id="g-mime-stream-flush" href="gmime/GMimeStream.html#g-mime-stream-flush"> +<ANCHOR id="g-mime-stream-seek" href="gmime/GMimeStream.html#g-mime-stream-seek"> +<ANCHOR id="g-mime-stream-tell" href="gmime/GMimeStream.html#g-mime-stream-tell"> +<ANCHOR id="g-mime-stream-reset" href="gmime/GMimeStream.html#g-mime-stream-reset"> +<ANCHOR id="g-mime-stream-eos" href="gmime/GMimeStream.html#g-mime-stream-eos"> +<ANCHOR id="g-mime-stream-close" href="gmime/GMimeStream.html#g-mime-stream-close"> +<ANCHOR id="g-mime-stream-length" href="gmime/GMimeStream.html#g-mime-stream-length"> +<ANCHOR id="g-mime-stream-substream" href="gmime/GMimeStream.html#g-mime-stream-substream"> +<ANCHOR id="g-mime-stream-set-bounds" href="gmime/GMimeStream.html#g-mime-stream-set-bounds"> +<ANCHOR id="g-mime-stream-write-string" href="gmime/GMimeStream.html#g-mime-stream-write-string"> +<ANCHOR id="g-mime-stream-printf" href="gmime/GMimeStream.html#g-mime-stream-printf"> +<ANCHOR id="g-mime-stream-write-to-stream" href="gmime/GMimeStream.html#g-mime-stream-write-to-stream"> +<ANCHOR id="g-mime-stream-writev" href="gmime/GMimeStream.html#g-mime-stream-writev"> +<ANCHOR id="GMimeStreamFile" href="gmime/GMimeStreamFile.html"> +<ANCHOR id="GMimeStreamFile.synopsis" href="gmime/GMimeStreamFile.html#GMimeStreamFile.synopsis"> +<ANCHOR id="GMimeStreamFile.object-hierarchy" href="gmime/GMimeStreamFile.html#GMimeStreamFile.object-hierarchy"> +<ANCHOR id="GMimeStreamFile.description" href="gmime/GMimeStreamFile.html#GMimeStreamFile.description"> +<ANCHOR id="GMimeStreamFile.details" href="gmime/GMimeStreamFile.html#GMimeStreamFile.details"> +<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-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"> +<ANCHOR id="GMimeStreamFs" href="gmime/GMimeStreamFs.html"> +<ANCHOR id="GMimeStreamFs.synopsis" href="gmime/GMimeStreamFs.html#GMimeStreamFs.synopsis"> +<ANCHOR id="GMimeStreamFs.object-hierarchy" href="gmime/GMimeStreamFs.html#GMimeStreamFs.object-hierarchy"> +<ANCHOR id="GMimeStreamFs.description" href="gmime/GMimeStreamFs.html#GMimeStreamFs.description"> +<ANCHOR id="GMimeStreamFs.details" href="gmime/GMimeStreamFs.html#GMimeStreamFs.details"> +<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-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"> +<ANCHOR id="GMimeStreamMem" href="gmime/GMimeStreamMem.html"> +<ANCHOR id="GMimeStreamMem.synopsis" href="gmime/GMimeStreamMem.html#GMimeStreamMem.synopsis"> +<ANCHOR id="GMimeStreamMem.object-hierarchy" href="gmime/GMimeStreamMem.html#GMimeStreamMem.object-hierarchy"> +<ANCHOR id="GMimeStreamMem.description" href="gmime/GMimeStreamMem.html#GMimeStreamMem.description"> +<ANCHOR id="GMimeStreamMem.details" href="gmime/GMimeStreamMem.html#GMimeStreamMem.details"> +<ANCHOR id="GMimeStreamMem-struct" href="gmime/GMimeStreamMem.html#GMimeStreamMem-struct"> +<ANCHOR id="g-mime-stream-mem-new" href="gmime/GMimeStreamMem.html#g-mime-stream-mem-new"> +<ANCHOR id="g-mime-stream-mem-new-with-byte-array" href="gmime/GMimeStreamMem.html#g-mime-stream-mem-new-with-byte-array"> +<ANCHOR id="g-mime-stream-mem-new-with-buffer" href="gmime/GMimeStreamMem.html#g-mime-stream-mem-new-with-buffer"> +<ANCHOR id="g-mime-stream-mem-get-byte-array" href="gmime/GMimeStreamMem.html#g-mime-stream-mem-get-byte-array"> +<ANCHOR id="g-mime-stream-mem-set-byte-array" href="gmime/GMimeStreamMem.html#g-mime-stream-mem-set-byte-array"> +<ANCHOR id="g-mime-stream-mem-get-owner" href="gmime/GMimeStreamMem.html#g-mime-stream-mem-get-owner"> +<ANCHOR id="g-mime-stream-mem-set-owner" href="gmime/GMimeStreamMem.html#g-mime-stream-mem-set-owner"> +<ANCHOR id="GMimeStreamMem.see-also" href="gmime/GMimeStreamMem.html#GMimeStreamMem.see-also"> +<ANCHOR id="GMimeStreamMmap" href="gmime/GMimeStreamMmap.html"> +<ANCHOR id="GMimeStreamMmap.synopsis" href="gmime/GMimeStreamMmap.html#GMimeStreamMmap.synopsis"> +<ANCHOR id="GMimeStreamMmap.object-hierarchy" href="gmime/GMimeStreamMmap.html#GMimeStreamMmap.object-hierarchy"> +<ANCHOR id="GMimeStreamMmap.description" href="gmime/GMimeStreamMmap.html#GMimeStreamMmap.description"> +<ANCHOR id="GMimeStreamMmap.details" href="gmime/GMimeStreamMmap.html#GMimeStreamMmap.details"> +<ANCHOR id="GMimeStreamMmap-struct" href="gmime/GMimeStreamMmap.html#GMimeStreamMmap-struct"> +<ANCHOR id="g-mime-stream-mmap-new" href="gmime/GMimeStreamMmap.html#g-mime-stream-mmap-new"> +<ANCHOR id="g-mime-stream-mmap-new-with-bounds" href="gmime/GMimeStreamMmap.html#g-mime-stream-mmap-new-with-bounds"> +<ANCHOR id="GMimeStreamMmap.see-also" href="gmime/GMimeStreamMmap.html#GMimeStreamMmap.see-also"> +<ANCHOR id="GMimeStreamNull" href="gmime/GMimeStreamNull.html"> +<ANCHOR id="GMimeStreamNull.synopsis" href="gmime/GMimeStreamNull.html#GMimeStreamNull.synopsis"> +<ANCHOR id="GMimeStreamNull.object-hierarchy" href="gmime/GMimeStreamNull.html#GMimeStreamNull.object-hierarchy"> +<ANCHOR id="GMimeStreamNull.description" href="gmime/GMimeStreamNull.html#GMimeStreamNull.description"> +<ANCHOR id="GMimeStreamNull.details" href="gmime/GMimeStreamNull.html#GMimeStreamNull.details"> +<ANCHOR id="GMimeStreamNull-struct" href="gmime/GMimeStreamNull.html#GMimeStreamNull-struct"> +<ANCHOR id="g-mime-stream-null-new" href="gmime/GMimeStreamNull.html#g-mime-stream-null-new"> +<ANCHOR id="GMimeStreamNull.see-also" href="gmime/GMimeStreamNull.html#GMimeStreamNull.see-also"> +<ANCHOR id="GMimeStreamFilter" href="gmime/GMimeStreamFilter.html"> +<ANCHOR id="GMimeStreamFilter.synopsis" href="gmime/GMimeStreamFilter.html#GMimeStreamFilter.synopsis"> +<ANCHOR id="GMimeStreamFilter.object-hierarchy" href="gmime/GMimeStreamFilter.html#GMimeStreamFilter.object-hierarchy"> +<ANCHOR id="GMimeStreamFilter.description" href="gmime/GMimeStreamFilter.html#GMimeStreamFilter.description"> +<ANCHOR id="GMimeStreamFilter.details" href="gmime/GMimeStreamFilter.html#GMimeStreamFilter.details"> +<ANCHOR id="GMimeStreamFilter-struct" href="gmime/GMimeStreamFilter.html#GMimeStreamFilter-struct"> +<ANCHOR id="g-mime-stream-filter-new" href="gmime/GMimeStreamFilter.html#g-mime-stream-filter-new"> +<ANCHOR id="g-mime-stream-filter-add" href="gmime/GMimeStreamFilter.html#g-mime-stream-filter-add"> +<ANCHOR id="g-mime-stream-filter-remove" href="gmime/GMimeStreamFilter.html#g-mime-stream-filter-remove"> +<ANCHOR id="GMimeStreamFilter.see-also" href="gmime/GMimeStreamFilter.html#GMimeStreamFilter.see-also"> +<ANCHOR id="GMimeStreamBuffer" href="gmime/GMimeStreamBuffer.html"> +<ANCHOR id="GMimeStreamBuffer.synopsis" href="gmime/GMimeStreamBuffer.html#GMimeStreamBuffer.synopsis"> +<ANCHOR id="GMimeStreamBuffer.object-hierarchy" href="gmime/GMimeStreamBuffer.html#GMimeStreamBuffer.object-hierarchy"> +<ANCHOR id="GMimeStreamBuffer.description" href="gmime/GMimeStreamBuffer.html#GMimeStreamBuffer.description"> +<ANCHOR id="GMimeStreamBuffer.details" href="gmime/GMimeStreamBuffer.html#GMimeStreamBuffer.details"> +<ANCHOR id="GMimeStreamBufferMode" href="gmime/GMimeStreamBuffer.html#GMimeStreamBufferMode"> +<ANCHOR id="GMIME-STREAM-BUFFER-CACHE-READ:CAPS" href="gmime/GMimeStreamBuffer.html#GMIME-STREAM-BUFFER-CACHE-READ:CAPS"> +<ANCHOR id="GMIME-STREAM-BUFFER-BLOCK-READ:CAPS" href="gmime/GMimeStreamBuffer.html#GMIME-STREAM-BUFFER-BLOCK-READ:CAPS"> +<ANCHOR id="GMIME-STREAM-BUFFER-BLOCK-WRITE:CAPS" href="gmime/GMimeStreamBuffer.html#GMIME-STREAM-BUFFER-BLOCK-WRITE:CAPS"> +<ANCHOR id="GMimeStreamBuffer-struct" href="gmime/GMimeStreamBuffer.html#GMimeStreamBuffer-struct"> +<ANCHOR id="g-mime-stream-buffer-new" href="gmime/GMimeStreamBuffer.html#g-mime-stream-buffer-new"> +<ANCHOR id="g-mime-stream-buffer-gets" href="gmime/GMimeStreamBuffer.html#g-mime-stream-buffer-gets"> +<ANCHOR id="g-mime-stream-buffer-readln" href="gmime/GMimeStreamBuffer.html#g-mime-stream-buffer-readln"> +<ANCHOR id="GMimeStreamBuffer.see-also" href="gmime/GMimeStreamBuffer.html#GMimeStreamBuffer.see-also"> +<ANCHOR id="GMimeStreamPipe" href="gmime/GMimeStreamPipe.html"> +<ANCHOR id="GMimeStreamPipe.synopsis" href="gmime/GMimeStreamPipe.html#GMimeStreamPipe.synopsis"> +<ANCHOR id="GMimeStreamPipe.object-hierarchy" href="gmime/GMimeStreamPipe.html#GMimeStreamPipe.object-hierarchy"> +<ANCHOR id="GMimeStreamPipe.description" href="gmime/GMimeStreamPipe.html#GMimeStreamPipe.description"> +<ANCHOR id="GMimeStreamPipe.details" href="gmime/GMimeStreamPipe.html#GMimeStreamPipe.details"> +<ANCHOR id="GMimeStreamPipe-struct" href="gmime/GMimeStreamPipe.html#GMimeStreamPipe-struct"> +<ANCHOR id="g-mime-stream-pipe-new" href="gmime/GMimeStreamPipe.html#g-mime-stream-pipe-new"> +<ANCHOR id="g-mime-stream-pipe-get-owner" href="gmime/GMimeStreamPipe.html#g-mime-stream-pipe-get-owner"> +<ANCHOR id="g-mime-stream-pipe-set-owner" href="gmime/GMimeStreamPipe.html#g-mime-stream-pipe-set-owner"> +<ANCHOR id="GMimeStreamPipe.see-also" href="gmime/GMimeStreamPipe.html#GMimeStreamPipe.see-also"> +<ANCHOR id="GMimeStreamCat" href="gmime/GMimeStreamCat.html"> +<ANCHOR id="GMimeStreamCat.synopsis" href="gmime/GMimeStreamCat.html#GMimeStreamCat.synopsis"> +<ANCHOR id="GMimeStreamCat.object-hierarchy" href="gmime/GMimeStreamCat.html#GMimeStreamCat.object-hierarchy"> +<ANCHOR id="GMimeStreamCat.description" href="gmime/GMimeStreamCat.html#GMimeStreamCat.description"> +<ANCHOR id="GMimeStreamCat.details" href="gmime/GMimeStreamCat.html#GMimeStreamCat.details"> +<ANCHOR id="GMimeStreamCat-struct" href="gmime/GMimeStreamCat.html#GMimeStreamCat-struct"> +<ANCHOR id="g-mime-stream-cat-new" href="gmime/GMimeStreamCat.html#g-mime-stream-cat-new"> +<ANCHOR id="g-mime-stream-cat-add-source" href="gmime/GMimeStreamCat.html#g-mime-stream-cat-add-source"> +<ANCHOR id="GMimeStreamCat.see-also" href="gmime/GMimeStreamCat.html#GMimeStreamCat.see-also"> +<ANCHOR id="GMimeFilter" href="gmime/GMimeFilter.html"> +<ANCHOR id="GMimeFilter.synopsis" href="gmime/GMimeFilter.html#GMimeFilter.synopsis"> +<ANCHOR id="GMimeFilter.object-hierarchy" href="gmime/GMimeFilter.html#GMimeFilter.object-hierarchy"> +<ANCHOR id="GMimeFilter.description" href="gmime/GMimeFilter.html#GMimeFilter.description"> +<ANCHOR id="GMimeFilter.details" href="gmime/GMimeFilter.html#GMimeFilter.details"> +<ANCHOR id="GMimeFilter-struct" href="gmime/GMimeFilter.html#GMimeFilter-struct"> +<ANCHOR id="g-mime-filter-copy" href="gmime/GMimeFilter.html#g-mime-filter-copy"> +<ANCHOR id="g-mime-filter-filter" href="gmime/GMimeFilter.html#g-mime-filter-filter"> +<ANCHOR id="g-mime-filter-complete" href="gmime/GMimeFilter.html#g-mime-filter-complete"> +<ANCHOR id="g-mime-filter-reset" href="gmime/GMimeFilter.html#g-mime-filter-reset"> +<ANCHOR id="g-mime-filter-backup" href="gmime/GMimeFilter.html#g-mime-filter-backup"> +<ANCHOR id="g-mime-filter-set-size" href="gmime/GMimeFilter.html#g-mime-filter-set-size"> +<ANCHOR id="GMimeFilter.see-also" href="gmime/GMimeFilter.html#GMimeFilter.see-also"> +<ANCHOR id="GMimeFilterBasic" href="gmime/GMimeFilterBasic.html"> +<ANCHOR id="GMimeFilterBasic.synopsis" href="gmime/GMimeFilterBasic.html#GMimeFilterBasic.synopsis"> +<ANCHOR id="GMimeFilterBasic.object-hierarchy" href="gmime/GMimeFilterBasic.html#GMimeFilterBasic.object-hierarchy"> +<ANCHOR id="GMimeFilterBasic.description" href="gmime/GMimeFilterBasic.html#GMimeFilterBasic.description"> +<ANCHOR id="GMimeFilterBasic.details" href="gmime/GMimeFilterBasic.html#GMimeFilterBasic.details"> +<ANCHOR id="GMimeFilterBasic-struct" href="gmime/GMimeFilterBasic.html#GMimeFilterBasic-struct"> +<ANCHOR id="g-mime-filter-basic-new" href="gmime/GMimeFilterBasic.html#g-mime-filter-basic-new"> +<ANCHOR id="GMimeFilterBasic.see-also" href="gmime/GMimeFilterBasic.html#GMimeFilterBasic.see-also"> +<ANCHOR id="GMimeFilterBest" href="gmime/GMimeFilterBest.html"> +<ANCHOR id="GMimeFilterBest.synopsis" href="gmime/GMimeFilterBest.html#GMimeFilterBest.synopsis"> +<ANCHOR id="GMimeFilterBest.object-hierarchy" href="gmime/GMimeFilterBest.html#GMimeFilterBest.object-hierarchy"> +<ANCHOR id="GMimeFilterBest.description" href="gmime/GMimeFilterBest.html#GMimeFilterBest.description"> +<ANCHOR id="GMimeFilterBest.details" href="gmime/GMimeFilterBest.html#GMimeFilterBest.details"> +<ANCHOR id="GMimeFilterBest-struct" href="gmime/GMimeFilterBest.html#GMimeFilterBest-struct"> +<ANCHOR id="GMimeFilterBestFlags" href="gmime/GMimeFilterBest.html#GMimeFilterBestFlags"> +<ANCHOR id="GMIME-FILTER-BEST-CHARSET:CAPS" href="gmime/GMimeFilterBest.html#GMIME-FILTER-BEST-CHARSET:CAPS"> +<ANCHOR id="GMIME-FILTER-BEST-ENCODING:CAPS" href="gmime/GMimeFilterBest.html#GMIME-FILTER-BEST-ENCODING:CAPS"> +<ANCHOR id="g-mime-filter-best-new" href="gmime/GMimeFilterBest.html#g-mime-filter-best-new"> +<ANCHOR id="g-mime-filter-best-charset" href="gmime/GMimeFilterBest.html#g-mime-filter-best-charset"> +<ANCHOR id="g-mime-filter-best-encoding" href="gmime/GMimeFilterBest.html#g-mime-filter-best-encoding"> +<ANCHOR id="GMimeFilterBest.see-also" href="gmime/GMimeFilterBest.html#GMimeFilterBest.see-also"> +<ANCHOR id="GMimeFilterCharset" href="gmime/GMimeFilterCharset.html"> +<ANCHOR id="GMimeFilterCharset.synopsis" href="gmime/GMimeFilterCharset.html#GMimeFilterCharset.synopsis"> +<ANCHOR id="GMimeFilterCharset.object-hierarchy" href="gmime/GMimeFilterCharset.html#GMimeFilterCharset.object-hierarchy"> +<ANCHOR id="GMimeFilterCharset.description" href="gmime/GMimeFilterCharset.html#GMimeFilterCharset.description"> +<ANCHOR id="GMimeFilterCharset.details" href="gmime/GMimeFilterCharset.html#GMimeFilterCharset.details"> +<ANCHOR id="GMimeFilterCharset-struct" href="gmime/GMimeFilterCharset.html#GMimeFilterCharset-struct"> +<ANCHOR id="g-mime-filter-charset-new" href="gmime/GMimeFilterCharset.html#g-mime-filter-charset-new"> +<ANCHOR id="GMimeFilterCRLF" href="gmime/GMimeFilterCRLF.html"> +<ANCHOR id="GMimeFilterCRLF.synopsis" href="gmime/GMimeFilterCRLF.html#GMimeFilterCRLF.synopsis"> +<ANCHOR id="GMimeFilterCRLF.object-hierarchy" href="gmime/GMimeFilterCRLF.html#GMimeFilterCRLF.object-hierarchy"> +<ANCHOR id="GMimeFilterCRLF.description" href="gmime/GMimeFilterCRLF.html#GMimeFilterCRLF.description"> +<ANCHOR id="GMimeFilterCRLF.details" href="gmime/GMimeFilterCRLF.html#GMimeFilterCRLF.details"> +<ANCHOR id="GMimeFilterCRLF-struct" href="gmime/GMimeFilterCRLF.html#GMimeFilterCRLF-struct"> +<ANCHOR id="g-mime-filter-crlf-new" href="gmime/GMimeFilterCRLF.html#g-mime-filter-crlf-new"> +<ANCHOR id="GMimeFilterEnriched" href="gmime/GMimeFilterEnriched.html"> +<ANCHOR id="GMimeFilterEnriched.synopsis" href="gmime/GMimeFilterEnriched.html#GMimeFilterEnriched.synopsis"> +<ANCHOR id="GMimeFilterEnriched.object-hierarchy" href="gmime/GMimeFilterEnriched.html#GMimeFilterEnriched.object-hierarchy"> +<ANCHOR id="GMimeFilterEnriched.description" href="gmime/GMimeFilterEnriched.html#GMimeFilterEnriched.description"> +<ANCHOR id="GMimeFilterEnriched.details" href="gmime/GMimeFilterEnriched.html#GMimeFilterEnriched.details"> +<ANCHOR id="GMIME-FILTER-ENRICHED-IS-RICHTEXT:CAPS" href="gmime/GMimeFilterEnriched.html#GMIME-FILTER-ENRICHED-IS-RICHTEXT:CAPS"> +<ANCHOR id="GMimeFilterEnriched-struct" href="gmime/GMimeFilterEnriched.html#GMimeFilterEnriched-struct"> +<ANCHOR id="g-mime-filter-enriched-new" href="gmime/GMimeFilterEnriched.html#g-mime-filter-enriched-new"> +<ANCHOR id="GMimeFilterEnriched.see-also" href="gmime/GMimeFilterEnriched.html#GMimeFilterEnriched.see-also"> +<ANCHOR id="GMimeFilterFrom" href="gmime/GMimeFilterFrom.html"> +<ANCHOR id="GMimeFilterFrom.synopsis" href="gmime/GMimeFilterFrom.html#GMimeFilterFrom.synopsis"> +<ANCHOR id="GMimeFilterFrom.object-hierarchy" href="gmime/GMimeFilterFrom.html#GMimeFilterFrom.object-hierarchy"> +<ANCHOR id="GMimeFilterFrom.description" href="gmime/GMimeFilterFrom.html#GMimeFilterFrom.description"> +<ANCHOR id="GMimeFilterFrom.details" href="gmime/GMimeFilterFrom.html#GMimeFilterFrom.details"> +<ANCHOR id="GMimeFilterFrom-struct" href="gmime/GMimeFilterFrom.html#GMimeFilterFrom-struct"> +<ANCHOR id="GMimeFilterFromMode" href="gmime/GMimeFilterFrom.html#GMimeFilterFromMode"> +<ANCHOR id="GMIME-FILTER-FROM-MODE-DEFAULT:CAPS" href="gmime/GMimeFilterFrom.html#GMIME-FILTER-FROM-MODE-DEFAULT:CAPS"> +<ANCHOR id="GMIME-FILTER-FROM-MODE-ESCAPE:CAPS" href="gmime/GMimeFilterFrom.html#GMIME-FILTER-FROM-MODE-ESCAPE:CAPS"> +<ANCHOR id="GMIME-FILTER-FROM-MODE-ARMOR:CAPS" href="gmime/GMimeFilterFrom.html#GMIME-FILTER-FROM-MODE-ARMOR:CAPS"> +<ANCHOR id="g-mime-filter-from-new" href="gmime/GMimeFilterFrom.html#g-mime-filter-from-new"> +<ANCHOR id="GMimeFilterFrom.see-also" href="gmime/GMimeFilterFrom.html#GMimeFilterFrom.see-also"> +<ANCHOR id="GMimeFilterGZip" href="gmime/GMimeFilterGZip.html"> +<ANCHOR id="GMimeFilterGZip.synopsis" href="gmime/GMimeFilterGZip.html#GMimeFilterGZip.synopsis"> +<ANCHOR id="GMimeFilterGZip.object-hierarchy" href="gmime/GMimeFilterGZip.html#GMimeFilterGZip.object-hierarchy"> +<ANCHOR id="GMimeFilterGZip.description" href="gmime/GMimeFilterGZip.html#GMimeFilterGZip.description"> +<ANCHOR id="GMimeFilterGZip.details" href="gmime/GMimeFilterGZip.html#GMimeFilterGZip.details"> +<ANCHOR id="GMimeFilterGZip-struct" href="gmime/GMimeFilterGZip.html#GMimeFilterGZip-struct"> +<ANCHOR id="GMimeFilterGZipMode" href="gmime/GMimeFilterGZip.html#GMimeFilterGZipMode"> +<ANCHOR id="GMIME-FILTER-GZIP-MODE-ZIP:CAPS" href="gmime/GMimeFilterGZip.html#GMIME-FILTER-GZIP-MODE-ZIP:CAPS"> +<ANCHOR id="GMIME-FILTER-GZIP-MODE-UNZIP:CAPS" href="gmime/GMimeFilterGZip.html#GMIME-FILTER-GZIP-MODE-UNZIP:CAPS"> +<ANCHOR id="g-mime-filter-gzip-new" href="gmime/GMimeFilterGZip.html#g-mime-filter-gzip-new"> +<ANCHOR id="GMimeFilterGZip.see-also" href="gmime/GMimeFilterGZip.html#GMimeFilterGZip.see-also"> +<ANCHOR id="GMimeFilterHTML" href="gmime/GMimeFilterHTML.html"> +<ANCHOR id="GMimeFilterHTML.synopsis" href="gmime/GMimeFilterHTML.html#GMimeFilterHTML.synopsis"> +<ANCHOR id="GMimeFilterHTML.object-hierarchy" href="gmime/GMimeFilterHTML.html#GMimeFilterHTML.object-hierarchy"> +<ANCHOR id="GMimeFilterHTML.description" href="gmime/GMimeFilterHTML.html#GMimeFilterHTML.description"> +<ANCHOR id="GMimeFilterHTML.details" href="gmime/GMimeFilterHTML.html#GMimeFilterHTML.details"> +<ANCHOR id="GMimeFilterHTML-struct" href="gmime/GMimeFilterHTML.html#GMimeFilterHTML-struct"> +<ANCHOR id="GMIME-FILTER-HTML-PRE:CAPS" href="gmime/GMimeFilterHTML.html#GMIME-FILTER-HTML-PRE:CAPS"> +<ANCHOR id="GMIME-FILTER-HTML-CONVERT-NL:CAPS" href="gmime/GMimeFilterHTML.html#GMIME-FILTER-HTML-CONVERT-NL:CAPS"> +<ANCHOR id="GMIME-FILTER-HTML-CONVERT-SPACES:CAPS" href="gmime/GMimeFilterHTML.html#GMIME-FILTER-HTML-CONVERT-SPACES:CAPS"> +<ANCHOR id="GMIME-FILTER-HTML-CONVERT-URLS:CAPS" href="gmime/GMimeFilterHTML.html#GMIME-FILTER-HTML-CONVERT-URLS:CAPS"> +<ANCHOR id="GMIME-FILTER-HTML-MARK-CITATION:CAPS" href="gmime/GMimeFilterHTML.html#GMIME-FILTER-HTML-MARK-CITATION:CAPS"> +<ANCHOR id="GMIME-FILTER-HTML-CONVERT-ADDRESSES:CAPS" href="gmime/GMimeFilterHTML.html#GMIME-FILTER-HTML-CONVERT-ADDRESSES:CAPS"> +<ANCHOR id="GMIME-FILTER-HTML-ESCAPE-8BIT:CAPS" href="gmime/GMimeFilterHTML.html#GMIME-FILTER-HTML-ESCAPE-8BIT:CAPS"> +<ANCHOR id="GMIME-FILTER-HTML-CITE:CAPS" href="gmime/GMimeFilterHTML.html#GMIME-FILTER-HTML-CITE:CAPS"> +<ANCHOR id="g-mime-filter-html-new" href="gmime/GMimeFilterHTML.html#g-mime-filter-html-new"> +<ANCHOR id="GMimeFilterHTML.see-also" href="gmime/GMimeFilterHTML.html#GMimeFilterHTML.see-also"> +<ANCHOR id="GMimeFilterMd5" href="gmime/GMimeFilterMd5.html"> +<ANCHOR id="GMimeFilterMd5.synopsis" href="gmime/GMimeFilterMd5.html#GMimeFilterMd5.synopsis"> +<ANCHOR id="GMimeFilterMd5.object-hierarchy" href="gmime/GMimeFilterMd5.html#GMimeFilterMd5.object-hierarchy"> +<ANCHOR id="GMimeFilterMd5.description" href="gmime/GMimeFilterMd5.html#GMimeFilterMd5.description"> +<ANCHOR id="GMimeFilterMd5.details" href="gmime/GMimeFilterMd5.html#GMimeFilterMd5.details"> +<ANCHOR id="GMimeFilterMd5-struct" href="gmime/GMimeFilterMd5.html#GMimeFilterMd5-struct"> +<ANCHOR id="g-mime-filter-md5-new" href="gmime/GMimeFilterMd5.html#g-mime-filter-md5-new"> +<ANCHOR id="g-mime-filter-md5-get-digest" href="gmime/GMimeFilterMd5.html#g-mime-filter-md5-get-digest"> +<ANCHOR id="GMimeFilterMd5.see-also" href="gmime/GMimeFilterMd5.html#GMimeFilterMd5.see-also"> +<ANCHOR id="GMimeFilterStrip" href="gmime/GMimeFilterStrip.html"> +<ANCHOR id="GMimeFilterStrip.synopsis" href="gmime/GMimeFilterStrip.html#GMimeFilterStrip.synopsis"> +<ANCHOR id="GMimeFilterStrip.object-hierarchy" href="gmime/GMimeFilterStrip.html#GMimeFilterStrip.object-hierarchy"> +<ANCHOR id="GMimeFilterStrip.description" href="gmime/GMimeFilterStrip.html#GMimeFilterStrip.description"> +<ANCHOR id="GMimeFilterStrip.details" href="gmime/GMimeFilterStrip.html#GMimeFilterStrip.details"> +<ANCHOR id="GMimeFilterStrip-struct" href="gmime/GMimeFilterStrip.html#GMimeFilterStrip-struct"> +<ANCHOR id="g-mime-filter-strip-new" href="gmime/GMimeFilterStrip.html#g-mime-filter-strip-new"> +<ANCHOR id="GMimeFilterStrip.see-also" href="gmime/GMimeFilterStrip.html#GMimeFilterStrip.see-also"> +<ANCHOR id="GMimeFilterWindows" href="gmime/GMimeFilterWindows.html"> +<ANCHOR id="GMimeFilterWindows.synopsis" href="gmime/GMimeFilterWindows.html#GMimeFilterWindows.synopsis"> +<ANCHOR id="GMimeFilterWindows.object-hierarchy" href="gmime/GMimeFilterWindows.html#GMimeFilterWindows.object-hierarchy"> +<ANCHOR id="GMimeFilterWindows.description" href="gmime/GMimeFilterWindows.html#GMimeFilterWindows.description"> +<ANCHOR id="GMimeFilterWindows.details" href="gmime/GMimeFilterWindows.html#GMimeFilterWindows.details"> +<ANCHOR id="GMimeFilterWindows-struct" href="gmime/GMimeFilterWindows.html#GMimeFilterWindows-struct"> +<ANCHOR id="g-mime-filter-windows-new" href="gmime/GMimeFilterWindows.html#g-mime-filter-windows-new"> +<ANCHOR id="g-mime-filter-windows-is-windows-charset" href="gmime/GMimeFilterWindows.html#g-mime-filter-windows-is-windows-charset"> +<ANCHOR id="g-mime-filter-windows-real-charset" href="gmime/GMimeFilterWindows.html#g-mime-filter-windows-real-charset"> +<ANCHOR id="GMimeFilterWindows.see-also" href="gmime/GMimeFilterWindows.html#GMimeFilterWindows.see-also"> +<ANCHOR id="GMimeFilterYenc" href="gmime/GMimeFilterYenc.html"> +<ANCHOR id="GMimeFilterYenc.synopsis" href="gmime/GMimeFilterYenc.html#GMimeFilterYenc.synopsis"> +<ANCHOR id="GMimeFilterYenc.object-hierarchy" href="gmime/GMimeFilterYenc.html#GMimeFilterYenc.object-hierarchy"> +<ANCHOR id="GMimeFilterYenc.description" href="gmime/GMimeFilterYenc.html#GMimeFilterYenc.description"> +<ANCHOR id="GMimeFilterYenc.details" href="gmime/GMimeFilterYenc.html#GMimeFilterYenc.details"> +<ANCHOR id="GMimeFilterYenc-struct" href="gmime/GMimeFilterYenc.html#GMimeFilterYenc-struct"> +<ANCHOR id="g-mime-filter-yenc-new" href="gmime/GMimeFilterYenc.html#g-mime-filter-yenc-new"> +<ANCHOR id="g-mime-filter-yenc-set-state" href="gmime/GMimeFilterYenc.html#g-mime-filter-yenc-set-state"> +<ANCHOR id="g-mime-filter-yenc-set-crc" href="gmime/GMimeFilterYenc.html#g-mime-filter-yenc-set-crc"> +<ANCHOR id="g-mime-filter-yenc-get-crc" href="gmime/GMimeFilterYenc.html#g-mime-filter-yenc-get-crc"> +<ANCHOR id="g-mime-filter-yenc-get-pcrc" href="gmime/GMimeFilterYenc.html#g-mime-filter-yenc-get-pcrc"> +<ANCHOR id="GMIME-YENCODE-CRC-INIT:CAPS" href="gmime/GMimeFilterYenc.html#GMIME-YENCODE-CRC-INIT:CAPS"> +<ANCHOR id="GMIME-YENCODE-CRC-FINAL:CAPS" href="gmime/GMimeFilterYenc.html#GMIME-YENCODE-CRC-FINAL:CAPS"> +<ANCHOR id="GMIME-YENCODE-STATE-INIT:CAPS" href="gmime/GMimeFilterYenc.html#GMIME-YENCODE-STATE-INIT:CAPS"> +<ANCHOR id="GMIME-YDECODE-STATE-INIT:CAPS" href="gmime/GMimeFilterYenc.html#GMIME-YDECODE-STATE-INIT:CAPS"> +<ANCHOR id="GMIME-YDECODE-STATE-EOLN:CAPS" href="gmime/GMimeFilterYenc.html#GMIME-YDECODE-STATE-EOLN:CAPS"> +<ANCHOR id="GMIME-YDECODE-STATE-ESCAPE:CAPS" href="gmime/GMimeFilterYenc.html#GMIME-YDECODE-STATE-ESCAPE:CAPS"> +<ANCHOR id="GMIME-YDECODE-STATE-END:CAPS" href="gmime/GMimeFilterYenc.html#GMIME-YDECODE-STATE-END:CAPS"> +<ANCHOR id="GMIME-YDECODE-STATE-BEGIN:CAPS" href="gmime/GMimeFilterYenc.html#GMIME-YDECODE-STATE-BEGIN:CAPS"> +<ANCHOR id="GMIME-YDECODE-STATE-DECODE:CAPS" href="gmime/GMimeFilterYenc.html#GMIME-YDECODE-STATE-DECODE:CAPS"> +<ANCHOR id="GMIME-YDECODE-STATE-PART:CAPS" href="gmime/GMimeFilterYenc.html#GMIME-YDECODE-STATE-PART:CAPS"> +<ANCHOR id="g-mime-ydecode-step" href="gmime/GMimeFilterYenc.html#g-mime-ydecode-step"> +<ANCHOR id="g-mime-yencode-step" href="gmime/GMimeFilterYenc.html#g-mime-yencode-step"> +<ANCHOR id="g-mime-yencode-close" href="gmime/GMimeFilterYenc.html#g-mime-yencode-close"> +<ANCHOR id="GMimeFilterYenc.see-also" href="gmime/GMimeFilterYenc.html#GMimeFilterYenc.see-also"> +<ANCHOR id="GMimeDataWrapper" href="gmime/GMimeDataWrapper.html"> +<ANCHOR id="GMimeDataWrapper.synopsis" href="gmime/GMimeDataWrapper.html#GMimeDataWrapper.synopsis"> +<ANCHOR id="GMimeDataWrapper.object-hierarchy" href="gmime/GMimeDataWrapper.html#GMimeDataWrapper.object-hierarchy"> +<ANCHOR id="GMimeDataWrapper.description" href="gmime/GMimeDataWrapper.html#GMimeDataWrapper.description"> +<ANCHOR id="GMimeDataWrapper.details" href="gmime/GMimeDataWrapper.html#GMimeDataWrapper.details"> +<ANCHOR id="GMimeDataWrapper-struct" href="gmime/GMimeDataWrapper.html#GMimeDataWrapper-struct"> +<ANCHOR id="g-mime-data-wrapper-new" href="gmime/GMimeDataWrapper.html#g-mime-data-wrapper-new"> +<ANCHOR id="g-mime-data-wrapper-new-with-stream" href="gmime/GMimeDataWrapper.html#g-mime-data-wrapper-new-with-stream"> +<ANCHOR id="g-mime-data-wrapper-set-stream" href="gmime/GMimeDataWrapper.html#g-mime-data-wrapper-set-stream"> +<ANCHOR id="g-mime-data-wrapper-get-stream" href="gmime/GMimeDataWrapper.html#g-mime-data-wrapper-get-stream"> +<ANCHOR id="g-mime-data-wrapper-set-encoding" href="gmime/GMimeDataWrapper.html#g-mime-data-wrapper-set-encoding"> +<ANCHOR id="g-mime-data-wrapper-get-encoding" href="gmime/GMimeDataWrapper.html#g-mime-data-wrapper-get-encoding"> +<ANCHOR id="g-mime-data-wrapper-write-to-stream" href="gmime/GMimeDataWrapper.html#g-mime-data-wrapper-write-to-stream"> +<ANCHOR id="GMimeDataWrapper.see-also" href="gmime/GMimeDataWrapper.html#GMimeDataWrapper.see-also"> +<ANCHOR id="gmime-GMimeHeader" href="gmime/gmime-GMimeHeader.html"> +<ANCHOR id="gmime-GMimeHeader.synopsis" href="gmime/gmime-GMimeHeader.html#gmime-GMimeHeader.synopsis"> +<ANCHOR id="gmime-GMimeHeader.description" href="gmime/gmime-GMimeHeader.html#gmime-GMimeHeader.description"> +<ANCHOR id="gmime-GMimeHeader.details" href="gmime/gmime-GMimeHeader.html#gmime-GMimeHeader.details"> +<ANCHOR id="GMimeHeaderIter" href="gmime/gmime-GMimeHeader.html#GMimeHeaderIter"> +<ANCHOR id="GMimeHeaderList" href="gmime/gmime-GMimeHeader.html#GMimeHeaderList"> +<ANCHOR id="GMimeHeaderWriter" href="gmime/gmime-GMimeHeader.html#GMimeHeaderWriter"> +<ANCHOR id="GMimeHeaderForeachFunc" href="gmime/gmime-GMimeHeader.html#GMimeHeaderForeachFunc"> +<ANCHOR id="g-mime-header-iter-new" href="gmime/gmime-GMimeHeader.html#g-mime-header-iter-new"> +<ANCHOR id="g-mime-header-iter-free" href="gmime/gmime-GMimeHeader.html#g-mime-header-iter-free"> +<ANCHOR id="g-mime-header-iter-copy" href="gmime/gmime-GMimeHeader.html#g-mime-header-iter-copy"> +<ANCHOR id="g-mime-header-iter-copy-to" href="gmime/gmime-GMimeHeader.html#g-mime-header-iter-copy-to"> +<ANCHOR id="g-mime-header-iter-equal" href="gmime/gmime-GMimeHeader.html#g-mime-header-iter-equal"> +<ANCHOR id="g-mime-header-iter-first" href="gmime/gmime-GMimeHeader.html#g-mime-header-iter-first"> +<ANCHOR id="g-mime-header-iter-last" href="gmime/gmime-GMimeHeader.html#g-mime-header-iter-last"> +<ANCHOR id="g-mime-header-iter-next" href="gmime/gmime-GMimeHeader.html#g-mime-header-iter-next"> +<ANCHOR id="g-mime-header-iter-prev" href="gmime/gmime-GMimeHeader.html#g-mime-header-iter-prev"> +<ANCHOR id="g-mime-header-iter-is-valid" href="gmime/gmime-GMimeHeader.html#g-mime-header-iter-is-valid"> +<ANCHOR id="g-mime-header-iter-get-name" href="gmime/gmime-GMimeHeader.html#g-mime-header-iter-get-name"> +<ANCHOR id="g-mime-header-iter-get-value" href="gmime/gmime-GMimeHeader.html#g-mime-header-iter-get-value"> +<ANCHOR id="g-mime-header-iter-set-value" href="gmime/gmime-GMimeHeader.html#g-mime-header-iter-set-value"> +<ANCHOR id="g-mime-header-iter-remove" href="gmime/gmime-GMimeHeader.html#g-mime-header-iter-remove"> +<ANCHOR id="g-mime-header-list-new" href="gmime/gmime-GMimeHeader.html#g-mime-header-list-new"> +<ANCHOR id="g-mime-header-list-destroy" href="gmime/gmime-GMimeHeader.html#g-mime-header-list-destroy"> +<ANCHOR id="g-mime-header-list-clear" href="gmime/gmime-GMimeHeader.html#g-mime-header-list-clear"> +<ANCHOR id="g-mime-header-list-contains" href="gmime/gmime-GMimeHeader.html#g-mime-header-list-contains"> +<ANCHOR id="g-mime-header-list-prepend" href="gmime/gmime-GMimeHeader.html#g-mime-header-list-prepend"> +<ANCHOR id="g-mime-header-list-append" href="gmime/gmime-GMimeHeader.html#g-mime-header-list-append"> +<ANCHOR id="g-mime-header-list-remove" href="gmime/gmime-GMimeHeader.html#g-mime-header-list-remove"> +<ANCHOR id="g-mime-header-list-set" href="gmime/gmime-GMimeHeader.html#g-mime-header-list-set"> +<ANCHOR id="g-mime-header-list-get" href="gmime/gmime-GMimeHeader.html#g-mime-header-list-get"> +<ANCHOR id="g-mime-header-list-get-iter" href="gmime/gmime-GMimeHeader.html#g-mime-header-list-get-iter"> +<ANCHOR id="g-mime-header-list-foreach" href="gmime/gmime-GMimeHeader.html#g-mime-header-list-foreach"> +<ANCHOR id="g-mime-header-list-register-writer" href="gmime/gmime-GMimeHeader.html#g-mime-header-list-register-writer"> +<ANCHOR id="g-mime-header-list-write-to-stream" href="gmime/gmime-GMimeHeader.html#g-mime-header-list-write-to-stream"> +<ANCHOR id="g-mime-header-list-to-string" href="gmime/gmime-GMimeHeader.html#g-mime-header-list-to-string"> +<ANCHOR id="g-mime-header-list-get-stream" href="gmime/gmime-GMimeHeader.html#g-mime-header-list-get-stream"> +<ANCHOR id="g-mime-header-list-set-stream" href="gmime/gmime-GMimeHeader.html#g-mime-header-list-set-stream"> +<ANCHOR id="gmime-GMimeHeader.see-also" href="gmime/gmime-GMimeHeader.html#gmime-GMimeHeader.see-also"> +<ANCHOR id="GMimeContentType" href="gmime/GMimeContentType.html"> +<ANCHOR id="GMimeContentType.synopsis" href="gmime/GMimeContentType.html#GMimeContentType.synopsis"> +<ANCHOR id="GMimeContentType.object-hierarchy" href="gmime/GMimeContentType.html#GMimeContentType.object-hierarchy"> +<ANCHOR id="GMimeContentType.description" href="gmime/GMimeContentType.html#GMimeContentType.description"> +<ANCHOR id="GMimeContentType.details" href="gmime/GMimeContentType.html#GMimeContentType.details"> +<ANCHOR id="GMimeContentType-struct" href="gmime/GMimeContentType.html#GMimeContentType-struct"> +<ANCHOR id="g-mime-content-type-new" href="gmime/GMimeContentType.html#g-mime-content-type-new"> +<ANCHOR id="g-mime-content-type-new-from-string" href="gmime/GMimeContentType.html#g-mime-content-type-new-from-string"> +<ANCHOR id="g-mime-content-type-to-string" href="gmime/GMimeContentType.html#g-mime-content-type-to-string"> +<ANCHOR id="g-mime-content-type-is-type" href="gmime/GMimeContentType.html#g-mime-content-type-is-type"> +<ANCHOR id="g-mime-content-type-get-media-type" href="gmime/GMimeContentType.html#g-mime-content-type-get-media-type"> +<ANCHOR id="g-mime-content-type-set-media-type" href="gmime/GMimeContentType.html#g-mime-content-type-set-media-type"> +<ANCHOR id="g-mime-content-type-get-media-subtype" href="gmime/GMimeContentType.html#g-mime-content-type-get-media-subtype"> +<ANCHOR id="g-mime-content-type-set-media-subtype" href="gmime/GMimeContentType.html#g-mime-content-type-set-media-subtype"> +<ANCHOR id="g-mime-content-type-get-params" href="gmime/GMimeContentType.html#g-mime-content-type-get-params"> +<ANCHOR id="g-mime-content-type-set-params" href="gmime/GMimeContentType.html#g-mime-content-type-set-params"> +<ANCHOR id="g-mime-content-type-get-parameter" href="gmime/GMimeContentType.html#g-mime-content-type-get-parameter"> +<ANCHOR id="g-mime-content-type-set-parameter" href="gmime/GMimeContentType.html#g-mime-content-type-set-parameter"> +<ANCHOR id="GMimeContentDisposition" href="gmime/GMimeContentDisposition.html"> +<ANCHOR id="GMimeContentDisposition.synopsis" href="gmime/GMimeContentDisposition.html#GMimeContentDisposition.synopsis"> +<ANCHOR id="GMimeContentDisposition.object-hierarchy" href="gmime/GMimeContentDisposition.html#GMimeContentDisposition.object-hierarchy"> +<ANCHOR id="GMimeContentDisposition.description" href="gmime/GMimeContentDisposition.html#GMimeContentDisposition.description"> +<ANCHOR id="GMimeContentDisposition.details" href="gmime/GMimeContentDisposition.html#GMimeContentDisposition.details"> +<ANCHOR id="GMIME-DISPOSITION-ATTACHMENT:CAPS" href="gmime/GMimeContentDisposition.html#GMIME-DISPOSITION-ATTACHMENT:CAPS"> +<ANCHOR id="GMIME-DISPOSITION-INLINE:CAPS" href="gmime/GMimeContentDisposition.html#GMIME-DISPOSITION-INLINE:CAPS"> +<ANCHOR id="GMimeContentDisposition-struct" href="gmime/GMimeContentDisposition.html#GMimeContentDisposition-struct"> +<ANCHOR id="g-mime-content-disposition-new" href="gmime/GMimeContentDisposition.html#g-mime-content-disposition-new"> +<ANCHOR id="g-mime-content-disposition-new-from-string" href="gmime/GMimeContentDisposition.html#g-mime-content-disposition-new-from-string"> +<ANCHOR id="g-mime-content-disposition-set-disposition" href="gmime/GMimeContentDisposition.html#g-mime-content-disposition-set-disposition"> +<ANCHOR id="g-mime-content-disposition-get-disposition" href="gmime/GMimeContentDisposition.html#g-mime-content-disposition-get-disposition"> +<ANCHOR id="g-mime-content-disposition-get-params" href="gmime/GMimeContentDisposition.html#g-mime-content-disposition-get-params"> +<ANCHOR id="g-mime-content-disposition-set-params" href="gmime/GMimeContentDisposition.html#g-mime-content-disposition-set-params"> +<ANCHOR id="g-mime-content-disposition-set-parameter" href="gmime/GMimeContentDisposition.html#g-mime-content-disposition-set-parameter"> +<ANCHOR id="g-mime-content-disposition-get-parameter" href="gmime/GMimeContentDisposition.html#g-mime-content-disposition-get-parameter"> +<ANCHOR id="g-mime-content-disposition-to-string" href="gmime/GMimeContentDisposition.html#g-mime-content-disposition-to-string"> +<ANCHOR id="gmime-GMimeParam" href="gmime/gmime-GMimeParam.html"> +<ANCHOR id="gmime-GMimeParam.synopsis" href="gmime/gmime-GMimeParam.html#gmime-GMimeParam.synopsis"> +<ANCHOR id="gmime-GMimeParam.description" href="gmime/gmime-GMimeParam.html#gmime-GMimeParam.description"> +<ANCHOR id="gmime-GMimeParam.details" href="gmime/gmime-GMimeParam.html#gmime-GMimeParam.details"> +<ANCHOR id="GMimeParam" href="gmime/gmime-GMimeParam.html#GMimeParam"> +<ANCHOR id="g-mime-param-new" href="gmime/gmime-GMimeParam.html#g-mime-param-new"> +<ANCHOR id="g-mime-param-new-from-string" href="gmime/gmime-GMimeParam.html#g-mime-param-new-from-string"> +<ANCHOR id="g-mime-param-destroy" href="gmime/gmime-GMimeParam.html#g-mime-param-destroy"> +<ANCHOR id="g-mime-param-next" href="gmime/gmime-GMimeParam.html#g-mime-param-next"> +<ANCHOR id="g-mime-param-get-name" href="gmime/gmime-GMimeParam.html#g-mime-param-get-name"> +<ANCHOR id="g-mime-param-get-value" href="gmime/gmime-GMimeParam.html#g-mime-param-get-value"> +<ANCHOR id="g-mime-param-append" href="gmime/gmime-GMimeParam.html#g-mime-param-append"> +<ANCHOR id="g-mime-param-append-param" href="gmime/gmime-GMimeParam.html#g-mime-param-append-param"> +<ANCHOR id="g-mime-param-write-to-string" href="gmime/gmime-GMimeParam.html#g-mime-param-write-to-string"> +<ANCHOR id="gmime-GMimeParam.see-also" href="gmime/gmime-GMimeParam.html#gmime-GMimeParam.see-also"> +<ANCHOR id="InternetAddress" href="gmime/InternetAddress.html"> +<ANCHOR id="InternetAddress.synopsis" href="gmime/InternetAddress.html#InternetAddress.synopsis"> +<ANCHOR id="InternetAddress.object-hierarchy" href="gmime/InternetAddress.html#InternetAddress.object-hierarchy"> +<ANCHOR id="InternetAddress.description" href="gmime/InternetAddress.html#InternetAddress.description"> +<ANCHOR id="InternetAddress.details" href="gmime/InternetAddress.html#InternetAddress.details"> +<ANCHOR id="InternetAddress-struct" href="gmime/InternetAddress.html#InternetAddress-struct"> +<ANCHOR id="internet-address-get-name" href="gmime/InternetAddress.html#internet-address-get-name"> +<ANCHOR id="internet-address-set-name" href="gmime/InternetAddress.html#internet-address-set-name"> +<ANCHOR id="internet-address-to-string" href="gmime/InternetAddress.html#internet-address-to-string"> +<ANCHOR id="InternetAddress.see-also" href="gmime/InternetAddress.html#InternetAddress.see-also"> +<ANCHOR id="InternetAddressGroup" href="gmime/InternetAddressGroup.html"> +<ANCHOR id="InternetAddressGroup.synopsis" href="gmime/InternetAddressGroup.html#InternetAddressGroup.synopsis"> +<ANCHOR id="InternetAddressGroup.object-hierarchy" href="gmime/InternetAddressGroup.html#InternetAddressGroup.object-hierarchy"> +<ANCHOR id="InternetAddressGroup.description" href="gmime/InternetAddressGroup.html#InternetAddressGroup.description"> +<ANCHOR id="InternetAddressGroup.details" href="gmime/InternetAddressGroup.html#InternetAddressGroup.details"> +<ANCHOR id="InternetAddressGroup-struct" href="gmime/InternetAddressGroup.html#InternetAddressGroup-struct"> +<ANCHOR id="internet-address-group-new" href="gmime/InternetAddressGroup.html#internet-address-group-new"> +<ANCHOR id="internet-address-group-get-members" href="gmime/InternetAddressGroup.html#internet-address-group-get-members"> +<ANCHOR id="internet-address-group-set-members" href="gmime/InternetAddressGroup.html#internet-address-group-set-members"> +<ANCHOR id="internet-address-group-add-member" href="gmime/InternetAddressGroup.html#internet-address-group-add-member"> +<ANCHOR id="InternetAddressGroup.see-also" href="gmime/InternetAddressGroup.html#InternetAddressGroup.see-also"> +<ANCHOR id="InternetAddressMailbox" href="gmime/InternetAddressMailbox.html"> +<ANCHOR id="InternetAddressMailbox.synopsis" href="gmime/InternetAddressMailbox.html#InternetAddressMailbox.synopsis"> +<ANCHOR id="InternetAddressMailbox.object-hierarchy" href="gmime/InternetAddressMailbox.html#InternetAddressMailbox.object-hierarchy"> +<ANCHOR id="InternetAddressMailbox.description" href="gmime/InternetAddressMailbox.html#InternetAddressMailbox.description"> +<ANCHOR id="InternetAddressMailbox.details" href="gmime/InternetAddressMailbox.html#InternetAddressMailbox.details"> +<ANCHOR id="InternetAddressMailbox-struct" href="gmime/InternetAddressMailbox.html#InternetAddressMailbox-struct"> +<ANCHOR id="internet-address-mailbox-new" href="gmime/InternetAddressMailbox.html#internet-address-mailbox-new"> +<ANCHOR id="internet-address-mailbox-get-addr" href="gmime/InternetAddressMailbox.html#internet-address-mailbox-get-addr"> +<ANCHOR id="internet-address-mailbox-set-addr" href="gmime/InternetAddressMailbox.html#internet-address-mailbox-set-addr"> +<ANCHOR id="InternetAddressMailbox.see-also" href="gmime/InternetAddressMailbox.html#InternetAddressMailbox.see-also"> +<ANCHOR id="InternetAddressList" href="gmime/InternetAddressList.html"> +<ANCHOR id="InternetAddressList.synopsis" href="gmime/InternetAddressList.html#InternetAddressList.synopsis"> +<ANCHOR id="InternetAddressList.object-hierarchy" href="gmime/InternetAddressList.html#InternetAddressList.object-hierarchy"> +<ANCHOR id="InternetAddressList.description" href="gmime/InternetAddressList.html#InternetAddressList.description"> +<ANCHOR id="InternetAddressList.details" href="gmime/InternetAddressList.html#InternetAddressList.details"> +<ANCHOR id="InternetAddressList-struct" href="gmime/InternetAddressList.html#InternetAddressList-struct"> +<ANCHOR id="internet-address-list-new" href="gmime/InternetAddressList.html#internet-address-list-new"> +<ANCHOR id="internet-address-list-length" href="gmime/InternetAddressList.html#internet-address-list-length"> +<ANCHOR id="internet-address-list-clear" href="gmime/InternetAddressList.html#internet-address-list-clear"> +<ANCHOR id="internet-address-list-add" href="gmime/InternetAddressList.html#internet-address-list-add"> +<ANCHOR id="internet-address-list-insert" href="gmime/InternetAddressList.html#internet-address-list-insert"> +<ANCHOR id="internet-address-list-remove" href="gmime/InternetAddressList.html#internet-address-list-remove"> +<ANCHOR id="internet-address-list-remove-at" href="gmime/InternetAddressList.html#internet-address-list-remove-at"> +<ANCHOR id="internet-address-list-contains" href="gmime/InternetAddressList.html#internet-address-list-contains"> +<ANCHOR id="internet-address-list-index-of" href="gmime/InternetAddressList.html#internet-address-list-index-of"> +<ANCHOR id="internet-address-list-get-address" href="gmime/InternetAddressList.html#internet-address-list-get-address"> +<ANCHOR id="internet-address-list-set-address" href="gmime/InternetAddressList.html#internet-address-list-set-address"> +<ANCHOR id="internet-address-list-prepend" href="gmime/InternetAddressList.html#internet-address-list-prepend"> +<ANCHOR id="internet-address-list-append" href="gmime/InternetAddressList.html#internet-address-list-append"> +<ANCHOR id="internet-address-list-to-string" href="gmime/InternetAddressList.html#internet-address-list-to-string"> +<ANCHOR id="internet-address-list-parse-string" href="gmime/InternetAddressList.html#internet-address-list-parse-string"> +<ANCHOR id="internet-address-list-writer" href="gmime/InternetAddressList.html#internet-address-list-writer"> +<ANCHOR id="InternetAddressList.see-also" href="gmime/InternetAddressList.html#InternetAddressList.see-also"> +<ANCHOR id="GMimeObject" href="gmime/GMimeObject.html"> +<ANCHOR id="GMimeObject.synopsis" href="gmime/GMimeObject.html#GMimeObject.synopsis"> +<ANCHOR id="GMimeObject.object-hierarchy" href="gmime/GMimeObject.html#GMimeObject.object-hierarchy"> +<ANCHOR id="GMimeObject.description" href="gmime/GMimeObject.html#GMimeObject.description"> +<ANCHOR id="GMimeObject.details" href="gmime/GMimeObject.html#GMimeObject.details"> +<ANCHOR id="GMimeObject-struct" href="gmime/GMimeObject.html#GMimeObject-struct"> +<ANCHOR id="GMimeObjectForeachFunc" href="gmime/GMimeObject.html#GMimeObjectForeachFunc"> +<ANCHOR id="g-mime-object-register-type" href="gmime/GMimeObject.html#g-mime-object-register-type"> +<ANCHOR id="g-mime-object-new" href="gmime/GMimeObject.html#g-mime-object-new"> +<ANCHOR id="g-mime-object-new-type" href="gmime/GMimeObject.html#g-mime-object-new-type"> +<ANCHOR id="g-mime-object-set-content-type" href="gmime/GMimeObject.html#g-mime-object-set-content-type"> +<ANCHOR id="g-mime-object-get-content-type" href="gmime/GMimeObject.html#g-mime-object-get-content-type"> +<ANCHOR id="g-mime-object-set-content-type-parameter" href="gmime/GMimeObject.html#g-mime-object-set-content-type-parameter"> +<ANCHOR id="g-mime-object-get-content-type-parameter" href="gmime/GMimeObject.html#g-mime-object-get-content-type-parameter"> +<ANCHOR id="g-mime-object-set-disposition" href="gmime/GMimeObject.html#g-mime-object-set-disposition"> +<ANCHOR id="g-mime-object-get-disposition" href="gmime/GMimeObject.html#g-mime-object-get-disposition"> +<ANCHOR id="g-mime-object-set-content-disposition" href="gmime/GMimeObject.html#g-mime-object-set-content-disposition"> +<ANCHOR id="g-mime-object-get-content-disposition" href="gmime/GMimeObject.html#g-mime-object-get-content-disposition"> +<ANCHOR id="g-mime-object-set-content-disposition-parameter" href="gmime/GMimeObject.html#g-mime-object-set-content-disposition-parameter"> +<ANCHOR id="g-mime-object-get-content-disposition-parameter" href="gmime/GMimeObject.html#g-mime-object-get-content-disposition-parameter"> +<ANCHOR id="g-mime-object-set-content-id" href="gmime/GMimeObject.html#g-mime-object-set-content-id"> +<ANCHOR id="g-mime-object-get-content-id" href="gmime/GMimeObject.html#g-mime-object-get-content-id"> +<ANCHOR id="g-mime-object-prepend-header" href="gmime/GMimeObject.html#g-mime-object-prepend-header"> +<ANCHOR id="g-mime-object-append-header" href="gmime/GMimeObject.html#g-mime-object-append-header"> +<ANCHOR id="g-mime-object-remove-header" href="gmime/GMimeObject.html#g-mime-object-remove-header"> +<ANCHOR id="g-mime-object-set-header" href="gmime/GMimeObject.html#g-mime-object-set-header"> +<ANCHOR id="g-mime-object-get-header" href="gmime/GMimeObject.html#g-mime-object-get-header"> +<ANCHOR id="g-mime-object-get-headers" href="gmime/GMimeObject.html#g-mime-object-get-headers"> +<ANCHOR id="g-mime-object-get-header-list" href="gmime/GMimeObject.html#g-mime-object-get-header-list"> +<ANCHOR id="g-mime-object-write-to-stream" href="gmime/GMimeObject.html#g-mime-object-write-to-stream"> +<ANCHOR id="g-mime-object-to-string" href="gmime/GMimeObject.html#g-mime-object-to-string"> +<ANCHOR id="g-mime-object-encode" href="gmime/GMimeObject.html#g-mime-object-encode"> +<ANCHOR id="GMimeMessage" href="gmime/GMimeMessage.html"> +<ANCHOR id="GMimeMessage.synopsis" href="gmime/GMimeMessage.html#GMimeMessage.synopsis"> +<ANCHOR id="GMimeMessage.object-hierarchy" href="gmime/GMimeMessage.html#GMimeMessage.object-hierarchy"> +<ANCHOR id="GMimeMessage.description" href="gmime/GMimeMessage.html#GMimeMessage.description"> +<ANCHOR id="GMimeMessage.details" href="gmime/GMimeMessage.html#GMimeMessage.details"> +<ANCHOR id="GMimeRecipientType" href="gmime/GMimeMessage.html#GMimeRecipientType"> +<ANCHOR id="GMIME-RECIPIENT-TYPE-TO:CAPS" href="gmime/GMimeMessage.html#GMIME-RECIPIENT-TYPE-TO:CAPS"> +<ANCHOR id="GMIME-RECIPIENT-TYPE-CC:CAPS" href="gmime/GMimeMessage.html#GMIME-RECIPIENT-TYPE-CC:CAPS"> +<ANCHOR id="GMIME-RECIPIENT-TYPE-BCC:CAPS" href="gmime/GMimeMessage.html#GMIME-RECIPIENT-TYPE-BCC:CAPS"> +<ANCHOR id="GMimeMessage-struct" href="gmime/GMimeMessage.html#GMimeMessage-struct"> +<ANCHOR id="g-mime-message-new" href="gmime/GMimeMessage.html#g-mime-message-new"> +<ANCHOR id="g-mime-message-set-sender" href="gmime/GMimeMessage.html#g-mime-message-set-sender"> +<ANCHOR id="g-mime-message-get-sender" href="gmime/GMimeMessage.html#g-mime-message-get-sender"> +<ANCHOR id="g-mime-message-set-reply-to" href="gmime/GMimeMessage.html#g-mime-message-set-reply-to"> +<ANCHOR id="g-mime-message-get-reply-to" href="gmime/GMimeMessage.html#g-mime-message-get-reply-to"> +<ANCHOR id="g-mime-message-add-recipient" href="gmime/GMimeMessage.html#g-mime-message-add-recipient"> +<ANCHOR id="g-mime-message-get-recipients" href="gmime/GMimeMessage.html#g-mime-message-get-recipients"> +<ANCHOR id="g-mime-message-get-all-recipients" href="gmime/GMimeMessage.html#g-mime-message-get-all-recipients"> +<ANCHOR id="g-mime-message-set-subject" href="gmime/GMimeMessage.html#g-mime-message-set-subject"> +<ANCHOR id="g-mime-message-get-subject" href="gmime/GMimeMessage.html#g-mime-message-get-subject"> +<ANCHOR id="g-mime-message-set-date" href="gmime/GMimeMessage.html#g-mime-message-set-date"> +<ANCHOR id="g-mime-message-get-date" href="gmime/GMimeMessage.html#g-mime-message-get-date"> +<ANCHOR id="g-mime-message-set-date-as-string" href="gmime/GMimeMessage.html#g-mime-message-set-date-as-string"> +<ANCHOR id="g-mime-message-get-date-as-string" href="gmime/GMimeMessage.html#g-mime-message-get-date-as-string"> +<ANCHOR id="g-mime-message-set-message-id" href="gmime/GMimeMessage.html#g-mime-message-set-message-id"> +<ANCHOR id="g-mime-message-get-message-id" href="gmime/GMimeMessage.html#g-mime-message-get-message-id"> +<ANCHOR id="g-mime-message-set-mime-part" href="gmime/GMimeMessage.html#g-mime-message-set-mime-part"> +<ANCHOR id="g-mime-message-get-mime-part" href="gmime/GMimeMessage.html#g-mime-message-get-mime-part"> +<ANCHOR id="g-mime-message-foreach" href="gmime/GMimeMessage.html#g-mime-message-foreach"> +<ANCHOR id="g-mime-message-get-body" href="gmime/GMimeMessage.html#g-mime-message-get-body"> +<ANCHOR id="GMimePart" href="gmime/GMimePart.html"> +<ANCHOR id="GMimePart.synopsis" href="gmime/GMimePart.html#GMimePart.synopsis"> +<ANCHOR id="GMimePart.object-hierarchy" href="gmime/GMimePart.html#GMimePart.object-hierarchy"> +<ANCHOR id="GMimePart.description" href="gmime/GMimePart.html#GMimePart.description"> +<ANCHOR id="GMimePart.details" href="gmime/GMimePart.html#GMimePart.details"> +<ANCHOR id="GMimePart-struct" href="gmime/GMimePart.html#GMimePart-struct"> +<ANCHOR id="g-mime-part-new" href="gmime/GMimePart.html#g-mime-part-new"> +<ANCHOR id="g-mime-part-new-with-type" href="gmime/GMimePart.html#g-mime-part-new-with-type"> +<ANCHOR id="g-mime-part-set-content-description" href="gmime/GMimePart.html#g-mime-part-set-content-description"> +<ANCHOR id="g-mime-part-get-content-description" href="gmime/GMimePart.html#g-mime-part-get-content-description"> +<ANCHOR id="g-mime-part-set-content-id" href="gmime/GMimePart.html#g-mime-part-set-content-id"> +<ANCHOR id="g-mime-part-get-content-id" href="gmime/GMimePart.html#g-mime-part-get-content-id"> +<ANCHOR id="g-mime-part-set-content-md5" href="gmime/GMimePart.html#g-mime-part-set-content-md5"> +<ANCHOR id="g-mime-part-get-content-md5" href="gmime/GMimePart.html#g-mime-part-get-content-md5"> +<ANCHOR id="g-mime-part-verify-content-md5" href="gmime/GMimePart.html#g-mime-part-verify-content-md5"> +<ANCHOR id="g-mime-part-set-content-location" href="gmime/GMimePart.html#g-mime-part-set-content-location"> +<ANCHOR id="g-mime-part-get-content-location" href="gmime/GMimePart.html#g-mime-part-get-content-location"> +<ANCHOR id="g-mime-part-set-content-encoding" href="gmime/GMimePart.html#g-mime-part-set-content-encoding"> +<ANCHOR id="g-mime-part-get-content-encoding" href="gmime/GMimePart.html#g-mime-part-get-content-encoding"> +<ANCHOR id="g-mime-part-get-best-content-encoding" href="gmime/GMimePart.html#g-mime-part-get-best-content-encoding"> +<ANCHOR id="g-mime-part-set-filename" href="gmime/GMimePart.html#g-mime-part-set-filename"> +<ANCHOR id="g-mime-part-get-filename" href="gmime/GMimePart.html#g-mime-part-get-filename"> +<ANCHOR id="g-mime-part-get-content-object" href="gmime/GMimePart.html#g-mime-part-get-content-object"> +<ANCHOR id="g-mime-part-set-content-object" href="gmime/GMimePart.html#g-mime-part-set-content-object"> +<ANCHOR id="GMimeMultipart" href="gmime/GMimeMultipart.html"> +<ANCHOR id="GMimeMultipart.synopsis" href="gmime/GMimeMultipart.html#GMimeMultipart.synopsis"> +<ANCHOR id="GMimeMultipart.object-hierarchy" href="gmime/GMimeMultipart.html#GMimeMultipart.object-hierarchy"> +<ANCHOR id="GMimeMultipart.description" href="gmime/GMimeMultipart.html#GMimeMultipart.description"> +<ANCHOR id="GMimeMultipart.details" href="gmime/GMimeMultipart.html#GMimeMultipart.details"> +<ANCHOR id="GMimeMultipart-struct" href="gmime/GMimeMultipart.html#GMimeMultipart-struct"> +<ANCHOR id="g-mime-multipart-new" href="gmime/GMimeMultipart.html#g-mime-multipart-new"> +<ANCHOR id="g-mime-multipart-new-with-subtype" href="gmime/GMimeMultipart.html#g-mime-multipart-new-with-subtype"> +<ANCHOR id="g-mime-multipart-set-preface" href="gmime/GMimeMultipart.html#g-mime-multipart-set-preface"> +<ANCHOR id="g-mime-multipart-get-preface" href="gmime/GMimeMultipart.html#g-mime-multipart-get-preface"> +<ANCHOR id="g-mime-multipart-set-postface" href="gmime/GMimeMultipart.html#g-mime-multipart-set-postface"> +<ANCHOR id="g-mime-multipart-get-postface" href="gmime/GMimeMultipart.html#g-mime-multipart-get-postface"> +<ANCHOR id="g-mime-multipart-set-boundary" href="gmime/GMimeMultipart.html#g-mime-multipart-set-boundary"> +<ANCHOR id="g-mime-multipart-get-boundary" href="gmime/GMimeMultipart.html#g-mime-multipart-get-boundary"> +<ANCHOR id="g-mime-multipart-get-count" href="gmime/GMimeMultipart.html#g-mime-multipart-get-count"> +<ANCHOR id="g-mime-multipart-contains" href="gmime/GMimeMultipart.html#g-mime-multipart-contains"> +<ANCHOR id="g-mime-multipart-index-of" href="gmime/GMimeMultipart.html#g-mime-multipart-index-of"> +<ANCHOR id="g-mime-multipart-add" href="gmime/GMimeMultipart.html#g-mime-multipart-add"> +<ANCHOR id="g-mime-multipart-clear" href="gmime/GMimeMultipart.html#g-mime-multipart-clear"> +<ANCHOR id="g-mime-multipart-insert" href="gmime/GMimeMultipart.html#g-mime-multipart-insert"> +<ANCHOR id="g-mime-multipart-remove" href="gmime/GMimeMultipart.html#g-mime-multipart-remove"> +<ANCHOR id="g-mime-multipart-remove-at" href="gmime/GMimeMultipart.html#g-mime-multipart-remove-at"> +<ANCHOR id="g-mime-multipart-replace" href="gmime/GMimeMultipart.html#g-mime-multipart-replace"> +<ANCHOR id="g-mime-multipart-get-part" href="gmime/GMimeMultipart.html#g-mime-multipart-get-part"> +<ANCHOR id="g-mime-multipart-foreach" href="gmime/GMimeMultipart.html#g-mime-multipart-foreach"> +<ANCHOR id="g-mime-multipart-get-subpart-from-content-id" href="gmime/GMimeMultipart.html#g-mime-multipart-get-subpart-from-content-id"> +<ANCHOR id="GMimeMultipartEncrypted" href="gmime/GMimeMultipartEncrypted.html"> +<ANCHOR id="GMimeMultipartEncrypted.synopsis" href="gmime/GMimeMultipartEncrypted.html#GMimeMultipartEncrypted.synopsis"> +<ANCHOR id="GMimeMultipartEncrypted.object-hierarchy" href="gmime/GMimeMultipartEncrypted.html#GMimeMultipartEncrypted.object-hierarchy"> +<ANCHOR id="GMimeMultipartEncrypted.description" href="gmime/GMimeMultipartEncrypted.html#GMimeMultipartEncrypted.description"> +<ANCHOR id="GMimeMultipartEncrypted.details" href="gmime/GMimeMultipartEncrypted.html#GMimeMultipartEncrypted.details"> +<ANCHOR id="GMimeMultipartEncrypted-struct" href="gmime/GMimeMultipartEncrypted.html#GMimeMultipartEncrypted-struct"> +<ANCHOR id="g-mime-multipart-encrypted-new" href="gmime/GMimeMultipartEncrypted.html#g-mime-multipart-encrypted-new"> +<ANCHOR id="g-mime-multipart-encrypted-encrypt" href="gmime/GMimeMultipartEncrypted.html#g-mime-multipart-encrypted-encrypt"> +<ANCHOR id="g-mime-multipart-encrypted-decrypt" href="gmime/GMimeMultipartEncrypted.html#g-mime-multipart-encrypted-decrypt"> +<ANCHOR id="GMimeMultipartEncrypted.see-also" href="gmime/GMimeMultipartEncrypted.html#GMimeMultipartEncrypted.see-also"> +<ANCHOR id="GMimeMultipartSigned" href="gmime/GMimeMultipartSigned.html"> +<ANCHOR id="GMimeMultipartSigned.synopsis" href="gmime/GMimeMultipartSigned.html#GMimeMultipartSigned.synopsis"> +<ANCHOR id="GMimeMultipartSigned.object-hierarchy" href="gmime/GMimeMultipartSigned.html#GMimeMultipartSigned.object-hierarchy"> +<ANCHOR id="GMimeMultipartSigned.description" href="gmime/GMimeMultipartSigned.html#GMimeMultipartSigned.description"> +<ANCHOR id="GMimeMultipartSigned.details" href="gmime/GMimeMultipartSigned.html#GMimeMultipartSigned.details"> +<ANCHOR id="GMimeMultipartSigned-struct" href="gmime/GMimeMultipartSigned.html#GMimeMultipartSigned-struct"> +<ANCHOR id="g-mime-multipart-signed-new" href="gmime/GMimeMultipartSigned.html#g-mime-multipart-signed-new"> +<ANCHOR id="g-mime-multipart-signed-sign" href="gmime/GMimeMultipartSigned.html#g-mime-multipart-signed-sign"> +<ANCHOR id="g-mime-multipart-signed-verify" href="gmime/GMimeMultipartSigned.html#g-mime-multipart-signed-verify"> +<ANCHOR id="GMimeMultipartSigned.see-also" href="gmime/GMimeMultipartSigned.html#GMimeMultipartSigned.see-also"> +<ANCHOR id="GMimeMessagePart" href="gmime/GMimeMessagePart.html"> +<ANCHOR id="GMimeMessagePart.synopsis" href="gmime/GMimeMessagePart.html#GMimeMessagePart.synopsis"> +<ANCHOR id="GMimeMessagePart.object-hierarchy" href="gmime/GMimeMessagePart.html#GMimeMessagePart.object-hierarchy"> +<ANCHOR id="GMimeMessagePart.description" href="gmime/GMimeMessagePart.html#GMimeMessagePart.description"> +<ANCHOR id="GMimeMessagePart.details" href="gmime/GMimeMessagePart.html#GMimeMessagePart.details"> +<ANCHOR id="GMimeMessagePart-struct" href="gmime/GMimeMessagePart.html#GMimeMessagePart-struct"> +<ANCHOR id="g-mime-message-part-new" href="gmime/GMimeMessagePart.html#g-mime-message-part-new"> +<ANCHOR id="g-mime-message-part-new-with-message" href="gmime/GMimeMessagePart.html#g-mime-message-part-new-with-message"> +<ANCHOR id="g-mime-message-part-get-message" href="gmime/GMimeMessagePart.html#g-mime-message-part-get-message"> +<ANCHOR id="g-mime-message-part-set-message" href="gmime/GMimeMessagePart.html#g-mime-message-part-set-message"> +<ANCHOR id="GMimeMessagePartial" href="gmime/GMimeMessagePartial.html"> +<ANCHOR id="GMimeMessagePartial.synopsis" href="gmime/GMimeMessagePartial.html#GMimeMessagePartial.synopsis"> +<ANCHOR id="GMimeMessagePartial.object-hierarchy" href="gmime/GMimeMessagePartial.html#GMimeMessagePartial.object-hierarchy"> +<ANCHOR id="GMimeMessagePartial.description" href="gmime/GMimeMessagePartial.html#GMimeMessagePartial.description"> +<ANCHOR id="GMimeMessagePartial.details" href="gmime/GMimeMessagePartial.html#GMimeMessagePartial.details"> +<ANCHOR id="GMimeMessagePartial-struct" href="gmime/GMimeMessagePartial.html#GMimeMessagePartial-struct"> +<ANCHOR id="g-mime-message-partial-new" href="gmime/GMimeMessagePartial.html#g-mime-message-partial-new"> +<ANCHOR id="g-mime-message-partial-get-id" href="gmime/GMimeMessagePartial.html#g-mime-message-partial-get-id"> +<ANCHOR id="g-mime-message-partial-get-number" href="gmime/GMimeMessagePartial.html#g-mime-message-partial-get-number"> +<ANCHOR id="g-mime-message-partial-get-total" href="gmime/GMimeMessagePartial.html#g-mime-message-partial-get-total"> +<ANCHOR id="g-mime-message-partial-reconstruct-message" href="gmime/GMimeMessagePartial.html#g-mime-message-partial-reconstruct-message"> +<ANCHOR id="g-mime-message-partial-split-message" href="gmime/GMimeMessagePartial.html#g-mime-message-partial-split-message"> +<ANCHOR id="gmime-GMimePartIter" href="gmime/gmime-GMimePartIter.html"> +<ANCHOR id="gmime-GMimePartIter.synopsis" href="gmime/gmime-GMimePartIter.html#gmime-GMimePartIter.synopsis"> +<ANCHOR id="gmime-GMimePartIter.description" href="gmime/gmime-GMimePartIter.html#gmime-GMimePartIter.description"> +<ANCHOR id="gmime-GMimePartIter.details" href="gmime/gmime-GMimePartIter.html#gmime-GMimePartIter.details"> +<ANCHOR id="GMimePartIter" href="gmime/gmime-GMimePartIter.html#GMimePartIter"> +<ANCHOR id="g-mime-part-iter-new" href="gmime/gmime-GMimePartIter.html#g-mime-part-iter-new"> +<ANCHOR id="g-mime-part-iter-free" href="gmime/gmime-GMimePartIter.html#g-mime-part-iter-free"> +<ANCHOR id="g-mime-part-iter-reset" href="gmime/gmime-GMimePartIter.html#g-mime-part-iter-reset"> +<ANCHOR id="g-mime-part-iter-jump-to" href="gmime/gmime-GMimePartIter.html#g-mime-part-iter-jump-to"> +<ANCHOR id="g-mime-part-iter-is-valid" href="gmime/gmime-GMimePartIter.html#g-mime-part-iter-is-valid"> +<ANCHOR id="g-mime-part-iter-next" href="gmime/gmime-GMimePartIter.html#g-mime-part-iter-next"> +<ANCHOR id="g-mime-part-iter-prev" href="gmime/gmime-GMimePartIter.html#g-mime-part-iter-prev"> +<ANCHOR id="g-mime-part-iter-get-toplevel" href="gmime/gmime-GMimePartIter.html#g-mime-part-iter-get-toplevel"> +<ANCHOR id="g-mime-part-iter-get-current" href="gmime/gmime-GMimePartIter.html#g-mime-part-iter-get-current"> +<ANCHOR id="g-mime-part-iter-get-parent" href="gmime/gmime-GMimePartIter.html#g-mime-part-iter-get-parent"> +<ANCHOR id="g-mime-part-iter-get-path" href="gmime/gmime-GMimePartIter.html#g-mime-part-iter-get-path"> +<ANCHOR id="g-mime-part-iter-replace" href="gmime/gmime-GMimePartIter.html#g-mime-part-iter-replace"> +<ANCHOR id="g-mime-part-iter-remove" href="gmime/gmime-GMimePartIter.html#g-mime-part-iter-remove"> +<ANCHOR id="gmime-GMimePartIter.see-also" href="gmime/gmime-GMimePartIter.html#gmime-GMimePartIter.see-also"> +<ANCHOR id="GMimeParser" href="gmime/GMimeParser.html"> +<ANCHOR id="GMimeParser.synopsis" href="gmime/GMimeParser.html#GMimeParser.synopsis"> +<ANCHOR id="GMimeParser.object-hierarchy" href="gmime/GMimeParser.html#GMimeParser.object-hierarchy"> +<ANCHOR id="GMimeParser.description" href="gmime/GMimeParser.html#GMimeParser.description"> +<ANCHOR id="GMimeParser.details" href="gmime/GMimeParser.html#GMimeParser.details"> +<ANCHOR id="GMimeParser-struct" href="gmime/GMimeParser.html#GMimeParser-struct"> +<ANCHOR id="GMimeParserHeaderRegexFunc" href="gmime/GMimeParser.html#GMimeParserHeaderRegexFunc"> +<ANCHOR id="g-mime-parser-new" href="gmime/GMimeParser.html#g-mime-parser-new"> +<ANCHOR id="g-mime-parser-new-with-stream" href="gmime/GMimeParser.html#g-mime-parser-new-with-stream"> +<ANCHOR id="g-mime-parser-init-with-stream" href="gmime/GMimeParser.html#g-mime-parser-init-with-stream"> +<ANCHOR id="g-mime-parser-get-persist-stream" href="gmime/GMimeParser.html#g-mime-parser-get-persist-stream"> +<ANCHOR id="g-mime-parser-set-persist-stream" href="gmime/GMimeParser.html#g-mime-parser-set-persist-stream"> +<ANCHOR id="g-mime-parser-get-scan-from" href="gmime/GMimeParser.html#g-mime-parser-get-scan-from"> +<ANCHOR id="g-mime-parser-set-scan-from" href="gmime/GMimeParser.html#g-mime-parser-set-scan-from"> +<ANCHOR id="g-mime-parser-get-respect-content-length" href="gmime/GMimeParser.html#g-mime-parser-get-respect-content-length"> +<ANCHOR id="g-mime-parser-set-respect-content-length" href="gmime/GMimeParser.html#g-mime-parser-set-respect-content-length"> +<ANCHOR id="g-mime-parser-set-header-regex" href="gmime/GMimeParser.html#g-mime-parser-set-header-regex"> +<ANCHOR id="g-mime-parser-tell" href="gmime/GMimeParser.html#g-mime-parser-tell"> +<ANCHOR id="g-mime-parser-eos" href="gmime/GMimeParser.html#g-mime-parser-eos"> +<ANCHOR id="g-mime-parser-construct-part" href="gmime/GMimeParser.html#g-mime-parser-construct-part"> +<ANCHOR id="g-mime-parser-construct-message" href="gmime/GMimeParser.html#g-mime-parser-construct-message"> +<ANCHOR id="g-mime-parser-get-from" href="gmime/GMimeParser.html#g-mime-parser-get-from"> +<ANCHOR id="g-mime-parser-get-from-offset" href="gmime/GMimeParser.html#g-mime-parser-get-from-offset"> +<ANCHOR id="g-mime-parser-get-headers-begin" href="gmime/GMimeParser.html#g-mime-parser-get-headers-begin"> +<ANCHOR id="g-mime-parser-get-headers-end" href="gmime/GMimeParser.html#g-mime-parser-get-headers-end"> +<ANCHOR id="GMimeCertificate" href="gmime/GMimeCertificate.html"> +<ANCHOR id="GMimeCertificate.synopsis" href="gmime/GMimeCertificate.html#GMimeCertificate.synopsis"> +<ANCHOR id="GMimeCertificateList" href="gmime/GMimeCertificate.html#GMimeCertificateList"> +<ANCHOR id="GMimeCertificate.object-hierarchy" href="gmime/GMimeCertificate.html#GMimeCertificate.object-hierarchy"> +<ANCHOR id="GMimeCertificate.description" href="gmime/GMimeCertificate.html#GMimeCertificate.description"> +<ANCHOR id="GMimeCertificate.details" href="gmime/GMimeCertificate.html#GMimeCertificate.details"> +<ANCHOR id="GMimePubKeyAlgo" href="gmime/GMimeCertificate.html#GMimePubKeyAlgo"> +<ANCHOR id="GMIME-PUBKEY-ALGO-DEFAULT:CAPS" href="gmime/GMimeCertificate.html#GMIME-PUBKEY-ALGO-DEFAULT:CAPS"> +<ANCHOR id="GMIME-PUBKEY-ALGO-RSA:CAPS" href="gmime/GMimeCertificate.html#GMIME-PUBKEY-ALGO-RSA:CAPS"> +<ANCHOR id="GMIME-PUBKEY-ALGO-RSA-E:CAPS" href="gmime/GMimeCertificate.html#GMIME-PUBKEY-ALGO-RSA-E:CAPS"> +<ANCHOR id="GMIME-PUBKEY-ALGO-RSA-S:CAPS" href="gmime/GMimeCertificate.html#GMIME-PUBKEY-ALGO-RSA-S:CAPS"> +<ANCHOR id="GMIME-PUBKEY-ALGO-ELG-E:CAPS" href="gmime/GMimeCertificate.html#GMIME-PUBKEY-ALGO-ELG-E:CAPS"> +<ANCHOR id="GMIME-PUBKEY-ALGO-DSA:CAPS" href="gmime/GMimeCertificate.html#GMIME-PUBKEY-ALGO-DSA:CAPS"> +<ANCHOR id="GMIME-PUBKEY-ALGO-ELG:CAPS" href="gmime/GMimeCertificate.html#GMIME-PUBKEY-ALGO-ELG:CAPS"> +<ANCHOR id="GMimeDigestAlgo" href="gmime/GMimeCertificate.html#GMimeDigestAlgo"> +<ANCHOR id="GMIME-DIGEST-ALGO-DEFAULT:CAPS" href="gmime/GMimeCertificate.html#GMIME-DIGEST-ALGO-DEFAULT:CAPS"> +<ANCHOR id="GMIME-DIGEST-ALGO-MD5:CAPS" href="gmime/GMimeCertificate.html#GMIME-DIGEST-ALGO-MD5:CAPS"> +<ANCHOR id="GMIME-DIGEST-ALGO-SHA1:CAPS" href="gmime/GMimeCertificate.html#GMIME-DIGEST-ALGO-SHA1:CAPS"> +<ANCHOR id="GMIME-DIGEST-ALGO-RIPEMD160:CAPS" href="gmime/GMimeCertificate.html#GMIME-DIGEST-ALGO-RIPEMD160:CAPS"> +<ANCHOR id="GMIME-DIGEST-ALGO-MD2:CAPS" href="gmime/GMimeCertificate.html#GMIME-DIGEST-ALGO-MD2:CAPS"> +<ANCHOR id="GMIME-DIGEST-ALGO-TIGER192:CAPS" href="gmime/GMimeCertificate.html#GMIME-DIGEST-ALGO-TIGER192:CAPS"> +<ANCHOR id="GMIME-DIGEST-ALGO-HAVAL5160:CAPS" href="gmime/GMimeCertificate.html#GMIME-DIGEST-ALGO-HAVAL5160:CAPS"> +<ANCHOR id="GMIME-DIGEST-ALGO-SHA256:CAPS" href="gmime/GMimeCertificate.html#GMIME-DIGEST-ALGO-SHA256:CAPS"> +<ANCHOR id="GMIME-DIGEST-ALGO-SHA384:CAPS" href="gmime/GMimeCertificate.html#GMIME-DIGEST-ALGO-SHA384:CAPS"> +<ANCHOR id="GMIME-DIGEST-ALGO-SHA512:CAPS" href="gmime/GMimeCertificate.html#GMIME-DIGEST-ALGO-SHA512:CAPS"> +<ANCHOR id="GMIME-DIGEST-ALGO-SHA224:CAPS" href="gmime/GMimeCertificate.html#GMIME-DIGEST-ALGO-SHA224:CAPS"> +<ANCHOR id="GMIME-DIGEST-ALGO-MD4:CAPS" href="gmime/GMimeCertificate.html#GMIME-DIGEST-ALGO-MD4:CAPS"> +<ANCHOR id="GMimeCertificateTrust" href="gmime/GMimeCertificate.html#GMimeCertificateTrust"> +<ANCHOR id="GMIME-CERTIFICATE-TRUST-NONE:CAPS" href="gmime/GMimeCertificate.html#GMIME-CERTIFICATE-TRUST-NONE:CAPS"> +<ANCHOR id="GMIME-CERTIFICATE-TRUST-NEVER:CAPS" href="gmime/GMimeCertificate.html#GMIME-CERTIFICATE-TRUST-NEVER:CAPS"> +<ANCHOR id="GMIME-CERTIFICATE-TRUST-UNDEFINED:CAPS" href="gmime/GMimeCertificate.html#GMIME-CERTIFICATE-TRUST-UNDEFINED:CAPS"> +<ANCHOR id="GMIME-CERTIFICATE-TRUST-MARGINAL:CAPS" href="gmime/GMimeCertificate.html#GMIME-CERTIFICATE-TRUST-MARGINAL:CAPS"> +<ANCHOR id="GMIME-CERTIFICATE-TRUST-FULLY:CAPS" href="gmime/GMimeCertificate.html#GMIME-CERTIFICATE-TRUST-FULLY:CAPS"> +<ANCHOR id="GMIME-CERTIFICATE-TRUST-ULTIMATE:CAPS" href="gmime/GMimeCertificate.html#GMIME-CERTIFICATE-TRUST-ULTIMATE:CAPS"> +<ANCHOR id="GMimeCertificate-struct" href="gmime/GMimeCertificate.html#GMimeCertificate-struct"> +<ANCHOR id="g-mime-certificate-new" href="gmime/GMimeCertificate.html#g-mime-certificate-new"> +<ANCHOR id="g-mime-certificate-get-pubkey-algo" href="gmime/GMimeCertificate.html#g-mime-certificate-get-pubkey-algo"> +<ANCHOR id="g-mime-certificate-set-pubkey-algo" href="gmime/GMimeCertificate.html#g-mime-certificate-set-pubkey-algo"> +<ANCHOR id="g-mime-certificate-get-digest-algo" href="gmime/GMimeCertificate.html#g-mime-certificate-get-digest-algo"> +<ANCHOR id="g-mime-certificate-set-digest-algo" href="gmime/GMimeCertificate.html#g-mime-certificate-set-digest-algo"> +<ANCHOR id="g-mime-certificate-get-issuer-serial" href="gmime/GMimeCertificate.html#g-mime-certificate-get-issuer-serial"> +<ANCHOR id="g-mime-certificate-set-issuer-serial" href="gmime/GMimeCertificate.html#g-mime-certificate-set-issuer-serial"> +<ANCHOR id="g-mime-certificate-get-issuer-name" href="gmime/GMimeCertificate.html#g-mime-certificate-get-issuer-name"> +<ANCHOR id="g-mime-certificate-set-issuer-name" href="gmime/GMimeCertificate.html#g-mime-certificate-set-issuer-name"> +<ANCHOR id="g-mime-certificate-get-fingerprint" href="gmime/GMimeCertificate.html#g-mime-certificate-get-fingerprint"> +<ANCHOR id="g-mime-certificate-set-fingerprint" href="gmime/GMimeCertificate.html#g-mime-certificate-set-fingerprint"> +<ANCHOR id="g-mime-certificate-get-created" href="gmime/GMimeCertificate.html#g-mime-certificate-get-created"> +<ANCHOR id="g-mime-certificate-set-created" href="gmime/GMimeCertificate.html#g-mime-certificate-set-created"> +<ANCHOR id="g-mime-certificate-get-expires" href="gmime/GMimeCertificate.html#g-mime-certificate-get-expires"> +<ANCHOR id="g-mime-certificate-set-expires" href="gmime/GMimeCertificate.html#g-mime-certificate-set-expires"> +<ANCHOR id="g-mime-certificate-get-key-id" href="gmime/GMimeCertificate.html#g-mime-certificate-get-key-id"> +<ANCHOR id="g-mime-certificate-set-key-id" href="gmime/GMimeCertificate.html#g-mime-certificate-set-key-id"> +<ANCHOR id="g-mime-certificate-get-trust" href="gmime/GMimeCertificate.html#g-mime-certificate-get-trust"> +<ANCHOR id="g-mime-certificate-set-trust" href="gmime/GMimeCertificate.html#g-mime-certificate-set-trust"> +<ANCHOR id="g-mime-certificate-get-email" href="gmime/GMimeCertificate.html#g-mime-certificate-get-email"> +<ANCHOR id="g-mime-certificate-set-email" href="gmime/GMimeCertificate.html#g-mime-certificate-set-email"> +<ANCHOR id="g-mime-certificate-get-name" href="gmime/GMimeCertificate.html#g-mime-certificate-get-name"> +<ANCHOR id="g-mime-certificate-set-name" href="gmime/GMimeCertificate.html#g-mime-certificate-set-name"> +<ANCHOR id="GMimeCertificateList-struct" href="gmime/GMimeCertificate.html#GMimeCertificateList-struct"> +<ANCHOR id="g-mime-certificate-list-new" href="gmime/GMimeCertificate.html#g-mime-certificate-list-new"> +<ANCHOR id="g-mime-certificate-list-length" href="gmime/GMimeCertificate.html#g-mime-certificate-list-length"> +<ANCHOR id="g-mime-certificate-list-clear" href="gmime/GMimeCertificate.html#g-mime-certificate-list-clear"> +<ANCHOR id="g-mime-certificate-list-add" href="gmime/GMimeCertificate.html#g-mime-certificate-list-add"> +<ANCHOR id="g-mime-certificate-list-insert" href="gmime/GMimeCertificate.html#g-mime-certificate-list-insert"> +<ANCHOR id="g-mime-certificate-list-remove" href="gmime/GMimeCertificate.html#g-mime-certificate-list-remove"> +<ANCHOR id="g-mime-certificate-list-remove-at" href="gmime/GMimeCertificate.html#g-mime-certificate-list-remove-at"> +<ANCHOR id="g-mime-certificate-list-contains" href="gmime/GMimeCertificate.html#g-mime-certificate-list-contains"> +<ANCHOR id="g-mime-certificate-list-index-of" href="gmime/GMimeCertificate.html#g-mime-certificate-list-index-of"> +<ANCHOR id="g-mime-certificate-list-get-certificate" href="gmime/GMimeCertificate.html#g-mime-certificate-list-get-certificate"> +<ANCHOR id="g-mime-certificate-list-set-certificate" href="gmime/GMimeCertificate.html#g-mime-certificate-list-set-certificate"> +<ANCHOR id="GMimeSignature" href="gmime/GMimeSignature.html"> +<ANCHOR id="GMimeSignature.synopsis" href="gmime/GMimeSignature.html#GMimeSignature.synopsis"> +<ANCHOR id="GMimeSignatureList" href="gmime/GMimeSignature.html#GMimeSignatureList"> +<ANCHOR id="GMimeSignature.object-hierarchy" href="gmime/GMimeSignature.html#GMimeSignature.object-hierarchy"> +<ANCHOR id="GMimeSignature.description" href="gmime/GMimeSignature.html#GMimeSignature.description"> +<ANCHOR id="GMimeSignature.details" href="gmime/GMimeSignature.html#GMimeSignature.details"> +<ANCHOR id="GMimeSignatureStatus" href="gmime/GMimeSignature.html#GMimeSignatureStatus"> +<ANCHOR id="GMIME-SIGNATURE-STATUS-GOOD:CAPS" href="gmime/GMimeSignature.html#GMIME-SIGNATURE-STATUS-GOOD:CAPS"> +<ANCHOR id="GMIME-SIGNATURE-STATUS-ERROR:CAPS" href="gmime/GMimeSignature.html#GMIME-SIGNATURE-STATUS-ERROR:CAPS"> +<ANCHOR id="GMIME-SIGNATURE-STATUS-BAD:CAPS" href="gmime/GMimeSignature.html#GMIME-SIGNATURE-STATUS-BAD:CAPS"> +<ANCHOR id="GMimeSignatureError" href="gmime/GMimeSignature.html#GMimeSignatureError"> +<ANCHOR id="GMIME-SIGNATURE-ERROR-NONE:CAPS" href="gmime/GMimeSignature.html#GMIME-SIGNATURE-ERROR-NONE:CAPS"> +<ANCHOR id="GMIME-SIGNATURE-ERROR-EXPSIG:CAPS" href="gmime/GMimeSignature.html#GMIME-SIGNATURE-ERROR-EXPSIG:CAPS"> +<ANCHOR id="GMIME-SIGNATURE-ERROR-NO-PUBKEY:CAPS" href="gmime/GMimeSignature.html#GMIME-SIGNATURE-ERROR-NO-PUBKEY:CAPS"> +<ANCHOR id="GMIME-SIGNATURE-ERROR-EXPKEYSIG:CAPS" href="gmime/GMimeSignature.html#GMIME-SIGNATURE-ERROR-EXPKEYSIG:CAPS"> +<ANCHOR id="GMIME-SIGNATURE-ERROR-REVKEYSIG:CAPS" href="gmime/GMimeSignature.html#GMIME-SIGNATURE-ERROR-REVKEYSIG:CAPS"> +<ANCHOR id="GMIME-SIGNATURE-ERROR-UNSUPP-ALGO:CAPS" href="gmime/GMimeSignature.html#GMIME-SIGNATURE-ERROR-UNSUPP-ALGO:CAPS"> +<ANCHOR id="GMimeSignature-struct" href="gmime/GMimeSignature.html#GMimeSignature-struct"> +<ANCHOR id="g-mime-signature-new" href="gmime/GMimeSignature.html#g-mime-signature-new"> +<ANCHOR id="g-mime-signature-get-certificate" href="gmime/GMimeSignature.html#g-mime-signature-get-certificate"> +<ANCHOR id="g-mime-signature-set-certificate" href="gmime/GMimeSignature.html#g-mime-signature-set-certificate"> +<ANCHOR id="g-mime-signature-get-status" href="gmime/GMimeSignature.html#g-mime-signature-get-status"> +<ANCHOR id="g-mime-signature-set-status" href="gmime/GMimeSignature.html#g-mime-signature-set-status"> +<ANCHOR id="g-mime-signature-get-errors" href="gmime/GMimeSignature.html#g-mime-signature-get-errors"> +<ANCHOR id="g-mime-signature-set-errors" href="gmime/GMimeSignature.html#g-mime-signature-set-errors"> +<ANCHOR id="g-mime-signature-get-created" href="gmime/GMimeSignature.html#g-mime-signature-get-created"> +<ANCHOR id="g-mime-signature-set-created" href="gmime/GMimeSignature.html#g-mime-signature-set-created"> +<ANCHOR id="g-mime-signature-get-expires" href="gmime/GMimeSignature.html#g-mime-signature-get-expires"> +<ANCHOR id="g-mime-signature-set-expires" href="gmime/GMimeSignature.html#g-mime-signature-set-expires"> +<ANCHOR id="GMimeSignatureList-struct" href="gmime/GMimeSignature.html#GMimeSignatureList-struct"> +<ANCHOR id="g-mime-signature-list-new" href="gmime/GMimeSignature.html#g-mime-signature-list-new"> +<ANCHOR id="g-mime-signature-list-length" href="gmime/GMimeSignature.html#g-mime-signature-list-length"> +<ANCHOR id="g-mime-signature-list-clear" href="gmime/GMimeSignature.html#g-mime-signature-list-clear"> +<ANCHOR id="g-mime-signature-list-add" href="gmime/GMimeSignature.html#g-mime-signature-list-add"> +<ANCHOR id="g-mime-signature-list-insert" href="gmime/GMimeSignature.html#g-mime-signature-list-insert"> +<ANCHOR id="g-mime-signature-list-remove" href="gmime/GMimeSignature.html#g-mime-signature-list-remove"> +<ANCHOR id="g-mime-signature-list-remove-at" href="gmime/GMimeSignature.html#g-mime-signature-list-remove-at"> +<ANCHOR id="g-mime-signature-list-contains" href="gmime/GMimeSignature.html#g-mime-signature-list-contains"> +<ANCHOR id="g-mime-signature-list-index-of" href="gmime/GMimeSignature.html#g-mime-signature-list-index-of"> +<ANCHOR id="g-mime-signature-list-get-signature" href="gmime/GMimeSignature.html#g-mime-signature-list-get-signature"> +<ANCHOR id="g-mime-signature-list-set-signature" href="gmime/GMimeSignature.html#g-mime-signature-list-set-signature"> +<ANCHOR id="GMimeCryptoContext" href="gmime/GMimeCryptoContext.html"> +<ANCHOR id="GMimeCryptoContext.synopsis" href="gmime/GMimeCryptoContext.html#GMimeCryptoContext.synopsis"> +<ANCHOR id="GMimeCryptoContext.object-hierarchy" href="gmime/GMimeCryptoContext.html#GMimeCryptoContext.object-hierarchy"> +<ANCHOR id="GMimeCryptoContext.description" href="gmime/GMimeCryptoContext.html#GMimeCryptoContext.description"> +<ANCHOR id="GMimeCryptoContext.details" href="gmime/GMimeCryptoContext.html#GMimeCryptoContext.details"> +<ANCHOR id="GMimePasswordRequestFunc" href="gmime/GMimeCryptoContext.html#GMimePasswordRequestFunc"> +<ANCHOR id="GMimeCryptoContext-struct" href="gmime/GMimeCryptoContext.html#GMimeCryptoContext-struct"> +<ANCHOR id="g-mime-crypto-context-set-request-password" href="gmime/GMimeCryptoContext.html#g-mime-crypto-context-set-request-password"> +<ANCHOR id="g-mime-crypto-context-get-signature-protocol" href="gmime/GMimeCryptoContext.html#g-mime-crypto-context-get-signature-protocol"> +<ANCHOR id="g-mime-crypto-context-get-encryption-protocol" href="gmime/GMimeCryptoContext.html#g-mime-crypto-context-get-encryption-protocol"> +<ANCHOR id="g-mime-crypto-context-get-key-exchange-protocol" href="gmime/GMimeCryptoContext.html#g-mime-crypto-context-get-key-exchange-protocol"> +<ANCHOR id="g-mime-crypto-context-digest-id" href="gmime/GMimeCryptoContext.html#g-mime-crypto-context-digest-id"> +<ANCHOR id="g-mime-crypto-context-digest-name" href="gmime/GMimeCryptoContext.html#g-mime-crypto-context-digest-name"> +<ANCHOR id="g-mime-crypto-context-sign" href="gmime/GMimeCryptoContext.html#g-mime-crypto-context-sign"> +<ANCHOR id="g-mime-crypto-context-verify" href="gmime/GMimeCryptoContext.html#g-mime-crypto-context-verify"> +<ANCHOR id="g-mime-crypto-context-encrypt" href="gmime/GMimeCryptoContext.html#g-mime-crypto-context-encrypt"> +<ANCHOR id="g-mime-crypto-context-decrypt" href="gmime/GMimeCryptoContext.html#g-mime-crypto-context-decrypt"> +<ANCHOR id="g-mime-crypto-context-import-keys" href="gmime/GMimeCryptoContext.html#g-mime-crypto-context-import-keys"> +<ANCHOR id="g-mime-crypto-context-export-keys" href="gmime/GMimeCryptoContext.html#g-mime-crypto-context-export-keys"> +<ANCHOR id="GMimeCipherAlgo" href="gmime/GMimeCryptoContext.html#GMimeCipherAlgo"> +<ANCHOR id="GMIME-CIPHER-ALGO-DEFAULT:CAPS" href="gmime/GMimeCryptoContext.html#GMIME-CIPHER-ALGO-DEFAULT:CAPS"> +<ANCHOR id="GMIME-CIPHER-ALGO-IDEA:CAPS" href="gmime/GMimeCryptoContext.html#GMIME-CIPHER-ALGO-IDEA:CAPS"> +<ANCHOR id="GMIME-CIPHER-ALGO-3DES:CAPS" href="gmime/GMimeCryptoContext.html#GMIME-CIPHER-ALGO-3DES:CAPS"> +<ANCHOR id="GMIME-CIPHER-ALGO-CAST5:CAPS" href="gmime/GMimeCryptoContext.html#GMIME-CIPHER-ALGO-CAST5:CAPS"> +<ANCHOR id="GMIME-CIPHER-ALGO-BLOWFISH:CAPS" href="gmime/GMimeCryptoContext.html#GMIME-CIPHER-ALGO-BLOWFISH:CAPS"> +<ANCHOR id="GMIME-CIPHER-ALGO-AES:CAPS" href="gmime/GMimeCryptoContext.html#GMIME-CIPHER-ALGO-AES:CAPS"> +<ANCHOR id="GMIME-CIPHER-ALGO-AES192:CAPS" href="gmime/GMimeCryptoContext.html#GMIME-CIPHER-ALGO-AES192:CAPS"> +<ANCHOR id="GMIME-CIPHER-ALGO-AES256:CAPS" href="gmime/GMimeCryptoContext.html#GMIME-CIPHER-ALGO-AES256:CAPS"> +<ANCHOR id="GMIME-CIPHER-ALGO-TWOFISH:CAPS" href="gmime/GMimeCryptoContext.html#GMIME-CIPHER-ALGO-TWOFISH:CAPS"> +<ANCHOR id="GMIME-CIPHER-ALGO-CAMELLIA128:CAPS" href="gmime/GMimeCryptoContext.html#GMIME-CIPHER-ALGO-CAMELLIA128:CAPS"> +<ANCHOR id="GMIME-CIPHER-ALGO-CAMELLIA192:CAPS" href="gmime/GMimeCryptoContext.html#GMIME-CIPHER-ALGO-CAMELLIA192:CAPS"> +<ANCHOR id="GMIME-CIPHER-ALGO-CAMELLIA256:CAPS" href="gmime/GMimeCryptoContext.html#GMIME-CIPHER-ALGO-CAMELLIA256:CAPS"> +<ANCHOR id="GMimeDecryptResult" href="gmime/GMimeCryptoContext.html#GMimeDecryptResult"> +<ANCHOR id="g-mime-decrypt-result-new" href="gmime/GMimeCryptoContext.html#g-mime-decrypt-result-new"> +<ANCHOR id="g-mime-decrypt-result-get-recipients" href="gmime/GMimeCryptoContext.html#g-mime-decrypt-result-get-recipients"> +<ANCHOR id="g-mime-decrypt-result-set-recipients" href="gmime/GMimeCryptoContext.html#g-mime-decrypt-result-set-recipients"> +<ANCHOR id="g-mime-decrypt-result-get-signatures" href="gmime/GMimeCryptoContext.html#g-mime-decrypt-result-get-signatures"> +<ANCHOR id="g-mime-decrypt-result-set-signatures" href="gmime/GMimeCryptoContext.html#g-mime-decrypt-result-set-signatures"> +<ANCHOR id="g-mime-decrypt-result-get-cipher" href="gmime/GMimeCryptoContext.html#g-mime-decrypt-result-get-cipher"> +<ANCHOR id="g-mime-decrypt-result-set-cipher" href="gmime/GMimeCryptoContext.html#g-mime-decrypt-result-set-cipher"> +<ANCHOR id="g-mime-decrypt-result-get-mdc" href="gmime/GMimeCryptoContext.html#g-mime-decrypt-result-get-mdc"> +<ANCHOR id="g-mime-decrypt-result-set-mdc" href="gmime/GMimeCryptoContext.html#g-mime-decrypt-result-set-mdc"> +<ANCHOR id="GMimeGpgContext" href="gmime/GMimeGpgContext.html"> +<ANCHOR id="GMimeGpgContext.synopsis" href="gmime/GMimeGpgContext.html#GMimeGpgContext.synopsis"> +<ANCHOR id="GMimeGpgContext.object-hierarchy" href="gmime/GMimeGpgContext.html#GMimeGpgContext.object-hierarchy"> +<ANCHOR id="GMimeGpgContext.description" href="gmime/GMimeGpgContext.html#GMimeGpgContext.description"> +<ANCHOR id="GMimeGpgContext.details" href="gmime/GMimeGpgContext.html#GMimeGpgContext.details"> +<ANCHOR id="GMimeGpgContext-struct" href="gmime/GMimeGpgContext.html#GMimeGpgContext-struct"> +<ANCHOR id="g-mime-gpg-context-new" href="gmime/GMimeGpgContext.html#g-mime-gpg-context-new"> +<ANCHOR id="g-mime-gpg-context-get-always-trust" href="gmime/GMimeGpgContext.html#g-mime-gpg-context-get-always-trust"> +<ANCHOR id="g-mime-gpg-context-set-always-trust" href="gmime/GMimeGpgContext.html#g-mime-gpg-context-set-always-trust"> +<ANCHOR id="g-mime-gpg-context-get-auto-key-retrieve" href="gmime/GMimeGpgContext.html#g-mime-gpg-context-get-auto-key-retrieve"> +<ANCHOR id="g-mime-gpg-context-set-auto-key-retrieve" href="gmime/GMimeGpgContext.html#g-mime-gpg-context-set-auto-key-retrieve"> +<ANCHOR id="g-mime-gpg-context-get-use-agent" href="gmime/GMimeGpgContext.html#g-mime-gpg-context-get-use-agent"> +<ANCHOR id="g-mime-gpg-context-set-use-agent" href="gmime/GMimeGpgContext.html#g-mime-gpg-context-set-use-agent"> +<ANCHOR id="GMimeGpgContext.see-also" href="gmime/GMimeGpgContext.html#GMimeGpgContext.see-also"> +<ANCHOR id="GMimePkcs7Context" href="gmime/GMimePkcs7Context.html"> +<ANCHOR id="GMimePkcs7Context.synopsis" href="gmime/GMimePkcs7Context.html#GMimePkcs7Context.synopsis"> +<ANCHOR id="GMimePkcs7Context.object-hierarchy" href="gmime/GMimePkcs7Context.html#GMimePkcs7Context.object-hierarchy"> +<ANCHOR id="GMimePkcs7Context.description" href="gmime/GMimePkcs7Context.html#GMimePkcs7Context.description"> +<ANCHOR id="GMimePkcs7Context.details" href="gmime/GMimePkcs7Context.html#GMimePkcs7Context.details"> +<ANCHOR id="GMimePkcs7Context-struct" href="gmime/GMimePkcs7Context.html#GMimePkcs7Context-struct"> +<ANCHOR id="g-mime-pkcs7-context-new" href="gmime/GMimePkcs7Context.html#g-mime-pkcs7-context-new"> +<ANCHOR id="g-mime-pkcs7-context-get-always-trust" href="gmime/GMimePkcs7Context.html#g-mime-pkcs7-context-get-always-trust"> +<ANCHOR id="g-mime-pkcs7-context-set-always-trust" href="gmime/GMimePkcs7Context.html#g-mime-pkcs7-context-set-always-trust"> +<ANCHOR id="GMimePkcs7Context.see-also" href="gmime/GMimePkcs7Context.html#GMimePkcs7Context.see-also"> diff --git a/docs/reference/html/left.png b/docs/reference/html/left.png Binary files differnew file mode 100644 index 0000000..48cab27 --- /dev/null +++ b/docs/reference/html/left.png diff --git a/docs/reference/html/right.png b/docs/reference/html/right.png Binary files differnew file mode 100644 index 0000000..ed55207 --- /dev/null +++ b/docs/reference/html/right.png diff --git a/docs/reference/html/style.css b/docs/reference/html/style.css new file mode 100644 index 0000000..d6f6c26 --- /dev/null +++ b/docs/reference/html/style.css @@ -0,0 +1,266 @@ +.synopsis, .classsynopsis +{ + /* tango:aluminium 1/2 */ + background: #eeeeec; + border: solid 1px #d3d7cf; + padding: 0.5em; +} +.programlisting +{ + /* tango:sky blue 0/1 */ + background: #e6f3ff; + border: solid 1px #729fcf; + padding: 0.5em; +} +.variablelist +{ + padding: 4px; + margin-left: 3em; +} +.variablelist td:first-child +{ + vertical-align: top; +} + +@media screen { + sup a.footnote + { + position: relative; + top: 0em ! important; + + } + /* this is needed so that the local anchors are displayed below the naviagtion */ + div.footnote a[name], div.refnamediv a[name], div.refsect1 a[name], div.refsect2 a[name], div.index a[name], div.glossary a[name], div.sect1 a[name] + { + display: inline-block; + position: relative; + top:-5em; + } + /* this seems to be a bug in the xsl style sheets when generating indexes */ + div.index div.index + { + top: 0em; + } + /* make space for the fixed navigation bar and add space at the bottom so that + * link targets appear somewhat close to top + */ + body + { + padding-top: 3.2em; + padding-bottom: 20em; + } + /* style and size the navigation bar */ + table.navigation#top + { + position: fixed; + /* tango:scarlet red 0/1 */ + background: #ffe6e6; + border: solid 1px #ef2929; + margin-top: 0; + margin-bottom: 0; + top: 0; + left: 0; + height: 3em; + z-index: 10; + } + .navigation a, .navigation a:visited + { + /* tango:scarlet red 3 */ + color: #a40000; + } + .navigation a:hover + { + /* tango:scarlet red 1 */ + color: #ef2929; + } + td.shortcuts + { + /* tango:scarlet red 1 */ + color: #ef2929; + font-size: 80%; + white-space: nowrap; + } +} +@media print { + table.navigation { + visibility: collapse; + display: none; + } + div.titlepage table.navigation { + visibility: visible; + display: table; + /* tango:scarlet red 0/1 */ + background: #ffe6e6; + border: solid 1px #ef2929; + margin-top: 0; + margin-bottom: 0; + top: 0; + left: 0; + height: 3em; + } +} + +.navigation .title +{ + font-size: 200%; +} + +div.gallery-float +{ + float: left; + padding: 10px; +} +div.gallery-float img +{ + border-style: none; +} +div.gallery-spacer +{ + clear: both; +} + +a, a:visited +{ + text-decoration: none; + /* tango:sky blue 2 */ + color: #3465a4; +} +a:hover +{ + text-decoration: underline; + /* tango:sky blue 1 */ + color: #729fcf; +} + +div.table table +{ + border-collapse: collapse; + border-spacing: 0px; + /* tango:aluminium 3 */ + border: solid 1px #babdb6; +} + +div.table table td, div.table table th +{ + /* tango:aluminium 3 */ + border: solid 1px #babdb6; + padding: 3px; + vertical-align: top; +} + +div.table table th +{ + /* tango:aluminium 2 */ + background-color: #d3d7cf; +} + +hr +{ + /* tango:aluminium 3 */ + color: #babdb6; + background: #babdb6; + border: none 0px; + height: 1px; + clear: both; +} + +.footer +{ + padding-top: 3.5em; + /* tango:aluminium 3 */ + color: #babdb6; + text-align: center; + font-size: 80%; +} + +.warning +{ + /* tango:orange 0/1 */ + background: #ffeed9; + border-color: #ffb04f; +} +.note +{ + /* tango:chameleon 0/0.5 */ + background: #d8ffb2; + border-color: #abf562; +} +.note, .warning +{ + padding: 0.5em; + border-width: 1px; + border-style: solid; +} +.note h3, .warning h3 +{ + margin-top: 0.0em +} +.note p, .warning p +{ + margin-bottom: 0.0em +} + +/* blob links */ +h2 .extralinks, h3 .extralinks +{ + float: right; + /* tango:aluminium 3 */ + color: #babdb6; + font-size: 80%; + font-weight: normal; +} + +.annotation +{ + /* tango:aluminium 5 */ + color: #555753; + font-size: 80%; + font-weight: normal; +} + +/* code listings */ + +.listing_code .programlisting .cbracket { color: #a40000; } /* tango: scarlet red 3 */ +.listing_code .programlisting .comment { color: #a1a39d; } /* tango: aluminium 4 */ +.listing_code .programlisting .function { color: #000000; font-weight: bold; } +.listing_code .programlisting .function a { color: #11326b; font-weight: bold; } /* tango: sky blue 4 */ +.listing_code .programlisting .keyword { color: #4e9a06; } /* tango: chameleon 3 */ +.listing_code .programlisting .linenum { color: #babdb6; } /* tango: aluminium 3 */ +.listing_code .programlisting .normal { color: #000000; } +.listing_code .programlisting .number { color: #75507b; } /* tango: plum 2 */ +.listing_code .programlisting .preproc { color: #204a87; } /* tango: sky blue 3 */ +.listing_code .programlisting .string { color: #c17d11; } /* tango: chocolate 2 */ +.listing_code .programlisting .type { color: #000000; } +.listing_code .programlisting .type a { color: #11326b; } /* tango: sky blue 4 */ +.listing_code .programlisting .symbol { color: #ce5c00; } /* tango: orange 3 */ + +.listing_frame { + /* tango:sky blue 1 */ + border: solid 1px #729fcf; + padding: 0px; +} + +.listing_lines, .listing_code { + margin-top: 0px; + margin-bottom: 0px; + padding: 0.5em; +} +.listing_lines { + /* tango:sky blue 0.5 */ + background: #a6c5e3; + /* tango:aluminium 6 */ + color: #2e3436; +} +.listing_code { + /* tango:sky blue 0 */ + background: #e6f3ff; +} +.listing_code .programlisting { + /* override from previous */ + border: none 0px; + padding: 0px; +} +.listing_lines pre, .listing_code pre { + margin: 0px; +} + diff --git a/docs/reference/html/up.png b/docs/reference/html/up.png Binary files differnew file mode 100644 index 0000000..8eb591f --- /dev/null +++ b/docs/reference/html/up.png diff --git a/docs/reference/question_index.sgml b/docs/reference/question_index.sgml new file mode 100644 index 0000000..8372600 --- /dev/null +++ b/docs/reference/question_index.sgml @@ -0,0 +1,81 @@ +<refentry id="gmime-question-index" revision="1 Feb 2003"> + <refmeta> + <refentrytitle>Frequently Asked Questions</refentrytitle> + <manvolnum>3</manvolnum> + <refmiscinfo>Frequently Asked Questions</refmiscinfo> + </refmeta> + <refnamediv> + <refname>Frequently Asked Questions</refname> + <refpurpose> +Find answers to common questions in the GMime manual +</refpurpose> + </refnamediv> + <refsect1> + <title>Questions and Answers</title> + <para>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. + </para> + <qandaset> + <qandadiv> + <title>General</title> + <qandaentry> + <question><para>Where can I get help with GMime, submit a bug report, or make a feature request?</para></question> + <answer> + <para>See the <link + linkend="gmime-resources">documentation on this + topic</link>.</para> + </answer> + </qandaentry> + <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> + </answer> + </qandaentry> + <qandaentry> + <question><para>How does memory management work in GMime? Should I free data returned from functions?</para></question> + <answer> + <para>Most accessor functions return a pointer to internal + members. When these internal members are objects + themselves (e.g. subclasses + of <ulink url="http://developer.gnome.org/doc/API/2.0/gobject/gobject-The-Base-Object-Type.html">GObject</ulink>), + there is no need to unref them unless otherwise stated in + the documentation for that particular function.</para> + <para>For accessor functions that return strings, they will be + declared "const" if they should not be freed. Non-const + strings should be freed with <ulink + url="http://developer.gnome.org/doc/API/2.0/glib/glib-Memory-Allocation.html#g-free">g_free()</ulink>.</para> + </answer> + </qandaentry> + <qandaentry> + <question><para>How do I use GMime with threads?</para></question> + <answer> + <para>First, read the <ulink + url="http://developer.gnome.org/doc/API/2.0/glib/glib-Threads.html">GThread</ulink> documentation for + portable threading primitives.</para> + <para>Secondly, all functions + in <link linkend="gmime-charset">gmime-charset</link>, <link linkend="gmime-iconv">gmime-iconv</link> + and <link linkend="gmime-utils">gmime-utils</link> should + be thread-safe. Objects subclassing + <ulink url="http://developer.gnome.org/doc/API/2.0/gobject/gobject-The-Base-Object-Type.html">GObject</ulink> + are not. This means that you'll have to do your own mutex + locking if you want to access the same GObjects from + multiple threads. + </para> + </answer> + </qandaentry> + <qandaentry> + <question><para>How do I use GMime with C++?</para></question> + <answer> + <para>The GMime header files use the subset of C that's + also valid C++, so you can simply use the normal GMime API + in a C++ program.</para> + </answer> + </qandaentry> + </qandadiv> + </qandaset> + </refsect1> +</refentry> diff --git a/docs/reference/resources.sgml b/docs/reference/resources.sgml new file mode 100644 index 0000000..7904140 --- /dev/null +++ b/docs/reference/resources.sgml @@ -0,0 +1,57 @@ +<refentry id="gmime-resources" revision="1 Feb 2003"> + <refmeta> + <refentrytitle>Mailing lists and bug reports</refentrytitle> + <manvolnum>3</manvolnum> + <refmiscinfo>Mailing lists and bug reports</refmiscinfo> + </refmeta> + <refnamediv> + <refname>Mailing lists and bug reports</refname> + <refpurpose> +Getting help with GMime +</refpurpose> + </refnamediv> + <refsect1> + <title>Filing a bug report or feature request</title> + <para> +If you encounter a bug, misfeature, or missing feature in GMime, please +file a bug report at +<ulink url="http://bugzilla.gnome.org">http://bugzilla.gnome.org</ulink>. +We'd also appreciate reports of incomplete or misleading information in +the GMime documentation; file those against the "docs" component of the +"gmime" product in Bugzilla. +</para> + <para> +The bug tracker should definitely be used for feature requests, it's +not only for bugs. We track all GMime development in Bugzilla, so it's +the way to be sure the GMime developers won't forget about an issue. +</para> + </refsect1> + <refsect1> + <title>Submitting Patches</title> + <para> +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 +patch generated by the <command>diff</command> utility, using the +<option>-u</option> option to make the patch more readable. All +patches must be offered under the terms of +the <ulink url="http://www.gnu.org/licenses/lgpl-2.1.txt">LGPLv2.1</ulink> +license, so be sure you are authorized to give us the patch under +those terms. +</para> + <para> +If you want to discuss your patch before or after developing it, mail +<ulink url="mailto:gmime-devel-list@gnome.org">gmime-devel-list@gnome.org</ulink>, +but be sure to file +the <ulink url="http://bugzilla.gnome.org">Bugzilla</ulink> report as +well, this way it's less likely to slip through the cracks. +</para> + </refsect1> + <refsect1> + <title>Mailing lists</title> + <para>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 + at <ulink url="http://mail.gnome.org/mailman/listinfo/gmime-devel-list">http://mail.gnome.org/mailman/listinfo/gmime-devel-list</ulink>. +</para> + </refsect1> +</refentry> diff --git a/docs/reference/streams.sgml b/docs/reference/streams.sgml new file mode 100644 index 0000000..de2926f --- /dev/null +++ b/docs/reference/streams.sgml @@ -0,0 +1,73 @@ +<refentry id="gmime-streams"> + <refmeta> + <refentrytitle>GMime Streams</refentrytitle> + <refmiscinfo>GMime Library</refmiscinfo> + </refmeta> + + <refnamediv> + <refname>GMime Streams</refname> + <refpurpose>How to use GMime Streams</refpurpose> + </refnamediv> + <refsect1 id="stream-overview"> + <title>Overview of Streams</title> + <para>Streams are the fundamental method for reading and writing + data used by GMime. You'll probably notice that the basic API is + similar to that of the low-level Unix I/O layer (read(), write(), + lseek(), etc) with some additional nicities such as a printf-like + function.</para> + + <para>The three (3) basic stream types are: GMimeStreamFile, + GMimeStreamFs and GMimeStreamMem. You can manipulate all three + streams using the GMimeStream interfaces. In addition, some of + these streams have extended interfaces to allow more fine grained + manipulation.</para> + + <para>GMimeStreamFile and GMimeStreamFs are very similar in that + they are both meant for reading and writing data to the file + system (in the form of files). Since GMimeStreamFile is an + abstracted layer above the standard libc FILE type, one of the + added benefits is buffered I/O. GMimeStreamFs, on the other hand, + is an abstracted layer above Unix file descriptors. While a + GMimeStreamFs can be used on top of a UNIX socket or pipe, you + must be careful because sockets and pipes are not seekable.</para> + + <para>Unlike the previous 2 stream types, GMimeStreamMem does not + interact with the file system at all (except maybe the swap + partition/file indirectly). Memory streams are handy when you want + reads and writes to be nearly instantaneous and/or if you don't + want to create a temporary file on disk.</para> + + <para>The four (4) advanced stream types are GMimeStreamMmap, + GMimeStreamNull, GMimeStreamBuffer and GMimeStreamFilter.</para> + + <para>Our most simple stream, GMimeStreamNull, is the stream + equivalent of /dev/null on Unix systems. The main difference is + that GMimeStreamNull records the number of bytes written to it - + you may find this useful if you need to know the number of bytes a + GMimeObject (for example) will require.</para> + + <para>GMimeStreamMmap is a memory-mapped stream. This isn't + guarenteed to work on all systems since not all systems support + the POSIX mmap system call, but for those that do - this might + present a faster stream than GMimeStreamFs and/or + GMimeStreamFile. You'll have to do some experimentation to know + for sure.</para> + + <para>The GMimeStreamBuffer can be used on top of any other type + of stream and has 3 modes: block reads, block writes, and cached + reads. Block reads are especially useful if you will be making a + lot of small reads from a stream that accesses the file + system. Block writes are useful for very much the same reason. The + final mode, cached reads, can become memory intensive but can be + very helpful when inheriting from a stream that does not support + seeking (Note: this mode is the least tested so be careful using + it).</para> + + <para>Our final stream type, GMimeStreamFilter, can also be used + on top of another stream. This stream, as you may have guessed, + filters reads and writes to its inherited stream. For example, one + could write a compression filter and apply it to a + GMimeStreamFilter and any further reads or writes would be + (un)compressed.</para> + </refsect1> +</refentry> diff --git a/docs/reference/tmpl/gmime-certificate.sgml b/docs/reference/tmpl/gmime-certificate.sgml new file mode 100644 index 0000000..32d0fff --- /dev/null +++ b/docs/reference/tmpl/gmime-certificate.sgml @@ -0,0 +1,390 @@ +<!-- ##### SECTION Title ##### --> +gmime-certificate + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### ENUM GMimePubKeyAlgo ##### --> +<para> + +</para> + +@GMIME_PUBKEY_ALGO_DEFAULT: +@GMIME_PUBKEY_ALGO_RSA: +@GMIME_PUBKEY_ALGO_RSA_E: +@GMIME_PUBKEY_ALGO_RSA_S: +@GMIME_PUBKEY_ALGO_ELG_E: +@GMIME_PUBKEY_ALGO_DSA: +@GMIME_PUBKEY_ALGO_ELG: + +<!-- ##### ENUM GMimeDigestAlgo ##### --> +<para> + +</para> + +@GMIME_DIGEST_ALGO_DEFAULT: +@GMIME_DIGEST_ALGO_MD5: +@GMIME_DIGEST_ALGO_SHA1: +@GMIME_DIGEST_ALGO_RIPEMD160: +@GMIME_DIGEST_ALGO_MD2: +@GMIME_DIGEST_ALGO_TIGER192: +@GMIME_DIGEST_ALGO_HAVAL5160: +@GMIME_DIGEST_ALGO_SHA256: +@GMIME_DIGEST_ALGO_SHA384: +@GMIME_DIGEST_ALGO_SHA512: +@GMIME_DIGEST_ALGO_SHA224: +@GMIME_DIGEST_ALGO_MD4: + +<!-- ##### ENUM GMimeCertificateTrust ##### --> +<para> + +</para> + +@GMIME_CERTIFICATE_TRUST_NONE: +@GMIME_CERTIFICATE_TRUST_NEVER: +@GMIME_CERTIFICATE_TRUST_UNDEFINED: +@GMIME_CERTIFICATE_TRUST_MARGINAL: +@GMIME_CERTIFICATE_TRUST_FULLY: +@GMIME_CERTIFICATE_TRUST_ULTIMATE: + +<!-- ##### STRUCT GMimeCertificate ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_certificate_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_certificate_get_pubkey_algo ##### --> +<para> + +</para> + +@cert: +@Returns: + + +<!-- ##### FUNCTION g_mime_certificate_set_pubkey_algo ##### --> +<para> + +</para> + +@cert: +@algo: + + +<!-- ##### FUNCTION g_mime_certificate_get_digest_algo ##### --> +<para> + +</para> + +@cert: +@Returns: + + +<!-- ##### FUNCTION g_mime_certificate_set_digest_algo ##### --> +<para> + +</para> + +@cert: +@algo: + + +<!-- ##### FUNCTION g_mime_certificate_get_issuer_serial ##### --> +<para> + +</para> + +@cert: +@Returns: + + +<!-- ##### FUNCTION g_mime_certificate_set_issuer_serial ##### --> +<para> + +</para> + +@cert: +@issuer_serial: + + +<!-- ##### FUNCTION g_mime_certificate_get_issuer_name ##### --> +<para> + +</para> + +@cert: +@Returns: + + +<!-- ##### FUNCTION g_mime_certificate_set_issuer_name ##### --> +<para> + +</para> + +@cert: +@issuer_name: + + +<!-- ##### FUNCTION g_mime_certificate_get_fingerprint ##### --> +<para> + +</para> + +@cert: +@Returns: + + +<!-- ##### FUNCTION g_mime_certificate_set_fingerprint ##### --> +<para> + +</para> + +@cert: +@fingerprint: + + +<!-- ##### FUNCTION g_mime_certificate_get_created ##### --> +<para> + +</para> + +@cert: +@Returns: + + +<!-- ##### FUNCTION g_mime_certificate_set_created ##### --> +<para> + +</para> + +@cert: +@created: + + +<!-- ##### FUNCTION g_mime_certificate_get_expires ##### --> +<para> + +</para> + +@cert: +@Returns: + + +<!-- ##### FUNCTION g_mime_certificate_set_expires ##### --> +<para> + +</para> + +@cert: +@expires: + + +<!-- ##### FUNCTION g_mime_certificate_get_key_id ##### --> +<para> + +</para> + +@cert: +@Returns: + + +<!-- ##### FUNCTION g_mime_certificate_set_key_id ##### --> +<para> + +</para> + +@cert: +@key_id: + + +<!-- ##### FUNCTION g_mime_certificate_get_trust ##### --> +<para> + +</para> + +@cert: +@Returns: + + +<!-- ##### FUNCTION g_mime_certificate_set_trust ##### --> +<para> + +</para> + +@cert: +@trust: + + +<!-- ##### FUNCTION g_mime_certificate_get_email ##### --> +<para> + +</para> + +@cert: +@Returns: + + +<!-- ##### FUNCTION g_mime_certificate_set_email ##### --> +<para> + +</para> + +@cert: +@email: + + +<!-- ##### FUNCTION g_mime_certificate_get_name ##### --> +<para> + +</para> + +@cert: +@Returns: + + +<!-- ##### FUNCTION g_mime_certificate_set_name ##### --> +<para> + +</para> + +@cert: +@name: + + +<!-- ##### STRUCT GMimeCertificateList ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_certificate_list_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_certificate_list_length ##### --> +<para> + +</para> + +@list: +@Returns: + + +<!-- ##### FUNCTION g_mime_certificate_list_clear ##### --> +<para> + +</para> + +@list: + + +<!-- ##### FUNCTION g_mime_certificate_list_add ##### --> +<para> + +</para> + +@list: +@cert: +@Returns: + + +<!-- ##### FUNCTION g_mime_certificate_list_insert ##### --> +<para> + +</para> + +@list: +@index: +@cert: + + +<!-- ##### FUNCTION g_mime_certificate_list_remove ##### --> +<para> + +</para> + +@list: +@cert: +@Returns: + + +<!-- ##### FUNCTION g_mime_certificate_list_remove_at ##### --> +<para> + +</para> + +@list: +@index: +@Returns: + + +<!-- ##### FUNCTION g_mime_certificate_list_contains ##### --> +<para> + +</para> + +@list: +@cert: +@Returns: + + +<!-- ##### FUNCTION g_mime_certificate_list_index_of ##### --> +<para> + +</para> + +@list: +@cert: +@Returns: + + +<!-- ##### FUNCTION g_mime_certificate_list_get_certificate ##### --> +<para> + +</para> + +@list: +@index: +@Returns: + + +<!-- ##### FUNCTION g_mime_certificate_list_set_certificate ##### --> +<para> + +</para> + +@list: +@index: +@cert: + + diff --git a/docs/reference/tmpl/gmime-charset.sgml b/docs/reference/tmpl/gmime-charset.sgml new file mode 100644 index 0000000..381da8a --- /dev/null +++ b/docs/reference/tmpl/gmime-charset.sgml @@ -0,0 +1,184 @@ +<!-- ##### SECTION Title ##### --> +gmime-charset + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeCharset ##### --> +<para> + +</para> + +@mask: +@level: + +<!-- ##### FUNCTION g_mime_charset_map_init ##### --> +<para> + +</para> + +@void: + + +<!-- ##### FUNCTION g_mime_charset_map_shutdown ##### --> +<para> + +</para> + +@void: + + +<!-- ##### FUNCTION g_mime_locale_charset ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_locale_language ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_charset_language ##### --> +<para> + +</para> + +@charset: +@Returns: + + +<!-- ##### FUNCTION g_mime_charset_canon_name ##### --> +<para> + +</para> + +@charset: +@Returns: + + +<!-- ##### FUNCTION g_mime_charset_iconv_name ##### --> +<para> + +</para> + +@charset: +@Returns: + + +<!-- ##### FUNCTION g_mime_charset_name ##### --> +<para> + +</para> + +@charset: +@Returns: + + +<!-- ##### FUNCTION g_mime_charset_locale_name ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_charset_iso_to_windows ##### --> +<para> + +</para> + +@isocharset: +@Returns: + + +<!-- ##### FUNCTION g_mime_charset_init ##### --> +<para> + +</para> + +@charset: + + +<!-- ##### FUNCTION g_mime_charset_step ##### --> +<para> + +</para> + +@charset: +@inbuf: +@inlen: + + +<!-- ##### FUNCTION g_mime_charset_best_name ##### --> +<para> + +</para> + +@charset: +@Returns: + + +<!-- ##### FUNCTION g_mime_charset_best ##### --> +<para> + +</para> + +@inbuf: +@inlen: +@Returns: + + +<!-- ##### FUNCTION g_mime_charset_can_encode ##### --> +<para> + +</para> + +@mask: +@charset: +@text: +@len: +@Returns: + + +<!-- ##### FUNCTION g_mime_set_user_charsets ##### --> +<para> + +</para> + +@charsets: + + +<!-- ##### FUNCTION g_mime_user_charsets ##### --> +<para> + +</para> + +@void: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-cipher-context.sgml b/docs/reference/tmpl/gmime-cipher-context.sgml new file mode 100644 index 0000000..f458d30 --- /dev/null +++ b/docs/reference/tmpl/gmime-cipher-context.sgml @@ -0,0 +1,569 @@ +<!-- ##### SECTION Title ##### --> +gmime-cipher-context + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### USER_FUNCTION GMimePasswordRequestFunc ##### --> +<para> + +</para> + +@ctx: +@user_id: +@prompt_ctx: +@reprompt: +@response: +@err: +@Returns: + + +<!-- ##### ENUM GMimeCipherHash ##### --> +<para> + +</para> + +@GMIME_CIPHER_HASH_DEFAULT: +@GMIME_CIPHER_HASH_MD2: +@GMIME_CIPHER_HASH_MD5: +@GMIME_CIPHER_HASH_SHA1: +@GMIME_CIPHER_HASH_SHA224: +@GMIME_CIPHER_HASH_SHA256: +@GMIME_CIPHER_HASH_SHA384: +@GMIME_CIPHER_HASH_SHA512: +@GMIME_CIPHER_HASH_RIPEMD160: +@GMIME_CIPHER_HASH_TIGER192: +@GMIME_CIPHER_HASH_HAVAL5160: + +<!-- ##### STRUCT GMimeCipherContext ##### --> +<para> + +</para> + + +<!-- ##### STRUCT GMimeSignatureValidity ##### --> +<para> + +</para> + +@status: +@signers: +@details: + +<!-- ##### ENUM GMimeSignatureStatus ##### --> +<para> + +</para> + +@GMIME_SIGNATURE_STATUS_NONE: +@GMIME_SIGNATURE_STATUS_GOOD: +@GMIME_SIGNATURE_STATUS_BAD: +@GMIME_SIGNATURE_STATUS_UNKNOWN: + +<!-- ##### ENUM GMimeSignerStatus ##### --> +<para> + +</para> + +@GMIME_SIGNER_STATUS_NONE: +@GMIME_SIGNER_STATUS_GOOD: +@GMIME_SIGNER_STATUS_BAD: +@GMIME_SIGNER_STATUS_ERROR: + +<!-- ##### ENUM GMimeSignerTrust ##### --> +<para> + +</para> + +@GMIME_SIGNER_TRUST_NONE: +@GMIME_SIGNER_TRUST_NEVER: +@GMIME_SIGNER_TRUST_UNDEFINED: +@GMIME_SIGNER_TRUST_MARGINAL: +@GMIME_SIGNER_TRUST_FULLY: +@GMIME_SIGNER_TRUST_ULTIMATE: + +<!-- ##### ENUM GMimeSignerError ##### --> +<para> + +</para> + +@GMIME_SIGNER_ERROR_NONE: +@GMIME_SIGNER_ERROR_EXPSIG: +@GMIME_SIGNER_ERROR_NO_PUBKEY: +@GMIME_SIGNER_ERROR_EXPKEYSIG: +@GMIME_SIGNER_ERROR_REVKEYSIG: + +<!-- ##### STRUCT GMimeSigner ##### --> +<para> + +</para> + +@next: +@status: +@errors: +@trust: +@unused: +@issuer_serial: +@issuer_name: +@fingerprint: +@sig_created: +@sig_expires: +@key_created: +@key_expires: +@keyid: +@email: +@name: + +<!-- ##### FUNCTION g_mime_cipher_context_set_request_password ##### --> +<para> + +</para> + +@ctx: +@request_passwd: + + +<!-- ##### FUNCTION g_mime_cipher_context_hash_id ##### --> +<para> + +</para> + +@ctx: +@hash: +@Returns: + + +<!-- ##### FUNCTION g_mime_cipher_context_hash_name ##### --> +<para> + +</para> + +@ctx: +@hash: +@Returns: + + +<!-- ##### FUNCTION g_mime_cipher_context_sign ##### --> +<para> + +</para> + +@ctx: +@userid: +@hash: +@istream: +@ostream: +@err: +@Returns: + + +<!-- ##### FUNCTION g_mime_cipher_context_verify ##### --> +<para> + +</para> + +@ctx: +@hash: +@istream: +@sigstream: +@err: +@Returns: + + +<!-- ##### FUNCTION g_mime_cipher_context_encrypt ##### --> +<para> + +</para> + +@ctx: +@sign: +@userid: +@recipients: +@istream: +@ostream: +@err: +@Returns: + + +<!-- ##### FUNCTION g_mime_cipher_context_decrypt ##### --> +<para> + +</para> + +@ctx: +@istream: +@ostream: +@err: +@Returns: + + +<!-- ##### FUNCTION g_mime_cipher_context_import_keys ##### --> +<para> + +</para> + +@ctx: +@istream: +@err: +@Returns: + + +<!-- ##### FUNCTION g_mime_cipher_context_export_keys ##### --> +<para> + +</para> + +@ctx: +@keys: +@ostream: +@err: +@Returns: + + +<!-- ##### FUNCTION g_mime_signer_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_signer_free ##### --> +<para> + +</para> + +@signer: + + +<!-- ##### FUNCTION g_mime_signer_next ##### --> +<para> + +</para> + +@signer: +@Returns: + + +<!-- ##### FUNCTION g_mime_signer_get_status ##### --> +<para> + +</para> + +@signer: +@Returns: + + +<!-- ##### FUNCTION g_mime_signer_set_status ##### --> +<para> + +</para> + +@signer: +@status: + + +<!-- ##### FUNCTION g_mime_signer_get_errors ##### --> +<para> + +</para> + +@signer: +@Returns: + + +<!-- ##### FUNCTION g_mime_signer_set_errors ##### --> +<para> + +</para> + +@signer: +@error: + + +<!-- ##### FUNCTION g_mime_signer_get_trust ##### --> +<para> + +</para> + +@signer: +@Returns: + + +<!-- ##### FUNCTION g_mime_signer_set_trust ##### --> +<para> + +</para> + +@signer: +@trust: + + +<!-- ##### FUNCTION g_mime_signer_get_issuer_serial ##### --> +<para> + +</para> + +@signer: +@Returns: + + +<!-- ##### FUNCTION g_mime_signer_set_issuer_serial ##### --> +<para> + +</para> + +@signer: +@issuer_serial: + + +<!-- ##### FUNCTION g_mime_signer_get_issuer_name ##### --> +<para> + +</para> + +@signer: +@Returns: + + +<!-- ##### FUNCTION g_mime_signer_set_issuer_name ##### --> +<para> + +</para> + +@signer: +@issuer_name: + + +<!-- ##### FUNCTION g_mime_signer_get_fingerprint ##### --> +<para> + +</para> + +@signer: +@Returns: + + +<!-- ##### FUNCTION g_mime_signer_set_fingerprint ##### --> +<para> + +</para> + +@signer: +@fingerprint: + + +<!-- ##### FUNCTION g_mime_signer_get_sig_created ##### --> +<para> + +</para> + +@signer: +@Returns: + + +<!-- ##### FUNCTION g_mime_signer_set_sig_created ##### --> +<para> + +</para> + +@signer: +@created: + + +<!-- ##### FUNCTION g_mime_signer_get_sig_expires ##### --> +<para> + +</para> + +@signer: +@Returns: + + +<!-- ##### FUNCTION g_mime_signer_set_sig_expires ##### --> +<para> + +</para> + +@signer: +@expires: + + +<!-- ##### FUNCTION g_mime_signer_get_key_created ##### --> +<para> + +</para> + +@signer: +@Returns: + + +<!-- ##### FUNCTION g_mime_signer_set_key_created ##### --> +<para> + +</para> + +@signer: +@created: + + +<!-- ##### FUNCTION g_mime_signer_get_key_expires ##### --> +<para> + +</para> + +@signer: +@Returns: + + +<!-- ##### FUNCTION g_mime_signer_set_key_expires ##### --> +<para> + +</para> + +@signer: +@expires: + + +<!-- ##### FUNCTION g_mime_signer_get_key_id ##### --> +<para> + +</para> + +@signer: +@Returns: + + +<!-- ##### FUNCTION g_mime_signer_set_key_id ##### --> +<para> + +</para> + +@signer: +@key_id: + + +<!-- ##### FUNCTION g_mime_signer_get_email ##### --> +<para> + +</para> + +@signer: +@Returns: + + +<!-- ##### FUNCTION g_mime_signer_set_email ##### --> +<para> + +</para> + +@signer: +@email: + + +<!-- ##### FUNCTION g_mime_signer_get_name ##### --> +<para> + +</para> + +@signer: +@Returns: + + +<!-- ##### FUNCTION g_mime_signer_set_name ##### --> +<para> + +</para> + +@signer: +@name: + + +<!-- ##### FUNCTION g_mime_signature_validity_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_signature_validity_free ##### --> +<para> + +</para> + +@validity: + + +<!-- ##### FUNCTION g_mime_signature_validity_set_status ##### --> +<para> + +</para> + +@validity: +@status: + + +<!-- ##### FUNCTION g_mime_signature_validity_get_status ##### --> +<para> + +</para> + +@validity: +@Returns: + + +<!-- ##### FUNCTION g_mime_signature_validity_set_details ##### --> +<para> + +</para> + +@validity: +@details: + + +<!-- ##### FUNCTION g_mime_signature_validity_get_details ##### --> +<para> + +</para> + +@validity: +@Returns: + + +<!-- ##### FUNCTION g_mime_signature_validity_add_signer ##### --> +<para> + +</para> + +@validity: +@signer: + + +<!-- ##### FUNCTION g_mime_signature_validity_get_signers ##### --> +<para> + +</para> + +@validity: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-content-type.sgml b/docs/reference/tmpl/gmime-content-type.sgml new file mode 100644 index 0000000..897dfbf --- /dev/null +++ b/docs/reference/tmpl/gmime-content-type.sgml @@ -0,0 +1,141 @@ +<!-- ##### SECTION Title ##### --> +gmime-content-type + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeContentType ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_content_type_new ##### --> +<para> + +</para> + +@type: +@subtype: +@Returns: + + +<!-- ##### FUNCTION g_mime_content_type_new_from_string ##### --> +<para> + +</para> + +@str: +@Returns: + + +<!-- ##### FUNCTION g_mime_content_type_to_string ##### --> +<para> + +</para> + +@mime_type: +@Returns: + + +<!-- ##### FUNCTION g_mime_content_type_is_type ##### --> +<para> + +</para> + +@mime_type: +@type: +@subtype: +@Returns: + + +<!-- ##### FUNCTION g_mime_content_type_get_media_type ##### --> +<para> + +</para> + +@mime_type: +@Returns: + + +<!-- ##### FUNCTION g_mime_content_type_set_media_type ##### --> +<para> + +</para> + +@mime_type: +@type: + + +<!-- ##### FUNCTION g_mime_content_type_get_media_subtype ##### --> +<para> + +</para> + +@mime_type: +@Returns: + + +<!-- ##### FUNCTION g_mime_content_type_set_media_subtype ##### --> +<para> + +</para> + +@mime_type: +@subtype: + + +<!-- ##### FUNCTION g_mime_content_type_get_params ##### --> +<para> + +</para> + +@mime_type: +@Returns: + + +<!-- ##### FUNCTION g_mime_content_type_set_params ##### --> +<para> + +</para> + +@mime_type: +@params: + + +<!-- ##### FUNCTION g_mime_content_type_get_parameter ##### --> +<para> + +</para> + +@mime_type: +@attribute: +@Returns: + + +<!-- ##### FUNCTION g_mime_content_type_set_parameter ##### --> +<para> + +</para> + +@mime_type: +@attribute: +@value: + + diff --git a/docs/reference/tmpl/gmime-crypto-context.sgml b/docs/reference/tmpl/gmime-crypto-context.sgml new file mode 100644 index 0000000..63ed892 --- /dev/null +++ b/docs/reference/tmpl/gmime-crypto-context.sgml @@ -0,0 +1,286 @@ +<!-- ##### SECTION Title ##### --> +gmime-crypto-context + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### USER_FUNCTION GMimePasswordRequestFunc ##### --> +<para> + +</para> + +@ctx: +@user_id: +@prompt_ctx: +@reprompt: +@response: +@err: +@Returns: + + +<!-- ##### STRUCT GMimeCryptoContext ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_crypto_context_set_request_password ##### --> +<para> + +</para> + +@ctx: +@request_passwd: + + +<!-- ##### FUNCTION g_mime_crypto_context_get_signature_protocol ##### --> +<para> + +</para> + +@ctx: +@Returns: + + +<!-- ##### FUNCTION g_mime_crypto_context_get_encryption_protocol ##### --> +<para> + +</para> + +@ctx: +@Returns: + + +<!-- ##### FUNCTION g_mime_crypto_context_get_key_exchange_protocol ##### --> +<para> + +</para> + +@ctx: +@Returns: + + +<!-- ##### FUNCTION g_mime_crypto_context_digest_id ##### --> +<para> + +</para> + +@ctx: +@name: +@Returns: + + +<!-- ##### FUNCTION g_mime_crypto_context_digest_name ##### --> +<para> + +</para> + +@ctx: +@digest: +@Returns: + + +<!-- ##### FUNCTION g_mime_crypto_context_sign ##### --> +<para> + +</para> + +@ctx: +@userid: +@digest: +@istream: +@ostream: +@err: +@Returns: + + +<!-- ##### FUNCTION g_mime_crypto_context_verify ##### --> +<para> + +</para> + +@ctx: +@digest: +@istream: +@sigstream: +@err: +@Returns: + + +<!-- ##### FUNCTION g_mime_crypto_context_encrypt ##### --> +<para> + +</para> + +@ctx: +@sign: +@userid: +@digest: +@recipients: +@istream: +@ostream: +@err: +@Returns: + + +<!-- ##### FUNCTION g_mime_crypto_context_decrypt ##### --> +<para> + +</para> + +@ctx: +@istream: +@ostream: +@err: +@Returns: + + +<!-- ##### FUNCTION g_mime_crypto_context_import_keys ##### --> +<para> + +</para> + +@ctx: +@istream: +@err: +@Returns: + + +<!-- ##### FUNCTION g_mime_crypto_context_export_keys ##### --> +<para> + +</para> + +@ctx: +@keys: +@ostream: +@err: +@Returns: + + +<!-- ##### ENUM GMimeCipherAlgo ##### --> +<para> + +</para> + +@GMIME_CIPHER_ALGO_DEFAULT: +@GMIME_CIPHER_ALGO_IDEA: +@GMIME_CIPHER_ALGO_3DES: +@GMIME_CIPHER_ALGO_CAST5: +@GMIME_CIPHER_ALGO_BLOWFISH: +@GMIME_CIPHER_ALGO_AES: +@GMIME_CIPHER_ALGO_AES192: +@GMIME_CIPHER_ALGO_AES256: +@GMIME_CIPHER_ALGO_TWOFISH: +@GMIME_CIPHER_ALGO_CAMELLIA128: +@GMIME_CIPHER_ALGO_CAMELLIA192: +@GMIME_CIPHER_ALGO_CAMELLIA256: + +<!-- ##### STRUCT GMimeDecryptResult ##### --> +<para> + +</para> + +@parent_object: +@recipients: +@signatures: +@cipher: +@mdc: + +<!-- ##### FUNCTION g_mime_decrypt_result_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_decrypt_result_get_recipients ##### --> +<para> + +</para> + +@result: +@Returns: + + +<!-- ##### FUNCTION g_mime_decrypt_result_set_recipients ##### --> +<para> + +</para> + +@result: +@recipients: + + +<!-- ##### FUNCTION g_mime_decrypt_result_get_signatures ##### --> +<para> + +</para> + +@result: +@Returns: + + +<!-- ##### FUNCTION g_mime_decrypt_result_set_signatures ##### --> +<para> + +</para> + +@result: +@signatures: + + +<!-- ##### FUNCTION g_mime_decrypt_result_get_cipher ##### --> +<para> + +</para> + +@result: +@Returns: + + +<!-- ##### FUNCTION g_mime_decrypt_result_set_cipher ##### --> +<para> + +</para> + +@result: +@cipher: + + +<!-- ##### FUNCTION g_mime_decrypt_result_get_mdc ##### --> +<para> + +</para> + +@result: +@Returns: + + +<!-- ##### FUNCTION g_mime_decrypt_result_set_mdc ##### --> +<para> + +</para> + +@result: +@mdc: + + diff --git a/docs/reference/tmpl/gmime-data-wrapper.sgml b/docs/reference/tmpl/gmime-data-wrapper.sgml new file mode 100644 index 0000000..5e6a94a --- /dev/null +++ b/docs/reference/tmpl/gmime-data-wrapper.sgml @@ -0,0 +1,93 @@ +<!-- ##### SECTION Title ##### --> +gmime-data-wrapper + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeDataWrapper ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_data_wrapper_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_data_wrapper_new_with_stream ##### --> +<para> + +</para> + +@stream: +@encoding: +@Returns: + + +<!-- ##### FUNCTION g_mime_data_wrapper_set_stream ##### --> +<para> + +</para> + +@wrapper: +@stream: + + +<!-- ##### FUNCTION g_mime_data_wrapper_get_stream ##### --> +<para> + +</para> + +@wrapper: +@Returns: + + +<!-- ##### FUNCTION g_mime_data_wrapper_set_encoding ##### --> +<para> + +</para> + +@wrapper: +@encoding: + + +<!-- ##### FUNCTION g_mime_data_wrapper_get_encoding ##### --> +<para> + +</para> + +@wrapper: +@Returns: + + +<!-- ##### FUNCTION g_mime_data_wrapper_write_to_stream ##### --> +<para> + +</para> + +@wrapper: +@stream: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-disposition.sgml b/docs/reference/tmpl/gmime-disposition.sgml new file mode 100644 index 0000000..0472e20 --- /dev/null +++ b/docs/reference/tmpl/gmime-disposition.sgml @@ -0,0 +1,126 @@ +<!-- ##### SECTION Title ##### --> +gmime-disposition + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO GMIME_DISPOSITION_ATTACHMENT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_DISPOSITION_INLINE ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT GMimeContentDisposition ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_content_disposition_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_content_disposition_new_from_string ##### --> +<para> + +</para> + +@str: +@Returns: + + +<!-- ##### FUNCTION g_mime_content_disposition_set_disposition ##### --> +<para> + +</para> + +@disposition: +@value: + + +<!-- ##### FUNCTION g_mime_content_disposition_get_disposition ##### --> +<para> + +</para> + +@disposition: +@Returns: + + +<!-- ##### FUNCTION g_mime_content_disposition_get_params ##### --> +<para> + +</para> + +@disposition: +@Returns: + + +<!-- ##### FUNCTION g_mime_content_disposition_set_params ##### --> +<para> + +</para> + +@disposition: +@params: + + +<!-- ##### FUNCTION g_mime_content_disposition_set_parameter ##### --> +<para> + +</para> + +@disposition: +@attribute: +@value: + + +<!-- ##### FUNCTION g_mime_content_disposition_get_parameter ##### --> +<para> + +</para> + +@disposition: +@attribute: +@Returns: + + +<!-- ##### FUNCTION g_mime_content_disposition_to_string ##### --> +<para> + +</para> + +@disposition: +@fold: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-encodings.sgml b/docs/reference/tmpl/gmime-encodings.sgml new file mode 100644 index 0000000..0decbaa --- /dev/null +++ b/docs/reference/tmpl/gmime-encodings.sgml @@ -0,0 +1,297 @@ +<!-- ##### SECTION Title ##### --> +gmime-encodings + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### ENUM GMimeContentEncoding ##### --> +<para> + +</para> + +@GMIME_CONTENT_ENCODING_DEFAULT: +@GMIME_CONTENT_ENCODING_7BIT: +@GMIME_CONTENT_ENCODING_8BIT: +@GMIME_CONTENT_ENCODING_BINARY: +@GMIME_CONTENT_ENCODING_BASE64: +@GMIME_CONTENT_ENCODING_QUOTEDPRINTABLE: +@GMIME_CONTENT_ENCODING_UUENCODE: + +<!-- ##### FUNCTION g_mime_content_encoding_from_string ##### --> +<para> + +</para> + +@str: +@Returns: + + +<!-- ##### FUNCTION g_mime_content_encoding_to_string ##### --> +<para> + +</para> + +@encoding: +@Returns: + + +<!-- ##### ENUM GMimeEncodingConstraint ##### --> +<para> + +</para> + +@GMIME_ENCODING_CONSTRAINT_7BIT: +@GMIME_ENCODING_CONSTRAINT_8BIT: +@GMIME_ENCODING_CONSTRAINT_BINARY: + +<!-- ##### STRUCT GMimeEncoding ##### --> +<para> + +</para> + +@encoding: +@uubuf: +@encode: +@save: +@state: + +<!-- ##### FUNCTION g_mime_encoding_init_encode ##### --> +<para> + +</para> + +@state: +@encoding: + + +<!-- ##### FUNCTION g_mime_encoding_init_decode ##### --> +<para> + +</para> + +@state: +@encoding: + + +<!-- ##### FUNCTION g_mime_encoding_reset ##### --> +<para> + +</para> + +@state: + + +<!-- ##### FUNCTION g_mime_encoding_outlen ##### --> +<para> + +</para> + +@state: +@inlen: +@Returns: + + +<!-- ##### FUNCTION g_mime_encoding_step ##### --> +<para> + +</para> + +@state: +@inbuf: +@inlen: +@outbuf: +@Returns: + + +<!-- ##### FUNCTION g_mime_encoding_flush ##### --> +<para> + +</para> + +@state: +@inbuf: +@inlen: +@outbuf: +@Returns: + + +<!-- ##### MACRO GMIME_BASE64_ENCODE_LEN ##### --> +<para> + +</para> + +@x: + + +<!-- ##### FUNCTION g_mime_encoding_base64_decode_step ##### --> +<para> + +</para> + +@inbuf: +@inlen: +@outbuf: +@state: +@save: +@Returns: + + +<!-- ##### FUNCTION g_mime_encoding_base64_encode_step ##### --> +<para> + +</para> + +@inbuf: +@inlen: +@outbuf: +@state: +@save: +@Returns: + + +<!-- ##### FUNCTION g_mime_encoding_base64_encode_close ##### --> +<para> + +</para> + +@inbuf: +@inlen: +@outbuf: +@state: +@save: +@Returns: + + +<!-- ##### MACRO GMIME_UUDECODE_STATE_INIT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_UUDECODE_STATE_BEGIN ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_UUDECODE_STATE_END ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_UUENCODE_LEN ##### --> +<para> + +</para> + +@x: + + +<!-- ##### FUNCTION g_mime_encoding_uudecode_step ##### --> +<para> + +</para> + +@inbuf: +@inlen: +@outbuf: +@state: +@save: +@Returns: + + +<!-- ##### FUNCTION g_mime_encoding_uuencode_step ##### --> +<para> + +</para> + +@inbuf: +@inlen: +@outbuf: +@uubuf: +@state: +@save: +@Returns: + + +<!-- ##### FUNCTION g_mime_encoding_uuencode_close ##### --> +<para> + +</para> + +@inbuf: +@inlen: +@outbuf: +@uubuf: +@state: +@save: +@Returns: + + +<!-- ##### MACRO GMIME_QP_ENCODE_LEN ##### --> +<para> + +</para> + +@x: + + +<!-- ##### FUNCTION g_mime_encoding_quoted_decode_step ##### --> +<para> + +</para> + +@inbuf: +@inlen: +@outbuf: +@state: +@save: +@Returns: + + +<!-- ##### FUNCTION g_mime_encoding_quoted_encode_step ##### --> +<para> + +</para> + +@inbuf: +@inlen: +@outbuf: +@state: +@save: +@Returns: + + +<!-- ##### FUNCTION g_mime_encoding_quoted_encode_close ##### --> +<para> + +</para> + +@inbuf: +@inlen: +@outbuf: +@state: +@save: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-error.sgml b/docs/reference/tmpl/gmime-error.sgml new file mode 100644 index 0000000..dfe460e --- /dev/null +++ b/docs/reference/tmpl/gmime-error.sgml @@ -0,0 +1,37 @@ +<!-- ##### SECTION Title ##### --> +gmime-error + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO GMIME_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_ERROR_IS_SYSTEM ##### --> +<para> + +</para> + +@error: + + diff --git a/docs/reference/tmpl/gmime-filter-basic.sgml b/docs/reference/tmpl/gmime-filter-basic.sgml new file mode 100644 index 0000000..5be9a74 --- /dev/null +++ b/docs/reference/tmpl/gmime-filter-basic.sgml @@ -0,0 +1,38 @@ +<!-- ##### SECTION Title ##### --> +gmime-filter-basic + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeFilterBasic ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_filter_basic_new ##### --> +<para> + +</para> + +@encoding: +@encode: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-filter-best.sgml b/docs/reference/tmpl/gmime-filter-best.sgml new file mode 100644 index 0000000..8ab7f2c --- /dev/null +++ b/docs/reference/tmpl/gmime-filter-best.sgml @@ -0,0 +1,64 @@ +<!-- ##### SECTION Title ##### --> +gmime-filter-best + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeFilterBest ##### --> +<para> + +</para> + + +<!-- ##### ENUM GMimeFilterBestFlags ##### --> +<para> + +</para> + +@GMIME_FILTER_BEST_CHARSET: +@GMIME_FILTER_BEST_ENCODING: + +<!-- ##### FUNCTION g_mime_filter_best_new ##### --> +<para> + +</para> + +@flags: +@Returns: + + +<!-- ##### FUNCTION g_mime_filter_best_charset ##### --> +<para> + +</para> + +@best: +@Returns: + + +<!-- ##### FUNCTION g_mime_filter_best_encoding ##### --> +<para> + +</para> + +@best: +@constraint: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-filter-charset.sgml b/docs/reference/tmpl/gmime-filter-charset.sgml new file mode 100644 index 0000000..7ce6055 --- /dev/null +++ b/docs/reference/tmpl/gmime-filter-charset.sgml @@ -0,0 +1,38 @@ +<!-- ##### SECTION Title ##### --> +gmime-filter-charset + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeFilterCharset ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_filter_charset_new ##### --> +<para> + +</para> + +@from_charset: +@to_charset: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-filter-crlf.sgml b/docs/reference/tmpl/gmime-filter-crlf.sgml new file mode 100644 index 0000000..0fba1da --- /dev/null +++ b/docs/reference/tmpl/gmime-filter-crlf.sgml @@ -0,0 +1,38 @@ +<!-- ##### SECTION Title ##### --> +gmime-filter-crlf + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeFilterCRLF ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_filter_crlf_new ##### --> +<para> + +</para> + +@encode: +@dots: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-filter-enriched.sgml b/docs/reference/tmpl/gmime-filter-enriched.sgml new file mode 100644 index 0000000..6ae741c --- /dev/null +++ b/docs/reference/tmpl/gmime-filter-enriched.sgml @@ -0,0 +1,44 @@ +<!-- ##### SECTION Title ##### --> +gmime-filter-enriched + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO GMIME_FILTER_ENRICHED_IS_RICHTEXT ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT GMimeFilterEnriched ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_filter_enriched_new ##### --> +<para> + +</para> + +@flags: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-filter-from.sgml b/docs/reference/tmpl/gmime-filter-from.sgml new file mode 100644 index 0000000..2183889 --- /dev/null +++ b/docs/reference/tmpl/gmime-filter-from.sgml @@ -0,0 +1,46 @@ +<!-- ##### SECTION Title ##### --> +gmime-filter-from + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeFilterFrom ##### --> +<para> + +</para> + + +<!-- ##### ENUM GMimeFilterFromMode ##### --> +<para> + +</para> + +@GMIME_FILTER_FROM_MODE_DEFAULT: +@GMIME_FILTER_FROM_MODE_ESCAPE: +@GMIME_FILTER_FROM_MODE_ARMOR: + +<!-- ##### FUNCTION g_mime_filter_from_new ##### --> +<para> + +</para> + +@mode: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-filter-gzip.sgml b/docs/reference/tmpl/gmime-filter-gzip.sgml new file mode 100644 index 0000000..cfc9103 --- /dev/null +++ b/docs/reference/tmpl/gmime-filter-gzip.sgml @@ -0,0 +1,46 @@ +<!-- ##### SECTION Title ##### --> +gmime-filter-gzip + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeFilterGZip ##### --> +<para> + +</para> + + +<!-- ##### ENUM GMimeFilterGZipMode ##### --> +<para> + +</para> + +@GMIME_FILTER_GZIP_MODE_ZIP: +@GMIME_FILTER_GZIP_MODE_UNZIP: + +<!-- ##### FUNCTION g_mime_filter_gzip_new ##### --> +<para> + +</para> + +@mode: +@level: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-filter-html.sgml b/docs/reference/tmpl/gmime-filter-html.sgml new file mode 100644 index 0000000..6de0c4f --- /dev/null +++ b/docs/reference/tmpl/gmime-filter-html.sgml @@ -0,0 +1,94 @@ +<!-- ##### SECTION Title ##### --> +gmime-filter-html + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeFilterHTML ##### --> +<para> + +</para> + + +<!-- ##### MACRO GMIME_FILTER_HTML_PRE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_FILTER_HTML_CONVERT_NL ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_FILTER_HTML_CONVERT_SPACES ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_FILTER_HTML_CONVERT_URLS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_FILTER_HTML_MARK_CITATION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_FILTER_HTML_CONVERT_ADDRESSES ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_FILTER_HTML_ESCAPE_8BIT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_FILTER_HTML_CITE ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION g_mime_filter_html_new ##### --> +<para> + +</para> + +@flags: +@colour: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-filter-md5.sgml b/docs/reference/tmpl/gmime-filter-md5.sgml new file mode 100644 index 0000000..bbf595e --- /dev/null +++ b/docs/reference/tmpl/gmime-filter-md5.sgml @@ -0,0 +1,46 @@ +<!-- ##### SECTION Title ##### --> +gmime-filter-md5 + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeFilterMd5 ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_filter_md5_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_filter_md5_get_digest ##### --> +<para> + +</para> + +@md5: +@digest: + + diff --git a/docs/reference/tmpl/gmime-filter-strip.sgml b/docs/reference/tmpl/gmime-filter-strip.sgml new file mode 100644 index 0000000..458655b --- /dev/null +++ b/docs/reference/tmpl/gmime-filter-strip.sgml @@ -0,0 +1,37 @@ +<!-- ##### SECTION Title ##### --> +gmime-filter-strip + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeFilterStrip ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_filter_strip_new ##### --> +<para> + +</para> + +@void: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-filter-windows.sgml b/docs/reference/tmpl/gmime-filter-windows.sgml new file mode 100644 index 0000000..1298d18 --- /dev/null +++ b/docs/reference/tmpl/gmime-filter-windows.sgml @@ -0,0 +1,55 @@ +<!-- ##### SECTION Title ##### --> +gmime-filter-windows + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeFilterWindows ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_filter_windows_new ##### --> +<para> + +</para> + +@claimed_charset: +@Returns: + + +<!-- ##### FUNCTION g_mime_filter_windows_is_windows_charset ##### --> +<para> + +</para> + +@filter: +@Returns: + + +<!-- ##### FUNCTION g_mime_filter_windows_real_charset ##### --> +<para> + +</para> + +@filter: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-filter-yenc.sgml b/docs/reference/tmpl/gmime-filter-yenc.sgml new file mode 100644 index 0000000..ee4cfca --- /dev/null +++ b/docs/reference/tmpl/gmime-filter-yenc.sgml @@ -0,0 +1,186 @@ +<!-- ##### SECTION Title ##### --> +gmime-filter-yenc + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeFilterYenc ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_filter_yenc_new ##### --> +<para> + +</para> + +@encode: +@Returns: + + +<!-- ##### FUNCTION g_mime_filter_yenc_set_state ##### --> +<para> + +</para> + +@yenc: +@state: + + +<!-- ##### FUNCTION g_mime_filter_yenc_set_crc ##### --> +<para> + +</para> + +@yenc: +@crc: + + +<!-- ##### FUNCTION g_mime_filter_yenc_get_crc ##### --> +<para> + +</para> + +@yenc: +@Returns: + + +<!-- ##### FUNCTION g_mime_filter_yenc_get_pcrc ##### --> +<para> + +</para> + +@yenc: +@Returns: + + +<!-- ##### MACRO GMIME_YENCODE_CRC_INIT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_YENCODE_CRC_FINAL ##### --> +<para> + +</para> + +@crc: + + +<!-- ##### MACRO GMIME_YENCODE_STATE_INIT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_YDECODE_STATE_INIT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_YDECODE_STATE_EOLN ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_YDECODE_STATE_ESCAPE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_YDECODE_STATE_END ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_YDECODE_STATE_BEGIN ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_YDECODE_STATE_DECODE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_YDECODE_STATE_PART ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION g_mime_ydecode_step ##### --> +<para> + +</para> + +@inbuf: +@inlen: +@outbuf: +@state: +@pcrc: +@crc: +@Returns: + + +<!-- ##### FUNCTION g_mime_yencode_step ##### --> +<para> + +</para> + +@inbuf: +@inlen: +@outbuf: +@state: +@pcrc: +@crc: +@Returns: + + +<!-- ##### FUNCTION g_mime_yencode_close ##### --> +<para> + +</para> + +@inbuf: +@inlen: +@outbuf: +@state: +@pcrc: +@crc: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-filter.sgml b/docs/reference/tmpl/gmime-filter.sgml new file mode 100644 index 0000000..6202aa0 --- /dev/null +++ b/docs/reference/tmpl/gmime-filter.sgml @@ -0,0 +1,93 @@ +<!-- ##### SECTION Title ##### --> +gmime-filter + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeFilter ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_filter_copy ##### --> +<para> + +</para> + +@filter: +@Returns: + + +<!-- ##### FUNCTION g_mime_filter_filter ##### --> +<para> + +</para> + +@filter: +@inbuf: +@inlen: +@prespace: +@outbuf: +@outlen: +@outprespace: + + +<!-- ##### FUNCTION g_mime_filter_complete ##### --> +<para> + +</para> + +@filter: +@inbuf: +@inlen: +@prespace: +@outbuf: +@outlen: +@outprespace: + + +<!-- ##### FUNCTION g_mime_filter_reset ##### --> +<para> + +</para> + +@filter: + + +<!-- ##### FUNCTION g_mime_filter_backup ##### --> +<para> + +</para> + +@filter: +@data: +@length: + + +<!-- ##### FUNCTION g_mime_filter_set_size ##### --> +<para> + +</para> + +@filter: +@size: +@keep: + + diff --git a/docs/reference/tmpl/gmime-gpg-context.sgml b/docs/reference/tmpl/gmime-gpg-context.sgml new file mode 100644 index 0000000..bdc906a --- /dev/null +++ b/docs/reference/tmpl/gmime-gpg-context.sgml @@ -0,0 +1,92 @@ +<!-- ##### SECTION Title ##### --> +gmime-gpg-context + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeGpgContext ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_gpg_context_new ##### --> +<para> + +</para> + +@request_passwd: +@path: +@Returns: + + +<!-- ##### FUNCTION g_mime_gpg_context_get_always_trust ##### --> +<para> + +</para> + +@ctx: +@Returns: + + +<!-- ##### FUNCTION g_mime_gpg_context_set_always_trust ##### --> +<para> + +</para> + +@ctx: +@always_trust: + + +<!-- ##### FUNCTION g_mime_gpg_context_get_auto_key_retrieve ##### --> +<para> + +</para> + +@ctx: +@Returns: + + +<!-- ##### FUNCTION g_mime_gpg_context_set_auto_key_retrieve ##### --> +<para> + +</para> + +@ctx: +@auto_key_retrieve: + + +<!-- ##### FUNCTION g_mime_gpg_context_get_use_agent ##### --> +<para> + +</para> + +@ctx: +@Returns: + + +<!-- ##### FUNCTION g_mime_gpg_context_set_use_agent ##### --> +<para> + +</para> + +@ctx: +@use_agent: + + diff --git a/docs/reference/tmpl/gmime-header.sgml b/docs/reference/tmpl/gmime-header.sgml new file mode 100644 index 0000000..10a7f3a --- /dev/null +++ b/docs/reference/tmpl/gmime-header.sgml @@ -0,0 +1,337 @@ +<!-- ##### SECTION Title ##### --> +gmime-header + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeHeaderIter ##### --> +<para> + +</para> + +@hdrlist: +@cursor: +@version: + +<!-- ##### STRUCT GMimeHeaderList ##### --> +<para> + +</para> + + +<!-- ##### USER_FUNCTION GMimeHeaderWriter ##### --> +<para> + +</para> + +@stream: +@name: +@value: +@Returns: + + +<!-- ##### USER_FUNCTION GMimeHeaderForeachFunc ##### --> +<para> + +</para> + +@name: +@value: +@user_data: + + +<!-- ##### FUNCTION g_mime_header_iter_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_header_iter_free ##### --> +<para> + +</para> + +@iter: + + +<!-- ##### FUNCTION g_mime_header_iter_copy ##### --> +<para> + +</para> + +@iter: +@Returns: + + +<!-- ##### FUNCTION g_mime_header_iter_copy_to ##### --> +<para> + +</para> + +@src: +@dest: + + +<!-- ##### FUNCTION g_mime_header_iter_equal ##### --> +<para> + +</para> + +@iter1: +@iter2: +@Returns: + + +<!-- ##### FUNCTION g_mime_header_iter_first ##### --> +<para> + +</para> + +@iter: +@Returns: + + +<!-- ##### FUNCTION g_mime_header_iter_last ##### --> +<para> + +</para> + +@iter: +@Returns: + + +<!-- ##### FUNCTION g_mime_header_iter_next ##### --> +<para> + +</para> + +@iter: +@Returns: + + +<!-- ##### FUNCTION g_mime_header_iter_prev ##### --> +<para> + +</para> + +@iter: +@Returns: + + +<!-- ##### FUNCTION g_mime_header_iter_is_valid ##### --> +<para> + +</para> + +@iter: +@Returns: + + +<!-- ##### FUNCTION g_mime_header_iter_get_name ##### --> +<para> + +</para> + +@iter: +@Returns: + + +<!-- ##### FUNCTION g_mime_header_iter_get_value ##### --> +<para> + +</para> + +@iter: +@Returns: + + +<!-- ##### FUNCTION g_mime_header_iter_set_value ##### --> +<para> + +</para> + +@iter: +@value: +@Returns: + + +<!-- ##### FUNCTION g_mime_header_iter_remove ##### --> +<para> + +</para> + +@iter: +@Returns: + + +<!-- ##### FUNCTION g_mime_header_list_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_header_list_destroy ##### --> +<para> + +</para> + +@headers: + + +<!-- ##### FUNCTION g_mime_header_list_clear ##### --> +<para> + +</para> + +@headers: + + +<!-- ##### FUNCTION g_mime_header_list_contains ##### --> +<para> + +</para> + +@headers: +@name: +@Returns: + + +<!-- ##### FUNCTION g_mime_header_list_prepend ##### --> +<para> + +</para> + +@headers: +@name: +@value: + + +<!-- ##### FUNCTION g_mime_header_list_append ##### --> +<para> + +</para> + +@headers: +@name: +@value: + + +<!-- ##### FUNCTION g_mime_header_list_remove ##### --> +<para> + +</para> + +@headers: +@name: +@Returns: + + +<!-- ##### FUNCTION g_mime_header_list_set ##### --> +<para> + +</para> + +@headers: +@name: +@value: + + +<!-- ##### FUNCTION g_mime_header_list_get ##### --> +<para> + +</para> + +@headers: +@name: +@Returns: + + +<!-- ##### FUNCTION g_mime_header_list_get_iter ##### --> +<para> + +</para> + +@headers: +@iter: +@Returns: + + +<!-- ##### FUNCTION g_mime_header_list_foreach ##### --> +<para> + +</para> + +@headers: +@func: +@user_data: + + +<!-- ##### FUNCTION g_mime_header_list_register_writer ##### --> +<para> + +</para> + +@headers: +@name: +@writer: + + +<!-- ##### FUNCTION g_mime_header_list_write_to_stream ##### --> +<para> + +</para> + +@headers: +@stream: +@Returns: + + +<!-- ##### FUNCTION g_mime_header_list_to_string ##### --> +<para> + +</para> + +@headers: +@Returns: + + +<!-- ##### FUNCTION g_mime_header_list_get_stream ##### --> +<para> + +</para> + +@headers: +@Returns: + + +<!-- ##### FUNCTION g_mime_header_list_set_stream ##### --> +<para> + +</para> + +@headers: +@stream: + + diff --git a/docs/reference/tmpl/gmime-iconv-utils.sgml b/docs/reference/tmpl/gmime-iconv-utils.sgml new file mode 100644 index 0000000..d68ec1d --- /dev/null +++ b/docs/reference/tmpl/gmime-iconv-utils.sgml @@ -0,0 +1,81 @@ +<!-- ##### SECTION Title ##### --> +gmime-iconv-utils + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION g_mime_iconv_strdup ##### --> +<para> + +</para> + +@cd: +@str: +@Returns: + + +<!-- ##### FUNCTION g_mime_iconv_strndup ##### --> +<para> + +</para> + +@cd: +@str: +@n: +@Returns: + + +<!-- ##### FUNCTION g_mime_iconv_utf8_to_locale ##### --> +<para> + +</para> + +@str: +@Returns: + + +<!-- ##### FUNCTION g_mime_iconv_utf8_to_locale_length ##### --> +<para> + +</para> + +@str: +@n: +@Returns: + + +<!-- ##### FUNCTION g_mime_iconv_locale_to_utf8 ##### --> +<para> + +</para> + +@str: +@Returns: + + +<!-- ##### FUNCTION g_mime_iconv_locale_to_utf8_length ##### --> +<para> + +</para> + +@str: +@n: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-iconv.sgml b/docs/reference/tmpl/gmime-iconv.sgml new file mode 100644 index 0000000..260482d --- /dev/null +++ b/docs/reference/tmpl/gmime-iconv.sgml @@ -0,0 +1,69 @@ +<!-- ##### SECTION Title ##### --> +gmime-iconv + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION g_mime_iconv_init ##### --> +<para> + +</para> + +@void: + + +<!-- ##### FUNCTION g_mime_iconv_shutdown ##### --> +<para> + +</para> + +@void: + + +<!-- ##### FUNCTION g_mime_iconv_open ##### --> +<para> + +</para> + +@to: +@from: +@Returns: + + +<!-- ##### MACRO g_mime_iconv ##### --> +<para> + +</para> + +@cd: +@inbuf: +@inleft: +@outbuf: +@outleft: + + +<!-- ##### FUNCTION g_mime_iconv_close ##### --> +<para> + +</para> + +@cd: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-message-part.sgml b/docs/reference/tmpl/gmime-message-part.sgml new file mode 100644 index 0000000..d65aee2 --- /dev/null +++ b/docs/reference/tmpl/gmime-message-part.sgml @@ -0,0 +1,65 @@ +<!-- ##### SECTION Title ##### --> +gmime-message-part + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeMessagePart ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_message_part_new ##### --> +<para> + +</para> + +@subtype: +@Returns: + + +<!-- ##### FUNCTION g_mime_message_part_new_with_message ##### --> +<para> + +</para> + +@subtype: +@message: +@Returns: + + +<!-- ##### FUNCTION g_mime_message_part_get_message ##### --> +<para> + +</para> + +@part: +@Returns: + + +<!-- ##### FUNCTION g_mime_message_part_set_message ##### --> +<para> + +</para> + +@part: +@message: + + diff --git a/docs/reference/tmpl/gmime-message-partial.sgml b/docs/reference/tmpl/gmime-message-partial.sgml new file mode 100644 index 0000000..b6f1720 --- /dev/null +++ b/docs/reference/tmpl/gmime-message-partial.sgml @@ -0,0 +1,87 @@ +<!-- ##### SECTION Title ##### --> +gmime-message-partial + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeMessagePartial ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_message_partial_new ##### --> +<para> + +</para> + +@id: +@number: +@total: +@Returns: + + +<!-- ##### FUNCTION g_mime_message_partial_get_id ##### --> +<para> + +</para> + +@partial: +@Returns: + + +<!-- ##### FUNCTION g_mime_message_partial_get_number ##### --> +<para> + +</para> + +@partial: +@Returns: + + +<!-- ##### FUNCTION g_mime_message_partial_get_total ##### --> +<para> + +</para> + +@partial: +@Returns: + + +<!-- ##### FUNCTION g_mime_message_partial_reconstruct_message ##### --> +<para> + +</para> + +@partials: +@num: +@Returns: + + +<!-- ##### FUNCTION g_mime_message_partial_split_message ##### --> +<para> + +</para> + +@message: +@max_size: +@nparts: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-message.sgml b/docs/reference/tmpl/gmime-message.sgml new file mode 100644 index 0000000..29dc5bc --- /dev/null +++ b/docs/reference/tmpl/gmime-message.sgml @@ -0,0 +1,223 @@ +<!-- ##### SECTION Title ##### --> +gmime-message + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### ENUM GMimeRecipientType ##### --> +<para> + +</para> + +@GMIME_RECIPIENT_TYPE_TO: +@GMIME_RECIPIENT_TYPE_CC: +@GMIME_RECIPIENT_TYPE_BCC: + +<!-- ##### STRUCT GMimeMessage ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_message_new ##### --> +<para> + +</para> + +@pretty_headers: +@Returns: + + +<!-- ##### FUNCTION g_mime_message_set_sender ##### --> +<para> + +</para> + +@message: +@sender: + + +<!-- ##### FUNCTION g_mime_message_get_sender ##### --> +<para> + +</para> + +@message: +@Returns: + + +<!-- ##### FUNCTION g_mime_message_set_reply_to ##### --> +<para> + +</para> + +@message: +@reply_to: + + +<!-- ##### FUNCTION g_mime_message_get_reply_to ##### --> +<para> + +</para> + +@message: +@Returns: + + +<!-- ##### FUNCTION g_mime_message_add_recipient ##### --> +<para> + +</para> + +@message: +@type: +@name: +@addr: + + +<!-- ##### FUNCTION g_mime_message_get_recipients ##### --> +<para> + +</para> + +@message: +@type: +@Returns: + + +<!-- ##### FUNCTION g_mime_message_get_all_recipients ##### --> +<para> + +</para> + +@message: +@Returns: + + +<!-- ##### FUNCTION g_mime_message_set_subject ##### --> +<para> + +</para> + +@message: +@subject: + + +<!-- ##### FUNCTION g_mime_message_get_subject ##### --> +<para> + +</para> + +@message: +@Returns: + + +<!-- ##### FUNCTION g_mime_message_set_date ##### --> +<para> + +</para> + +@message: +@date: +@tz_offset: + + +<!-- ##### FUNCTION g_mime_message_get_date ##### --> +<para> + +</para> + +@message: +@date: +@tz_offset: + + +<!-- ##### FUNCTION g_mime_message_set_date_as_string ##### --> +<para> + +</para> + +@message: +@str: + + +<!-- ##### FUNCTION g_mime_message_get_date_as_string ##### --> +<para> + +</para> + +@message: +@Returns: + + +<!-- ##### FUNCTION g_mime_message_set_message_id ##### --> +<para> + +</para> + +@message: +@message_id: + + +<!-- ##### FUNCTION g_mime_message_get_message_id ##### --> +<para> + +</para> + +@message: +@Returns: + + +<!-- ##### FUNCTION g_mime_message_set_mime_part ##### --> +<para> + +</para> + +@message: +@mime_part: + + +<!-- ##### FUNCTION g_mime_message_get_mime_part ##### --> +<para> + +</para> + +@message: +@Returns: + + +<!-- ##### FUNCTION g_mime_message_foreach ##### --> +<para> + +</para> + +@message: +@callback: +@user_data: + + +<!-- ##### FUNCTION g_mime_message_get_body ##### --> +<para> + +</para> + +@message: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-multipart-encrypted.sgml b/docs/reference/tmpl/gmime-multipart-encrypted.sgml new file mode 100644 index 0000000..d94b953 --- /dev/null +++ b/docs/reference/tmpl/gmime-multipart-encrypted.sgml @@ -0,0 +1,65 @@ +<!-- ##### SECTION Title ##### --> +gmime-multipart-encrypted + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeMultipartEncrypted ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_multipart_encrypted_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_multipart_encrypted_encrypt ##### --> +<para> + +</para> + +@mpe: +@content: +@ctx: +@sign: +@userid: +@digest: +@recipients: +@err: +@Returns: + + +<!-- ##### FUNCTION g_mime_multipart_encrypted_decrypt ##### --> +<para> + +</para> + +@mpe: +@ctx: +@result: +@err: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-multipart-signed.sgml b/docs/reference/tmpl/gmime-multipart-signed.sgml new file mode 100644 index 0000000..ec02cc5 --- /dev/null +++ b/docs/reference/tmpl/gmime-multipart-signed.sgml @@ -0,0 +1,62 @@ +<!-- ##### SECTION Title ##### --> +gmime-multipart-signed + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeMultipartSigned ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_multipart_signed_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_multipart_signed_sign ##### --> +<para> + +</para> + +@mps: +@content: +@ctx: +@userid: +@digest: +@err: +@Returns: + + +<!-- ##### FUNCTION g_mime_multipart_signed_verify ##### --> +<para> + +</para> + +@mps: +@ctx: +@err: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-multipart.sgml b/docs/reference/tmpl/gmime-multipart.sgml new file mode 100644 index 0000000..3f99762 --- /dev/null +++ b/docs/reference/tmpl/gmime-multipart.sgml @@ -0,0 +1,217 @@ +<!-- ##### SECTION Title ##### --> +gmime-multipart + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeMultipart ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_multipart_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_multipart_new_with_subtype ##### --> +<para> + +</para> + +@subtype: +@Returns: + + +<!-- ##### FUNCTION g_mime_multipart_set_preface ##### --> +<para> + +</para> + +@multipart: +@preface: + + +<!-- ##### FUNCTION g_mime_multipart_get_preface ##### --> +<para> + +</para> + +@multipart: +@Returns: + + +<!-- ##### FUNCTION g_mime_multipart_set_postface ##### --> +<para> + +</para> + +@multipart: +@postface: + + +<!-- ##### FUNCTION g_mime_multipart_get_postface ##### --> +<para> + +</para> + +@multipart: +@Returns: + + +<!-- ##### FUNCTION g_mime_multipart_set_boundary ##### --> +<para> + +</para> + +@multipart: +@boundary: + + +<!-- ##### FUNCTION g_mime_multipart_get_boundary ##### --> +<para> + +</para> + +@multipart: +@Returns: + + +<!-- ##### FUNCTION g_mime_multipart_get_count ##### --> +<para> + +</para> + +@multipart: +@Returns: + + +<!-- ##### FUNCTION g_mime_multipart_contains ##### --> +<para> + +</para> + +@multipart: +@part: +@Returns: + + +<!-- ##### FUNCTION g_mime_multipart_index_of ##### --> +<para> + +</para> + +@multipart: +@part: +@Returns: + + +<!-- ##### FUNCTION g_mime_multipart_add ##### --> +<para> + +</para> + +@multipart: +@part: + + +<!-- ##### FUNCTION g_mime_multipart_clear ##### --> +<para> + +</para> + +@multipart: + + +<!-- ##### FUNCTION g_mime_multipart_insert ##### --> +<para> + +</para> + +@multipart: +@index: +@part: + + +<!-- ##### FUNCTION g_mime_multipart_remove ##### --> +<para> + +</para> + +@multipart: +@part: +@Returns: + + +<!-- ##### FUNCTION g_mime_multipart_remove_at ##### --> +<para> + +</para> + +@multipart: +@index: +@Returns: + + +<!-- ##### FUNCTION g_mime_multipart_replace ##### --> +<para> + +</para> + +@multipart: +@index: +@replacement: +@Returns: + + +<!-- ##### FUNCTION g_mime_multipart_get_part ##### --> +<para> + +</para> + +@multipart: +@index: +@Returns: + + +<!-- ##### FUNCTION g_mime_multipart_foreach ##### --> +<para> + +</para> + +@multipart: +@callback: +@user_data: + + +<!-- ##### FUNCTION g_mime_multipart_get_subpart_from_content_id ##### --> +<para> + +</para> + +@multipart: +@content_id: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-object.sgml b/docs/reference/tmpl/gmime-object.sgml new file mode 100644 index 0000000..fdfaaaf --- /dev/null +++ b/docs/reference/tmpl/gmime-object.sgml @@ -0,0 +1,275 @@ +<!-- ##### SECTION Title ##### --> +gmime-object + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeObject ##### --> +<para> + +</para> + + +<!-- ##### USER_FUNCTION GMimeObjectForeachFunc ##### --> +<para> + +</para> + +@parent: +@part: +@user_data: + + +<!-- ##### FUNCTION g_mime_object_register_type ##### --> +<para> + +</para> + +@type: +@subtype: +@object_type: + + +<!-- ##### FUNCTION g_mime_object_new ##### --> +<para> + +</para> + +@content_type: +@Returns: + + +<!-- ##### FUNCTION g_mime_object_new_type ##### --> +<para> + +</para> + +@type: +@subtype: +@Returns: + + +<!-- ##### FUNCTION g_mime_object_set_content_type ##### --> +<para> + +</para> + +@object: +@content_type: + + +<!-- ##### FUNCTION g_mime_object_get_content_type ##### --> +<para> + +</para> + +@object: +@Returns: + + +<!-- ##### FUNCTION g_mime_object_set_content_type_parameter ##### --> +<para> + +</para> + +@object: +@name: +@value: + + +<!-- ##### FUNCTION g_mime_object_get_content_type_parameter ##### --> +<para> + +</para> + +@object: +@name: +@Returns: + + +<!-- ##### FUNCTION g_mime_object_set_disposition ##### --> +<para> + +</para> + +@object: +@disposition: + + +<!-- ##### FUNCTION g_mime_object_get_disposition ##### --> +<para> + +</para> + +@object: +@Returns: + + +<!-- ##### FUNCTION g_mime_object_set_content_disposition ##### --> +<para> + +</para> + +@object: +@disposition: + + +<!-- ##### FUNCTION g_mime_object_get_content_disposition ##### --> +<para> + +</para> + +@object: +@Returns: + + +<!-- ##### FUNCTION g_mime_object_set_content_disposition_parameter ##### --> +<para> + +</para> + +@object: +@attribute: +@value: + + +<!-- ##### FUNCTION g_mime_object_get_content_disposition_parameter ##### --> +<para> + +</para> + +@object: +@attribute: +@Returns: + + +<!-- ##### FUNCTION g_mime_object_set_content_id ##### --> +<para> + +</para> + +@object: +@content_id: + + +<!-- ##### FUNCTION g_mime_object_get_content_id ##### --> +<para> + +</para> + +@object: +@Returns: + + +<!-- ##### FUNCTION g_mime_object_prepend_header ##### --> +<para> + +</para> + +@object: +@header: +@value: + + +<!-- ##### FUNCTION g_mime_object_append_header ##### --> +<para> + +</para> + +@object: +@header: +@value: + + +<!-- ##### FUNCTION g_mime_object_remove_header ##### --> +<para> + +</para> + +@object: +@header: +@Returns: + + +<!-- ##### FUNCTION g_mime_object_set_header ##### --> +<para> + +</para> + +@object: +@header: +@value: + + +<!-- ##### FUNCTION g_mime_object_get_header ##### --> +<para> + +</para> + +@object: +@header: +@Returns: + + +<!-- ##### FUNCTION g_mime_object_get_headers ##### --> +<para> + +</para> + +@object: +@Returns: + + +<!-- ##### FUNCTION g_mime_object_get_header_list ##### --> +<para> + +</para> + +@object: +@Returns: + + +<!-- ##### FUNCTION g_mime_object_write_to_stream ##### --> +<para> + +</para> + +@object: +@stream: +@Returns: + + +<!-- ##### FUNCTION g_mime_object_to_string ##### --> +<para> + +</para> + +@object: +@Returns: + + +<!-- ##### FUNCTION g_mime_object_encode ##### --> +<para> + +</para> + +@object: +@constraint: + + diff --git a/docs/reference/tmpl/gmime-param.sgml b/docs/reference/tmpl/gmime-param.sgml new file mode 100644 index 0000000..9c495f0 --- /dev/null +++ b/docs/reference/tmpl/gmime-param.sgml @@ -0,0 +1,116 @@ +<!-- ##### SECTION Title ##### --> +gmime-param + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeParam ##### --> +<para> + +</para> + +@next: +@name: +@value: + +<!-- ##### FUNCTION g_mime_param_new ##### --> +<para> + +</para> + +@name: +@value: +@Returns: + + +<!-- ##### FUNCTION g_mime_param_new_from_string ##### --> +<para> + +</para> + +@str: +@Returns: + + +<!-- ##### FUNCTION g_mime_param_destroy ##### --> +<para> + +</para> + +@param: + + +<!-- ##### FUNCTION g_mime_param_next ##### --> +<para> + +</para> + +@param: +@Returns: + + +<!-- ##### FUNCTION g_mime_param_get_name ##### --> +<para> + +</para> + +@param: +@Returns: + + +<!-- ##### FUNCTION g_mime_param_get_value ##### --> +<para> + +</para> + +@param: +@Returns: + + +<!-- ##### FUNCTION g_mime_param_append ##### --> +<para> + +</para> + +@params: +@name: +@value: +@Returns: + + +<!-- ##### FUNCTION g_mime_param_append_param ##### --> +<para> + +</para> + +@params: +@param: +@Returns: + + +<!-- ##### FUNCTION g_mime_param_write_to_string ##### --> +<para> + +</para> + +@param: +@fold: +@str: + + diff --git a/docs/reference/tmpl/gmime-parser.sgml b/docs/reference/tmpl/gmime-parser.sgml new file mode 100644 index 0000000..299b847 --- /dev/null +++ b/docs/reference/tmpl/gmime-parser.sgml @@ -0,0 +1,204 @@ +<!-- ##### SECTION Title ##### --> +gmime-parser + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeParser ##### --> +<para> + +</para> + + +<!-- ##### USER_FUNCTION GMimeParserHeaderRegexFunc ##### --> +<para> + +</para> + +@parser: +@header: +@value: +@offset: +@user_data: + + +<!-- ##### FUNCTION g_mime_parser_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_parser_new_with_stream ##### --> +<para> + +</para> + +@stream: +@Returns: + + +<!-- ##### FUNCTION g_mime_parser_init_with_stream ##### --> +<para> + +</para> + +@parser: +@stream: + + +<!-- ##### FUNCTION g_mime_parser_get_persist_stream ##### --> +<para> + +</para> + +@parser: +@Returns: + + +<!-- ##### FUNCTION g_mime_parser_set_persist_stream ##### --> +<para> + +</para> + +@parser: +@persist: + + +<!-- ##### FUNCTION g_mime_parser_get_scan_from ##### --> +<para> + +</para> + +@parser: +@Returns: + + +<!-- ##### FUNCTION g_mime_parser_set_scan_from ##### --> +<para> + +</para> + +@parser: +@scan_from: + + +<!-- ##### FUNCTION g_mime_parser_get_respect_content_length ##### --> +<para> + +</para> + +@parser: +@Returns: + + +<!-- ##### FUNCTION g_mime_parser_set_respect_content_length ##### --> +<para> + +</para> + +@parser: +@respect_content_length: + + +<!-- ##### FUNCTION g_mime_parser_set_header_regex ##### --> +<para> + +</para> + +@parser: +@regex: +@header_cb: +@user_data: + + +<!-- ##### FUNCTION g_mime_parser_tell ##### --> +<para> + +</para> + +@parser: +@Returns: + + +<!-- ##### FUNCTION g_mime_parser_eos ##### --> +<para> + +</para> + +@parser: +@Returns: + + +<!-- ##### FUNCTION g_mime_parser_construct_part ##### --> +<para> + +</para> + +@parser: +@Returns: + + +<!-- ##### FUNCTION g_mime_parser_construct_message ##### --> +<para> + +</para> + +@parser: +@Returns: + + +<!-- ##### FUNCTION g_mime_parser_get_from ##### --> +<para> + +</para> + +@parser: +@Returns: + + +<!-- ##### FUNCTION g_mime_parser_get_from_offset ##### --> +<para> + +</para> + +@parser: +@Returns: + + +<!-- ##### FUNCTION g_mime_parser_get_headers_begin ##### --> +<para> + +</para> + +@parser: +@Returns: + + +<!-- ##### FUNCTION g_mime_parser_get_headers_end ##### --> +<para> + +</para> + +@parser: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-part-iter.sgml b/docs/reference/tmpl/gmime-part-iter.sgml new file mode 100644 index 0000000..1dbea9f --- /dev/null +++ b/docs/reference/tmpl/gmime-part-iter.sgml @@ -0,0 +1,145 @@ +<!-- ##### SECTION Title ##### --> +gmime-part-iter + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimePartIter ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_part_iter_new ##### --> +<para> + +</para> + +@toplevel: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_iter_free ##### --> +<para> + +</para> + +@iter: + + +<!-- ##### FUNCTION g_mime_part_iter_reset ##### --> +<para> + +</para> + +@iter: + + +<!-- ##### FUNCTION g_mime_part_iter_jump_to ##### --> +<para> + +</para> + +@iter: +@path: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_iter_is_valid ##### --> +<para> + +</para> + +@iter: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_iter_next ##### --> +<para> + +</para> + +@iter: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_iter_prev ##### --> +<para> + +</para> + +@iter: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_iter_get_toplevel ##### --> +<para> + +</para> + +@iter: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_iter_get_current ##### --> +<para> + +</para> + +@iter: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_iter_get_parent ##### --> +<para> + +</para> + +@iter: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_iter_get_path ##### --> +<para> + +</para> + +@iter: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_iter_replace ##### --> +<para> + +</para> + +@iter: +@replacement: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_iter_remove ##### --> +<para> + +</para> + +@iter: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-part.sgml b/docs/reference/tmpl/gmime-part.sgml new file mode 100644 index 0000000..abbdf2a --- /dev/null +++ b/docs/reference/tmpl/gmime-part.sgml @@ -0,0 +1,192 @@ +<!-- ##### SECTION Title ##### --> +gmime-part + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimePart ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_part_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_new_with_type ##### --> +<para> + +</para> + +@type: +@subtype: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_set_content_description ##### --> +<para> + +</para> + +@mime_part: +@description: + + +<!-- ##### FUNCTION g_mime_part_get_content_description ##### --> +<para> + +</para> + +@mime_part: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_set_content_id ##### --> +<para> + +</para> + +@mime_part: +@content_id: + + +<!-- ##### FUNCTION g_mime_part_get_content_id ##### --> +<para> + +</para> + +@mime_part: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_set_content_md5 ##### --> +<para> + +</para> + +@mime_part: +@content_md5: + + +<!-- ##### FUNCTION g_mime_part_get_content_md5 ##### --> +<para> + +</para> + +@mime_part: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_verify_content_md5 ##### --> +<para> + +</para> + +@mime_part: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_set_content_location ##### --> +<para> + +</para> + +@mime_part: +@content_location: + + +<!-- ##### FUNCTION g_mime_part_get_content_location ##### --> +<para> + +</para> + +@mime_part: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_set_content_encoding ##### --> +<para> + +</para> + +@mime_part: +@encoding: + + +<!-- ##### FUNCTION g_mime_part_get_content_encoding ##### --> +<para> + +</para> + +@mime_part: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_get_best_content_encoding ##### --> +<para> + +</para> + +@mime_part: +@constraint: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_set_filename ##### --> +<para> + +</para> + +@mime_part: +@filename: + + +<!-- ##### FUNCTION g_mime_part_get_filename ##### --> +<para> + +</para> + +@mime_part: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_get_content_object ##### --> +<para> + +</para> + +@mime_part: +@Returns: + + +<!-- ##### FUNCTION g_mime_part_set_content_object ##### --> +<para> + +</para> + +@mime_part: +@content: + + diff --git a/docs/reference/tmpl/gmime-pkcs7-context.sgml b/docs/reference/tmpl/gmime-pkcs7-context.sgml new file mode 100644 index 0000000..bc873dc --- /dev/null +++ b/docs/reference/tmpl/gmime-pkcs7-context.sgml @@ -0,0 +1,55 @@ +<!-- ##### SECTION Title ##### --> +gmime-pkcs7-context + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimePkcs7Context ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_pkcs7_context_new ##### --> +<para> + +</para> + +@request_passwd: +@Returns: + + +<!-- ##### FUNCTION g_mime_pkcs7_context_get_always_trust ##### --> +<para> + +</para> + +@ctx: +@Returns: + + +<!-- ##### FUNCTION g_mime_pkcs7_context_set_always_trust ##### --> +<para> + +</para> + +@ctx: +@always_trust: + + diff --git a/docs/reference/tmpl/gmime-session-simple.sgml b/docs/reference/tmpl/gmime-session-simple.sgml new file mode 100644 index 0000000..1d95224 --- /dev/null +++ b/docs/reference/tmpl/gmime-session-simple.sgml @@ -0,0 +1,52 @@ +<!-- ##### SECTION Title ##### --> +gmime-session-simple + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT GMimeSessionSimple ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_session_simple_set_request_passwd ##### --> +<para> + +</para> + +@session: +@request_passwd: + + +<!-- ##### FUNCTION g_mime_session_simple_set_forget_passwd ##### --> +<para> + +</para> + +@session: +@forget_passwd: + + +<!-- ##### FUNCTION g_mime_session_simple_set_is_online ##### --> +<para> + +</para> + +@session: +@is_online: + + diff --git a/docs/reference/tmpl/gmime-session.sgml b/docs/reference/tmpl/gmime-session.sgml new file mode 100644 index 0000000..fdb4890 --- /dev/null +++ b/docs/reference/tmpl/gmime-session.sgml @@ -0,0 +1,57 @@ +<!-- ##### SECTION Title ##### --> +gmime-session + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT GMimeSession ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_session_request_passwd ##### --> +<para> + +</para> + +@session: +@prompt: +@secret: +@item: +@err: +@Returns: + + +<!-- ##### FUNCTION g_mime_session_forget_passwd ##### --> +<para> + +</para> + +@session: +@item: +@err: + + +<!-- ##### FUNCTION g_mime_session_is_online ##### --> +<para> + +</para> + +@session: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-signature.sgml b/docs/reference/tmpl/gmime-signature.sgml new file mode 100644 index 0000000..c11c974 --- /dev/null +++ b/docs/reference/tmpl/gmime-signature.sgml @@ -0,0 +1,260 @@ +<!-- ##### SECTION Title ##### --> +gmime-signature + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### ENUM GMimeSignatureStatus ##### --> +<para> + +</para> + +@GMIME_SIGNATURE_STATUS_GOOD: +@GMIME_SIGNATURE_STATUS_ERROR: +@GMIME_SIGNATURE_STATUS_BAD: + +<!-- ##### ENUM GMimeSignatureError ##### --> +<para> + +</para> + +@GMIME_SIGNATURE_ERROR_NONE: +@GMIME_SIGNATURE_ERROR_EXPSIG: +@GMIME_SIGNATURE_ERROR_NO_PUBKEY: +@GMIME_SIGNATURE_ERROR_EXPKEYSIG: +@GMIME_SIGNATURE_ERROR_REVKEYSIG: +@GMIME_SIGNATURE_ERROR_UNSUPP_ALGO: + +<!-- ##### STRUCT GMimeSignature ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_signature_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_signature_get_certificate ##### --> +<para> + +</para> + +@sig: +@Returns: + + +<!-- ##### FUNCTION g_mime_signature_set_certificate ##### --> +<para> + +</para> + +@sig: +@cert: + + +<!-- ##### FUNCTION g_mime_signature_get_status ##### --> +<para> + +</para> + +@sig: +@Returns: + + +<!-- ##### FUNCTION g_mime_signature_set_status ##### --> +<para> + +</para> + +@sig: +@status: + + +<!-- ##### FUNCTION g_mime_signature_get_errors ##### --> +<para> + +</para> + +@sig: +@Returns: + + +<!-- ##### FUNCTION g_mime_signature_set_errors ##### --> +<para> + +</para> + +@sig: +@errors: + + +<!-- ##### FUNCTION g_mime_signature_get_created ##### --> +<para> + +</para> + +@sig: +@Returns: + + +<!-- ##### FUNCTION g_mime_signature_set_created ##### --> +<para> + +</para> + +@sig: +@created: + + +<!-- ##### FUNCTION g_mime_signature_get_expires ##### --> +<para> + +</para> + +@sig: +@Returns: + + +<!-- ##### FUNCTION g_mime_signature_set_expires ##### --> +<para> + +</para> + +@sig: +@expires: + + +<!-- ##### STRUCT GMimeSignatureList ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_signature_list_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_signature_list_length ##### --> +<para> + +</para> + +@list: +@Returns: + + +<!-- ##### FUNCTION g_mime_signature_list_clear ##### --> +<para> + +</para> + +@list: + + +<!-- ##### FUNCTION g_mime_signature_list_add ##### --> +<para> + +</para> + +@list: +@sig: +@Returns: + + +<!-- ##### FUNCTION g_mime_signature_list_insert ##### --> +<para> + +</para> + +@list: +@index: +@sig: + + +<!-- ##### FUNCTION g_mime_signature_list_remove ##### --> +<para> + +</para> + +@list: +@sig: +@Returns: + + +<!-- ##### FUNCTION g_mime_signature_list_remove_at ##### --> +<para> + +</para> + +@list: +@index: +@Returns: + + +<!-- ##### FUNCTION g_mime_signature_list_contains ##### --> +<para> + +</para> + +@list: +@sig: +@Returns: + + +<!-- ##### FUNCTION g_mime_signature_list_index_of ##### --> +<para> + +</para> + +@list: +@sig: +@Returns: + + +<!-- ##### FUNCTION g_mime_signature_list_get_signature ##### --> +<para> + +</para> + +@list: +@index: +@Returns: + + +<!-- ##### FUNCTION g_mime_signature_list_set_signature ##### --> +<para> + +</para> + +@list: +@index: +@sig: + + diff --git a/docs/reference/tmpl/gmime-stream-buffer.sgml b/docs/reference/tmpl/gmime-stream-buffer.sgml new file mode 100644 index 0000000..cbcc706 --- /dev/null +++ b/docs/reference/tmpl/gmime-stream-buffer.sgml @@ -0,0 +1,67 @@ +<!-- ##### SECTION Title ##### --> +gmime-stream-buffer + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### ENUM GMimeStreamBufferMode ##### --> +<para> + +</para> + +@GMIME_STREAM_BUFFER_CACHE_READ: +@GMIME_STREAM_BUFFER_BLOCK_READ: +@GMIME_STREAM_BUFFER_BLOCK_WRITE: + +<!-- ##### STRUCT GMimeStreamBuffer ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_stream_buffer_new ##### --> +<para> + +</para> + +@source: +@mode: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_buffer_gets ##### --> +<para> + +</para> + +@stream: +@buf: +@max: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_buffer_readln ##### --> +<para> + +</para> + +@stream: +@buffer: + + diff --git a/docs/reference/tmpl/gmime-stream-cat.sgml b/docs/reference/tmpl/gmime-stream-cat.sgml new file mode 100644 index 0000000..4c17fea --- /dev/null +++ b/docs/reference/tmpl/gmime-stream-cat.sgml @@ -0,0 +1,47 @@ +<!-- ##### SECTION Title ##### --> +gmime-stream-cat + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeStreamCat ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_stream_cat_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_cat_add_source ##### --> +<para> + +</para> + +@cat: +@source: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-stream-file.sgml b/docs/reference/tmpl/gmime-stream-file.sgml new file mode 100644 index 0000000..0309a69 --- /dev/null +++ b/docs/reference/tmpl/gmime-stream-file.sgml @@ -0,0 +1,66 @@ +<!-- ##### SECTION Title ##### --> +gmime-stream-file + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeStreamFile ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_stream_file_new ##### --> +<para> + +</para> + +@fp: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_file_new_with_bounds ##### --> +<para> + +</para> + +@fp: +@start: +@end: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_file_get_owner ##### --> +<para> + +</para> + +@stream: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_file_set_owner ##### --> +<para> + +</para> + +@stream: +@owner: + + diff --git a/docs/reference/tmpl/gmime-stream-filter.sgml b/docs/reference/tmpl/gmime-stream-filter.sgml new file mode 100644 index 0000000..cb86fbb --- /dev/null +++ b/docs/reference/tmpl/gmime-stream-filter.sgml @@ -0,0 +1,56 @@ +<!-- ##### SECTION Title ##### --> +gmime-stream-filter + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeStreamFilter ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_stream_filter_new ##### --> +<para> + +</para> + +@stream: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_filter_add ##### --> +<para> + +</para> + +@stream: +@filter: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_filter_remove ##### --> +<para> + +</para> + +@stream: +@id: + + diff --git a/docs/reference/tmpl/gmime-stream-fs.sgml b/docs/reference/tmpl/gmime-stream-fs.sgml new file mode 100644 index 0000000..fa14bb5 --- /dev/null +++ b/docs/reference/tmpl/gmime-stream-fs.sgml @@ -0,0 +1,66 @@ +<!-- ##### SECTION Title ##### --> +gmime-stream-fs + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeStreamFs ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_stream_fs_new ##### --> +<para> + +</para> + +@fd: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_fs_new_with_bounds ##### --> +<para> + +</para> + +@fd: +@start: +@end: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_fs_get_owner ##### --> +<para> + +</para> + +@stream: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_fs_set_owner ##### --> +<para> + +</para> + +@stream: +@owner: + + diff --git a/docs/reference/tmpl/gmime-stream-gio.sgml b/docs/reference/tmpl/gmime-stream-gio.sgml new file mode 100644 index 0000000..fe948db --- /dev/null +++ b/docs/reference/tmpl/gmime-stream-gio.sgml @@ -0,0 +1,72 @@ +<!-- ##### SECTION Title ##### --> +gmime-stream-gio + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeStreamGIO ##### --> +<para> + +</para> + +@parent_object: +@ostream: +@istream: +@file: +@owner: +@eos: + +<!-- ##### FUNCTION g_mime_stream_gio_new ##### --> +<para> + +</para> + +@file: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_gio_new_with_bounds ##### --> +<para> + +</para> + +@file: +@start: +@end: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_gio_get_owner ##### --> +<para> + +</para> + +@stream: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_gio_set_owner ##### --> +<para> + +</para> + +@stream: +@owner: + + diff --git a/docs/reference/tmpl/gmime-stream-mem.sgml b/docs/reference/tmpl/gmime-stream-mem.sgml new file mode 100644 index 0000000..83664ca --- /dev/null +++ b/docs/reference/tmpl/gmime-stream-mem.sgml @@ -0,0 +1,92 @@ +<!-- ##### SECTION Title ##### --> +gmime-stream-mem + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeStreamMem ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_stream_mem_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_mem_new_with_byte_array ##### --> +<para> + +</para> + +@array: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_mem_new_with_buffer ##### --> +<para> + +</para> + +@buffer: +@len: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_mem_get_byte_array ##### --> +<para> + +</para> + +@mem: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_mem_set_byte_array ##### --> +<para> + +</para> + +@mem: +@array: + + +<!-- ##### FUNCTION g_mime_stream_mem_get_owner ##### --> +<para> + +</para> + +@mem: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_mem_set_owner ##### --> +<para> + +</para> + +@mem: +@owner: + + diff --git a/docs/reference/tmpl/gmime-stream-mmap.sgml b/docs/reference/tmpl/gmime-stream-mmap.sgml new file mode 100644 index 0000000..bbff4d4 --- /dev/null +++ b/docs/reference/tmpl/gmime-stream-mmap.sgml @@ -0,0 +1,52 @@ +<!-- ##### SECTION Title ##### --> +gmime-stream-mmap + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeStreamMmap ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_stream_mmap_new ##### --> +<para> + +</para> + +@fd: +@prot: +@flags: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_mmap_new_with_bounds ##### --> +<para> + +</para> + +@fd: +@prot: +@flags: +@start: +@end: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-stream-null.sgml b/docs/reference/tmpl/gmime-stream-null.sgml new file mode 100644 index 0000000..8f00845 --- /dev/null +++ b/docs/reference/tmpl/gmime-stream-null.sgml @@ -0,0 +1,37 @@ +<!-- ##### SECTION Title ##### --> +gmime-stream-null + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeStreamNull ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_stream_null_new ##### --> +<para> + +</para> + +@void: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-stream-pipe.sgml b/docs/reference/tmpl/gmime-stream-pipe.sgml new file mode 100644 index 0000000..73a7107 --- /dev/null +++ b/docs/reference/tmpl/gmime-stream-pipe.sgml @@ -0,0 +1,55 @@ +<!-- ##### SECTION Title ##### --> +gmime-stream-pipe + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeStreamPipe ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_stream_pipe_new ##### --> +<para> + +</para> + +@fd: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_pipe_get_owner ##### --> +<para> + +</para> + +@stream: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_pipe_set_owner ##### --> +<para> + +</para> + +@stream: +@owner: + + diff --git a/docs/reference/tmpl/gmime-stream.sgml b/docs/reference/tmpl/gmime-stream.sgml new file mode 100644 index 0000000..f9c149e --- /dev/null +++ b/docs/reference/tmpl/gmime-stream.sgml @@ -0,0 +1,205 @@ +<!-- ##### SECTION Title ##### --> +gmime-stream + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### ENUM GMimeSeekWhence ##### --> +<para> + +</para> + +@GMIME_STREAM_SEEK_SET: +@GMIME_STREAM_SEEK_CUR: +@GMIME_STREAM_SEEK_END: + +<!-- ##### STRUCT GMimeStreamIOVector ##### --> +<para> + +</para> + +@data: +@len: + +<!-- ##### STRUCT GMimeStream ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_stream_construct ##### --> +<para> + +</para> + +@stream: +@start: +@end: + + +<!-- ##### FUNCTION g_mime_stream_read ##### --> +<para> + +</para> + +@stream: +@buf: +@len: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_write ##### --> +<para> + +</para> + +@stream: +@buf: +@len: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_flush ##### --> +<para> + +</para> + +@stream: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_seek ##### --> +<para> + +</para> + +@stream: +@offset: +@whence: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_tell ##### --> +<para> + +</para> + +@stream: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_reset ##### --> +<para> + +</para> + +@stream: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_eos ##### --> +<para> + +</para> + +@stream: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_close ##### --> +<para> + +</para> + +@stream: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_length ##### --> +<para> + +</para> + +@stream: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_substream ##### --> +<para> + +</para> + +@stream: +@start: +@end: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_set_bounds ##### --> +<para> + +</para> + +@stream: +@start: +@end: + + +<!-- ##### FUNCTION g_mime_stream_write_string ##### --> +<para> + +</para> + +@stream: +@str: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_printf ##### --> +<para> + +</para> + +@stream: +@fmt: +@...: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_write_to_stream ##### --> +<para> + +</para> + +@src: +@dest: +@Returns: + + +<!-- ##### FUNCTION g_mime_stream_writev ##### --> +<para> + +</para> + +@stream: +@vector: +@count: +@Returns: + + diff --git a/docs/reference/tmpl/gmime-unused.sgml b/docs/reference/tmpl/gmime-unused.sgml new file mode 100644 index 0000000..a46f8d0 --- /dev/null +++ b/docs/reference/tmpl/gmime-unused.sgml @@ -0,0 +1,1182 @@ +<!-- ##### SECTION ./tmpl/gmime-cipher-context.sgml:Image ##### --> + + + +<!-- ##### SECTION ./tmpl/gmime-cipher-context.sgml:Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/gmime-cipher-context.sgml:See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/gmime-cipher-context.sgml:Short_Description ##### --> + + + +<!-- ##### SECTION ./tmpl/gmime-cipher-context.sgml:Stability_Level ##### --> + + + +<!-- ##### SECTION ./tmpl/gmime-cipher-context.sgml:Title ##### --> +gmime-cipher-context + + +<!-- ##### SECTION ./tmpl/gmime-session-simple.sgml:Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/gmime-session-simple.sgml:See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/gmime-session-simple.sgml:Short_Description ##### --> + + + +<!-- ##### SECTION ./tmpl/gmime-session-simple.sgml:Stability_Level ##### --> + + + +<!-- ##### SECTION ./tmpl/gmime-session-simple.sgml:Title ##### --> +gmime-session-simple + + +<!-- ##### SECTION ./tmpl/gmime-session.sgml:Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/gmime-session.sgml:See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/gmime-session.sgml:Short_Description ##### --> + + + +<!-- ##### SECTION ./tmpl/gmime-session.sgml:Stability_Level ##### --> + + + +<!-- ##### SECTION ./tmpl/gmime-session.sgml:Title ##### --> +gmime-session + + +<!-- ##### ENUM GMimeBestEncoding ##### --> +<para> + +</para> + +@GMIME_BEST_ENCODING_7BIT: +@GMIME_BEST_ENCODING_8BIT: +@GMIME_BEST_ENCODING_BINARY: + +<!-- ##### STRUCT GMimeCipherContext ##### --> +<para> + +</para> + + +<!-- ##### ENUM GMimeCipherHash ##### --> +<para> + +</para> + +@GMIME_CIPHER_HASH_DEFAULT: +@GMIME_CIPHER_HASH_MD2: +@GMIME_CIPHER_HASH_MD5: +@GMIME_CIPHER_HASH_SHA1: +@GMIME_CIPHER_HASH_SHA224: +@GMIME_CIPHER_HASH_SHA256: +@GMIME_CIPHER_HASH_SHA384: +@GMIME_CIPHER_HASH_SHA512: +@GMIME_CIPHER_HASH_RIPEMD160: +@GMIME_CIPHER_HASH_TIGER192: +@GMIME_CIPHER_HASH_HAVAL5160: + +<!-- ##### ENUM GMimeCryptoCipherAlgo ##### --> +<para> + +</para> + +@GMIME_CRYPTO_CIPHER_ALGO_DEFAULT: +@GMIME_CRYPTO_CIPHER_ALGO_IDEA: +@GMIME_CRYPTO_CIPHER_ALGO_3DES: +@GMIME_CRYPTO_CIPHER_ALGO_CAST5: +@GMIME_CRYPTO_CIPHER_ALGO_BLOWFISH: +@GMIME_CRYPTO_CIPHER_ALGO_AES: +@GMIME_CRYPTO_CIPHER_ALGO_AES192: +@GMIME_CRYPTO_CIPHER_ALGO_AES256: +@GMIME_CRYPTO_CIPHER_ALGO_TWOFISH: +@GMIME_CRYPTO_CIPHER_ALGO_CAMELLIA128: +@GMIME_CRYPTO_CIPHER_ALGO_CAMELLIA196: +@GMIME_CRYPTO_CIPHER_ALGO_CAMELLIA256: + +<!-- ##### ENUM GMimeCryptoHash ##### --> +<para> + +</para> + +@GMIME_CRYPTO_HASH_DEFAULT: +@GMIME_CRYPTO_HASH_MD5: +@GMIME_CRYPTO_HASH_SHA1: +@GMIME_CRYPTO_HASH_RIPEMD160: +@GMIME_CRYPTO_HASH_MD2: +@GMIME_CRYPTO_HASH_TIGER192: +@GMIME_CRYPTO_HASH_HAVAL5160: +@GMIME_CRYPTO_HASH_SHA256: +@GMIME_CRYPTO_HASH_SHA384: +@GMIME_CRYPTO_HASH_SHA512: +@GMIME_CRYPTO_HASH_SHA224: +@GMIME_CRYPTO_HASH_MD4: + +<!-- ##### STRUCT GMimeCryptoKey ##### --> +<para> + +</para> + +@pubkey_algo: +@issuer_serial: +@issuer_name: +@fingerprint: +@created: +@expires: +@keyid: +@email: +@name: + +<!-- ##### ENUM GMimeCryptoPubKeyAlgo ##### --> +<para> + +</para> + +@GMIME_CRYPTO_PUBKEY_ALGO_DEFAULT: +@GMIME_CRYPTO_PUBKEY_ALGO_RSA: +@GMIME_CRYPTO_PUBKEY_ALGO_RSA_E: +@GMIME_CRYPTO_PUBKEY_ALGO_RSA_S: +@GMIME_CRYPTO_PUBKEY_ALGO_ELG_E: +@GMIME_CRYPTO_PUBKEY_ALGO_DSA: +@GMIME_CRYPTO_PUBKEY_ALGO_ELG: + +<!-- ##### STRUCT GMimeCryptoRecipient ##### --> +<para> + +</para> + +@next: +@pubkey_algo: +@keyid: + +<!-- ##### STRUCT GMimeDecryptionResult ##### --> +<para> + +</para> + +@validity: +@recipients: +@cipher: +@mdc: + +<!-- ##### STRUCT GMimeSession ##### --> +<para> + +</para> + + +<!-- ##### STRUCT GMimeSessionSimple ##### --> +<para> + +</para> + + +<!-- ##### STRUCT GMimeSignatureValidity ##### --> +<para> + +</para> + +@status: +@signers: +@details: + +<!-- ##### STRUCT GMimeSigner ##### --> +<para> + +</para> + +@next: +@status: +@errors: +@trust: +@unused: +@issuer_serial: +@issuer_name: +@fingerprint: +@sig_created: +@sig_expires: +@key_created: +@key_expires: +@keyid: +@email: +@name: + +<!-- ##### ENUM GMimeSignerError ##### --> +<para> + +</para> + +@GMIME_SIGNER_ERROR_NONE: +@GMIME_SIGNER_ERROR_EXPSIG: +@GMIME_SIGNER_ERROR_NO_PUBKEY: +@GMIME_SIGNER_ERROR_EXPKEYSIG: +@GMIME_SIGNER_ERROR_REVKEYSIG: + +<!-- ##### ENUM GMimeSignerStatus ##### --> +<para> + +</para> + +@GMIME_SIGNER_STATUS_NONE: +@GMIME_SIGNER_STATUS_GOOD: +@GMIME_SIGNER_STATUS_BAD: +@GMIME_SIGNER_STATUS_ERROR: + +<!-- ##### ENUM GMimeSignerTrust ##### --> +<para> + +</para> + +@GMIME_SIGNER_TRUST_NONE: +@GMIME_SIGNER_TRUST_NEVER: +@GMIME_SIGNER_TRUST_UNDEFINED: +@GMIME_SIGNER_TRUST_MARGINAL: +@GMIME_SIGNER_TRUST_FULLY: +@GMIME_SIGNER_TRUST_ULTIMATE: + +<!-- ##### FUNCTION g_mime_cipher_context_decrypt ##### --> +<para> + +</para> + +@ctx: +@istream: +@ostream: +@err: +@Returns: + +<!-- ##### FUNCTION g_mime_cipher_context_encrypt ##### --> +<para> + +</para> + +@ctx: +@sign: +@userid: +@recipients: +@istream: +@ostream: +@err: +@Returns: + +<!-- ##### FUNCTION g_mime_cipher_context_export_keys ##### --> +<para> + +</para> + +@ctx: +@keys: +@ostream: +@err: +@Returns: + +<!-- ##### FUNCTION g_mime_cipher_context_hash_id ##### --> +<para> + +</para> + +@ctx: +@hash: +@Returns: + +<!-- ##### FUNCTION g_mime_cipher_context_hash_name ##### --> +<para> + +</para> + +@ctx: +@hash: +@Returns: + +<!-- ##### FUNCTION g_mime_cipher_context_import_keys ##### --> +<para> + +</para> + +@ctx: +@istream: +@err: +@Returns: + +<!-- ##### FUNCTION g_mime_cipher_context_set_request_password ##### --> +<para> + +</para> + +@ctx: +@request_passwd: + +<!-- ##### FUNCTION g_mime_cipher_context_sign ##### --> +<para> + +</para> + +@ctx: +@userid: +@hash: +@istream: +@ostream: +@err: +@Returns: + +<!-- ##### FUNCTION g_mime_cipher_context_verify ##### --> +<para> + +</para> + +@ctx: +@hash: +@istream: +@sigstream: +@err: +@Returns: + +<!-- ##### FUNCTION g_mime_crypto_context_hash_id ##### --> +<para> + +</para> + +@ctx: +@hash: +@Returns: + +<!-- ##### FUNCTION g_mime_crypto_context_hash_name ##### --> +<para> + +</para> + +@ctx: +@hash: +@Returns: + +<!-- ##### FUNCTION g_mime_crypto_key_get_creation_date ##### --> +<para> + +</para> + +@key: +@Returns: + +<!-- ##### FUNCTION g_mime_crypto_key_get_email ##### --> +<para> + +</para> + +@key: +@Returns: + +<!-- ##### FUNCTION g_mime_crypto_key_get_expiration_date ##### --> +<para> + +</para> + +@key: +@Returns: + +<!-- ##### FUNCTION g_mime_crypto_key_get_fingerprint ##### --> +<para> + +</para> + +@key: +@Returns: + +<!-- ##### FUNCTION g_mime_crypto_key_get_issuer_name ##### --> +<para> + +</para> + +@key: +@Returns: + +<!-- ##### FUNCTION g_mime_crypto_key_get_issuer_serial ##### --> +<para> + +</para> + +@key: +@Returns: + +<!-- ##### FUNCTION g_mime_crypto_key_get_key_id ##### --> +<para> + +</para> + +@key: +@Returns: + +<!-- ##### FUNCTION g_mime_crypto_key_get_name ##### --> +<para> + +</para> + +@key: +@Returns: + +<!-- ##### FUNCTION g_mime_crypto_key_get_pubkey_algo ##### --> +<para> + +</para> + +@key: +@Returns: + +<!-- ##### FUNCTION g_mime_crypto_key_set_creation_date ##### --> +<para> + +</para> + +@key: +@created: + +<!-- ##### FUNCTION g_mime_crypto_key_set_email ##### --> +<para> + +</para> + +@key: +@email: + +<!-- ##### FUNCTION g_mime_crypto_key_set_expiration_date ##### --> +<para> + +</para> + +@key: +@expires: + +<!-- ##### FUNCTION g_mime_crypto_key_set_fingerprint ##### --> +<para> + +</para> + +@key: +@fingerprint: + +<!-- ##### FUNCTION g_mime_crypto_key_set_issuer_name ##### --> +<para> + +</para> + +@key: +@issuer_name: + +<!-- ##### FUNCTION g_mime_crypto_key_set_issuer_serial ##### --> +<para> + +</para> + +@key: +@issuer_serial: + +<!-- ##### FUNCTION g_mime_crypto_key_set_key_id ##### --> +<para> + +</para> + +@key: +@key_id: + +<!-- ##### FUNCTION g_mime_crypto_key_set_name ##### --> +<para> + +</para> + +@key: +@name: + +<!-- ##### FUNCTION g_mime_crypto_key_set_pubkey_algo ##### --> +<para> + +</para> + +@key: +@pubkey_algo: + +<!-- ##### FUNCTION g_mime_crypto_recipient_free ##### --> +<para> + +</para> + +@recipient: + +<!-- ##### FUNCTION g_mime_crypto_recipient_get_key_id ##### --> +<para> + +</para> + +@recipient: +@Returns: + +<!-- ##### FUNCTION g_mime_crypto_recipient_get_pubkey_algo ##### --> +<para> + +</para> + +@recipient: +@Returns: + +<!-- ##### FUNCTION g_mime_crypto_recipient_new ##### --> +<para> + +</para> + +@void: +@Returns: + +<!-- ##### FUNCTION g_mime_crypto_recipient_next ##### --> +<para> + +</para> + +@recipient: +@Returns: + +<!-- ##### FUNCTION g_mime_crypto_recipient_set_key_id ##### --> +<para> + +</para> + +@recipient: +@key_id: + +<!-- ##### FUNCTION g_mime_crypto_recipient_set_pubkey_algo ##### --> +<para> + +</para> + +@recipient: +@pubkey_algo: + +<!-- ##### FUNCTION g_mime_decryption_result_add_recipient ##### --> +<para> + +</para> + +@result: +@recipient: + +<!-- ##### FUNCTION g_mime_decryption_result_free ##### --> +<para> + +</para> + +@result: + +<!-- ##### FUNCTION g_mime_decryption_result_get_cipher ##### --> +<para> + +</para> + +@result: +@Returns: + +<!-- ##### FUNCTION g_mime_decryption_result_get_mdc ##### --> +<para> + +</para> + +@result: +@Returns: + +<!-- ##### FUNCTION g_mime_decryption_result_get_recipients ##### --> +<para> + +</para> + +@result: +@Returns: + +<!-- ##### FUNCTION g_mime_decryption_result_get_validity ##### --> +<para> + +</para> + +@result: +@Returns: + +<!-- ##### FUNCTION g_mime_decryption_result_new ##### --> +<para> + +</para> + +@void: +@Returns: + +<!-- ##### FUNCTION g_mime_decryption_result_set_cipher ##### --> +<para> + +</para> + +@result: +@cipher: + +<!-- ##### FUNCTION g_mime_decryption_result_set_mdc ##### --> +<para> + +</para> + +@result: +@mdc: + +<!-- ##### FUNCTION g_mime_decryption_result_set_validity ##### --> +<para> + +</para> + +@result: +@validity: + +<!-- ##### FUNCTION g_mime_header_list_has_raw ##### --> +<para> + +</para> + +@headers: +@Returns: + +<!-- ##### FUNCTION g_mime_header_list_set_raw ##### --> +<para> + +</para> + +@headers: +@raw: + +<!-- ##### FUNCTION g_mime_multipart_encrypted_get_signature_validity ##### --> +<para> + +</para> + +@mpe: +@Returns: + +<!-- ##### FUNCTION g_mime_session_forget_passwd ##### --> +<para> + +</para> + +@session: +@item: +@err: + +<!-- ##### FUNCTION g_mime_session_is_online ##### --> +<para> + +</para> + +@session: +@Returns: + +<!-- ##### FUNCTION g_mime_session_request_passwd ##### --> +<para> + +</para> + +@session: +@prompt: +@secret: +@item: +@err: +@Returns: + +<!-- ##### FUNCTION g_mime_session_simple_set_forget_passwd ##### --> +<para> + +</para> + +@session: +@forget_passwd: + +<!-- ##### FUNCTION g_mime_session_simple_set_is_online ##### --> +<para> + +</para> + +@session: +@is_online: + +<!-- ##### FUNCTION g_mime_session_simple_set_request_passwd ##### --> +<para> + +</para> + +@session: +@request_passwd: + +<!-- ##### FUNCTION g_mime_signature_validity_add_signer ##### --> +<para> + +</para> + +@validity: +@signer: + +<!-- ##### FUNCTION g_mime_signature_validity_free ##### --> +<para> + +</para> + +@validity: + +<!-- ##### FUNCTION g_mime_signature_validity_get_details ##### --> +<para> + +</para> + +@validity: +@Returns: + +<!-- ##### FUNCTION g_mime_signature_validity_get_signers ##### --> +<para> + +</para> + +@validity: +@Returns: + +<!-- ##### FUNCTION g_mime_signature_validity_get_status ##### --> +<para> + +</para> + +@validity: +@Returns: + +<!-- ##### FUNCTION g_mime_signature_validity_new ##### --> +<para> + +</para> + +@void: +@Returns: + +<!-- ##### FUNCTION g_mime_signature_validity_set_details ##### --> +<para> + +</para> + +@validity: +@details: + +<!-- ##### FUNCTION g_mime_signature_validity_set_status ##### --> +<para> + +</para> + +@validity: +@status: + +<!-- ##### FUNCTION g_mime_signer_free ##### --> +<para> + +</para> + +@signer: + +<!-- ##### FUNCTION g_mime_signer_get_created ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_creation_date ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_email ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_errors ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_expiration_date ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_expires ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_fingerprint ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_hash ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_hash_algo ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_issuer_name ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_issuer_serial ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_key ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_key_created ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_key_expires ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_key_id ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_name ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_pubkey_algo ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_sig_class ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_sig_created ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_sig_expires ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_sig_version ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_status ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_get_trust ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_new ##### --> +<para> + +</para> + +@void: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_next ##### --> +<para> + +</para> + +@signer: +@Returns: + +<!-- ##### FUNCTION g_mime_signer_set_created ##### --> +<para> + +</para> + +@signer: +@created: + +<!-- ##### FUNCTION g_mime_signer_set_creation_date ##### --> +<para> + +</para> + +@signer: +@created: + +<!-- ##### FUNCTION g_mime_signer_set_email ##### --> +<para> + +</para> + +@signer: +@email: + +<!-- ##### FUNCTION g_mime_signer_set_errors ##### --> +<para> + +</para> + +@signer: +@error: + +<!-- ##### FUNCTION g_mime_signer_set_expiration_date ##### --> +<para> + +</para> + +@signer: +@expires: + +<!-- ##### FUNCTION g_mime_signer_set_expires ##### --> +<para> + +</para> + +@signer: +@expires: + +<!-- ##### FUNCTION g_mime_signer_set_fingerprint ##### --> +<para> + +</para> + +@signer: +@fingerprint: + +<!-- ##### FUNCTION g_mime_signer_set_hash ##### --> +<para> + +</para> + +@signer: +@hash: + +<!-- ##### FUNCTION g_mime_signer_set_hash_algo ##### --> +<para> + +</para> + +@signer: +@hash: + +<!-- ##### FUNCTION g_mime_signer_set_issuer_name ##### --> +<para> + +</para> + +@signer: +@issuer_name: + +<!-- ##### FUNCTION g_mime_signer_set_issuer_serial ##### --> +<para> + +</para> + +@signer: +@issuer_serial: + +<!-- ##### FUNCTION g_mime_signer_set_key_created ##### --> +<para> + +</para> + +@signer: +@created: + +<!-- ##### FUNCTION g_mime_signer_set_key_expires ##### --> +<para> + +</para> + +@signer: +@expires: + +<!-- ##### FUNCTION g_mime_signer_set_key_id ##### --> +<para> + +</para> + +@signer: +@key_id: + +<!-- ##### FUNCTION g_mime_signer_set_name ##### --> +<para> + +</para> + +@signer: +@name: + +<!-- ##### FUNCTION g_mime_signer_set_pubkey_algo ##### --> +<para> + +</para> + +@signer: +@pubkey_algo: + +<!-- ##### FUNCTION g_mime_signer_set_sig_class ##### --> +<para> + +</para> + +@signer: +@sig_class: + +<!-- ##### FUNCTION g_mime_signer_set_sig_created ##### --> +<para> + +</para> + +@signer: +@created: + +<!-- ##### FUNCTION g_mime_signer_set_sig_expires ##### --> +<para> + +</para> + +@signer: +@expires: + +<!-- ##### FUNCTION g_mime_signer_set_sig_version ##### --> +<para> + +</para> + +@signer: +@version: + +<!-- ##### FUNCTION g_mime_signer_set_status ##### --> +<para> + +</para> + +@signer: +@status: + +<!-- ##### FUNCTION g_mime_signer_set_trust ##### --> +<para> + +</para> + +@signer: +@trust: + diff --git a/docs/reference/tmpl/gmime-utils.sgml b/docs/reference/tmpl/gmime-utils.sgml new file mode 100644 index 0000000..42b01bf --- /dev/null +++ b/docs/reference/tmpl/gmime-utils.sgml @@ -0,0 +1,240 @@ +<!-- ##### SECTION Title ##### --> +gmime-utils + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT GMimeReferences ##### --> +<para> + +</para> + +@next: +@msgid: + +<!-- ##### FUNCTION g_mime_utils_header_decode_date ##### --> +<para> + +</para> + +@str: +@tz_offset: +@Returns: + + +<!-- ##### FUNCTION g_mime_utils_header_format_date ##### --> +<para> + +</para> + +@date: +@tz_offset: +@Returns: + + +<!-- ##### FUNCTION g_mime_utils_generate_message_id ##### --> +<para> + +</para> + +@fqdn: +@Returns: + + +<!-- ##### FUNCTION g_mime_utils_decode_message_id ##### --> +<para> + +</para> + +@message_id: +@Returns: + + +<!-- ##### FUNCTION g_mime_references_get_message_id ##### --> +<para> + +</para> + +@ref: +@Returns: + + +<!-- ##### FUNCTION g_mime_references_get_next ##### --> +<para> + +</para> + +@ref: +@Returns: + + +<!-- ##### FUNCTION g_mime_references_decode ##### --> +<para> + +</para> + +@text: +@Returns: + + +<!-- ##### FUNCTION g_mime_references_append ##### --> +<para> + +</para> + +@refs: +@msgid: + + +<!-- ##### FUNCTION g_mime_references_clear ##### --> +<para> + +</para> + +@refs: + + +<!-- ##### FUNCTION g_mime_references_free ##### --> +<para> + +</para> + +@refs: + + +<!-- ##### FUNCTION g_mime_utils_header_fold ##### --> +<para> + +</para> + +@str: +@Returns: + + +<!-- ##### FUNCTION g_mime_utils_header_printf ##### --> +<para> + +</para> + +@format: +@...: +@Returns: + + +<!-- ##### FUNCTION g_mime_utils_quote_string ##### --> +<para> + +</para> + +@str: +@Returns: + + +<!-- ##### FUNCTION g_mime_utils_unquote_string ##### --> +<para> + +</para> + +@str: + + +<!-- ##### FUNCTION g_mime_utils_text_is_8bit ##### --> +<para> + +</para> + +@text: +@len: +@Returns: + + +<!-- ##### FUNCTION g_mime_utils_best_encoding ##### --> +<para> + +</para> + +@text: +@len: +@Returns: + + +<!-- ##### FUNCTION g_mime_utils_decode_8bit ##### --> +<para> + +</para> + +@text: +@len: +@Returns: + + +<!-- ##### FUNCTION g_mime_utils_header_decode_text ##### --> +<para> + +</para> + +@text: +@Returns: + + +<!-- ##### FUNCTION g_mime_utils_header_encode_text ##### --> +<para> + +</para> + +@text: +@Returns: + + +<!-- ##### FUNCTION g_mime_utils_header_decode_phrase ##### --> +<para> + +</para> + +@phrase: +@Returns: + + +<!-- ##### FUNCTION g_mime_utils_header_encode_phrase ##### --> +<para> + +</para> + +@phrase: +@Returns: + + +<!-- ##### FUNCTION g_mime_utils_structured_header_fold ##### --> +<para> + +</para> + +@str: +@Returns: + + +<!-- ##### FUNCTION g_mime_utils_unstructured_header_fold ##### --> +<para> + +</para> + +@str: +@Returns: + + diff --git a/docs/reference/tmpl/gmime.sgml b/docs/reference/tmpl/gmime.sgml new file mode 100644 index 0000000..dbf4f2a --- /dev/null +++ b/docs/reference/tmpl/gmime.sgml @@ -0,0 +1,131 @@ +<!-- ##### SECTION Title ##### --> +gmime + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO GMIME_MAJOR_VERSION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_MICRO_VERSION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_MINOR_VERSION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_BINARY_AGE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_INTERFACE_AGE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GMIME_CHECK_VERSION ##### --> +<para> + +</para> + +@major: +@minor: +@micro: + + +<!-- ##### MACRO GMIME_ENABLE_RFC2047_WORKAROUNDS ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION g_mime_init ##### --> +<para> + +</para> + +@flags: + + +<!-- ##### FUNCTION g_mime_shutdown ##### --> +<para> + +</para> + +@void: + + +<!-- ##### VARIABLE gmime_major_version ##### --> +<para> + +</para> + + +<!-- ##### VARIABLE gmime_minor_version ##### --> +<para> + +</para> + + +<!-- ##### VARIABLE gmime_micro_version ##### --> +<para> + +</para> + + +<!-- ##### VARIABLE gmime_binary_age ##### --> +<para> + +</para> + + +<!-- ##### VARIABLE gmime_interface_age ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION g_mime_check_version ##### --> +<para> + +</para> + +@major: +@minor: +@micro: +@Returns: + + diff --git a/docs/reference/tmpl/internet-address-group.sgml b/docs/reference/tmpl/internet-address-group.sgml new file mode 100644 index 0000000..c738d96 --- /dev/null +++ b/docs/reference/tmpl/internet-address-group.sgml @@ -0,0 +1,65 @@ +<!-- ##### SECTION Title ##### --> +internet-address-group + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT InternetAddressGroup ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION internet_address_group_new ##### --> +<para> + +</para> + +@name: +@Returns: + + +<!-- ##### FUNCTION internet_address_group_get_members ##### --> +<para> + +</para> + +@group: +@Returns: + + +<!-- ##### FUNCTION internet_address_group_set_members ##### --> +<para> + +</para> + +@group: +@members: + + +<!-- ##### FUNCTION internet_address_group_add_member ##### --> +<para> + +</para> + +@group: +@member: +@Returns: + + diff --git a/docs/reference/tmpl/internet-address-list.sgml b/docs/reference/tmpl/internet-address-list.sgml new file mode 100644 index 0000000..f2c7065 --- /dev/null +++ b/docs/reference/tmpl/internet-address-list.sgml @@ -0,0 +1,180 @@ +<!-- ##### SECTION Title ##### --> +internet-address-list + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT InternetAddressList ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION internet_address_list_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION internet_address_list_length ##### --> +<para> + +</para> + +@list: +@Returns: + + +<!-- ##### FUNCTION internet_address_list_clear ##### --> +<para> + +</para> + +@list: + + +<!-- ##### FUNCTION internet_address_list_add ##### --> +<para> + +</para> + +@list: +@ia: +@Returns: + + +<!-- ##### FUNCTION internet_address_list_insert ##### --> +<para> + +</para> + +@list: +@index: +@ia: + + +<!-- ##### FUNCTION internet_address_list_remove ##### --> +<para> + +</para> + +@list: +@ia: +@Returns: + + +<!-- ##### FUNCTION internet_address_list_remove_at ##### --> +<para> + +</para> + +@list: +@index: +@Returns: + + +<!-- ##### FUNCTION internet_address_list_contains ##### --> +<para> + +</para> + +@list: +@ia: +@Returns: + + +<!-- ##### FUNCTION internet_address_list_index_of ##### --> +<para> + +</para> + +@list: +@ia: +@Returns: + + +<!-- ##### FUNCTION internet_address_list_get_address ##### --> +<para> + +</para> + +@list: +@index: +@Returns: + + +<!-- ##### FUNCTION internet_address_list_set_address ##### --> +<para> + +</para> + +@list: +@index: +@ia: + + +<!-- ##### FUNCTION internet_address_list_prepend ##### --> +<para> + +</para> + +@list: +@prepend: + + +<!-- ##### FUNCTION internet_address_list_append ##### --> +<para> + +</para> + +@list: +@append: + + +<!-- ##### FUNCTION internet_address_list_to_string ##### --> +<para> + +</para> + +@list: +@encode: +@Returns: + + +<!-- ##### FUNCTION internet_address_list_parse_string ##### --> +<para> + +</para> + +@str: +@Returns: + + +<!-- ##### FUNCTION internet_address_list_writer ##### --> +<para> + +</para> + +@list: +@str: + + diff --git a/docs/reference/tmpl/internet-address-mailbox.sgml b/docs/reference/tmpl/internet-address-mailbox.sgml new file mode 100644 index 0000000..447d773 --- /dev/null +++ b/docs/reference/tmpl/internet-address-mailbox.sgml @@ -0,0 +1,56 @@ +<!-- ##### SECTION Title ##### --> +internet-address-mailbox + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT InternetAddressMailbox ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION internet_address_mailbox_new ##### --> +<para> + +</para> + +@name: +@addr: +@Returns: + + +<!-- ##### FUNCTION internet_address_mailbox_get_addr ##### --> +<para> + +</para> + +@mailbox: +@Returns: + + +<!-- ##### FUNCTION internet_address_mailbox_set_addr ##### --> +<para> + +</para> + +@mailbox: +@addr: + + diff --git a/docs/reference/tmpl/internet-address.sgml b/docs/reference/tmpl/internet-address.sgml new file mode 100644 index 0000000..bc7912f --- /dev/null +++ b/docs/reference/tmpl/internet-address.sgml @@ -0,0 +1,56 @@ +<!-- ##### SECTION Title ##### --> +internet-address + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT InternetAddress ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION internet_address_get_name ##### --> +<para> + +</para> + +@ia: +@Returns: + + +<!-- ##### FUNCTION internet_address_set_name ##### --> +<para> + +</para> + +@ia: +@name: + + +<!-- ##### FUNCTION internet_address_to_string ##### --> +<para> + +</para> + +@ia: +@encode: +@Returns: + + diff --git a/docs/reference/tree_index.sgml b/docs/reference/tree_index.sgml new file mode 100644 index 0000000..6d2f0df --- /dev/null +++ b/docs/reference/tree_index.sgml @@ -0,0 +1,45 @@ +<screen> + <link linkend="GMimeHeader">GMimeHeader</link> + <link linkend="GMimeParam">GMimeParam</link> + <link linkend="GObject">GObject</link> + <link linkend="GMimeContentDisposition">GMimeContentDisposition</link> + <link linkend="GMimeContentType">GMimeContentType</link> + <link linkend="GMimeDataWrapper">GMimeDataWrapper</link> + <link linkend="GMimeObject">GMimeObject</link> + <link linkend="GMimeMessage">GMimeMessage</link> + <link linkend="GMimeMessagePart">GMimeMessagePart</link> + <link linkend="GMimeMessagePartial">GMimeMessagePartial</link> + <link linkend="GMimeMultipart">GMimeMultipart</link> + <link linkend="GMimeMultipartEncrypted">GMimeMultipartEncrypted</link> + <link linkend="GMimeMultipartSigned">GMimeMultipartSigned</link> + <link linkend="GMimePart">GMimePart</link> + <link linkend="GMimeParser">GMimeParser</link> + <link linkend="GMimeStream">GMimeStream</link> + <link linkend="GMimeStreamBuffer">GMimeStreamBuffer</link> + <link linkend="GMimeStreamCat">GMimeStreamCat</link> + <link linkend="GMimeStreamFile">GMimeStreamFile</link> + <link linkend="GMimeStreamFilter">GMimeStreamFilter</link> + <link linkend="GMimeStreamFs">GMimeStreamFs</link> + <link linkend="GMimeStreamMem">GMimeStreamMem</link> + <link linkend="GMimeStreamMmap">GMimeStreamMmap</link> + <link linkend="GMimeStreamNull">GMimeStreamNull</link> + <link linkend="GMimeFilter">GMimeFilter</link> + <link linkend="GMimeFilterBasic">GMimeFilterBasic</link> + <link linkend="GMimeFilterBest">GMimeFilterBest</link> + <link linkend="GMimeFilterCharset">GMimeFilterCharset</link> + <link linkend="GMimeFilterCRLF">GMimeFilterCRLF</link> + <link linkend="GMimeFilterFrom">GMimeFilterFrom</link> + <link linkend="GMimeFilterGZip">GMimeFilterGZip</link> + <link linkend="GMimeFilterHTML">GMimeFilterHTML</link> + <link linkend="GMimeFilterMd5">GMimeFilterMd5</link> + <link linkend="GMimeFilterStrip">GMimeFilterStrip</link> + <link linkend="GMimeFilterYenc">GMimeFilterYenc</link> + <link linkend="GMimeCipherContext">GMimeCipherContext</link> + <link linkend="GMimeGpgContext">GMimeGpgContext</link> + <link linkend="GMimeSession">GMimeSession</link> + <link linkend="GMimeSessionSimple">GMimeSessionSimple</link> + <link linkend="InternetAddress">InternetAddress</link> + <link linkend="InternetAddressGroup">InternetAddressGroup</link> + <link linkend="InternetAddressMailbox">InternetAddressMailbox</link> + <link linkend="InternetAddressList">InternetAddressList</link> +</screen> diff --git a/docs/tutorial/Makefile.am b/docs/tutorial/Makefile.am new file mode 100644 index 0000000..13e713d --- /dev/null +++ b/docs/tutorial/Makefile.am @@ -0,0 +1,24 @@ +.PHONY: html + +EXTRA_DIST = gmime-tut.sgml + +html: +if HAVE_DOCBOOK + if test -w $(srcdir); then \ + (cd $(srcdir); \ + $(DB2HTML) -o html gmime-tut.sgml); \ + fi +else + echo "***" + echo "*** Warning: Tutorial not built" + echo "***" +endif + +dist-hook: html +if HAVE_DOCBOOK + cp -Rp $(srcdir)/html $(distdir) +else + echo "*** DISTRIBUTION IS INCOMPLETE" + echo "***" +endif + diff --git a/docs/tutorial/Makefile.in b/docs/tutorial/Makefile.in new file mode 100644 index 0000000..e8763f9 --- /dev/null +++ b/docs/tutorial/Makefile.in @@ -0,0 +1,438 @@ +# Makefile.in generated by automake 1.11.3 from Makefile.am. +# @configure_input@ + +# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, +# 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software +# Foundation, Inc. +# This Makefile.in is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY, to the extent permitted by law; without +# even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. + +@SET_MAKE@ +VPATH = @srcdir@ +pkgdatadir = $(datadir)/@PACKAGE@ +pkgincludedir = $(includedir)/@PACKAGE@ +pkglibdir = $(libdir)/@PACKAGE@ +pkglibexecdir = $(libexecdir)/@PACKAGE@ +am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd +install_sh_DATA = $(install_sh) -c -m 644 +install_sh_PROGRAM = $(install_sh) -c +install_sh_SCRIPT = $(install_sh) -c +INSTALL_HEADER = $(INSTALL_DATA) +transform = $(program_transform_name) +NORMAL_INSTALL = : +PRE_INSTALL = : +POST_INSTALL = : +NORMAL_UNINSTALL = : +PRE_UNINSTALL = : +POST_UNINSTALL = : +build_triplet = @build@ +host_triplet = @host@ +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 \ + $(top_srcdir)/configure.ac +am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ + $(ACLOCAL_M4) +mkinstalldirs = $(install_sh) -d +CONFIG_HEADER = $(top_builddir)/config.h +CONFIG_CLEAN_FILES = +CONFIG_CLEAN_VPATH_FILES = +SOURCES = +DIST_SOURCES = +DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) +ACLOCAL = @ACLOCAL@ +ACLOCAL_AMFLAGS = @ACLOCAL_AMFLAGS@ +AMTAR = @AMTAR@ +API_VERSION = @API_VERSION@ +AR = @AR@ +AUTOCONF = @AUTOCONF@ +AUTOHEADER = @AUTOHEADER@ +AUTOMAKE = @AUTOMAKE@ +AWK = @AWK@ +CC = @CC@ +CCDEPMODE = @CCDEPMODE@ +CFLAGS = @CFLAGS@ +CPP = @CPP@ +CPPFLAGS = @CPPFLAGS@ +CSC = @CSC@ +CYGPATH_W = @CYGPATH_W@ +DB2HTML = @DB2HTML@ +DEFS = @DEFS@ +DEPDIR = @DEPDIR@ +DLLTOOL = @DLLTOOL@ +DOLT_BASH = @DOLT_BASH@ +DSYMUTIL = @DSYMUTIL@ +DUMPBIN = @DUMPBIN@ +ECHO_C = @ECHO_C@ +ECHO_N = @ECHO_N@ +ECHO_T = @ECHO_T@ +EGREP = @EGREP@ +EXEEXT = @EXEEXT@ +FGREP = @FGREP@ +GACUTIL = @GACUTIL@ +GAPI_CODEGEN = @GAPI_CODEGEN@ +GAPI_FIXUP = @GAPI_FIXUP@ +GAPI_PARSER = @GAPI_PARSER@ +GAPI_TOOLS_CFLAGS = @GAPI_TOOLS_CFLAGS@ +GAPI_TOOLS_LIBS = @GAPI_TOOLS_LIBS@ +GLIB_CFLAGS = @GLIB_CFLAGS@ +GLIB_COMPILE_RESOURCES = @GLIB_COMPILE_RESOURCES@ +GLIB_GENMARSHAL = @GLIB_GENMARSHAL@ +GLIB_LIBS = @GLIB_LIBS@ +GLIB_MKENUMS = @GLIB_MKENUMS@ +GLIB_SHARP_CFLAGS = @GLIB_SHARP_CFLAGS@ +GLIB_SHARP_LIBS = @GLIB_SHARP_LIBS@ +GMIME_API_VERSION = @GMIME_API_VERSION@ +GMIME_BINARY_AGE = @GMIME_BINARY_AGE@ +GMIME_CFLAGS = @GMIME_CFLAGS@ +GMIME_INCLUDEDIR = @GMIME_INCLUDEDIR@ +GMIME_INTERFACE_AGE = @GMIME_INTERFACE_AGE@ +GMIME_LIBDIR = @GMIME_LIBDIR@ +GMIME_LIBS = @GMIME_LIBS@ +GMIME_LIBS_PRIVATE = @GMIME_LIBS_PRIVATE@ +GMIME_MAJOR_VERSION = @GMIME_MAJOR_VERSION@ +GMIME_MICRO_VERSION = @GMIME_MICRO_VERSION@ +GMIME_MINOR_VERSION = @GMIME_MINOR_VERSION@ +GMIME_VERSION = @GMIME_VERSION@ +GOBJECT_QUERY = @GOBJECT_QUERY@ +GPGME_CONFIG = @GPGME_CONFIG@ +GPGME_PTHREAD_CFLAGS = @GPGME_PTHREAD_CFLAGS@ +GPGME_PTHREAD_LIBS = @GPGME_PTHREAD_LIBS@ +GREP = @GREP@ +GTKDOC_CHECK = @GTKDOC_CHECK@ +GTKDOC_DEPS_CFLAGS = @GTKDOC_DEPS_CFLAGS@ +GTKDOC_DEPS_LIBS = @GTKDOC_DEPS_LIBS@ +GTKDOC_MKPDF = @GTKDOC_MKPDF@ +GTKDOC_REBASE = @GTKDOC_REBASE@ +HTML_DIR = @HTML_DIR@ +INSTALL = @INSTALL@ +INSTALL_DATA = @INSTALL_DATA@ +INSTALL_PROGRAM = @INSTALL_PROGRAM@ +INSTALL_SCRIPT = @INSTALL_SCRIPT@ +INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ +LD = @LD@ +LDFLAGS = @LDFLAGS@ +LIBICONV = @LIBICONV@ +LIBOBJS = @LIBOBJS@ +LIBS = @LIBS@ +LIBTOOL = @LIBTOOL@ +LIB_EXE_MACHINE_FLAG = @LIB_EXE_MACHINE_FLAG@ +LIPO = @LIPO@ +LN_S = @LN_S@ +LTCOMPILE = @LTCOMPILE@ +LTCXXCOMPILE = @LTCXXCOMPILE@ +LTLIBICONV = @LTLIBICONV@ +LTLIBOBJS = @LTLIBOBJS@ +LT_AGE = @LT_AGE@ +LT_CURRENT = @LT_CURRENT@ +LT_CURRENT_MINUS_AGE = @LT_CURRENT_MINUS_AGE@ +LT_RELEASE = @LT_RELEASE@ +LT_REVISION = @LT_REVISION@ +MAINT = @MAINT@ +MAKEINFO = @MAKEINFO@ +MANIFEST_TOOL = @MANIFEST_TOOL@ +MKDIR_P = @MKDIR_P@ +MV = @MV@ +NM = @NM@ +NMEDIT = @NMEDIT@ +OBJDUMP = @OBJDUMP@ +OBJEXT = @OBJEXT@ +OTOOL = @OTOOL@ +OTOOL64 = @OTOOL64@ +PACKAGE = @PACKAGE@ +PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ +PACKAGE_NAME = @PACKAGE_NAME@ +PACKAGE_STRING = @PACKAGE_STRING@ +PACKAGE_TARNAME = @PACKAGE_TARNAME@ +PACKAGE_URL = @PACKAGE_URL@ +PACKAGE_VERSION = @PACKAGE_VERSION@ +PATH_SEPARATOR = @PATH_SEPARATOR@ +PKG_CONFIG = @PKG_CONFIG@ +PKG_CONFIG_LIBDIR = @PKG_CONFIG_LIBDIR@ +PKG_CONFIG_PATH = @PKG_CONFIG_PATH@ +RANLIB = @RANLIB@ +RM = @RM@ +SED = @SED@ +SET_MAKE = @SET_MAKE@ +SHELL = @SHELL@ +STRIP = @STRIP@ +TAR = @TAR@ +VERSION = @VERSION@ +WINDRES = @WINDRES@ +abs_builddir = @abs_builddir@ +abs_srcdir = @abs_srcdir@ +abs_top_builddir = @abs_top_builddir@ +abs_top_srcdir = @abs_top_srcdir@ +ac_ct_AR = @ac_ct_AR@ +ac_ct_CC = @ac_ct_CC@ +ac_ct_DUMPBIN = @ac_ct_DUMPBIN@ +am__include = @am__include@ +am__leading_dot = @am__leading_dot@ +am__quote = @am__quote@ +am__tar = @am__tar@ +am__untar = @am__untar@ +bindir = @bindir@ +build = @build@ +build_alias = @build_alias@ +build_cpu = @build_cpu@ +build_os = @build_os@ +build_vendor = @build_vendor@ +builddir = @builddir@ +datadir = @datadir@ +datarootdir = @datarootdir@ +docdir = @docdir@ +dvidir = @dvidir@ +exec_prefix = @exec_prefix@ +gacdir = @gacdir@ +host = @host@ +host_alias = @host_alias@ +host_cpu = @host_cpu@ +host_os = @host_os@ +host_vendor = @host_vendor@ +htmldir = @htmldir@ +includedir = @includedir@ +infodir = @infodir@ +install_sh = @install_sh@ +libdir = @libdir@ +libexecdir = @libexecdir@ +localedir = @localedir@ +localstatedir = @localstatedir@ +mandir = @mandir@ +mkdir_p = @mkdir_p@ +ms_librarian = @ms_librarian@ +oldincludedir = @oldincludedir@ +pdfdir = @pdfdir@ +prefix = @prefix@ +program_transform_name = @program_transform_name@ +psdir = @psdir@ +sbindir = @sbindir@ +sharedstatedir = @sharedstatedir@ +srcdir = @srcdir@ +sysconfdir = @sysconfdir@ +target = @target@ +target_alias = @target_alias@ +target_cpu = @target_cpu@ +target_os = @target_os@ +target_vendor = @target_vendor@ +top_build_prefix = @top_build_prefix@ +top_builddir = @top_builddir@ +top_srcdir = @top_srcdir@ +EXTRA_DIST = gmime-tut.sgml +all: all-am + +.SUFFIXES: +$(srcdir)/Makefile.in: @MAINTAINER_MODE_TRUE@ $(srcdir)/Makefile.am $(am__configure_deps) + @for dep in $?; do \ + case '$(am__configure_deps)' in \ + *$$dep*) \ + ( cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh ) \ + && { if test -f $@; then exit 0; else break; fi; }; \ + exit 1;; \ + esac; \ + done; \ + echo ' cd $(top_srcdir) && $(AUTOMAKE) --foreign docs/tutorial/Makefile'; \ + $(am__cd) $(top_srcdir) && \ + $(AUTOMAKE) --foreign docs/tutorial/Makefile +.PRECIOUS: Makefile +Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status + @case '$?' in \ + *config.status*) \ + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh;; \ + *) \ + echo ' cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe)'; \ + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe);; \ + esac; + +$(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh + +$(top_srcdir)/configure: @MAINTAINER_MODE_TRUE@ $(am__configure_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(ACLOCAL_M4): @MAINTAINER_MODE_TRUE@ $(am__aclocal_m4_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(am__aclocal_m4_deps): + +mostlyclean-libtool: + -rm -f *.lo + +clean-libtool: + -rm -rf .libs _libs +tags: TAGS +TAGS: + +ctags: CTAGS +CTAGS: + + +distdir: $(DISTFILES) + @srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + topsrcdirstrip=`echo "$(top_srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + list='$(DISTFILES)'; \ + dist_files=`for file in $$list; do echo $$file; done | \ + sed -e "s|^$$srcdirstrip/||;t" \ + -e "s|^$$topsrcdirstrip/|$(top_builddir)/|;t"`; \ + case $$dist_files in \ + */*) $(MKDIR_P) `echo "$$dist_files" | \ + sed '/\//!d;s|^|$(distdir)/|;s,/[^/]*$$,,' | \ + sort -u` ;; \ + esac; \ + for file in $$dist_files; do \ + if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \ + if test -d $$d/$$file; then \ + dir=`echo "/$$file" | sed -e 's,/[^/]*$$,,'`; \ + if test -d "$(distdir)/$$file"; then \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \ + cp -fpR $(srcdir)/$$file "$(distdir)$$dir" || exit 1; \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + cp -fpR $$d/$$file "$(distdir)$$dir" || exit 1; \ + else \ + test -f "$(distdir)/$$file" \ + || cp -p $$d/$$file "$(distdir)/$$file" \ + || exit 1; \ + fi; \ + done + $(MAKE) $(AM_MAKEFLAGS) \ + top_distdir="$(top_distdir)" distdir="$(distdir)" \ + dist-hook +check-am: all-am +check: check-am +all-am: Makefile +installdirs: +install: install-am +install-exec: install-exec-am +install-data: install-data-am +uninstall: uninstall-am + +install-am: all-am + @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am + +installcheck: installcheck-am +install-strip: + if test -z '$(STRIP)'; then \ + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + install; \ + else \ + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'" install; \ + fi +mostlyclean-generic: + +clean-generic: + +distclean-generic: + -test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES) + -test . = "$(srcdir)" || test -z "$(CONFIG_CLEAN_VPATH_FILES)" || rm -f $(CONFIG_CLEAN_VPATH_FILES) + +maintainer-clean-generic: + @echo "This command is intended for maintainers to use" + @echo "it deletes files that may require special tools to rebuild." +clean: clean-am + +clean-am: clean-generic clean-libtool mostlyclean-am + +distclean: distclean-am + -rm -f Makefile +distclean-am: clean-am distclean-generic + +dvi: dvi-am + +dvi-am: + +html-am: + +info: info-am + +info-am: + +install-data-am: + +install-dvi: install-dvi-am + +install-dvi-am: + +install-exec-am: + +install-html: install-html-am + +install-html-am: + +install-info: install-info-am + +install-info-am: + +install-man: + +install-pdf: install-pdf-am + +install-pdf-am: + +install-ps: install-ps-am + +install-ps-am: + +installcheck-am: + +maintainer-clean: maintainer-clean-am + -rm -f Makefile +maintainer-clean-am: distclean-am maintainer-clean-generic + +mostlyclean: mostlyclean-am + +mostlyclean-am: mostlyclean-generic mostlyclean-libtool + +pdf: pdf-am + +pdf-am: + +ps: ps-am + +ps-am: + +uninstall-am: + +.MAKE: install-am install-strip + +.PHONY: all all-am check check-am clean clean-generic clean-libtool \ + dist-hook distclean distclean-generic distclean-libtool \ + distdir dvi dvi-am html html-am info info-am install \ + install-am install-data install-data-am install-dvi \ + install-dvi-am install-exec install-exec-am install-html \ + install-html-am install-info install-info-am install-man \ + install-pdf install-pdf-am install-ps install-ps-am \ + install-strip installcheck installcheck-am installdirs \ + maintainer-clean maintainer-clean-generic mostlyclean \ + mostlyclean-generic mostlyclean-libtool pdf pdf-am ps ps-am \ + uninstall uninstall-am + +.PHONY: html + +html: +@HAVE_DOCBOOK_TRUE@ if test -w $(srcdir); then \ +@HAVE_DOCBOOK_TRUE@ (cd $(srcdir); \ +@HAVE_DOCBOOK_TRUE@ $(DB2HTML) -o html gmime-tut.sgml); \ +@HAVE_DOCBOOK_TRUE@ fi +@HAVE_DOCBOOK_FALSE@ echo "***" +@HAVE_DOCBOOK_FALSE@ echo "*** Warning: Tutorial not built" +@HAVE_DOCBOOK_FALSE@ echo "***" + +dist-hook: html +@HAVE_DOCBOOK_TRUE@ cp -Rp $(srcdir)/html $(distdir) +@HAVE_DOCBOOK_FALSE@ echo "*** DISTRIBUTION IS INCOMPLETE" +@HAVE_DOCBOOK_FALSE@ echo "***" + +# Tell versions [3.59,3.63) of GNU make to not export all variables. +# Otherwise a system limit (for SysV at least) may be exceeded. +.NOEXPORT: diff --git a/docs/tutorial/gmime-tut.sgml b/docs/tutorial/gmime-tut.sgml new file mode 100644 index 0000000..57b3c61 --- /dev/null +++ b/docs/tutorial/gmime-tut.sgml @@ -0,0 +1,681 @@ +<!doctype book PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [ +<!notation PNG system "PNG"> +<!entity % local.notation.class "| PNG"> +]> +<book id="gmime-tut"> + + <bookinfo> + <title>GMime 2.6 tutorial</title> + <date>Oct 28, 2010</date> + <authorgroup> + <author> + <firstname>Jeffrey</firstname> + <surname>Stedfast</surname> + <affiliation> + <address> + <email>fejj@gnome.org</email> + </address> + </affiliation> + </author> + </authorgroup> + <abstract> + <para>This tutorial is meant to demonstrate how to use the GMime + C API.</para> + </abstract> + </bookinfo> + + <toc></toc> + + <!-- ***************************************************************** --> + <chapter id="ch-availability"> + <title>Tutorial Availability</title> + + <para>A copy of this tutorial is distributed with each source-code +release of GMime in both SGML and HTML formats. For binary +distributions, please check with your vendor.</para> + + <para>An online version of this tutorial is also available at <ulink +url="http://spruce.sourceforge.net/gmime/tutorial/">http://spruce.sourceforge.net/gmime/tutorial/</ulink>. + </para> + + </chapter> + + <!-- ***************************************************************** --> + <chapter id="ch-introduction"> + <title>Introduction</title> + + <para>GMime is a library for parsing and creating messages using the +Multipurpose Internet Mail Extension (MIME) format. It is licensed +under the <ulink +url="http://http://www.gnu.org/licenses/licenses.html#LGPL">GNU Lesser General +Public License (LGPL)</ulink> so you are free to develop your Free +Software applications using GMime without having to spend anything for +licenses or royalties.</para> + + <para>The primary author and maintainer of GMime is:</para> + + <itemizedlist> + <listitem> + <simpara>Jeffrey Stedfast <ulink url="mailto:fejj@gnome.org">fejj@gnome.org</ulink></simpara> + </listitem> + </itemizedlist> + + <para>GMime is essentially an object-oriented application programmers +interface (API). Although written completely in C, it is implemented +using the idea of classes and callback functions (pointers to +functions).</para> + + <para>GMime is built upon another library called GLib which also +serves as the foundation for such libraries as the GIMP ToolKit +(Gtk+). GLib is mostly a portability layer but also contains +additional functionality such as hash tables, linked lists, etc. For +more information on GLib, you should see the API reference at <ulink +url="http://library.gnome.org/devel/glib/stable/">http://library.gnome.org/devel/glib/stable/</ulink>.</para> + + </chapter> + + <!-- ***************************************************************** --> + <chapter id="ch-getting-started"> + <title>Getting Started</title> + + <para>The first thing you need to do, of course, is download the +GMime source and install it. You can always get the latest version +from <ulink url="http://download.gnome.org/pub/GNOME/sources/gmime/">http://download.gnome.org/pub/GNOME/sources/gmime/</ulink>. GMime +uses GNU autoconf for configuration. Once untar'd, type +<literal>./configure --help</literal> to see a list of options.</para> + + <para>More information about building GMime is available in either the +source distribution under <filename>docs/reference/</filename> or via +the online reference at <ulink +url="http://library.gnome.org/devel/gmime/stable/gmime-building.html">http://library.gnome.org/devel/gmime/stable/gmime-building.html</ulink>.</para> + + </chapter> + + <!-- ***************************************************************** --> + <chapter id="ch-basics"> + <title>Getting Down to the Basics</title> + + <!-- ----------------------------------------------------------------- --> + <sect1 id="sec-compiling"> + <title>Compiling</title> + + <para>The first thing you need to learn how to do is compile + your program with the proper compiler flags so that your program + will include the correct GMime headers and linker flags.</para> + + <para>To compile and link a simple program, you'll want to do + the following:</para> + + <para> + <literallayout> + <literal>gcc -g -Wall -o simple simple.c `pkg-config --cflags --libs gmime-2.4`</literal> + </literallayout> + </para> + </sect1> + + <!-- ----------------------------------------------------------------- --> + <sect1 id="sec-stream-basics"> + <title>GMimeStream Basics</title> + + <para>Before we get too deep into using GMime, it is important + to understand how to use the underlying I/O classes since GMime + is so very heavily dependant upon them.</para> + + <para>If you've looked at the API at all already, you will have + probably noticed that the stream functions work very much like + those of the standard low-level UNIX I/O functions (those that + use file descriptors) but with a few extras taken from the + higher-level Standard C I/O API.</para> + + <para>Let's take a moment to regres back to our early days of + programming where we learned how to write "Hello World!" on the + console:</para> + + <programlisting role="C"> +#include <stdio.h> + +int main (int argc, char **argv) +{ + fprintf (stdout, "Hello World!\n"); + fflush (stdout); + + return 0; +} + </programlisting> + + <para>Everyone should recognize what that program does. The + above program, rewritten to use GMime's stream classes would + look something like this:</para> + + <programlisting role="C"> +#include <stdio.h> +#include <gmime/gmime.h> + +int main (int argc, char **argv) +{ + GMimeStream *stream; + + /* initialize GMime */ + g_mime_init (0); + + /* create a stream around stdout */ + stream = g_mime_stream_file_new (stdout); + + /* 'printf' */ + g_mime_stream_printf (stream, "Hello World!\n"); + + /* flush stdout */ + g_mime_stream_flush (stream); + + /* free/close the stream */ + g_object_unref (stream); + + return 0; +} + </programlisting> + + <para>Hopefully, the only thing that may be new to you in either + of the above examples is the flushing of the stream after + writing to it. Most likely, in both examples, it is an unneeded + call, however it is there for completeness and you should + probably get into the habbit of flushing a stream after you've + finished writing to it. Like fflush(), g_mime_stream_flush() + will flush any write-buffers that the previous write-calls may + have left.</para> + + <para>The first function called in the second example is + <literal>g_mime_init</literal> with a value of + <literal>0</literal>. If you haven't guessed, + <literal>g_mime_init</literal> initializes the GMime library. It + takes a single bit-mask argument specifying which options to + enable. Currently there is only one optional bit-flag, + <literal>GMIME_INIT_FLAG_UTF8</literal> which is the default + anyway, so a value of <literal>0</literal> is used here. The + UTF-8 flag only exists for historical reasons.</para> + + <para>The only other line that should need explaining might be:</para> + + <programlisting role="C"> + stream = g_mime_stream_file_new (stdout); + </programlisting> + + <para>This line creates a new object of type GMimeStreamFile which + takes a <literal>FILE*</literal> argument. Once the + GMimeStreamFile is created, it takes ownership of the + <literal>FILE*</literal> so be careful if you want to be able to + ever use that <literal>FILE*</literal> handle again later in + your program or if you do not wish for it to be closed when the + GMimeStreamFile is closed later.</para> + + <para>One way of working around this is to do something like the + following example:</para> + + <programlisting role="C"> +#include <stdio.h> +#include <unistd.h> +#include <gmime/gmime.h> + +int main (int argc, char **argv) +{ + GMimeStream *stream; + + /* initialize GMime */ + g_mime_init (0); + + /* create a stream around stdout */ + stream = g_mime_stream_fs_new (dup (fileno (stdout))); + + /* 'printf' */ + g_mime_stream_printf (stream, "Hello World!\n"); + + /* flush stdout */ + g_mime_stream_flush (stream); + + /* free/close the stream */ + g_object_unref (stream); + + return 0; +} + </programlisting> + + <para>Here we have made a duplicate copy of stdout to give to + <literal>g_mime_stream_fs_new()</literal>. GMimeStreamFs is the + second type of stream meant for basic I/O, but instead of using + a <literal>FILE*</literal> handle, it instead uses an integer + file descriptor. The <literal>fileno()</literal> function + returns the integer file descriptor for a given + <literal>FILE*</literal> handle. The <literal>dup()</literal> + function makes a duplicate of the file descriptor passed to + it. More information can be read about these 2 functions by + using <literal>man</literal> on your local UNIX system or by + reading the Reference Manual for your libc.</para> + + <para>There are also some functions to tell GMimeStreamFile, + GMimeStreamFs and GMimeStreamMem that they are not the owners of + the backend storage and so when they are destroyed, they should + not close the file or free the memory buffer + (respectively). These functions are:</para> + + <programlisting role="C"> +void g_mime_stream_file_set_owner (GMimeStreamFile *stream, gboolean owner); +void g_mime_stream_fs_set_owner (GMimeStreamFs *stream, gboolean owner); +void g_mime_stream_mem_set_owner (GMimeStreamMem *stream, gboolean owner); + </programlisting> + + <para>Next, let's examine some of the other stream + functions.</para> + + <programlisting role="C"> + g_mime_stream_eos (stream); + </programlisting> + + <para>This function is useful for finding out if the + End-Of-Stream has been reached. This is similar in functionality + to Standard C's <literal>feof()</literal> function.</para> + + <programlisting role="C"> + g_mime_stream_reset (stream); + </programlisting> + + <para>This function will reset the state of a stream. Usually + this only means 'rewinding' to the beginning of the file. For + more complex streams, such as GMimeStreamFilter, however, this + will also reset the state of all of the filters that have been + attached to it (more on this later).</para> + + <programlisting role="C"> + g_mime_stream_length (stream); + </programlisting> + + <para>This function will return the length of the stream if + known, or -1 otherwise. For the most part, this function should + be avoided unless you absolutely need to know the stream length + and there is no other way to get it. The reason to avoid using + it is that it may be inaccurate if any filters are to be applied + as well as possibly being slow depending on the underlying + storage device.</para> + + <programlisting role="C"> + g_mime_stream_substream (stream, start, end); + </programlisting> + + <para>This function will return a substream of the original + stream, where the beginning of the new substream is the start + offset and the end is the end offset. These start and end + offsets MUST be within the bounds of the original + stream. Substreams can be useful if you want to only allow + reading and writing to a subsection of the original + stream.</para> + + <programlisting role="C"> + g_mime_stream_read (stream, buf, n); + </programlisting> + + <para>Like POSIX <literal>read()</literal>, this function will + try to read <literal>n</literal> bytes from the stream + into <literal>buf</literal>, but be warned that it is not + guaranteed to read the full requested buffer size if that much + data is not currently available.</para> + + <programlisting role="C"> + g_mime_stream_write (stream, buf, n); + </programlisting> + + <para>Like POSIX <literal>write()</literal> and standard + C's <literal>fwrite()</literal>, this function will write a + buffer of the specified length to the underlying + stream. However, unlike the POSIX <literal>write()</literal> + function, it will only fail if an irrecoverable error has + occurred and so it is not necessary to loop write attempts until + the entire buffer is written.</para> + + <programlisting role="C"> + g_mime_stream_seek (stream, offset, GMIME_STREAM_SEEK_SET); + g_mime_stream_seek (stream, offset, GMIME_STREAM_SEEK_CUR); + g_mime_stream_seek (stream, offset, GMIME_STREAM_SEEK_END); + </programlisting> + + <para>This function works exactly like the + POSIX <literal>lseek()</literal> or standard + C's <literal>fseek()</literal> functions.</para> + + </sect1> + + <!-- ----------------------------------------------------------------- --> + <sect1 id="sec-stream-classes"> + <title>Stream Class Overview</title> + + <para>There are a number of stream classes included with GMime, + but we are only going to go over the more widely useful stream + classes. You should be able to figure out the others on your + own.</para> + + <para>We've already seen GMimeStreamFile and GMimeStreamFs in + action in the prevous chapter, so let's skip them and start with + GMimeStreamMem.</para> + + <para>GMimeStremMem is a stream abstraction that reads and + writes to a memory buffer. Like any other stream, the basic + stream functions (read, write, seek, substream, eos, etc) apply + here as well. Internally, GMimeStreamMem uses the GLib + GByteArray structure for storage so you may want to read up on + that.</para> + + <para>There are several ways to instantiate a GMimeStreamMem + object. You will probably use + <literal>g_mime_stream_mem_new()</literal> most of the + time. There may be times, however, when you will already have a + memory buffer that you'd like to use as a stream. There are + several ways to create a GMimeStreamMem object to use this + buffer (or a copy of it).</para> + + <para>The first is + <literal>g_mime_stream_mem_new_with_byte_array()</literal>. This + assumes that you are already using a GByteArray and want to use + it as a stream. As explained in the previous chapter about + GMimeStreamFile and ownership, the same applies here. When the + GMimeStreamMem is destroyed, so is the GByteArray structure and + the memory buffer it contained. To get around this, create a new + GMimeStreamMem object using + <literal>g_mime_stream_mem_new()</literal> and then use + <literal>g_mime_stream_mem_set_byte_array()</literal> to set the + GByteArray as the memory buffer. This will make it so that + GMimeStreamMem does not own the GByteArray, so when the + GMimeStremMem object is destroyed, the GByteArray will + remain.</para> + + <para>Also at your disposal for creating GMimeStreamMem objects + with an initial buffer is + <literal>g_mime_stream_mem_new_with_buffer()</literal>. This + function, however, will duplicate the buffer passed to it so if + you have memory quotas you are trying to keep, you may wish to + find a way to use one of the above methods.</para> + + <para>That pretty much sums up how to use GMimeStreamMem. The + next most widely used stream class is probably + GMimeStreamBuffer. This stream class actually wraps another + stream object adding additional functionality such as read and + write buffering and a few additional read methods.</para> + + <para>As you may or may not know, buffering reads and writes is + a great way to improve I/O performance in applications. The time + it takes to do a lot of small reads and writes accumulates + fast.</para> + + <para>When using a GMimeStreamBuffer in + <literal>GMIME_STREAM_BUFFER_BLOCK_READ</literal> mode, a block + of 4K (4096 bytes) will be read into an intermediate + buffer. Each time your application performs a read on this + GMimeStreamBuffer stream, a chunk of that intermediate buffer + will be copied to your read buffer until all 4K have been read, + at which point GMimeStreamBuffer will pre-scan the next 4K and so + on.</para> + + <para>Similarly, using mode + <literal>GMIME_STREAM_BUFFER_BLOCK_WRITE</literal> will copy + each of your application write-buffers into an intermediate 4K + buffer. When that 4K buffer fills up, it will be flushed to the + underlying stream. You may also use + <literal>g_mime_stream_flush()</literal> to force the + intermediate buffer to be written to the underlying + stream.</para> + + <para>Note that the intermediate buffer size is 4096 bytes. You + should be aware that if you will mostly be reading and writing + blocks of larger than 4K, it is probably best to avoid using + GMimeStreamBuffer as it will not likely gain you any performance + and may decrease performance instead.</para> + + <para>GMimeStreamBuffer also adds 2 convenience functions for + reading. While they will both work with any stream class, they + are obviously much faster if used with a GMimeStreamBuffer in + mode <literal>GMIME_STREAM_BUFFER_BLOCK_READ</literal>. These + functions are:</para> + + <programlisting role="C"> +ssize_t g_mime_stream_buffer_gets (GMimeStream *stream, char *buf, size_t max); + +void g_mime_stream_buffer_readln (GMimeStream *stream, GByteArray *buffer); + </programlisting> + + <para>The first function is similar to Standard C's + <literal>fgets()</literal> function (although the arguments are + in a slightly different order). It reads up to the first + <literal>max - 1</literal> bytes, stopping after a + <literal>\n</literal> character, if found. <literal>buf</literal> + will always be nul-terminated.</para> + + <para>The second function, + <literal>g_mime_stream_buffer_readln()</literal>, has no + Standard C equivalent that I am aware of, but you should get the + idea of what it does based on the function name (I hope). It + reads exactly one (1) line (including the <literal>\n</literal> + character) and appends it to the end of + <literal>buffer</literal>.</para> + + <para>The last stream class you really need to know (and the + last one I have the patience to explain) is + GMimeStreamFilter. This is a special stream class which you can + attach GMimeFilters to so that reading/writing to this stream + will automagically convert the stream from one form to + another. GMime uses this stream internally for converting base64 + encoded attachments into their raw form and vice versa.</para> + + <note> + <para>As previously mentioned in the last chapter concerning + <literal>g_mime_stream_reset()</literal>, resetting a + GMimeStreamFilter stream will also reset all of the filters + applied.</para> + </note> + + <para>A great example usage of GMimeStreamFilter can be found in + the <filename>src/uuencode.c</filename> source file found in the + source distribution. Here's a clip of that source file + illustrating how to use stream filters:</para> + + <programlisting role="C"> + GMimeStream *istream, *ostream, *fstream; + GMimeFilter *filter; + int fd; + + ... + + if (g_mime_stream_printf (ostream, "begin %.3o %s\n", st.st_mode & 0777, name) == -1) { + fprintf (stderr, "%s: %s\n", progname, strerror (errno)); + g_object_unref (ostream); + exit (1); + } + + istream = g_mime_stream_fs_new (fd); + + fstream = g_mime_stream_filter_new (ostream); + + filter = g_mime_filter_basic_new (GMIME_CONTENT_ENCODING_UUENCODE, TRUE); + g_mime_stream_filter_add ((GMimeStreamFilter *) fstream, filter); + g_object_unref (filter); + + if (g_mime_stream_write_to_stream (istream, fstream) == -1) { + fprintf (stderr, "%s: %s\n", progname, strerror (errno)); + g_object_unref (fstream); + g_object_unref (istream); + g_object_unref (ostream); + exit (1); + } + + g_mime_stream_flush (fstream); + g_object_unref (fstream); + g_object_unref (istream); + + if (g_mime_stream_write_string (ostream, "end\n") == -1) { + fprintf (stderr, "%s: %s\n", progname, strerror (errno)); + g_object_unref (ostream); + exit (1); + } + + g_object_unref (ostream); + </programlisting> + + <para>The above snippet of code will read the contents of the input + stream (<literal>istream</literal>) and write it to our output + stream (<literal>ostream</literal>), but only after it has + passed through our filter-stream + (<literal>fstream</literal>). The filter attached to + <literal>fstream</literal> is one of the basic MIME filters that + encodes data in the traditional UUCP format. You have probably + run a program to do this many times in the past using the UNIX + command <literal>uuencode</literal>. Never thought writing a + replacement for <literal>uuencode</literal> could be so easy, + did you? Well, it is. And not only is it <emphasis>that + easy</emphasis>, but it also runs faster than the + <literal>uuencode</literal> shipped with GNU Sharutils (at least + up to and including the 4.2.1 release).</para> + + </sect1> + + <!-- ----------------------------------------------------------------- --> + <sect1 id="sec-filter-classes"> + <title>Filter Class Overview</title> + + <para>GMime comes pre-bundled with a number of stream filters + for your convenience and more may be added in the future. For + now, let's breeze through a summary of some of the more important + ones:</para> + + <para>GMimeFilterBasic is used quite a lot internally in GMime + for encoding and decoding the content of MIME parts. This class + contains a mode for encoding and decoding each of Base64, + Quoted-Printable, and Uuencode.</para> + + <para>If you are interested in converting between charsets for + your users, you will likely want to become familiar with + GMimeFilterCharset which provides a convenient way to convert + text streams of one charset into another charset.</para> + + <para>GMimeFilterCRLF will likely become very useful to you if + you are implementing any internet standards or DOS/UNIX + compatability. This filter is meant for converting line endings + from the traditional UNIX sequence (LF) to the internet standard + (and DOS) sequence, CRLF, and vice versa. Also included in this + filter is a way to escape and unescape lines beginning with '.' + in the method used by the SMTP and POP protocols.</para> + + <para>GMimeFilterFrom is one you will likely need to use if ever + you need to write to an mbox-formatted mail spool. At present, + it has 2 modes: <literal>GMIME_FILTER_FROM_MODE_ESCAPE</literal> + and <literal>GMIME_FILTER_FROM_MODE_ARMOR</literal>. If you are + writing to an mbox-formatted spool, you will always want to use + the <literal>ESCAPE</literal> mode which will escape lines + beginning with "From " by prepending a '>' character, resulting + in ">From ". The other mode might come in handy if you are + implementing a multipart/signed method where you are + quoted-printable encoding a text stream and need to special-case + From-lines in order to protect against UNIX systems which will + alter the message when writing it to an mbox file such as the + previously mentioned filter mode. The result is something like + "=46rom " which prevents the need to prepend a '>' character + when the message arrives at a UNIX machine.</para> + + <para>Also included are: GMimeFilterBest (which will likely not + concern you), GMimeFilterEnriched (which will convert + text/enriched and/or text/rtf to text/html), and GMimeFilterHTML + which will convert text/plain into text/html with options to + wrap strings that appear to be hyperlinks with appropriate <a + href=...> tags; GMimeFilterStrip (again, likely this won't + concern you), and finally GMimeFilterYenc which will encode or + decode the YEncode encoding.</para> + + <para>For an example on how to use filters, please see the end + of the previous chapter where it talks about GMimeStreamFilter + and provides a snippet from + <filename>src/uuencode.c</filename></para> + + <note> + <para>Note: Since it may be non-obvious, filters are applied + to a stream in the same order that they are added to the + GMimeFilterStream. This means that if you add a base64 encode + filter and then add a CRLF filter, the stream will first be + base64 encoded and then the end-of-line formatting will be + canonicalised to CRLF.</para> + </note> + + </sect1> + + </chapter> + + <!-- ***************************************************************** --> + <chapter id="ch-mime"> + <title>MIME, MIME, and more MIME</title> + + <!-- ----------------------------------------------------------------- --> + <sect1 id="sec-mime-part"> + <title>GMimePart</title> + + <para>Since most people seem to want to know how to "save an + attachment", let's start there.</para> + + <para>Given a GMimePart object, the first step to saving an + attachment is probably going to be figuring out what the + filename is. To do that, you'll likely want to do something + like:</para> + + <programlisting role="C"> +static void +save_attachment (GMimePart *part) +{ + GMimeDataWrapper *content; + const char *filename; + GMimeStream *stream; + int fd; + + filename = g_mime_part_get_filename (part); + ... + </programlisting> + + <para>The <literal>g_mime_part_get_filename()</literal> function + will first check for a <literal>filename</literal> parameter in + the Content-Disposition header. If that parameter exists, + it will return the value as the filename. However, if that does + not exist, it will fall back to checking for the + <literal>name</literal> parameter sometimes found in the + Content-Type header and return that value if it exists + (Microsoft Outlook, for example, will set the name parameter, + but will not set the filename parameter). If neither of these + param values are found, it will simply return + <literal>NULL</literal>.</para> + + <para>Now that you've got a filename for the MIME part (well, + assuming that it isn't NULL - in which case you'll have to + prompt the user or make up your own filename or something), the + next step is to open an output stream and write the MIME part's + content to disk:</para> + + <programlisting role="C"> + ... + if ((fd = open (filename, O_CREAT | O_WRONLY, 0666)) == -1) + return; + + stream = g_mime_stream_fs_new (fd); + + content = g_mime_part_get_content_object (part); + g_mime_data_wrapper_write_to_stream (content, stream); + g_mime_stream_flush (stream); + g_object_unref (stream); +} + </programlisting> + + <para>In order to get the content of a MIME part (eg. the body + of a part, not including the headers), you'll want to use + <literal>g_mime_part_get_content_object()</literal>. To write + the content object to a stream, you can use + <literal>g_mime_data_wrapper_write_to_stream()</literal>. On + fail, this function will return <literal>-1</literal>, otherwise + it will return some positive value which will usually equate to + the number of bytes written (but not always, due to filter + transformations); generally it's a good idea to not rely on the + returned value for anything other than error-checking.</para> + + </sect1> + + </chapter> + +</book> |
