File: gmime-part.xml

package info (click to toggle)
gmime2.2 2.2.3-3
links: PTS
area: main
in suites: etch, etch-m68k
size: 6,316 kB
ctags: 4,763
sloc: ansic: 33,448; xml: 9,170; sh: 8,825; makefile: 573; cs: 147; perl: 6
file content (769 lines) | stat: -rw-r--r-- 45,538 bytes
<refentry id="gmime-gmime-part">
<refmeta>
<refentrytitle>gmime-part</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GMIME Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>gmime-part</refname><refpurpose></refpurpose>
</refnamediv>

<refsynopsisdiv><title>Synopsis</title>
<anchor id="GMimePart"/>
<synopsis>



            <link linkend="GMimePart-struct">GMimePart</link>;
<link linkend="GMimePart">GMimePart</link>*  <link linkend="g-mime-part-new">g_mime_part_new</link>                 (void);
<link linkend="GMimePart">GMimePart</link>*  <link linkend="g-mime-part-new-with-type">g_mime_part_new_with_type</link>       (const <link linkend="char">char</link> *type,
                                             const <link linkend="char">char</link> *subtype);
<link linkend="void">void</link>        <link linkend="g-mime-part-set-content-header">g_mime_part_set_content_header</link>  (<link linkend="GMimePart">GMimePart</link> *mime_part,
                                             const <link linkend="char">char</link> *header,
                                             const <link linkend="char">char</link> *value);
const <link linkend="char">char</link>* <link linkend="g-mime-part-get-content-header">g_mime_part_get_content_header</link>  (<link linkend="GMimePart">GMimePart</link> *mime_part,
                                             const <link linkend="char">char</link> *header);
<link linkend="void">void</link>        <link linkend="g-mime-part-set-content-description">g_mime_part_set_content_description</link>
                                            (<link linkend="GMimePart">GMimePart</link> *mime_part,
                                             const <link linkend="char">char</link> *description);
const <link linkend="char">char</link>* <link linkend="g-mime-part-get-content-description">g_mime_part_get_content_description</link>
                                            (const <link linkend="GMimePart">GMimePart</link> *mime_part);
<link linkend="void">void</link>        <link linkend="g-mime-part-set-content-id">g_mime_part_set_content_id</link>      (<link linkend="GMimePart">GMimePart</link> *mime_part,
                                             const <link linkend="char">char</link> *content_id);
const <link linkend="char">char</link>* <link linkend="g-mime-part-get-content-id">g_mime_part_get_content_id</link>      (<link linkend="GMimePart">GMimePart</link> *mime_part);
<link linkend="void">void</link>        <link linkend="g-mime-part-set-content-md5">g_mime_part_set_content_md5</link>     (<link linkend="GMimePart">GMimePart</link> *mime_part,
                                             const <link linkend="char">char</link> *content_md5);
const <link linkend="char">char</link>* <link linkend="g-mime-part-get-content-md5">g_mime_part_get_content_md5</link>     (<link linkend="GMimePart">GMimePart</link> *mime_part);
<link linkend="gboolean">gboolean</link>    <link linkend="g-mime-part-verify-content-md5">g_mime_part_verify_content_md5</link>  (<link linkend="GMimePart">GMimePart</link> *mime_part);
<link linkend="void">void</link>        <link linkend="g-mime-part-set-content-location">g_mime_part_set_content_location</link>
                                            (<link linkend="GMimePart">GMimePart</link> *mime_part,
                                             const <link linkend="char">char</link> *content_location);
const <link linkend="char">char</link>* <link linkend="g-mime-part-get-content-location">g_mime_part_get_content_location</link>
                                            (<link linkend="GMimePart">GMimePart</link> *mime_part);
<link linkend="void">void</link>        <link linkend="g-mime-part-set-content-type">g_mime_part_set_content_type</link>    (<link linkend="GMimePart">GMimePart</link> *mime_part,
                                             <link linkend="GMimeContentType">GMimeContentType</link> *mime_type);
const <link linkend="GMimeContentType">GMimeContentType</link>* <link linkend="g-mime-part-get-content-type">g_mime_part_get_content_type</link>
                                            (<link linkend="GMimePart">GMimePart</link> *mime_part);
