| Server IP : 182.53.201.61 / Your IP : 216.73.217.175 Web Server : Apache/2.2.15 (Fedora) System : Linux km10.dyndns.org 2.6.31.5-127.fc12.i686.PAE #1 SMP Sat Nov 7 21:25:57 EST 2009 i686 User : apache ( 48) PHP Version : 5.3.3 Disable Function : NONE MySQL : ON | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : ON Directory : /usr/share/gtk-doc/html/camel/ |
Upload File : |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CamelInternetAddress</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="Camel Reference Manual">
<link rel="up" href="Addresses.html" title="Addresses">
<link rel="prev" href="camel-CamelAddress.html" title="CamelAddress">
<link rel="next" href="camel-CamelNNTPAddress.html" title="CamelNNTPAddress">
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="classes.html" title="Part I. Camel Classes">
<link rel="chapter" href="ClassTree.html" title="Class Hierarchy">
<link rel="chapter" href="Fundamentals.html" title="Fundamentals">
<link rel="chapter" href="Streams.html" title="Streams">
<link rel="chapter" href="StreamFilters.html" title="Stream Filters">
<link rel="chapter" href="Services.html" title="Services">
<link rel="chapter" href="Filters.html" title="Filters">
<link rel="chapter" href="Folders.html" title="Folders">
<link rel="chapter" href="SearchFolders.html" title="Search Folders">
<link rel="chapter" href="Addresses.html" title="Addresses">
<link rel="chapter" href="Crypto.html" title="Crypto Contexts">
<link rel="chapter" href="MIME.html" title="MIME Objects">
<link rel="chapter" href="Storage.html" title="Metadata Storage">
<link rel="chapter" href="Utilities.html" title="Utilities">
<link rel="chapter" href="Deprecated.html" title="Deprecated Objects">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
</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="camel-CamelAddress.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="camel-CamelNNTPAddress.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#camel-CamelInternetAddress.synopsis" class="shortcut">Top</a>
|
<a href="#camel-CamelInternetAddress.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="CamelInternetAddress">
<a name="camel-CamelInternetAddress"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="camel-CamelInternetAddress.top_of_page"></a>CamelInternetAddress</span></h2>
<p>CamelInternetAddress</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="camel-CamelInternetAddress.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
struct <a class="link" href="camel-CamelInternetAddress.html#CamelInternetAddress" title="struct CamelInternetAddress">CamelInternetAddress</a>;
<a class="link" href="camel-CamelInternetAddress.html#CamelInternetAddress" title="struct CamelInternetAddress">CamelInternetAddress</a> * <a class="link" href="camel-CamelInternetAddress.html#camel-internet-address-new" title="camel_internet_address_new ()">camel_internet_address_new</a> (void);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> <a class="link" href="camel-CamelInternetAddress.html#camel-internet-address-add" title="camel_internet_address_add ()">camel_internet_address_add</a> (<a class="link" href="camel-CamelInternetAddress.html#CamelInternetAddress" title="struct CamelInternetAddress">CamelInternetAddress</a> *addr,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *address);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="camel-CamelInternetAddress.html#camel-internet-address-get" title="camel_internet_address_get ()">camel_internet_address_get</a> (const <a class="link" href="camel-CamelInternetAddress.html#CamelInternetAddress" title="struct CamelInternetAddress">CamelInternetAddress</a> *addr,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> index,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> **namep,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> **addressp);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> <a class="link" href="camel-CamelInternetAddress.html#camel-internet-address-find-name" title="camel_internet_address_find_name ()">camel_internet_address_find_name</a> (<a class="link" href="camel-CamelInternetAddress.html#CamelInternetAddress" title="struct CamelInternetAddress">CamelInternetAddress</a> *addr,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> **addressp);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> <a class="link" href="camel-CamelInternetAddress.html#camel-internet-address-find-address" title="camel_internet_address_find_address ()">camel_internet_address_find_address</a> (<a class="link" href="camel-CamelInternetAddress.html#CamelInternetAddress" title="struct CamelInternetAddress">CamelInternetAddress</a> *addr,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *address,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> **namep);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> * <a class="link" href="camel-CamelInternetAddress.html#camel-internet-address-encode-address" title="camel_internet_address_encode_address ()">camel_internet_address_encode_address</a>
(<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> *len,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *addr);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> * <a class="link" href="camel-CamelInternetAddress.html#camel-internet-address-format-address" title="camel_internet_address_format_address ()">camel_internet_address_format_address</a>
(const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *addr);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="camel-CamelInternetAddress.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="camel-CamelInternetAddress.details"></a><h2>Details</h2>
<div class="refsect2" title="struct CamelInternetAddress">
<a name="CamelInternetAddress"></a><h3>struct CamelInternetAddress</h3>
<pre class="programlisting">struct CamelInternetAddress {
CamelAddress parent;
struct _CamelInternetAddressPrivate *priv;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="camel_internet_address_new ()">
<a name="camel-internet-address-new"></a><h3>camel_internet_address_new ()</h3>
<pre class="programlisting"><a class="link" href="camel-CamelInternetAddress.html#CamelInternetAddress" title="struct CamelInternetAddress">CamelInternetAddress</a> * camel_internet_address_new (void);</pre>
<p>
Create a new <a class="link" href="camel-CamelInternetAddress.html#CamelInternetAddress" title="struct CamelInternetAddress"><span class="type">CamelInternetAddress</span></a> object.</p>
<p>
</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="camel-CamelInternetAddress.html#CamelInternetAddress" title="struct CamelInternetAddress"><span class="type">CamelInternetAddress</span></a> object
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_internet_address_add ()">
<a name="camel-internet-address-add"></a><h3>camel_internet_address_add ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> camel_internet_address_add (<a class="link" href="camel-CamelInternetAddress.html#CamelInternetAddress" title="struct CamelInternetAddress">CamelInternetAddress</a> *addr,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *address);</pre>
<p>
Add a new internet address to <em class="parameter"><code>addr</code></em>.</p>
<p>
</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="camel-CamelInternetAddress.html#CamelInternetAddress" title="struct CamelInternetAddress"><span class="type">CamelInternetAddress</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td> name associated with the new address
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>address</code></em> :</span></p></td>
<td> routing address associated with the new address
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the index of added entry
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_internet_address_get ()">
<a name="camel-internet-address-get"></a><h3>camel_internet_address_get ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> camel_internet_address_get (const <a class="link" href="camel-CamelInternetAddress.html#CamelInternetAddress" title="struct CamelInternetAddress">CamelInternetAddress</a> *addr,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> index,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> **namep,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> **addressp);</pre>
<p>
Get the address at <em class="parameter"><code>index</code></em>.</p>
<p>
</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="camel-CamelInternetAddress.html#CamelInternetAddress" title="struct CamelInternetAddress"><span class="type">CamelInternetAddress</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td>
<td> address's array index
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>namep</code></em> :</span></p></td>
<td> holder for the returned name, or <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
><code class="literal">NULL</code></a>, if not required.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>addressp</code></em> :</span></p></td>
<td> holder for the returned address, or <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
><code class="literal">NULL</code></a>, if not required.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE--CAPS"
><code class="literal">TRUE</code></a> if such an address exists, or <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE--CAPS"
><code class="literal">FALSE</code></a> otherwise
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_internet_address_find_name ()">
<a name="camel-internet-address-find-name"></a><h3>camel_internet_address_find_name ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> camel_internet_address_find_name (<a class="link" href="camel-CamelInternetAddress.html#CamelInternetAddress" title="struct CamelInternetAddress">CamelInternetAddress</a> *addr,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> **addressp);</pre>
<p>
Find address by real name.</p>
<p>
</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="camel-CamelInternetAddress.html#CamelInternetAddress" title="struct CamelInternetAddress"><span class="type">CamelInternetAddress</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td> name to lookup
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>addressp</code></em> :</span></p></td>
<td> holder for address part, or <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
><code class="literal">NULL</code></a>, if not required.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the index of the address matching the name, or <code class="literal">-1</code> if no
match was found
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_internet_address_find_address ()">
<a name="camel-internet-address-find-address"></a><h3>camel_internet_address_find_address ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> camel_internet_address_find_address (<a class="link" href="camel-CamelInternetAddress.html#CamelInternetAddress" title="struct CamelInternetAddress">CamelInternetAddress</a> *addr,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *address,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> **namep);</pre>
<p>
Find an address by address.</p>
<p>
</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="camel-CamelInternetAddress.html#CamelInternetAddress" title="struct CamelInternetAddress"><span class="type">CamelInternetAddress</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>address</code></em> :</span></p></td>
<td> address to lookup
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>namep</code></em> :</span></p></td>
<td> holder for the matching name, or <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
><code class="literal">NULL</code></a>, if not required.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the index of the address, or <code class="literal">-1</code> if not found
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_internet_address_encode_address ()">
<a name="camel-internet-address-encode-address"></a><h3>camel_internet_address_encode_address ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> * camel_internet_address_encode_address
(<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> *len,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *addr);</pre>
<p>
Encode a single address ready for internet usage. Header folding
as per rfc822 is also performed, based on the length *<em class="parameter"><code>len</code></em>. If <em class="parameter"><code>len</code></em>
is <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
><code class="literal">NULL</code></a>, then no folding will occur.
</p>
<p>
Note: The value at *<em class="parameter"><code>in</code></em> will be updated based on any linewrapping done</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>len</code></em> :</span></p></td>
<td> the length of the line the address is being appended to
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td> the unencoded real name associated with the address
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>addr</code></em> :</span></p></td>
<td> the routing address
</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" title="camel_internet_address_format_address ()">
<a name="camel-internet-address-format-address"></a><h3>camel_internet_address_format_address ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> * camel_internet_address_format_address
(const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *addr);</pre>
<p>
Function to format a single address, suitable for display.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td> a name, quotes may be stripped from it
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>addr</code></em> :</span></p></td>
<td> an rfc822 routing address
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a nicely formatted string containing the rfc822 address
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.11</div>
</body>
</html>