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
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
|
<!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.73.2">
<link rel="start" 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="Crypto.html" title="Crypto Contexts">
<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="Filters.html" title="Stream Filters">
<link rel="chapter" href="Services.html" title="Services">
<link rel="chapter" href="Folders.html" title="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="index" href="ix01.html" title="Index">
</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="Crypto.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" lang="en">
<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">
<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);
int <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 char *name,
const char *address);
gboolean <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,
int index,
const char **namep,
const char **addressp);
int <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 char *name,
const char **addressp);
int <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 char *address,
const char **namep);
char* <a class="link" href="camel-CamelInternetAddress.html#camel-internet-address-encode-address" title="camel_internet_address_encode_address ()">camel_internet_address_encode_address</a>
(int *len,
const char *name,
const char *addr);
char* <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 char *real,
const char *addr);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="camel-CamelInternetAddress.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="camel-CamelInternetAddress.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<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" lang="en">
<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" lang="en">
<a name="camel-internet-address-add"></a><h3>camel_internet_address_add ()</h3>
<pre class="programlisting">int camel_internet_address_add (<a class="link" href="camel-CamelInternetAddress.html#CamelInternetAddress" title="struct CamelInternetAddress">CamelInternetAddress</a> *addr,
const char *name,
const char *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" lang="en">
<a name="camel-internet-address-get"></a><h3>camel_internet_address_get ()</h3>
<pre class="programlisting">gboolean camel_internet_address_get (const <a class="link" href="camel-CamelInternetAddress.html#CamelInternetAddress" title="struct CamelInternetAddress">CamelInternetAddress</a> *addr,
int index,
const char **namep,
const char **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 <code class="literal">NULL</code>, 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 <code class="literal">NULL</code>, if not required.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>%TRUE if such an address exists, or <code class="literal">FALSE</code> otherwise
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="camel-internet-address-find-name"></a><h3>camel_internet_address_find_name ()</h3>
<pre class="programlisting">int camel_internet_address_find_name (<a class="link" href="camel-CamelInternetAddress.html#CamelInternetAddress" title="struct CamelInternetAddress">CamelInternetAddress</a> *addr,
const char *name,
const char **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 <code class="literal">NULL</code>, 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" lang="en">
<a name="camel-internet-address-find-address"></a><h3>camel_internet_address_find_address ()</h3>
<pre class="programlisting">int camel_internet_address_find_address (<a class="link" href="camel-CamelInternetAddress.html#CamelInternetAddress" title="struct CamelInternetAddress">CamelInternetAddress</a> *addr,
const char *address,
const char **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 <code class="literal">NULL</code>, 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" lang="en">
<a name="camel-internet-address-encode-address"></a><h3>camel_internet_address_encode_address ()</h3>
<pre class="programlisting">char* camel_internet_address_encode_address
(int *len,
const char *name,
const char *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 <code class="literal">NULL</code>, 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" lang="en">
<a name="camel-internet-address-format-address"></a><h3>camel_internet_address_format_address ()</h3>
<pre class="programlisting">char* camel_internet_address_format_address
(const char *real,
const char *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>real</code></em> :</span></p></td>
<td>
</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>
|