<link linkend="void">void</link>        <link linkend="g-mime-part-set-encoding">g_mime_part_set_encoding</link>        (<link linkend="GMimePart">GMimePart</link> *mime_part,
                                             <link linkend="GMimePartEncodingType">GMimePartEncodingType</link> encoding);
<link linkend="GMimePartEncodingType">GMimePartEncodingType</link> <link linkend="g-mime-part-get-encoding">g_mime_part_get_encoding</link>
                                            (<link linkend="GMimePart">GMimePart</link> *mime_part);
const <link linkend="char">char</link>* <link linkend="g-mime-part-encoding-to-string">g_mime_part_encoding_to_string</link>  (<link linkend="GMimePartEncodingType">GMimePartEncodingType</link> encoding);
<link linkend="GMimePartEncodingType">GMimePartEncodingType</link> <link linkend="g-mime-part-encoding-from-string">g_mime_part_encoding_from_string</link>
                                            (const <link linkend="char">char</link> *encoding);
<link linkend="void">void</link>        <link linkend="g-mime-part-set-content-disposition-object">g_mime_part_set_content_disposition_object</link>
                                            (<link linkend="GMimePart">GMimePart</link> *mime_part,
                                             <link linkend="GMimeDisposition">GMimeDisposition</link> *disposition);
<link linkend="void">void</link>        <link linkend="g-mime-part-set-content-disposition">g_mime_part_set_content_disposition</link>
                                            (<link linkend="GMimePart">GMimePart</link> *mime_part,
                                             const <link linkend="char">char</link> *disposition);
const <link linkend="char">char</link>* <link linkend="g-mime-part-get-content-disposition">g_mime_part_get_content_disposition</link>
                                            (<link linkend="GMimePart">GMimePart</link> *mime_part);
<link linkend="void">void</link>        <link linkend="g-mime-part-add-content-disposition-parameter">g_mime_part_add_content_disposition_parameter</link>
                                            (<link linkend="GMimePart">GMimePart</link> *mime_part,
                                             const <link linkend="char">char</link> *attribute,
                                             const <link linkend="char">char</link> *value);
const <link linkend="char">char</link>* <link linkend="g-mime-part-get-content-disposition-parameter">g_mime_part_get_content_disposition_parameter</link>
                                            (<link linkend="GMimePart">GMimePart</link> *mime_part,
                                             const <link linkend="char">char</link> *attribute);
<link linkend="void">void</link>        <link linkend="g-mime-part-set-filename">g_mime_part_set_filename</link>        (<link linkend="GMimePart">GMimePart</link> *mime_part,
                                             const <link linkend="char">char</link> *filename);
const <link linkend="char">char</link>* <link linkend="g-mime-part-get-filename">g_mime_part_get_filename</link>        (const <link linkend="GMimePart">GMimePart</link> *mime_part);
<link linkend="void">void</link>        <link linkend="g-mime-part-set-content">g_mime_part_set_content</link>         (<link linkend="GMimePart">GMimePart</link> *mime_part,
                                             const <link linkend="char">char</link> *content,
                                             <link linkend="size-t">size_t</link> len);
<link linkend="void">void</link>        <link linkend="g-mime-part-set-pre-encoded-content">g_mime_part_set_pre_encoded_content</link>
                                            (<link linkend="GMimePart">GMimePart</link> *mime_part,
                                             const <link linkend="char">char</link> *content,
                                             <link linkend="size-t">size_t</link> len,
                                             <link linkend="GMimePartEncodingType">GMimePartEncodingType</link> encoding);
<link linkend="void">void</link>        <link linkend="g-mime-part-set-content-byte-array">g_mime_part_set_content_byte_array</link>
                                            (<link linkend="GMimePart">GMimePart</link> *mime_part,
                                             <link linkend="GByteArray">GByteArray</link> *content);
const <link linkend="char">char</link>* <link linkend="g-mime-part-get-content">g_mime_part_get_content</link>         (const <link linkend="GMimePart">GMimePart</link> *mime_part,
                                             <link linkend="size-t">size_t</link> *len);
<link linkend="GMimeDataWrapper">GMimeDataWrapper</link>* <link linkend="g-mime-part-get-content-object">g_mime_part_get_content_object</link>
                                            (const <link linkend="GMimePart">GMimePart</link> *mime_part);
