/usr/share/gtk-doc/html/camel/CamelAddress.html is in libcamel1.2-dev 3.2.3-0ubuntu7.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CamelAddress</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Camel Reference Manual">
<link rel="up" href="Addresses.html" title="Addresses">
<link rel="prev" href="Addresses.html" title="Addresses">
<link rel="next" href="CamelInternetAddress.html" title="CamelInternetAddress">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="Addresses.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="Addresses.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Camel Reference Manual</th>
<td><a accesskey="n" href="CamelInternetAddress.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#CamelAddress.synopsis" class="shortcut">Top</a>
|
<a href="#CamelAddress.description" class="shortcut">Description</a>
|
<a href="#CamelAddress.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="CamelAddress"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="CamelAddress.top_of_page"></a>CamelAddress</span></h2>
<p>CamelAddress</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="CamelAddress.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="CamelAddress.html#CamelAddress-struct" title="struct CamelAddress">CamelAddress</a>;
<a class="link" href="CamelAddress.html" title="CamelAddress"><span class="returnvalue">CamelAddress</span></a> * <a class="link" href="CamelAddress.html#camel-address-new" title="camel_address_new ()">camel_address_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="CamelAddress.html" title="CamelAddress"><span class="returnvalue">CamelAddress</span></a> * <a class="link" href="CamelAddress.html#camel-address-new-clone" title="camel_address_new_clone ()">camel_address_new_clone</a> (<em class="parameter"><code><a class="link" href="CamelAddress.html" title="CamelAddress"><span class="type">CamelAddress</span></a> *addr</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="CamelAddress.html#camel-address-length" title="camel_address_length ()">camel_address_length</a> (<em class="parameter"><code><a class="link" href="CamelAddress.html" title="CamelAddress"><span class="type">CamelAddress</span></a> *addr</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="CamelAddress.html#camel-address-decode" title="camel_address_decode ()">camel_address_decode</a> (<em class="parameter"><code><a class="link" href="CamelAddress.html" title="CamelAddress"><span class="type">CamelAddress</span></a> *addr</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *raw</code></em>);
<span class="returnvalue">gchar</span> * <a class="link" href="CamelAddress.html#camel-address-encode" title="camel_address_encode ()">camel_address_encode</a> (<em class="parameter"><code><a class="link" href="CamelAddress.html" title="CamelAddress"><span class="type">CamelAddress</span></a> *addr</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="CamelAddress.html#camel-address-unformat" title="camel_address_unformat ()">camel_address_unformat</a> (<em class="parameter"><code><a class="link" href="CamelAddress.html" title="CamelAddress"><span class="type">CamelAddress</span></a> *addr</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *raw</code></em>);
<span class="returnvalue">gchar</span> * <a class="link" href="CamelAddress.html#camel-address-format" title="camel_address_format ()">camel_address_format</a> (<em class="parameter"><code><a class="link" href="CamelAddress.html" title="CamelAddress"><span class="type">CamelAddress</span></a> *addr</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="CamelAddress.html#camel-address-cat" title="camel_address_cat ()">camel_address_cat</a> (<em class="parameter"><code><a class="link" href="CamelAddress.html" title="CamelAddress"><span class="type">CamelAddress</span></a> *dest</code></em>,
<em class="parameter"><code><a class="link" href="CamelAddress.html" title="CamelAddress"><span class="type">CamelAddress</span></a> *source</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="CamelAddress.html#camel-address-copy" title="camel_address_copy ()">camel_address_copy</a> (<em class="parameter"><code><a class="link" href="CamelAddress.html" title="CamelAddress"><span class="type">CamelAddress</span></a> *dest</code></em>,
<em class="parameter"><code><a class="link" href="CamelAddress.html" title="CamelAddress"><span class="type">CamelAddress</span></a> *source</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelAddress.html#camel-address-remove" title="camel_address_remove ()">camel_address_remove</a> (<em class="parameter"><code><a class="link" href="CamelAddress.html" title="CamelAddress"><span class="type">CamelAddress</span></a> *addr</code></em>,
<em class="parameter"><code><span class="type">gint</span> index</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="CamelAddress.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----<a class="link" href="CamelObject.html" title="CamelObject">CamelObject</a>
+----CamelAddress
+----<a class="link" href="CamelInternetAddress.html" title="CamelInternetAddress">CamelInternetAddress</a>
+----<a class="link" href="CamelNNTPAddress.html" title="CamelNNTPAddress">CamelNNTPAddress</a>
</pre>
</div>
<div class="refsect1">
<a name="CamelAddress.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="CamelAddress.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="CamelAddress-struct"></a><h3>struct CamelAddress</h3>
<pre class="programlisting">struct CamelAddress;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-address-new"></a><h3>camel_address_new ()</h3>
<pre class="programlisting"><a class="link" href="CamelAddress.html" title="CamelAddress"><span class="returnvalue">CamelAddress</span></a> * camel_address_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Create a new <a class="link" href="CamelAddress.html" title="CamelAddress"><span class="type">CamelAddress</span></a> object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="CamelAddress.html" title="CamelAddress"><span class="type">CamelAddress</span></a> object</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-address-new-clone"></a><h3>camel_address_new_clone ()</h3>
<pre class="programlisting"><a class="link" href="CamelAddress.html" title="CamelAddress"><span class="returnvalue">CamelAddress</span></a> * camel_address_new_clone (<em class="parameter"><code><a class="link" href="CamelAddress.html" title="CamelAddress"><span class="type">CamelAddress</span></a> *addr</code></em>);</pre>
<p>
Clone an existing address type.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>addr</code></em> :</span></p></td>
<td>a <a class="link" href="CamelAddress.html" title="CamelAddress"><span class="type">CamelAddress</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the cloned address</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-address-length"></a><h3>camel_address_length ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> camel_address_length (<em class="parameter"><code><a class="link" href="CamelAddress.html" title="CamelAddress"><span class="type">CamelAddress</span></a> *addr</code></em>);</pre>
<p>
Get the number of addresses stored in the address <em class="parameter"><code>addr</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>addr</code></em> :</span></p></td>
<td>a <a class="link" href="CamelAddress.html" title="CamelAddress"><span class="type">CamelAddress</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the number of addresses contained in <em class="parameter"><code>addr</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-address-decode"></a><h3>camel_address_decode ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> camel_address_decode (<em class="parameter"><code><a class="link" href="CamelAddress.html" title="CamelAddress"><span class="type">CamelAddress</span></a> *addr</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *raw</code></em>);</pre>
<p>
Construct a new address from a raw address field.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>addr</code></em> :</span></p></td>
<td>a <a class="link" href="CamelAddress.html" title="CamelAddress"><span class="type">CamelAddress</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>raw</code></em> :</span></p></td>
<td>raw address description</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the number of addresses parsed or <code class="literal">-1</code> on fail</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-address-encode"></a><h3>camel_address_encode ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> * camel_address_encode (<em class="parameter"><code><a class="link" href="CamelAddress.html" title="CamelAddress"><span class="type">CamelAddress</span></a> *addr</code></em>);</pre>
<p>
Encode an address in a format suitable for a raw header.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>addr</code></em> :</span></p></td>
<td>a <a class="link" href="CamelAddress.html" title="CamelAddress"><span class="type">CamelAddress</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the encoded address</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-address-unformat"></a><h3>camel_address_unformat ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> camel_address_unformat (<em class="parameter"><code><a class="link" href="CamelAddress.html" title="CamelAddress"><span class="type">CamelAddress</span></a> *addr</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *raw</code></em>);</pre>
<p>
Attempt to convert a previously formatted and/or edited
address back into internal form.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>addr</code></em> :</span></p></td>
<td>a <a class="link" href="CamelAddress.html" title="CamelAddress"><span class="type">CamelAddress</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>raw</code></em> :</span></p></td>
<td>raw address description</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the number of addresses parsed or <code class="literal">-1</code> on fail</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-address-format"></a><h3>camel_address_format ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> * camel_address_format (<em class="parameter"><code><a class="link" href="CamelAddress.html" title="CamelAddress"><span class="type">CamelAddress</span></a> *addr</code></em>);</pre>
<p>
Format an address in a format suitable for display.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>addr</code></em> :</span></p></td>
<td>a <a class="link" href="CamelAddress.html" title="CamelAddress"><span class="type">CamelAddress</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a newly allocated string containing the formatted addresses</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-address-cat"></a><h3>camel_address_cat ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> camel_address_cat (<em class="parameter"><code><a class="link" href="CamelAddress.html" title="CamelAddress"><span class="type">CamelAddress</span></a> *dest</code></em>,
<em class="parameter"><code><a class="link" href="CamelAddress.html" title="CamelAddress"><span class="type">CamelAddress</span></a> *source</code></em>);</pre>
<p>
Concatenate one address onto another. The addresses must
be of the same type.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>dest</code></em> :</span></p></td>
<td>destination <a class="link" href="CamelAddress.html" title="CamelAddress"><span class="type">CamelAddress</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
<td>source <a class="link" href="CamelAddress.html" title="CamelAddress"><span class="type">CamelAddress</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the number of addresses concatenated</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-address-copy"></a><h3>camel_address_copy ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> camel_address_copy (<em class="parameter"><code><a class="link" href="CamelAddress.html" title="CamelAddress"><span class="type">CamelAddress</span></a> *dest</code></em>,
<em class="parameter"><code><a class="link" href="CamelAddress.html" title="CamelAddress"><span class="type">CamelAddress</span></a> *source</code></em>);</pre>
<p>
Copy the contents of one address into another.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>dest</code></em> :</span></p></td>
<td>destination <a class="link" href="CamelAddress.html" title="CamelAddress"><span class="type">CamelAddress</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
<td>source <a class="link" href="CamelAddress.html" title="CamelAddress"><span class="type">CamelAddress</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the number of addresses copied</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-address-remove"></a><h3>camel_address_remove ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_address_remove (<em class="parameter"><code><a class="link" href="CamelAddress.html" title="CamelAddress"><span class="type">CamelAddress</span></a> *addr</code></em>,
<em class="parameter"><code><span class="type">gint</span> index</code></em>);</pre>
<p>
Remove an address by index, or all addresses.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>addr</code></em> :</span></p></td>
<td>a <a class="link" href="CamelAddress.html" title="CamelAddress"><span class="type">CamelAddress</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td>
<td>The address to remove, use <code class="literal">-1</code> to remove all address.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|