<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Parses an address string</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.imap-reopen.html">imap_reopen</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imap-rfc822-parse-headers.html">imap_rfc822_parse_headers</a></div>
<div class="up"><a href="ref.imap.html">IMAP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.imap-rfc822-parse-adrlist" class="refentry">
<div class="refnamediv">
<h1 class="refname">imap_rfc822_parse_adrlist</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">imap_rfc822_parse_adrlist</span> — <span class="dc-title">Parses an address string</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.imap-rfc822-parse-adrlist-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>imap_rfc822_parse_adrlist</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$address</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$default_host</code></span>
)</div>
<p class="para rdfs-comment">
Parses the address string as defined in <a href="http://www.faqs.org/rfcs/rfc2822" class="link external">» RFC2822</a> and for each address.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.imap-rfc822-parse-adrlist-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">address</code></em></span>
<dd>
<p class="para">
A string containing addresses
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">default_host</code></em></span>
<dd>
<p class="para">
The default host name
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.imap-rfc822-parse-adrlist-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an array of objects. The objects properties are:
</p>
<p class="para">
<ul class="itemizedlist">
<li class="listitem">
<span class="simpara">
mailbox - the mailbox name (username)
</span>
</li>
<li class="listitem">
<span class="simpara">
host - the host name
</span>
</li>
<li class="listitem">
<span class="simpara">
personal - the personal name
</span>
</li>
<li class="listitem">
<span class="simpara">
adl - at domain source route
</span>
</li>
</ul>
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.imap-rfc822-parse-adrlist-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3371">
<p><strong>Example #1 <span class="function"><strong>imap_rfc822_parse_adrlist()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$address_string </span><span style="color: #007700">= </span><span style="color: #DD0000">"Joe Doe <doe@example.com>, postmaster@example.com, root"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$address_array </span><span style="color: #007700">= </span><span style="color: #0000BB">imap_rfc822_parse_adrlist</span><span style="color: #007700">(</span><span style="color: #0000BB">$address_string</span><span style="color: #007700">, </span><span style="color: #DD0000">"example.com"</span><span style="color: #007700">);<br />if (!</span><span style="color: #0000BB">is_array</span><span style="color: #007700">(</span><span style="color: #0000BB">$address_array</span><span style="color: #007700">) || </span><span style="color: #0000BB">count</span><span style="color: #007700">(</span><span style="color: #0000BB">$address_array</span><span style="color: #007700">) < </span><span style="color: #0000BB">1</span><span style="color: #007700">) {<br /> die(</span><span style="color: #DD0000">"something is wrong\n"</span><span style="color: #007700">);<br />}<br /><br />foreach (</span><span style="color: #0000BB">$address_array </span><span style="color: #007700">as </span><span style="color: #0000BB">$id </span><span style="color: #007700">=> </span><span style="color: #0000BB">$val</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"# </span><span style="color: #0000BB">$id</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br /> echo </span><span style="color: #DD0000">" mailbox : " </span><span style="color: #007700">. </span><span style="color: #0000BB">$val</span><span style="color: #007700">-></span><span style="color: #0000BB">mailbox </span><span style="color: #007700">. </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /> echo </span><span style="color: #DD0000">" host : " </span><span style="color: #007700">. </span><span style="color: #0000BB">$val</span><span style="color: #007700">-></span><span style="color: #0000BB">host </span><span style="color: #007700">. </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /> echo </span><span style="color: #DD0000">" personal: " </span><span style="color: #007700">. </span><span style="color: #0000BB">$val</span><span style="color: #007700">-></span><span style="color: #0000BB">personal </span><span style="color: #007700">. </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /> echo </span><span style="color: #DD0000">" adl : " </span><span style="color: #007700">. </span><span style="color: #0000BB">$val</span><span style="color: #007700">-></span><span style="color: #0000BB">adl </span><span style="color: #007700">. </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
# 0
mailbox : doe
host : example.com
personal: Joe Doe
adl :
# 1
mailbox : postmaster
host : example.com
personal:
adl :
# 2
mailbox : root
host : example.com
personal:
adl :
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.imap-rfc822-parse-adrlist-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.imap-rfc822-parse-headers.html" class="function" rel="rdfs-seeAlso">imap_rfc822_parse_headers()</a> - Parse mail headers from a string</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.imap-reopen.html">imap_reopen</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imap-rfc822-parse-headers.html">imap_rfc822_parse_headers</a></div>
<div class="up"><a href="ref.imap.html">IMAP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