<link linkend="void">void</link>        <link linkend="g-mime-part-set-content-object">g_mime_part_set_content_object</link>  (<link linkend="GMimePart">GMimePart</link> *mime_part,
                                             <link linkend="GMimeDataWrapper">GMimeDataWrapper</link> *content);
<link linkend="ssize-t">ssize_t</link>     <link linkend="g-mime-part-write-to-stream">g_mime_part_write_to_stream</link>     (<link linkend="GMimePart">GMimePart</link> *mime_part,
                                             <link linkend="GMimeStream">GMimeStream</link> *stream);
<link linkend="char">char</link>*       <link linkend="g-mime-part-to-string">g_mime_part_to_string</link>           (<link linkend="GMimePart">GMimePart</link> *mime_part);


</synopsis>
</refsynopsisdiv>

<refsect1>
<title>Object Hierarchy</title>
<synopsis>

  <link linkend="GObject">GObject</link>
   +----<link linkend="GMimeObject">GMimeObject</link>
         +----GMimePart
               +----<link linkend="GMimeMessagePartial">GMimeMessagePartial</link>
</synopsis>

</refsect1>








<refsect1>
<title>Description</title>
<para>

</para>
</refsect1>

<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="GMimePart-struct"/>GMimePart</title>
<indexterm><primary>GMimePart</primary></indexterm><programlisting>typedef struct _GMimePart GMimePart;</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="g-mime-part-new"/>g_mime_part_new ()</title>
<indexterm><primary>g_mime_part_new</primary></indexterm><programlisting><link linkend="GMimePart">GMimePart</link>*  g_mime_part_new                 (void);</programlisting>
<para>
Creates a new MIME Part object with a default content-type of
text/plain.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>an empty MIME Part object with a default content-type of
text/plain.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-part-new-with-type"/>g_mime_part_new_with_type ()</title>
<indexterm><primary>g_mime_part_new_with_type</primary></indexterm><programlisting><link linkend="GMimePart">GMimePart</link>*  g_mime_part_new_with_type       (const <link linkend="char">char</link> *type,
                                             const <link linkend="char">char</link> *subtype);</programlisting>
<para>
Creates a new MIME Part with a sepcified type.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>type</parameter>&nbsp;:</term>
<listitem><simpara> content-type
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>subtype</parameter>&nbsp;:</term>
<listitem><simpara> content-subtype
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>an empty MIME Part object with the specified content-type.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-part-set-content-header"/>g_mime_part_set_content_header ()</title>
<indexterm><primary>g_mime_part_set_content_header</primary></indexterm><programlisting><link linkend="void">void</link>        g_mime_part_set_content_header  (<link linkend="GMimePart">GMimePart</link> *mime_part,
                                             const <link linkend="char">char</link> *header,
                                             const <link linkend="char">char</link> *value);</programlisting>
<para>
Set an arbitrary MIME content header.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>mime_part</parameter>&nbsp;:</term>
<listitem><simpara> mime part
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>header</parameter>&nbsp;:</term>
<listitem><simpara> header name
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
<listitem><simpara> header value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-part-get-content-header"/>g_mime_part_get_content_header ()</title>
<indexterm><primary>g_mime_part_get_content_header</primary></indexterm><programlisting>const <link linkend="char">char</link>* g_mime_part_get_content_header  (<link linkend="GMimePart">GMimePart</link> *mime_part,
                                             const <link linkend="char">char</link> *header);</programlisting>
<para>
Gets the value of the requested header if it exists, or <literal>NULL</literal>
otherwise.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>mime_part</parameter>&nbsp;:</term>
<listitem><simpara> mime part
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>header</parameter>&nbsp;:</term>
<listitem><simpara> header name
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>the value of the content header <parameter>header</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-part-set-content-description"/>g_mime_part_set_content_description ()</title>
<indexterm><primary>g_mime_part_set_content_description</primary></indexterm><programlisting><link linkend="void">void</link>        g_mime_part_set_content_description
                                            (<link linkend="GMimePart">GMimePart</link> *mime_part,
                                             const <link linkend="char">char</link> *description);</programlisting>
<para>
Set the content description for the specified mime part.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>mime_part</parameter>&nbsp;:</term>
<listitem><simpara> Mime part
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>description</parameter>&nbsp;:</term>
<listitem><simpara> content description
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-part-get-content-description"/>g_mime_part_get_content_description ()</title>
<indexterm><primary>g_mime_part_get_content_description</primary></indexterm><programlisting>const <link linkend="char">char</link>* g_mime_part_get_content_description
                                            (const <link linkend="GMimePart">GMimePart</link> *mime_part);</programlisting>
