<refentry id="InternetAddressGroup">
<refmeta>
<refentrytitle role="top_of_page" id="InternetAddressGroup.top_of_page">InternetAddressGroup</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>
  GMIME Library
</refmiscinfo>
</refmeta>
<refnamediv>
<refname>InternetAddressGroup</refname>
<refpurpose>rfc822 'group' address</refpurpose>
</refnamediv>

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

<synopsis>                    <link linkend="InternetAddressGroup-struct">InternetAddressGroup</link>;
<link linkend="InternetAddress"><returnvalue>InternetAddress</returnvalue></link> *   <link linkend="internet-address-group-new">internet_address_group_new</link>          (<parameter>const <link linkend="char"><type>char</type></link> *name</parameter>);
<link linkend="InternetAddressList"><returnvalue>InternetAddressList</returnvalue></link> * <link linkend="internet-address-group-get-members">internet_address_group_get_members</link>
                                                        (<parameter><link linkend="InternetAddressGroup"><type>InternetAddressGroup</type></link> *group</parameter>);
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="internet-address-group-set-members">internet_address_group_set_members</link>  (<parameter><link linkend="InternetAddressGroup"><type>InternetAddressGroup</type></link> *group</parameter>,
                                                         <parameter><link linkend="InternetAddressList"><type>InternetAddressList</type></link> *members</parameter>);
<link linkend="int"><returnvalue>int</returnvalue></link>                 <link linkend="internet-address-group-add-member">internet_address_group_add_member</link>   (<parameter><link linkend="InternetAddressGroup"><type>InternetAddressGroup</type></link> *group</parameter>,
                                                         <parameter><link linkend="InternetAddress"><type>InternetAddress</type></link> *member</parameter>);
</synopsis>
</refsynopsisdiv>
<refsect1 id="InternetAddressGroup.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----<link linkend="InternetAddress">InternetAddress</link>
         +----InternetAddressGroup
</synopsis>
</refsect1>

<refsect1 id="InternetAddressGroup.description" role="desc">
<title role="desc.title">Description</title>
<para>
An <link linkend="InternetAddressGroup"><type>InternetAddressGroup</type></link> represents an rfc822 'group' address.
</para>
</refsect1>
<refsect1 id="InternetAddressGroup.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="InternetAddressGroup-struct" role="struct">
<title>InternetAddressGroup</title>
<indexterm zone="InternetAddressGroup-struct"><primary>InternetAddressGroup</primary></indexterm>
<programlisting>typedef struct _InternetAddressGroup InternetAddressGroup;</programlisting>
<para>
An RFC 2822 Group address.
</para><variablelist role="struct">
</variablelist></refsect2>
<refsect2 id="internet-address-group-new" role="function">
<title>internet_address_group_new ()</title>
<indexterm zone="internet-address-group-new"><primary>internet_address_group_new</primary></indexterm>
<programlisting><link linkend="InternetAddress"><returnvalue>InternetAddress</returnvalue></link> *   internet_address_group_new          (<parameter>const <link linkend="char"><type>char</type></link> *name</parameter>);</programlisting>
<para>
Creates a new <link linkend="InternetAddressGroup"><type>InternetAddressGroup</type></link> object with a display name of
<parameter>name</parameter>.
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter>&#160;:</term>
<listitem><simpara>group name
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="InternetAddressGroup"><type>InternetAddressGroup</type></link> object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="internet-address-group-get-members" role="function">
<title>internet_address_group_get_members ()</title>
<indexterm zone="internet-address-group-get-members"><primary>internet_address_group_get_members</primary></indexterm>
<programlisting><link linkend="InternetAddressList"><returnvalue>InternetAddressList</returnvalue></link> * internet_address_group_get_members
                                                        (<parameter><link linkend="InternetAddressGroup"><type>InternetAddressGroup</type></link> *group</parameter>);</programlisting>
<para>
Gets the <link linkend="InternetAddressList"><type>InternetAddressList</type></link> containing the group members of an
rfc822 group address.
</para><variablelist role="params">
<varlistentry><term><parameter>group</parameter>&#160;:</term>
<listitem><simpara>a <link linkend="InternetAddressGroup"><type>InternetAddressGroup</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="InternetAddressList"><type>InternetAddressList</type></link> containing the members of <parameter>group</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="internet-address-group-set-members" role="function">
<title>internet_address_group_set_members ()</title>
<indexterm zone="internet-address-group-set-members"><primary>internet_address_group_set_members</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                internet_address_group_set_members  (<parameter><link linkend="InternetAddressGroup"><type>InternetAddressGroup</type></link> *group</parameter>,
                                                         <parameter><link linkend="InternetAddressList"><type>InternetAddressList</type></link> *members</parameter>);</programlisting>
<para>
Set the members of the internet address group.
</para><variablelist role="params">
<varlistentry><term><parameter>group</parameter>&#160;:</term>
<listitem><simpara>a <link linkend="InternetAddressGroup"><type>InternetAddressGroup</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>members</parameter>&#160;:</term>
<listitem><simpara>a <link linkend="InternetAddressList"><type>InternetAddressList</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="internet-address-group-add-member" role="function">
<title>internet_address_group_add_member ()</title>
<indexterm zone="internet-address-group-add-member"><primary>internet_address_group_add_member</primary></indexterm>
<programlisting><link linkend="int"><returnvalue>int</returnvalue></link>                 internet_address_group_add_member   (<parameter><link linkend="InternetAddressGroup"><type>InternetAddressGroup</type></link> *group</parameter>,
                                                         <parameter><link linkend="InternetAddress"><type>InternetAddress</type></link> *member</parameter>);</programlisting>
<para>
Add a contact to the internet address group.
</para><variablelist role="params">
<varlistentry><term><parameter>group</parameter>&#160;:</term>
<listitem><simpara>a <link linkend="InternetAddressGroup"><type>InternetAddressGroup</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>member</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 index of the newly added member.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

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

</refentry>
