docs/reference/html/InternetAddressList.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>InternetAddressList</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="InternetAddressMailbox.html" title="InternetAddressMailbox">
  10 <link rel="next" href="MimeParts.html" title="MIME Messages and Parts">
  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="InternetAddressMailbox.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="MimeParts.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="#InternetAddressList.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#InternetAddressList.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#InternetAddressList.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29 </td></tr>
  30 </table>
  31 <div class="refentry">
  32 <a name="InternetAddressList"></a><div class="titlepage"></div>
  33 <div class="refnamediv"><table width="100%"><tr>
  34 <td valign="top">
  35 <h2><span class="refentrytitle"><a name="InternetAddressList.top_of_page"></a>InternetAddressList</span></h2>
  36 <p>InternetAddressList — A list of internet addresses</p>
  37 </td>
  38 <td valign="top" align="right"></td>
  39 </tr></table></div>
  40 <div class="refsynopsisdiv">
  41 <a name="InternetAddressList.synopsis"></a><h2>Synopsis</h2>
  42 <pre class="synopsis">struct              <a class="link" href="InternetAddressList.html#InternetAddressList-struct" title="struct InternetAddressList">InternetAddressList</a>;
  43 <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="returnvalue">InternetAddressList</span></a> * <a class="link" href="InternetAddressList.html#internet-address-list-new" title="internet_address_list_new ()">internet_address_list_new</a>         (<em class="parameter"><code><span class="type">void</span></code></em>);
  44 <span class="returnvalue">int</span>                 <a class="link" href="InternetAddressList.html#internet-address-list-length" title="internet_address_list_length ()">internet_address_list_length</a>        (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>);
  45 <span class="returnvalue">void</span>                <a class="link" href="InternetAddressList.html#internet-address-list-clear" title="internet_address_list_clear ()">internet_address_list_clear</a>         (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>);
  46 <span class="returnvalue">int</span>                 <a class="link" href="InternetAddressList.html#internet-address-list-add" title="internet_address_list_add ()">internet_address_list_add</a>           (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>,
  47                                                          <em class="parameter"><code><a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> *ia</code></em>);
  48 <span class="returnvalue">void</span>                <a class="link" href="InternetAddressList.html#internet-address-list-insert" title="internet_address_list_insert ()">internet_address_list_insert</a>        (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>,
  49                                                          <em class="parameter"><code><span class="type">int</span> index</code></em>,
  50                                                          <em class="parameter"><code><a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> *ia</code></em>);
  51 <span class="returnvalue">gboolean</span>            <a class="link" href="InternetAddressList.html#internet-address-list-remove" title="internet_address_list_remove ()">internet_address_list_remove</a>        (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>,
  52                                                          <em class="parameter"><code><a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> *ia</code></em>);
  53 <span class="returnvalue">gboolean</span>            <a class="link" href="InternetAddressList.html#internet-address-list-remove-at" title="internet_address_list_remove_at ()">internet_address_list_remove_at</a>     (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>,
  54                                                          <em class="parameter"><code><span class="type">int</span> index</code></em>);
  55 <span class="returnvalue">gboolean</span>            <a class="link" href="InternetAddressList.html#internet-address-list-contains" title="internet_address_list_contains ()">internet_address_list_contains</a>      (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>,
  56                                                          <em class="parameter"><code><a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> *ia</code></em>);
  57 <span class="returnvalue">int</span>                 <a class="link" href="InternetAddressList.html#internet-address-list-index-of" title="internet_address_list_index_of ()">internet_address_list_index_of</a>      (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>,
  58                                                          <em class="parameter"><code><a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> *ia</code></em>);
  59 <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="returnvalue">InternetAddress</span></a> *   <a class="link" href="InternetAddressList.html#internet-address-list-get-address" title="internet_address_list_get_address ()">internet_address_list_get_address</a>   (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>,
  60                                                          <em class="parameter"><code><span class="type">int</span> index</code></em>);
  61 <span class="returnvalue">void</span>                <a class="link" href="InternetAddressList.html#internet-address-list-set-address" title="internet_address_list_set_address ()">internet_address_list_set_address</a>   (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>,
  62                                                          <em class="parameter"><code><span class="type">int</span> index</code></em>,
  63                                                          <em class="parameter"><code><a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> *ia</code></em>);
  64 <span class="returnvalue">void</span>                <a class="link" href="InternetAddressList.html#internet-address-list-prepend" title="internet_address_list_prepend ()">internet_address_list_prepend</a>       (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>,
  65                                                          <em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *prepend</code></em>);
  66 <span class="returnvalue">void</span>                <a class="link" href="InternetAddressList.html#internet-address-list-append" title="internet_address_list_append ()">internet_address_list_append</a>        (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>,
  67                                                          <em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *append</code></em>);
  68 <span class="returnvalue">char</span> *              <a class="link" href="InternetAddressList.html#internet-address-list-to-string" title="internet_address_list_to_string ()">internet_address_list_to_string</a>     (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>,
  69                                                          <em class="parameter"><code><span class="type">gboolean</span> encode</code></em>);
  70 <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="returnvalue">InternetAddressList</span></a> * <a class="link" href="InternetAddressList.html#internet-address-list-parse-string" title="internet_address_list_parse_string ()">internet_address_list_parse_string</a>
  71                                                         (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>);
  72 <span class="returnvalue">void</span>                <a class="link" href="InternetAddressList.html#internet-address-list-writer" title="internet_address_list_writer ()">internet_address_list_writer</a>        (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>,
  73                                                          <em class="parameter"><code><span class="type">GString</span> *str</code></em>);
  74 </pre>
  75 </div>
  76 <div class="refsect1">
  77 <a name="InternetAddressList.object-hierarchy"></a><h2>Object Hierarchy</h2>
  78 <pre class="synopsis">
  79   GObject
  80    +----InternetAddressList
  81 </pre>
  82 </div>
  83 <div class="refsect1">
  84 <a name="InternetAddressList.description"></a><h2>Description</h2>
  85 <p>
  86 An <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> is a collection of <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a>
  87 objects.
  88 </p>
  89 </div>
  90 <div class="refsect1">
  91 <a name="InternetAddressList.details"></a><h2>Details</h2>
  92 <div class="refsect2">
  93 <a name="InternetAddressList-struct"></a><h3>struct InternetAddressList</h3>
  94 <pre class="programlisting">struct InternetAddressList;</pre>
  95 <p>
  96 A collection of <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> objects.
  97 </p>
  98 <div class="variablelist"><table border="0">
  99 <col align="left" valign="top">
 100 <tbody></tbody>
 101 </table></div>
 102 </div>
 103 <hr>
 104 <div class="refsect2">
 105 <a name="internet-address-list-new"></a><h3>internet_address_list_new ()</h3>
 106 <pre class="programlisting"><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="returnvalue">InternetAddressList</span></a> * internet_address_list_new         (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 107 <p>
 108 Creates a new <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a>.
 109 </p>
 110 <div class="variablelist"><table border="0">
 111 <col align="left" valign="top">
 112 <tbody><tr>
 113 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 114 <td>a new <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a>.</td>
 115 </tr></tbody>
 116 </table></div>
 117 </div>
 118 <hr>
 119 <div class="refsect2">
 120 <a name="internet-address-list-length"></a><h3>internet_address_list_length ()</h3>
 121 <pre class="programlisting"><span class="returnvalue">int</span>                 internet_address_list_length        (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>);</pre>
 122 <p>
 123 Gets the length of the list.
 124 </p>
 125 <div class="variablelist"><table border="0">
 126 <col align="left" valign="top">
 127 <tbody>
 128 <tr>
 129 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
 130 <td>a <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a>
 131 </td>
 132 </tr>
 133 <tr>
 134 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 135 <td>the number of <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> objects in the list.</td>
 136 </tr>
 137 </tbody>
 138 </table></div>
 139 </div>
 140 <hr>
 141 <div class="refsect2">
 142 <a name="internet-address-list-clear"></a><h3>internet_address_list_clear ()</h3>
 143 <pre class="programlisting"><span class="returnvalue">void</span>                internet_address_list_clear         (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>);</pre>
 144 <p>
 145 Clears the list of addresses.
 146 </p>
 147 <div class="variablelist"><table border="0">
 148 <col align="left" valign="top">
 149 <tbody><tr>
 150 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
 151 <td>a <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a>
 152 </td>
 153 </tr></tbody>
 154 </table></div>
 155 </div>
 156 <hr>
 157 <div class="refsect2">
 158 <a name="internet-address-list-add"></a><h3>internet_address_list_add ()</h3>
 159 <pre class="programlisting"><span class="returnvalue">int</span>                 internet_address_list_add           (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>,
 160                                                          <em class="parameter"><code><a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> *ia</code></em>);</pre>
 161 <p>
 162 Adds an <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> to the <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a>.
 163 </p>
 164 <div class="variablelist"><table border="0">
 165 <col align="left" valign="top">
 166 <tbody>
 167 <tr>
 168 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
 169 <td>a <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a>
 170 </td>
 171 </tr>
 172 <tr>
 173 <td><p><span class="term"><em class="parameter"><code>ia</code></em> :</span></p></td>
 174 <td>a <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a>
 175 </td>
 176 </tr>
 177 <tr>
 178 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 179 <td>the index of the added <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a>.</td>
 180 </tr>
 181 </tbody>
 182 </table></div>
 183 </div>
 184 <hr>
 185 <div class="refsect2">
 186 <a name="internet-address-list-insert"></a><h3>internet_address_list_insert ()</h3>
 187 <pre class="programlisting"><span class="returnvalue">void</span>                internet_address_list_insert        (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>,
 188                                                          <em class="parameter"><code><span class="type">int</span> index</code></em>,
 189                                                          <em class="parameter"><code><a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> *ia</code></em>);</pre>
 190 <p>
 191 Inserts an <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> into the <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> at the
 192 specified index.
 193 </p>
 194 <div class="variablelist"><table border="0">
 195 <col align="left" valign="top">
 196 <tbody>
 197 <tr>
 198 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
 199 <td>a <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a>
 200 </td>
 201 </tr>
 202 <tr>
 203 <td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td>
 204 <td>index to insert at</td>
 205 </tr>
 206 <tr>
 207 <td><p><span class="term"><em class="parameter"><code>ia</code></em> :</span></p></td>
 208 <td>a <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a>
 209 </td>
 210 </tr>
 211 </tbody>
 212 </table></div>
 213 </div>
 214 <hr>
 215 <div class="refsect2">
 216 <a name="internet-address-list-remove"></a><h3>internet_address_list_remove ()</h3>
 217 <pre class="programlisting"><span class="returnvalue">gboolean</span>            internet_address_list_remove        (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>,
 218                                                          <em class="parameter"><code><a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> *ia</code></em>);</pre>
 219 <p>
 220 Removes an <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> from the <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a>.
 221 </p>
 222 <div class="variablelist"><table border="0">
 223 <col align="left" valign="top">
 224 <tbody>
 225 <tr>
 226 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
 227 <td>a <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a>
 228 </td>
 229 </tr>
 230 <tr>
 231 <td><p><span class="term"><em class="parameter"><code>ia</code></em> :</span></p></td>
 232 <td>a <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a>
 233 </td>
 234 </tr>
 235 <tr>
 236 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 237 <td>
 238 <code class="literal">TRUE</code> if the specified <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> was removed or
 239 <code class="literal">FALSE</code> otherwise.</td>
 240 </tr>
 241 </tbody>
 242 </table></div>
 243 </div>
 244 <hr>
 245 <div class="refsect2">
 246 <a name="internet-address-list-remove-at"></a><h3>internet_address_list_remove_at ()</h3>
 247 <pre class="programlisting"><span class="returnvalue">gboolean</span>            internet_address_list_remove_at     (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>,
 248                                                          <em class="parameter"><code><span class="type">int</span> index</code></em>);</pre>
 249 <p>
 250 Removes an <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> from the <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> at the
 251 specified index.
 252 </p>
 253 <div class="variablelist"><table border="0">
 254 <col align="left" valign="top">
 255 <tbody>
 256 <tr>
 257 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
 258 <td>a <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a>
 259 </td>
 260 </tr>
 261 <tr>
 262 <td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td>
 263 <td>index to remove</td>
 264 </tr>
 265 <tr>
 266 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 267 <td>
 268 <code class="literal">TRUE</code> if an <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> was removed or <code class="literal">FALSE</code>
 269 otherwise.</td>
 270 </tr>
 271 </tbody>
 272 </table></div>
 273 </div>
 274 <hr>
 275 <div class="refsect2">
 276 <a name="internet-address-list-contains"></a><h3>internet_address_list_contains ()</h3>
 277 <pre class="programlisting"><span class="returnvalue">gboolean</span>            internet_address_list_contains      (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>,
 278                                                          <em class="parameter"><code><a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> *ia</code></em>);</pre>
 279 <p>
 280 Checks whether or not the specified <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> is contained
 281 within the <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a>.
 282 </p>
 283 <div class="variablelist"><table border="0">
 284 <col align="left" valign="top">
 285 <tbody>
 286 <tr>
 287 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
 288 <td>a <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a>
 289 </td>
 290 </tr>
 291 <tr>
 292 <td><p><span class="term"><em class="parameter"><code>ia</code></em> :</span></p></td>
 293 <td>a <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a>
 294 </td>
 295 </tr>
 296 <tr>
 297 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 298 <td>
 299 <code class="literal">TRUE</code> if the specified <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> is contained
 300 within the specified <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> or <code class="literal">FALSE</code> otherwise.</td>
 301 </tr>
 302 </tbody>
 303 </table></div>
 304 </div>
 305 <hr>
 306 <div class="refsect2">
 307 <a name="internet-address-list-index-of"></a><h3>internet_address_list_index_of ()</h3>
 308 <pre class="programlisting"><span class="returnvalue">int</span>                 internet_address_list_index_of      (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>,
 309                                                          <em class="parameter"><code><a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> *ia</code></em>);</pre>
 310 <p>
 311 Gets the index of the specified <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> inside the
 312 <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a>.
 313 </p>
 314 <div class="variablelist"><table border="0">
 315 <col align="left" valign="top">
 316 <tbody>
 317 <tr>
 318 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
 319 <td>a <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a>
 320 </td>
 321 </tr>
 322 <tr>
 323 <td><p><span class="term"><em class="parameter"><code>ia</code></em> :</span></p></td>
 324 <td>a <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a>
 325 </td>
 326 </tr>
 327 <tr>
 328 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 329 <td>the index of the requested <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> within the
 330 <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> or <code class="literal">-1</code> if it is not contained within the
 331 <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a>.</td>
 332 </tr>
 333 </tbody>
 334 </table></div>
 335 </div>
 336 <hr>
 337 <div class="refsect2">
 338 <a name="internet-address-list-get-address"></a><h3>internet_address_list_get_address ()</h3>
 339 <pre class="programlisting"><a class="link" href="InternetAddress.html" title="InternetAddress"><span class="returnvalue">InternetAddress</span></a> *   internet_address_list_get_address   (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>,
 340                                                          <em class="parameter"><code><span class="type">int</span> index</code></em>);</pre>
 341 <p>
 342 Gets the <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> at the specified index.
 343 </p>
 344 <div class="variablelist"><table border="0">
 345 <col align="left" valign="top">
 346 <tbody>
 347 <tr>
 348 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
 349 <td>a <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a>
 350 </td>
 351 </tr>
 352 <tr>
 353 <td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td>
 354 <td>index of <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> to get</td>
 355 </tr>
 356 <tr>
 357 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 358 <td>the <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> at the specified index or <code class="literal">NULL</code> if
 359 the index is out of range.</td>
 360 </tr>
 361 </tbody>
 362 </table></div>
 363 </div>
 364 <hr>
 365 <div class="refsect2">
 366 <a name="internet-address-list-set-address"></a><h3>internet_address_list_set_address ()</h3>
 367 <pre class="programlisting"><span class="returnvalue">void</span>                internet_address_list_set_address   (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>,
 368                                                          <em class="parameter"><code><span class="type">int</span> index</code></em>,
 369                                                          <em class="parameter"><code><a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> *ia</code></em>);</pre>
 370 <p>
 371 Sets the <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> at the specified index to <em class="parameter"><code>ia</code></em>.
 372 </p>
 373 <div class="variablelist"><table border="0">
 374 <col align="left" valign="top">
 375 <tbody>
 376 <tr>
 377 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
 378 <td>a <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a>
 379 </td>
 380 </tr>
 381 <tr>
 382 <td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td>
 383 <td>index of <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> to set</td>
 384 </tr>
 385 <tr>
 386 <td><p><span class="term"><em class="parameter"><code>ia</code></em> :</span></p></td>
 387 <td>a <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a>
 388 </td>
 389 </tr>
 390 </tbody>
 391 </table></div>
 392 </div>
 393 <hr>
 394 <div class="refsect2">
 395 <a name="internet-address-list-prepend"></a><h3>internet_address_list_prepend ()</h3>
 396 <pre class="programlisting"><span class="returnvalue">void</span>                internet_address_list_prepend       (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>,
 397                                                          <em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *prepend</code></em>);</pre>
 398 <p>
 399 Inserts all of the addresses in <em class="parameter"><code>prepend</code></em> to the beginning of <em class="parameter"><code>list</code></em>.
 400 </p>
 401 <div class="variablelist"><table border="0">
 402 <col align="left" valign="top">
 403 <tbody>
 404 <tr>
 405 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
 406 <td>a <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a>
 407 </td>
 408 </tr>
 409 <tr>
 410 <td><p><span class="term"><em class="parameter"><code>prepend</code></em> :</span></p></td>
 411 <td>a <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a>
 412 </td>
 413 </tr>
 414 </tbody>
 415 </table></div>
 416 </div>
 417 <hr>
 418 <div class="refsect2">
 419 <a name="internet-address-list-append"></a><h3>internet_address_list_append ()</h3>
 420 <pre class="programlisting"><span class="returnvalue">void</span>                internet_address_list_append        (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>,
 421                                                          <em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *append</code></em>);</pre>
 422 <p>
 423 Adds all of the addresses in <em class="parameter"><code>append</code></em> to <em class="parameter"><code>list</code></em>.
 424 </p>
 425 <div class="variablelist"><table border="0">
 426 <col align="left" valign="top">
 427 <tbody>
 428 <tr>
 429 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
 430 <td>a <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a>
 431 </td>
 432 </tr>
 433 <tr>
 434 <td><p><span class="term"><em class="parameter"><code>append</code></em> :</span></p></td>
 435 <td>a <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a>
 436 </td>
 437 </tr>
 438 </tbody>
 439 </table></div>
 440 </div>
 441 <hr>
 442 <div class="refsect2">
 443 <a name="internet-address-list-to-string"></a><h3>internet_address_list_to_string ()</h3>
 444 <pre class="programlisting"><span class="returnvalue">char</span> *              internet_address_list_to_string     (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>,
 445                                                          <em class="parameter"><code><span class="type">gboolean</span> encode</code></em>);</pre>
 446 <p>
 447 Allocates a string buffer containing the rfc822 formatted addresses
 448 in <em class="parameter"><code>list</code></em>.
 449 </p>
 450 <div class="variablelist"><table border="0">
 451 <col align="left" valign="top">
 452 <tbody>
 453 <tr>
 454 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
 455 <td>list of internet addresses</td>
 456 </tr>
 457 <tr>
 458 <td><p><span class="term"><em class="parameter"><code>encode</code></em> :</span></p></td>
 459 <td>
 460 <code class="literal">TRUE</code> if the address should be rfc2047 encoded</td>
 461 </tr>
 462 <tr>
 463 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 464 <td>a string containing the list of addresses in rfc822 format
 465 or <code class="literal">NULL</code> if no addresses are contained in the list.</td>
 466 </tr>
 467 </tbody>
 468 </table></div>
 469 </div>
 470 <hr>
 471 <div class="refsect2">
 472 <a name="internet-address-list-parse-string"></a><h3>internet_address_list_parse_string ()</h3>
 473 <pre class="programlisting"><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="returnvalue">InternetAddressList</span></a> * internet_address_list_parse_string
 474                                                         (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>);</pre>
 475 <p>
 476 Construct a list of internet addresses from the given string.
 477 </p>
 478 <div class="variablelist"><table border="0">
 479 <col align="left" valign="top">
 480 <tbody>
 481 <tr>
 482 <td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
 483 <td>a string containing internet addresses</td>
 484 </tr>
 485 <tr>
 486 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 487 <td>a <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> or <code class="literal">NULL</code> if the input string does
 488 not contain any addresses.</td>
 489 </tr>
 490 </tbody>
 491 </table></div>
 492 </div>
 493 <hr>
 494 <div class="refsect2">
 495 <a name="internet-address-list-writer"></a><h3>internet_address_list_writer ()</h3>
 496 <pre class="programlisting"><span class="returnvalue">void</span>                internet_address_list_writer        (<em class="parameter"><code><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> *list</code></em>,
 497                                                          <em class="parameter"><code><span class="type">GString</span> *str</code></em>);</pre>
 498 <p>
 499 Writes the rfc2047-encoded rfc822 formatted addresses in <em class="parameter"><code>list</code></em> to
 500 <em class="parameter"><code>string</code></em>, folding appropriately.
 501 </p>
 502 <div class="variablelist"><table border="0">
 503 <col align="left" valign="top">
 504 <tbody>
 505 <tr>
 506 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
 507 <td>list of internet addresses</td>
 508 </tr>
 509 <tr>
 510 <td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
 511 <td>string to write to</td>
 512 </tr>
 513 </tbody>
 514 </table></div>
 515 </div>
 516 </div>
 517 <div class="refsect1">
 518 <a name="InternetAddressList.see-also"></a><h2>See Also</h2>
 519 <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a>
 520 </div>
 521 </div>
 522 <div class="footer">
 523 <hr>
 524           Generated by GTK-Doc V1.18</div>
 525 </body>
 526 </html>