<para>
Gets the value of the Content-Description for the specified mime
part if it exists or <literal>NULL</literal> otherwise.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>mime_part</parameter>&nbsp;:</term>
<listitem><simpara> Mime part
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>the content description for the specified mime part.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-part-set-content-id"/>g_mime_part_set_content_id ()</title>
<indexterm><primary>g_mime_part_set_content_id</primary></indexterm><programlisting><link linkend="void">void</link>        g_mime_part_set_content_id      (<link linkend="GMimePart">GMimePart</link> *mime_part,
                                             const <link linkend="char">char</link> *content_id);</programlisting>
<para>
Set the content id for the specified mime part.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>mime_part</parameter>&nbsp;:</term>
<listitem><simpara> Mime part
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>content_id</parameter>&nbsp;:</term>
<listitem><simpara> content id
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-part-get-content-id"/>g_mime_part_get_content_id ()</title>
<indexterm><primary>g_mime_part_get_content_id</primary></indexterm><programlisting>const <link linkend="char">char</link>* g_mime_part_get_content_id      (<link linkend="GMimePart">GMimePart</link> *mime_part);</programlisting>
<para>
Gets the content-id of the specified mime part if it exists, or
<literal>NULL</literal> otherwise.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>mime_part</parameter>&nbsp;:</term>
<listitem><simpara> Mime part
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>the content id for the specified mime part.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-part-set-content-md5"/>g_mime_part_set_content_md5 ()</title>
<indexterm><primary>g_mime_part_set_content_md5</primary></indexterm><programlisting><link linkend="void">void</link>        g_mime_part_set_content_md5     (<link linkend="GMimePart">GMimePart</link> *mime_part,
                                             const <link linkend="char">char</link> *content_md5);</programlisting>
<para>
Set the content md5 for the specified mime part.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>mime_part</parameter>&nbsp;:</term>
<listitem><simpara> Mime part
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>content_md5</parameter>&nbsp;:</term>
<listitem><simpara> content md5 or NULL to generate the md5 digest.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-part-get-content-md5"/>g_mime_part_get_content_md5 ()</title>
<indexterm><primary>g_mime_part_get_content_md5</primary></indexterm><programlisting>const <link linkend="char">char</link>* g_mime_part_get_content_md5     (<link linkend="GMimePart">GMimePart</link> *mime_part);</programlisting>
<para>
Gets the md5sum contained in the Content-Md5 header of the
specified mime part if it exists, or <literal>NULL</literal> otherwise.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>mime_part</parameter>&nbsp;:</term>
<listitem><simpara> Mime part
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>the content md5 for the specified mime part.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-part-verify-content-md5"/>g_mime_part_verify_content_md5 ()</title>
<indexterm><primary>g_mime_part_verify_content_md5</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    g_mime_part_verify_content_md5  (<link linkend="GMimePart">GMimePart</link> *mime_part);</programlisting>
<para>
Verify the content md5 for the specified mime part.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>mime_part</parameter>&nbsp;:</term>
<listitem><simpara> Mime part
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>TRUE if the md5 is valid or FALSE otherwise. Note: will
return FALSE if the mime part does not contain a Content-MD5.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-part-set-content-location"/>g_mime_part_set_content_location ()</title>
<indexterm><primary>g_mime_part_set_content_location</primary></indexterm><programlisting><link linkend="void">void</link>        g_mime_part_set_content_location
                                            (<link linkend="GMimePart">GMimePart</link> *mime_part,
                                             const <link linkend="char">char</link> *content_location);</programlisting>
<para>
Set the content location for the specified mime part.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>mime_part</parameter>&nbsp;:</term>
<listitem><simpara> Mime part
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>content_location</parameter>&nbsp;:</term>
<listitem><simpara> content location
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-part-get-content-location"/>g_mime_part_get_content_location ()</title>
<indexterm><primary>g_mime_part_get_content_location</primary></indexterm><programlisting>const <link linkend="char">char</link>* g_mime_part_get_content_location
                                            (<link linkend="GMimePart">GMimePart</link> *mime_part);</programlisting>
