docs/reference/html/InternetAddressMailbox.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>InternetAddressMailbox</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="InternetAddressGroup.html" title="InternetAddressGroup">
  10 <link rel="next" href="InternetAddressList.html" title="InternetAddressList">
  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="InternetAddressGroup.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="InternetAddressList.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="#InternetAddressMailbox.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#InternetAddressMailbox.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#InternetAddressMailbox.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29 </td></tr>
  30 </table>
  31 <div class="refentry">
  32 <a name="InternetAddressMailbox"></a><div class="titlepage"></div>
  33 <div class="refnamediv"><table width="100%"><tr>
  34 <td valign="top">
  35 <h2><span class="refentrytitle"><a name="InternetAddressMailbox.top_of_page"></a>InternetAddressMailbox</span></h2>
  36 <p>InternetAddressMailbox — rfc822 'mailbox' address</p>
  37 </td>
  38 <td valign="top" align="right"></td>
  39 </tr></table></div>
  40 <div class="refsynopsisdiv">
  41 <a name="InternetAddressMailbox.synopsis"></a><h2>Synopsis</h2>
  42 <pre class="synopsis">struct              <a class="link" href="InternetAddressMailbox.html#InternetAddressMailbox-struct" title="struct InternetAddressMailbox">InternetAddressMailbox</a>;
  43 <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>,
  44                                                          <em class="parameter"><code>const <span class="type">char</span> *addr</code></em>);
  45 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>);
  46 <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>,
  47                                                          <em class="parameter"><code>const <span class="type">char</span> *addr</code></em>);
  48 </pre>
  49 </div>
  50 <div class="refsect1">
  51 <a name="InternetAddressMailbox.object-hierarchy"></a><h2>Object Hierarchy</h2>
  52 <pre class="synopsis">
  53   GObject
  54    +----<a class="link" href="InternetAddress.html" title="InternetAddress">InternetAddress</a>
  55          +----InternetAddressMailbox
  56 </pre>
  57 </div>
  58 <div class="refsect1">
  59 <a name="InternetAddressMailbox.description"></a><h2>Description</h2>
  60 <p>
  61 An <a class="link" href="InternetAddressMailbox.html" title="InternetAddressMailbox"><span class="type">InternetAddressMailbox</span></a> represents what is a typical "email
  62 address".
  63 </p>
  64 </div>
  65 <div class="refsect1">
  66 <a name="InternetAddressMailbox.details"></a><h2>Details</h2>
  67 <div class="refsect2">
  68 <a name="InternetAddressMailbox-struct"></a><h3>struct InternetAddressMailbox</h3>
  69 <pre class="programlisting">struct InternetAddressMailbox;</pre>
  70 <p>
  71 An RFC 2822 Mailbox address.
  72 </p>
  73 <div class="variablelist"><table border="0">
  74 <col align="left" valign="top">
  75 <tbody></tbody>
  76 </table></div>
  77 </div>
  78 <hr>
  79 <div class="refsect2">
  80 <a name="internet-address-mailbox-new"></a><h3>internet_address_mailbox_new ()</h3>
  81 <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>,
  82                                                          <em class="parameter"><code>const <span class="type">char</span> *addr</code></em>);</pre>
  83 <p>
  84 Creates a new <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a> object with name <em class="parameter"><code>name</code></em> and address
  85 <em class="parameter"><code>addr</code></em>.
  86 </p>
  87 <div class="variablelist"><table border="0">
  88 <col align="left" valign="top">
  89 <tbody>
  90 <tr>
  91 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
  92 <td>person's name</td>
  93 </tr>
  94 <tr>
  95 <td><p><span class="term"><em class="parameter"><code>addr</code></em> :</span></p></td>
  96 <td>person's address</td>
  97 </tr>
  98 <tr>
  99 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 100 <td>a new <a class="link" href="InternetAddressMailbox.html" title="InternetAddressMailbox"><span class="type">InternetAddressMailbox</span></a> object.</td>
 101 </tr>
 102 </tbody>
 103 </table></div>
 104 </div>
 105 <hr>
 106 <div class="refsect2">
 107 <a name="internet-address-mailbox-get-addr"></a><h3>internet_address_mailbox_get_addr ()</h3>
 108 <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>
 109 <p>
 110 Gets the addr-spec of the internet address mailbox.
 111 </p>
 112 <div class="variablelist"><table border="0">
 113 <col align="left" valign="top">
 114 <tbody>
 115 <tr>
 116 <td><p><span class="term"><em class="parameter"><code>mailbox</code></em> :</span></p></td>
 117 <td>a <a class="link" href="InternetAddressMailbox.html" title="InternetAddressMailbox"><span class="type">InternetAddressMailbox</span></a>
 118 </td>
 119 </tr>
 120 <tr>
 121 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 122 <td>the address of the mailbox.</td>
 123 </tr>
 124 </tbody>
 125 </table></div>
 126 </div>
 127 <hr>
 128 <div class="refsect2">
 129 <a name="internet-address-mailbox-set-addr"></a><h3>internet_address_mailbox_set_addr ()</h3>
 130 <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>,
 131                                                          <em class="parameter"><code>const <span class="type">char</span> *addr</code></em>);</pre>
 132 <p>
 133 Set the mailbox address.
 134 </p>
 135 <div class="variablelist"><table border="0">
 136 <col align="left" valign="top">
 137 <tbody>
 138 <tr>
 139 <td><p><span class="term"><em class="parameter"><code>mailbox</code></em> :</span></p></td>
 140 <td>a <a class="link" href="InternetAddressMailbox.html" title="InternetAddressMailbox"><span class="type">InternetAddressMailbox</span></a>
 141 </td>
 142 </tr>
 143 <tr>
 144 <td><p><span class="term"><em class="parameter"><code>addr</code></em> :</span></p></td>
 145 <td>contact's email address</td>
 146 </tr>
 147 </tbody>
 148 </table></div>
 149 </div>
 150 </div>
 151 <div class="refsect1">
 152 <a name="InternetAddressMailbox.see-also"></a><h2>See Also</h2>
 153 <a class="link" href="InternetAddress.html" title="InternetAddress"><span class="type">InternetAddress</span></a>
 154 </div>
 155 </div>
 156 <div class="footer">
 157 <hr>
 158           Generated by GTK-Doc V1.18</div>
 159 </body>
 160 </html>