<!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>Parse RFC 822 compliant addresses</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.mailparse-msg-parse.html">mailparse_msg_parse</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.mailparse-stream-encode.html">mailparse_stream_encode</a></div>
<div class="up"><a href="ref.mailparse.html">Mailparse Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.mailparse-rfc822-parse-addresses" class="refentry">
<div class="refnamediv">
<h1 class="refname">mailparse_rfc822_parse_addresses</h1>
<p class="verinfo">(PECL mailparse >= 0.9.0)</p><p class="refpurpose"><span class="refname">mailparse_rfc822_parse_addresses</span> — <span class="dc-title">Parse RFC 822 compliant addresses</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.mailparse-rfc822-parse-addresses-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>mailparse_rfc822_parse_addresses</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$addresses</code></span>
)</div>
<p class="para rdfs-comment">
Parses a <a href="http://www.faqs.org/rfcs/rfc822" class="link external">» RFC 822</a> compliant recipient
list, such as that found in the <em>To:</em> header.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.mailparse-rfc822-parse-addresses-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">addresses</code></em></span>
<dd>
<p class="para">
A string containing addresses, like in:
<em>Wez Furlong <wez@example.com>, doe@example.com</em>
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
This string must not include the header name.
</p>
</p></blockquote>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.mailparse-rfc822-parse-addresses-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an array of associative arrays with the following keys for each
recipient:
<table class="doctable informaltable">
<tbody class="tbody">
<tr>
<td><em>display</em></td>
<td>
The recipient name, for display purpose. If this part is not set for a
recipient, this key will hold the same value as
<em>address</em>.
</td>
</tr>
<tr>
<td><em>address</em></td>
<td>The email address</td>
</tr>
<tr>
<td><em>is_group</em></td>
<td><strong><code>TRUE</code></strong> if the recipient is a newsgroup, <strong><code>FALSE</code></strong> otherwise.</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.mailparse-rfc822-parse-addresses-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3385">
<p><strong>Example #1 <span class="function"><strong>mailparse_rfc822_parse_addresses()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$to </span><span style="color: #007700">= </span><span style="color: #DD0000">'Wez Furlong <wez@example.com>, doe@example.com'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">mailparse_rfc822_parse_addresses</span><span style="color: #007700">(</span><span style="color: #0000BB">$to</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>
array(2) {
[0]=>
array(3) {
["display"]=>
string(11) "Wez Furlong"
["address"]=>
string(15) "wez@example.com"
["is_group"]=>
bool(false)
}
[1]=>
array(3) {
["display"]=>
string(15) "doe@example.com"
["address"]=>
string(15) "doe@example.com"
["is_group"]=>
bool(false)
}
}
</pre></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.mailparse-msg-parse.html">mailparse_msg_parse</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.mailparse-stream-encode.html">mailparse_stream_encode</a></div>
<div class="up"><a href="ref.mailparse.html">Mailparse Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