<para>
Gets the value of the Content-Location header if it exists, or
<literal>NULL</literal> otherwise.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>mime_part</parameter>&nbsp;:</term>
<listitem><simpara> Mime part
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>the content location for the specified mime part.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-part-set-content-type"/>g_mime_part_set_content_type ()</title>
<indexterm><primary>g_mime_part_set_content_type</primary></indexterm><programlisting><link linkend="void">void</link>        g_mime_part_set_content_type    (<link linkend="GMimePart">GMimePart</link> *mime_part,
                                             <link linkend="GMimeContentType">GMimeContentType</link> *mime_type);</programlisting>
<para>
Set the content type/subtype for the specified mime part.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>mime_part</parameter>&nbsp;:</term>
<listitem><simpara> Mime part
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mime_type</parameter>&nbsp;:</term>
<listitem><simpara> Mime content-type
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-part-get-content-type"/>g_mime_part_get_content_type ()</title>
<indexterm><primary>g_mime_part_get_content_type</primary></indexterm><programlisting>const <link linkend="GMimeContentType">GMimeContentType</link>* g_mime_part_get_content_type
                                            (<link linkend="GMimePart">GMimePart</link> *mime_part);</programlisting>
<para>
Gets the Content-Type object for the given mime part or <literal>NULL</literal> on
error.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>mime_part</parameter>&nbsp;:</term>
<listitem><simpara> Mime part
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>the content-type object for the specified mime part.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-part-set-encoding"/>g_mime_part_set_encoding ()</title>
<indexterm><primary>g_mime_part_set_encoding</primary></indexterm><programlisting><link linkend="void">void</link>        g_mime_part_set_encoding        (<link linkend="GMimePart">GMimePart</link> *mime_part,
                                             <link linkend="GMimePartEncodingType">GMimePartEncodingType</link> encoding);</programlisting>
<para>
Set the content encoding for the specified mime part. Available
values for the encoding are: GMIME_PART_ENCODING_DEFAULT,
GMIME_PART_ENCODING_7BIT, GMIME_PART_ENCODING_8BIT,
GMIME_PART_ENCODING_BINARY, GMIME_PART_ENCODING_BASE64 and
GMIME_PART_ENCODING_QUOTEDPRINTABLE.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>mime_part</parameter>&nbsp;:</term>
<listitem><simpara> Mime part
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>encoding</parameter>&nbsp;:</term>
<listitem><simpara> Mime encoding
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-part-get-encoding"/>g_mime_part_get_encoding ()</title>
<indexterm><primary>g_mime_part_get_encoding</primary></indexterm><programlisting><link linkend="GMimePartEncodingType">GMimePartEncodingType</link> g_mime_part_get_encoding
                                            (<link linkend="GMimePart">GMimePart</link> *mime_part);</programlisting>
<para>
Gets the content encoding of the mime part.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>mime_part</parameter>&nbsp;:</term>
<listitem><simpara> Mime part
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>the content encoding for the specified mime part. The
return value will be one of the following:
GMIME_PART_ENCODING_DEFAULT, GMIME_PART_ENCODING_7BIT,
GMIME_PART_ENCODING_8BIT, GMIME_PART_ENCODING_BINARY,
GMIME_PART_ENCODING_BASE64, GMIME_PART_ENCODING_QUOTEDPRINTABLE
or GMIME_PART_ENCODING_UUENCODE.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-part-encoding-to-string"/>g_mime_part_encoding_to_string ()</title>
<indexterm><primary>g_mime_part_encoding_to_string</primary></indexterm><programlisting>const <link linkend="char">char</link>* g_mime_part_encoding_to_string  (<link linkend="GMimePartEncodingType">GMimePartEncodingType</link> encoding);</programlisting>
<para>
Gets the string value of the content encoding.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>encoding</parameter>&nbsp;:</term>
<listitem><simpara> Mime encoding
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>the encoding type as a string. Available
values for the encoding are: GMIME_PART_ENCODING_DEFAULT,
GMIME_PART_ENCODING_7BIT, GMIME_PART_ENCODING_8BIT,
GMIME_PART_ENCODING_BINARY, GMIME_PART_ENCODING_BASE64,
GMIME_PART_ENCODING_QUOTEDPRINTABLE and
GMIME_PART_ENCODING_UUENCODE.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-part-encoding-from-string"/>g_mime_part_encoding_from_string ()</title>
<indexterm><primary>g_mime_part_encoding_from_string</primary></indexterm><programlisting><link linkend="GMimePartEncodingType">GMimePartEncodingType</link> g_mime_part_encoding_from_string
                                            (const <link linkend="char">char</link> *encoding);</programlisting>
