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