summaryrefslogtreecommitdiff
path: root/docs/reference/html/InternetAddressMailbox.html
blob: 20ec35df03c237daa4c2e87d4948d0bfd2fa58ab (plain)
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InternetAddressMailbox</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GMime 2.6 Reference Manual">
<link rel="up" href="InternetAddresses.html" title="Internet Addresses">
<link rel="prev" href="InternetAddressGroup.html" title="InternetAddressGroup">
<link rel="next" href="InternetAddressList.html" title="InternetAddressList">
<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="InternetAddressGroup.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="InternetAddresses.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">GMime 2.6 Reference Manual</th>
<td><a accesskey="n" href="InternetAddressList.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#InternetAddressMailbox.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#InternetAddressMailbox.description" class="shortcut">Description</a>
                   | 
                  <a href="#InternetAddressMailbox.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="InternetAddressMailbox"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InternetAddressMailbox.top_of_page"></a>InternetAddressMailbox</span></h2>
<p>InternetAddressMailbox — rfc822 'mailbox' address</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="InternetAddressMailbox.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct              <a class="link" href="InternetAddressMailbox.html#InternetAddressMailbox-struct" title="struct InternetAddressMailbox">InternetAddressMailbox</a>;
<a class="link" href="InternetAddress.html" title="InternetAddress"><span class="returnvalue">InternetAddress</span></a> *   <a class="link" href="InternetAddressMailbox.html#internet-address-mailbox-new" title="internet_address_mailbox_new ()">internet_address_mailbox_new</a>        (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *addr</code></em>);
const <span class="returnvalue">char</span> *        <a class="link" href="InternetAddressMailbox.html#internet-address-mailbox-get-addr" title="internet_address_mailbox_get_addr ()">internet_address_mailbox_get_addr</a>   (<em class="parameter"><code><a class="link" href="InternetAddressMailbox.html" title="InternetAddressMailbox"><span class="type">InternetAddressMailbox</span></a> *mailbox</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="InternetAddressMailbox.html#internet-address-mailbox-set-addr" title="internet_address_mailbox_set_addr ()">internet_address_mailbox_set_addr</a>   (<em class="parameter"><code><a class="link" href="InternetAddressMailbox.html" title="InternetAddressMailbox"><span class="type">InternetAddressMailbox</span></a> *mailbox</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *addr</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="InternetAddressMailbox.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GObject
   +----<a class="link" href="InternetAddress.html" title="InternetAddress">InternetAddress</a>
         +----InternetAddressMailbox
</pre>
</div>
<div class="refsect1">
<a name="InternetAddressMailbox.description"></a><h2>Description</h2>
<p>
An <a class="link" href="InternetAddressMailbox.html" title="InternetAddressMailbox"><span class="type">InternetAddressMailbox</span></a> represents what is a typical "email
address".
</p>
</div>
<div class="refsect1">
<a name="InternetAddressMailbox.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="InternetAddressMailbox-struct"></a><h3>struct InternetAddressMailbox</h3>
<pre class="programlisting">struct InternetAddressMailbox;</pre>
<p>
An RFC 2822 Mailbox address.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="internet-address-mailbox-new"></a><h3>internet_address_mailbox_new ()</h3>
<pre class="programlisting"><a class="link" href="InternetAddress.html" title="InternetAddress"><span class="returnvalue">InternetAddress</span></a> *   internet_address_mailbox_new        (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *addr</code></em>);</pre>
<p>
Creates a new <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> object with the specified <em class="parameter"><code>name</code></em> and
<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>name</code></em> :</span></p></td>
<td>person's name</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>addr</code></em> :</span></p></td>
<td>person's address</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="InternetAddressMailbox.html" title="InternetAddressMailbox"><span class="type">InternetAddressMailbox</span></a> object.
Note: The <em class="parameter"><code>name</code></em> string should be in UTF-8.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="internet-address-mailbox-get-addr"></a><h3>internet_address_mailbox_get_addr ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> *        internet_address_mailbox_get_addr   (<em class="parameter"><code><a class="link" href="InternetAddressMailbox.html" title="InternetAddressMailbox"><span class="type">InternetAddressMailbox</span></a> *mailbox</code></em>);</pre>
<p>
Gets the addr-spec of the internet address mailbox.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mailbox</code></em> :</span></p></td>
<td>a <a class="link" href="InternetAddressMailbox.html" title="InternetAddressMailbox"><span class="type">InternetAddressMailbox</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the address of the mailbox.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="internet-address-mailbox-set-addr"></a><h3>internet_address_mailbox_set_addr ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                internet_address_mailbox_set_addr   (<em class="parameter"><code><a class="link" href="InternetAddressMailbox.html" title="InternetAddressMailbox"><span class="type">InternetAddressMailbox</span></a> *mailbox</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *addr</code></em>);</pre>
<p>
Set the mailbox address.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mailbox</code></em> :</span></p></td>
<td>a <a class="link" href="InternetAddressMailbox.html" title="InternetAddressMailbox"><span class="type">InternetAddressMailbox</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>addr</code></em> :</span></p></td>
<td>contact's email address</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="InternetAddressMailbox.see-also"></a><h2>See Also</h2>
<a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>