<para>
Gets the content encoding enumeration value based on the input
string.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>encoding</parameter>&nbsp;:</term>
<listitem><simpara> Mime encoding in string format
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>the encoding string as a GMimePartEncodingType.  Available
values for the encoding are: GMIME_PART_ENCODING_DEFAULT,
GMIME_PART_ENCODING_7BIT, GMIME_PART_ENCODING_8BIT,
GMIME_PART_ENCODING_BINARY, GMIME_PART_ENCODING_BASE64,
GMIME_PART_ENCODING_QUOTEDPRINTABLE and
GMIME_PART_ENCODING_UUENCODE.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-part-set-content-disposition-object"/>g_mime_part_set_content_disposition_object ()</title>
<indexterm><primary>g_mime_part_set_content_disposition_object</primary></indexterm><programlisting><link linkend="void">void</link>        g_mime_part_set_content_disposition_object
                                            (<link linkend="GMimePart">GMimePart</link> *mime_part,
                                             <link linkend="GMimeDisposition">GMimeDisposition</link> *disposition);</programlisting>
<para>
Set the content disposition for the specified mime part</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>mime_part</parameter>&nbsp;:</term>
<listitem><simpara> Mime part
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>disposition</parameter>&nbsp;:</term>
<listitem><simpara> disposition object
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-part-set-content-disposition"/>g_mime_part_set_content_disposition ()</title>
<indexterm><primary>g_mime_part_set_content_disposition</primary></indexterm><programlisting><link linkend="void">void</link>        g_mime_part_set_content_disposition
                                            (<link linkend="GMimePart">GMimePart</link> *mime_part,
                                             const <link linkend="char">char</link> *disposition);</programlisting>
<para>
Set the content disposition for the specified mime part</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>mime_part</parameter>&nbsp;:</term>
<listitem><simpara> Mime part
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>disposition</parameter>&nbsp;:</term>
<listitem><simpara> disposition
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-part-get-content-disposition"/>g_mime_part_get_content_disposition ()</title>
<indexterm><primary>g_mime_part_get_content_disposition</primary></indexterm><programlisting>const <link linkend="char">char</link>* g_mime_part_get_content_disposition
                                            (<link linkend="GMimePart">GMimePart</link> *mime_part);</programlisting>
<para>
Gets the content disposition if set or <literal>NULL</literal> otherwise.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>mime_part</parameter>&nbsp;:</term>
<listitem><simpara> Mime part
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>the content disposition for the specified mime part.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-part-add-content-disposition-parameter"/>g_mime_part_add_content_disposition_parameter ()</title>
<indexterm><primary>g_mime_part_add_content_disposition_parameter</primary></indexterm><programlisting><link linkend="void">void</link>        g_mime_part_add_content_disposition_parameter
                                            (<link linkend="GMimePart">GMimePart</link> *mime_part,
                                             const <link linkend="char">char</link> *attribute,
                                             const <link linkend="char">char</link> *value);</programlisting>
<para>
Add a content-disposition parameter to the specified mime part.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>mime_part</parameter>&nbsp;:</term>
<listitem><simpara> Mime part
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>attribute</parameter>&nbsp;:</term>
<listitem><simpara> parameter name
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
<listitem><simpara> parameter value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-part-get-content-disposition-parameter"/>g_mime_part_get_content_disposition_parameter ()</title>
<indexterm><primary>g_mime_part_get_content_disposition_parameter</primary></indexterm><programlisting>const <link linkend="char">char</link>* g_mime_part_get_content_disposition_parameter
                                            (<link linkend="GMimePart">GMimePart</link> *mime_part,
                                             const <link linkend="char">char</link> *attribute);</programlisting>
