<refentry id="InternetAddress">
<refmeta>
<refentrytitle role="top_of_page" id="InternetAddress.top_of_page">InternetAddress</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>
  GMIME Library
</refmiscinfo>
</refmeta>
<refnamediv>
<refname>InternetAddress</refname>
<refpurpose>Internet addresses</refpurpose>
</refnamediv>

<refsynopsisdiv id="InternetAddress.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>                    <link linkend="InternetAddress-struct">InternetAddress</link>;
const <link linkend="char"><returnvalue>char</returnvalue></link> *        <link linkend="internet-address-get-name">internet_address_get_name</link>           (<parameter><link linkend="InternetAddress"><type>InternetAddress</type></link> *ia</parameter>);
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="internet-address-set-name">internet_address_set_name</link>           (<parameter><link linkend="InternetAddress"><type>InternetAddress</type></link> *ia</parameter>,
                                                         <parameter>const <link linkend="char"><type>char</type></link> *name</parameter>);
<link linkend="char"><returnvalue>char</returnvalue></link> *              <link linkend="internet-address-to-string">internet_address_to_string</link>          (<parameter><link linkend="InternetAddress"><type>InternetAddress</type></link> *ia</parameter>,
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> encode</parameter>);
</synopsis>
</refsynopsisdiv>
<refsect1 id="InternetAddress.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----InternetAddress
         +----<link linkend="InternetAddressGroup">InternetAddressGroup</link>
         +----<link linkend="InternetAddressMailbox">InternetAddressMailbox</link>
</synopsis>
</refsect1>

<refsect1 id="InternetAddress.description" role="desc">
<title role="desc.title">Description</title>
<para>
An <link linkend="InternetAddress"><type>InternetAddress</type></link> is the base class for <link linkend="InternetAddressGroup"><type>InternetAddressGroup</type></link> and
<link linkend="InternetAddressMailbox"><type>InternetAddressMailbox</type></link>.
</para>
</refsect1>
<refsect1 id="InternetAddress.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="InternetAddress-struct" role="struct">
<title>InternetAddress</title>
<indexterm zone="InternetAddress-struct"><primary>InternetAddress</primary></indexterm>
<programlisting>typedef struct _InternetAddress InternetAddress;</programlisting>
<para>
An RFC 2822 Address object.
</para><variablelist role="struct">
</variablelist></refsect2>
<refsect2 id="internet-address-get-name" role="function">
<title>internet_address_get_name ()</title>
<indexterm zone="internet-address-get-name"><primary>internet_address_get_name</primary></indexterm>
<programlisting>const <link linkend="char"><returnvalue>char</returnvalue></link> *        internet_address_get_name           (<parameter><link linkend="InternetAddress"><type>InternetAddress</type></link> *ia</parameter>);</programlisting>
<para>
Gets the display name of the <link linkend="InternetAddress"><type>InternetAddress</type></link>.
</para><variablelist role="params">
<varlistentry><term><parameter>ia</parameter>&#160;:</term>
<listitem><simpara>a <link linkend="InternetAddress"><type>InternetAddress</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the display name of <parameter>ia</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="internet-address-set-name" role="function">
<title>internet_address_set_name ()</title>
<indexterm zone="internet-address-set-name"><primary>internet_address_set_name</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                internet_address_set_name           (<parameter><link linkend="InternetAddress"><type>InternetAddress</type></link> *ia</parameter>,
                                                         <parameter>const <link linkend="char"><type>char</type></link> *name</parameter>);</programlisting>
<para>
Set the display name of the <link linkend="InternetAddress"><type>InternetAddress</type></link>.
</para><variablelist role="params">
<varlistentry><term><parameter>ia</parameter>&#160;:</term>
<listitem><simpara>a <link linkend="InternetAddress"><type>InternetAddress</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter>&#160;:</term>
<listitem><simpara>the display name for the address group or mailbox
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="internet-address-to-string" role="function">
<title>internet_address_to_string ()</title>
<indexterm zone="internet-address-to-string"><primary>internet_address_to_string</primary></indexterm>
<programlisting><link linkend="char"><returnvalue>char</returnvalue></link> *              internet_address_to_string          (<parameter><link linkend="InternetAddress"><type>InternetAddress</type></link> *ia</parameter>,
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> encode</parameter>);</programlisting>
<para>
Allocates a string containing the contents of the <link linkend="InternetAddress"><type>InternetAddress</type></link>
object.
</para><variablelist role="params">
<varlistentry><term><parameter>ia</parameter>&#160;:</term>
<listitem><simpara>Internet Address object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>encode</parameter>&#160;:</term>
<listitem><simpara><link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the address should be rfc2047 encoded
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the <link linkend="InternetAddress"><type>InternetAddress</type></link> object as an allocated string in
rfc822 format.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>
<refsect1 id="InternetAddress.see-also">
<title>See Also</title>
<link linkend="InternetAddressGroup"><type>InternetAddressGroup</type></link>, <link linkend="InternetAddressMailbox"><type>InternetAddressMailbox</type></link>
</refsect1>

</refentry>
