<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.imap.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'function.imap-rfc822-parse-adrlist.php',
    1 => 'imap_rfc822_parse_adrlist',
    2 => 'Parses an address string',
  ),
  'up' => 
  array (
    0 => 'ref.imap.php',
    1 => 'IMAP Functions',
  ),
  'prev' => 
  array (
    0 => 'function.imap-reopen.php',
    1 => 'imap_reopen',
  ),
  'next' => 
  array (
    0 => 'function.imap-rfc822-parse-headers.php',
    1 => 'imap_rfc822_parse_headers',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/imap/functions/imap-rfc822-parse-adrlist.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<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, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">imap_rfc822_parse_adrlist</span> &mdash; <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="methodname"><strong>imap_rfc822_parse_adrlist</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$string</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$default_hostname</code></span>): <span class="type"><a href="language.types.array.php" class="type array">array</a></span></div>

  <p class="para rdfs-comment">
   Parses the address string as defined in <a href="https://datatracker.ietf.org/doc/html/rfc2822" class="link external">&raquo;&nbsp;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><code class="parameter">string</code></dt>
     <dd>
      <p class="para">
       A string containing addresses
      </p>
     </dd>
    
    
     <dt><code class="parameter">default_hostname</code></dt>
     <dd>
      <p class="para">
       The default host name
      </p>
     </dd>
    
   </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-1">
    <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">&lt;?php<br /><br />$address_string </span><span style="color: #007700">= </span><span style="color: #DD0000">"Joe Doe &lt;doe@example.com&gt;, 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">) &lt; </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">=&gt; </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">-&gt;</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">-&gt;</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">-&gt;</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">-&gt;</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">?&gt;</span></span></code></div>
    </div>

    <div class="example-contents"><p>The above example will output:</p></div>
    <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode"># 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><span class="function"><a href="function.imap-rfc822-parse-headers.php" class="function" rel="rdfs-seeAlso">imap_rfc822_parse_headers()</a> - Parse mail headers from a string</span></li>
   </ul>
  </p>
 </div>

</div><?php manual_footer($setup); ?>