<para>
Gets the value of the Content-Disposition parameter specified by
<parameter>attribute</parameter>, or <literal>NULL</literal> if the parameter does not exist.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>mime_part</parameter>&nbsp;:</term>
<listitem><simpara> Mime part
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>attribute</parameter>&nbsp;:</term>
<listitem><simpara> parameter name
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>the value of a previously defined content-disposition
parameter specified by <link linkend="name"><type>name</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-part-set-filename"/>g_mime_part_set_filename ()</title>
<indexterm><primary>g_mime_part_set_filename</primary></indexterm><programlisting><link linkend="void">void</link>        g_mime_part_set_filename        (<link linkend="GMimePart">GMimePart</link> *mime_part,
                                             const <link linkend="char">char</link> *filename);</programlisting>
<para>
Sets the "filename" parameter on the Content-Disposition and also sets the
"name" parameter on the Content-Type.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>mime_part</parameter>&nbsp;:</term>
<listitem><simpara> Mime part
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>filename</parameter>&nbsp;:</term>
<listitem><simpara> the filename of the Mime Part's content
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-part-get-filename"/>g_mime_part_get_filename ()</title>
<indexterm><primary>g_mime_part_get_filename</primary></indexterm><programlisting>const <link linkend="char">char</link>* g_mime_part_get_filename        (const <link linkend="GMimePart">GMimePart</link> *mime_part);</programlisting>
<para>
Gets the filename of the specificed mime part, or <literal>NULL</literal> if the mime
part does not have the filename or name parameter set.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>mime_part</parameter>&nbsp;:</term>
<listitem><simpara> Mime part
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>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.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-part-set-content"/>g_mime_part_set_content ()</title>
<indexterm role="deprecated"><primary>g_mime_part_set_content</primary></indexterm><programlisting><link linkend="void">void</link>        g_mime_part_set_content         (<link linkend="GMimePart">GMimePart</link> *mime_part,
                                             const <link linkend="char">char</link> *content,
                                             <link linkend="size-t">size_t</link> len);</programlisting>
<warning><para><literal>g_mime_part_set_content</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
WARNING: This interface is deprecated. Use
<link linkend="g-mime-part-set-content-object"><function>g_mime_part_set_content_object()</function></link> instead.
</para>
<para>
Sets the content of the Mime Part (only non-multiparts)</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>mime_part</parameter>&nbsp;:</term>
<listitem><simpara> Mime part
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>content</parameter>&nbsp;:</term>
<listitem><simpara> raw mime part content
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>len</parameter>&nbsp;:</term>
<listitem><simpara> raw content length
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-part-set-pre-encoded-content"/>g_mime_part_set_pre_encoded_content ()</title>
<indexterm role="deprecated"><primary>g_mime_part_set_pre_encoded_content</primary></indexterm><programlisting><link linkend="void">void</link>        g_mime_part_set_pre_encoded_content
                                            (<link linkend="GMimePart">GMimePart</link> *mime_part,
                                             const <link linkend="char">char</link> *content,
                                             <link linkend="size-t">size_t</link> len,
                                             <link linkend="GMimePartEncodingType">GMimePartEncodingType</link> encoding);</programlisting>
<warning><para><literal>g_mime_part_set_pre_encoded_content</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
WARNING: This interface is deprecated. Use
<link linkend="g-mime-part-set-content-object"><function>g_mime_part_set_content_object()</function></link> instead.
</para>
<para>
Sets the encoding type and raw content on the mime part after
decoding the content.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>mime_part</parameter>&nbsp;:</term>
<listitem><simpara> Mime part
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>content</parameter>&nbsp;:</term>
<listitem><simpara> encoded mime part content
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>len</parameter>&nbsp;:</term>
<listitem><simpara> length of the content
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>encoding</parameter>&nbsp;:</term>
<listitem><simpara> content encoding
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-part-set-content-byte-array"/>g_mime_part_set_content_byte_array ()</title>
<indexterm role="deprecated"><primary>g_mime_part_set_content_byte_array</primary></indexterm><programlisting><link linkend="void">void</link>        g_mime_part_set_content_byte_array
                                            (<link linkend="GMimePart">GMimePart</link> *mime_part,
                                             <link linkend="GByteArray">GByteArray</link> *content);</programlisting>
