docs/reference/html/InternetAddressGroup.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>InternetAddressGroup</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GMime 2.6 Reference Manual">
   8 <link rel="up" href="InternetAddresses.html" title="Internet Addresses">
   9 <link rel="prev" href="InternetAddress.html" title="InternetAddress">
  10 <link rel="next" href="InternetAddressMailbox.html" title="InternetAddressMailbox">
  11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="InternetAddress.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="InternetAddresses.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GMime 2.6 Reference Manual</th>
  21 <td><a accesskey="n" href="InternetAddressMailbox.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#InternetAddressGroup.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#InternetAddressGroup.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#InternetAddressGroup.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29 </td></tr>
  30 </table>
  31 <div class="refentry">
  32 <a name="InternetAddressGroup"></a><div class="titlepage"></div>
  33 <div class="refnamediv"><table width="100%"><tr>
  34 <td valign="top">
  35 <h2><span class="refentrytitle"><a name="InternetAddressGroup.top_of_page"></a>InternetAddressGroup</span></h2>
  36 <p>InternetAddressGroup — rfc822 'group' address</p>
  37 </td>
  38 <td valign="top" align="right"></td>
  39 </tr></table></div>
  40 <div class="refsynopsisdiv">
  41 <a name="InternetAddressGroup.synopsis"></a><h2>Synopsis</h2>
  42 <pre class="synopsis">struct              <a class="link" href="InternetAddressGroup.html#InternetAddressGroup-struct" title="struct InternetAddressGroup">InternetAddressGroup</a>;
  43 <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>);
  44 <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>
  45                                                         (<em class="parameter"><code><a class="link" href="InternetAddressGroup.html" title="InternetAddressGroup"><span class="type">InternetAddressGroup</span></a> *group</code></em>);
  46 <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>,
  47                                                          <em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *members</code></em>);
  48 <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>,
  49                                                          <em class="parameter"><code><a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> *member</code></em>);
  50 </pre>
  51 </div>
  52 <div class="refsect1">
  53 <a name="InternetAddressGroup.object-hierarchy"></a><h2>Object Hierarchy</h2>
  54 <pre class="synopsis">
  55   GObject
  56    +----<a class="link" href="InternetAddress.html" title="InternetAddress">InternetAddress</a>
  57          +----InternetAddressGroup
  58 </pre>
  59 </div>
  60 <div class="refsect1">
  61 <a name="InternetAddressGroup.description"></a><h2>Description</h2>
  62 <p>
  63 An <a class="link" href="InternetAddressGroup.html" title="InternetAddressGroup"><span class="type">InternetAddressGroup</span></a> represents an rfc822 'group' address.
  64 </p>
  65 </div>
  66 <div class="refsect1">
  67 <a name="InternetAddressGroup.details"></a><h2>Details</h2>
  68 <div class="refsect2">
  69 <a name="InternetAddressGroup-struct"></a><h3>struct InternetAddressGroup</h3>
  70 <pre class="programlisting">struct InternetAddressGroup;</pre>
  71 <p>
  72 An RFC 2822 Group address.
  73 </p>
  74 <div class="variablelist"><table border="0">
  75 <col align="left" valign="top">
  76 <tbody></tbody>
  77 </table></div>
  78 </div>
  79 <hr>
  80 <div class="refsect2">
  81 <a name="internet-address-group-new"></a><h3>internet_address_group_new ()</h3>
  82 <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>
  83 <p>
  84 Creates a new <a class="link" href="InternetAddressGroup.html" title="InternetAddressGroup"><span class="type">InternetAddressGroup</span></a> object with a display name of
  85 <em class="parameter"><code>name</code></em>.
  86 </p>
  87 <div class="variablelist"><table border="0">
  88 <col align="left" valign="top">
  89 <tbody>
  90 <tr>
  91 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
  92 <td>group name</td>
  93 </tr>
  94 <tr>
  95 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
  96 <td>a new <a class="link" href="InternetAddressGroup.html" title="InternetAddressGroup"><span class="type">InternetAddressGroup</span></a> object.</td>
  97 </tr>
  98 </tbody>
  99 </table></div>
 100 </div>
 101 <hr>
 102 <div class="refsect2">
 103 <a name="internet-address-group-get-members"></a><h3>internet_address_group_get_members ()</h3>
 104 <pre class="programlisting"><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="returnvalue">InternetAddressList</span></a> * internet_address_group_get_members
 105                                                         (<em class="parameter"><code><a class="link" href="InternetAddressGroup.html" title="InternetAddressGroup"><span class="type">InternetAddressGroup</span></a> *group</code></em>);</pre>
 106 <p>
 107 Gets the <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> containing the group members of an
 108 rfc822 group address.
 109 </p>
 110 <div class="variablelist"><table border="0">
 111 <col align="left" valign="top">
 112 <tbody>
 113 <tr>
 114 <td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
 115 <td>a <a class="link" href="InternetAddressGroup.html" title="InternetAddressGroup"><span class="type">InternetAddressGroup</span></a>
 116 </td>
 117 </tr>
 118 <tr>
 119 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 120 <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>
 121 </tr>
 122 </tbody>
 123 </table></div>
 124 </div>
 125 <hr>
 126 <div class="refsect2">
 127 <a name="internet-address-group-set-members"></a><h3>internet_address_group_set_members ()</h3>
 128 <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>,
 129                                                          <em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *members</code></em>);</pre>
 130 <p>
 131 Set the members of the internet address group.
 132 </p>
 133 <div class="variablelist"><table border="0">
 134 <col align="left" valign="top">
 135 <tbody>
 136 <tr>
 137 <td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
 138 <td>a <a class="link" href="InternetAddressGroup.html" title="InternetAddressGroup"><span class="type">InternetAddressGroup</span></a>
 139 </td>
 140 </tr>
 141 <tr>
 142 <td><p><span class="term"><em class="parameter"><code>members</code></em> :</span></p></td>
 143 <td>a <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a>
 144 </td>
 145 </tr>
 146 </tbody>
 147 </table></div>
 148 </div>
 149 <hr>
 150 <div class="refsect2">
 151 <a name="internet-address-group-add-member"></a><h3>internet_address_group_add_member ()</h3>
 152 <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>,
 153                                                          <em class="parameter"><code><a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> *member</code></em>);</pre>
 154 <p>
 155 Add a contact to the internet address group.
 156 </p>
 157 <div class="variablelist"><table border="0">
 158 <col align="left" valign="top">
 159 <tbody>
 160 <tr>
 161 <td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
 162 <td>a <a class="link" href="InternetAddressGroup.html" title="InternetAddressGroup"><span class="type">InternetAddressGroup</span></a>
 163 </td>
 164 </tr>
 165 <tr>
 166 <td><p><span class="term"><em class="parameter"><code>member</code></em> :</span></p></td>
 167 <td>a <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a>
 168 </td>
 169 </tr>
 170 <tr>
 171 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 172 <td>the index of the newly added member.</td>
 173 </tr>
 174 </tbody>
 175 </table></div>
 176 </div>
 177 </div>
 178 <div class="refsect1">
 179 <a name="InternetAddressGroup.see-also"></a><h2>See Also</h2>
 180 <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a>
 181 </div>
 182 </div>
 183 <div class="footer">
 184 <hr>
 185           Generated by GTK-Doc V1.18</div>
 186 </body>
 187 </html>