summaryrefslogtreecommitdiff
path: root/docs/reference/data-wrappers.sgml
diff options
context:
space:
mode:
Diffstat (limited to 'docs/reference/data-wrappers.sgml')
-rw-r--r--docs/reference/data-wrappers.sgml22
1 files changed, 22 insertions, 0 deletions
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>