<warning><para><literal>g_mime_part_set_content_byte_array</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
WARNING: This interface is deprecated. Use
<link linkend="g-mime-part-set-content-object"><function>g_mime_part_set_content_object()</function></link> instead.
</para>
<para>
Sets the content of the Mime Part (only non-multiparts)</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>mime_part</parameter>&nbsp;:</term>
<listitem><simpara> Mime part
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>content</parameter>&nbsp;:</term>
<listitem><simpara> raw mime part content.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-part-get-content"/>g_mime_part_get_content ()</title>
<indexterm role="deprecated"><primary>g_mime_part_get_content</primary></indexterm><programlisting>const <link linkend="char">char</link>* g_mime_part_get_content         (const <link linkend="GMimePart">GMimePart</link> *mime_part,
                                             <link linkend="size-t">size_t</link> *len);</programlisting>
<warning><para><literal>g_mime_part_get_content</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Gets the raw contents of the mime part and sets <parameter>len</parameter> to the length
of the raw data buffer.
</para>
<para>
WARNING: This interface is deprecated. Use
<link linkend="g-mime-part-get-content-object"><function>g_mime_part_get_content_object()</function></link> instead.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>mime_part</parameter>&nbsp;:</term>
<listitem><simpara> MIME part object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>len</parameter>&nbsp;:</term>
<listitem><simpara> pointer to the content length
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>a const char * pointer to the raw contents of the MIME Part
and sets <parameter>len</parameter> to the length of the buffer. Note: textual content
will not be converted to UTF-8. Also note that this buffer will not
be nul-terminated and may in fact contain nul bytes mid-buffer so
you MUST treat the data returned as raw binary data even if the
content type is text.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-part-get-content-object"/>g_mime_part_get_content_object ()</title>
<indexterm><primary>g_mime_part_get_content_object</primary></indexterm><programlisting><link linkend="GMimeDataWrapper">GMimeDataWrapper</link>* g_mime_part_get_content_object
                                            (const <link linkend="GMimePart">GMimePart</link> *mime_part);</programlisting>
<para>
Gets the internal data-wrapper of the specified mime part, or <literal>NULL</literal>
on error.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>mime_part</parameter>&nbsp;:</term>
<listitem><simpara> MIME part object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>the data-wrapper for the mime part's contents.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-part-set-content-object"/>g_mime_part_set_content_object ()</title>
<indexterm><primary>g_mime_part_set_content_object</primary></indexterm><programlisting><link linkend="void">void</link>        g_mime_part_set_content_object  (<link linkend="GMimePart">GMimePart</link> *mime_part,
                                             <link linkend="GMimeDataWrapper">GMimeDataWrapper</link> *content);</programlisting>
<para>
Sets the content object on the mime part.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>mime_part</parameter>&nbsp;:</term>
<listitem><simpara> MIME Part
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>content</parameter>&nbsp;:</term>
<listitem><simpara> content object
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-part-write-to-stream"/>g_mime_part_write_to_stream ()</title>
<indexterm role="deprecated"><primary>g_mime_part_write_to_stream</primary></indexterm><programlisting><link linkend="ssize-t">ssize_t</link>     g_mime_part_write_to_stream     (<link linkend="GMimePart">GMimePart</link> *mime_part,
                                             <link linkend="GMimeStream">GMimeStream</link> *stream);</programlisting>
<warning><para><literal>g_mime_part_write_to_stream</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Writes the contents of the MIME Part to <parameter>stream</parameter>.
</para>
<para>
WARNING: This interface is deprecated. Use
<link linkend="g-mime-object-write-to-stream"><function>g_mime_object_write_to_stream()</function></link> instead.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>mime_part</parameter>&nbsp;:</term>
<listitem><simpara> MIME Part
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>stream</parameter>&nbsp;:</term>
<listitem><simpara> output stream
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>the number of bytes written or -1 on fail.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="g-mime-part-to-string"/>g_mime_part_to_string ()</title>
<indexterm role="deprecated"><primary>g_mime_part_to_string</primary></indexterm><programlisting><link linkend="char">char</link>*       g_mime_part_to_string           (<link linkend="GMimePart">GMimePart</link> *mime_part);</programlisting>
<warning><para><literal>g_mime_part_to_string</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Allocates a string buffer containing the MIME Part.
</para>
<para>
WARNING: This interface is deprecated. Use
<link linkend="g-mime-object-to-string"><function>g_mime_object_to_string()</function></link> instead.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>mime_part</parameter>&nbsp;:</term>
<listitem><simpara> MIME Part
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>an allocated string containing the MIME Part.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>