<?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 => 'zh',
  ),
  'this' => 
  array (
    0 => 'function.imap-headerinfo.php',
    1 => 'imap_headerinfo',
    2 => 'Read the header of the message',
  ),
  'up' => 
  array (
    0 => 'ref.imap.php',
    1 => 'IMAP 函数',
  ),
  'prev' => 
  array (
    0 => 'function.imap-header.php',
    1 => 'imap_header',
  ),
  'next' => 
  array (
    0 => 'function.imap-headers.php',
    1 => 'imap_headers',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/imap/functions/imap-headerinfo.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.imap-headerinfo" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">imap_headerinfo</h1>
  <p class="verinfo">(PHP 4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">imap_headerinfo</span> &mdash; <span class="dc-title">Read the header of the message</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.imap-headerinfo-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>imap_headerinfo</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="class.imap-connection.php" class="type IMAP\Connection">IMAP\Connection</a></span> <code class="parameter">$imap</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$message_num</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$from_length</code><span class="initializer"> = 0</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$subject_length</code><span class="initializer"> = 0</span></span><br>): <span class="type"><span class="type"><a href="class.stdclass.php" class="type stdClass">stdClass</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="para rdfs-comment">
   Gets information about the given message number by reading its headers.
  </p>
 </div>

 <div class="refsect1 parameters" id="refsect1-function.imap-headerinfo-parameters">
  <h3 class="title">参数</h3>
  <p class="para">
   <dl>
    <dt>
<code class="parameter">imap</code></dt><dd><p class="para"><span class="classname"><a href="class.imap-connection.php" class="classname">IMAP\Connection</a></span> 实例。</p></dd>
    
     <dt><code class="parameter">message_num</code></dt>
     <dd>
      <p class="para">
       The message number
      </p>
     </dd>
    
    
     <dt><code class="parameter">from_length</code></dt>
     <dd>
      <p class="para">
       Number of characters for the <code class="literal">fetchfrom</code> property.
       Must be greater than or equal to zero.
      </p>
     </dd>
    
    
     <dt><code class="parameter">subject_length</code></dt>
     <dd>
      <p class="para">
       Number of characters for the <code class="literal">fetchsubject</code> property
       Must be greater than or equal to zero.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-function.imap-headerinfo-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="para">
   Returns <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> on error or, if successful, the information in an object with following properties:
   <ul class="itemizedlist">
    <li class="listitem">
     <span class="simpara">
      toaddress - full to: line, up to 1024 characters
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      to - an array of objects from the To: line, with the following 
      properties: <code class="literal">personal</code>, <code class="literal">adl</code>,
      <code class="literal">mailbox</code>, and <code class="literal">host</code>
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      fromaddress - full from: line, up to 1024 characters
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      from - an array of objects from the From: line, with the following 
      properties: <code class="literal">personal</code>, <code class="literal">adl</code>,
      <code class="literal">mailbox</code>, and <code class="literal">host</code>
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      ccaddress - full cc: line, up to 1024 characters
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      cc - an array of objects from the Cc: line, with the following 
      properties: <code class="literal">personal</code>, <code class="literal">adl</code>,
      <code class="literal">mailbox</code>, and <code class="literal">host</code>
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      bccaddress - full bcc: line, up to 1024 characters
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      bcc - an array of objects from the Bcc: line, with the following 
      properties: <code class="literal">personal</code>, <code class="literal">adl</code>,
      <code class="literal">mailbox</code>, and <code class="literal">host</code>
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      reply_toaddress - full Reply-To: line, up to 1024 characters
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      reply_to - an array of objects from the Reply-To: line, with the following
      properties: <code class="literal">personal</code>, <code class="literal">adl</code>,
      <code class="literal">mailbox</code>, and <code class="literal">host</code>
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      senderaddress - full sender: line, up to 1024 characters
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      sender - an array of objects from the Sender: line, with the following 
      properties: <code class="literal">personal</code>, <code class="literal">adl</code>,
      <code class="literal">mailbox</code>, and <code class="literal">host</code>
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      return_pathaddress - full Return-Path: line, up to 1024 characters
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      return_path - an array of objects from the Return-Path: line, with the
      following properties: <code class="literal">personal</code>, 
      <code class="literal">adl</code>, <code class="literal">mailbox</code>, and 
      <code class="literal">host</code>
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      remail - 
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      date - The message date as found in its headers
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      Date - Same as date
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      subject - The message subject
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      Subject - Same as subject 
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      in_reply_to - 
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      message_id - 
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      newsgroups - 
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      followup_to - 
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      references - 
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      Recent - <code class="literal">R</code> if recent and seen, <code class="literal">N</code>
      if recent and not seen, &#039; &#039; if not recent.
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      Unseen - <code class="literal">U</code> if not seen AND not recent, &#039; &#039; if seen
      OR not seen and recent
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      Flagged - <code class="literal">F</code> if flagged, &#039; &#039; if not flagged
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      Answered - <code class="literal">A</code> if answered, &#039; &#039; if unanswered
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      Deleted - <code class="literal">D</code> if deleted, &#039; &#039; if not deleted
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      Draft - <code class="literal">X</code> if draft, &#039; &#039; if not draft
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      Msgno - The message number
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      MailDate - 
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      Size - The message size
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      udate - mail message date in Unix time
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      fetchfrom - from line formatted to fit <code class="parameter">from_length</code>
      characters
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      fetchsubject - subject line formatted to fit 
      <code class="parameter">subject_length</code> characters
     </span>
    </li>
   </ul>
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.imap-headerinfo-changelog">
  <h3 class="title">更新日志</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>版本</th>
      <th>说明</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
 <td>8.1.0</td>
 <td>
  现在 <code class="parameter">imap</code> 参数接受 <span class="classname"><a href="class.imap-connection.php" class="classname">IMAP\Connection</a></span>
  实例，之前接受有效的 <code class="literal">imap</code> <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span>。
 </td>
</tr>

     <tr>
      <td>8.0.0</td>
      <td>
       The unused <code class="parameter">defaulthost</code> parameter has been removed.
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 seealso" id="refsect1-function.imap-headerinfo-seealso">
  <h3 class="title">参见</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.imap-fetch-overview.php" class="function" rel="rdfs-seeAlso">imap_fetch_overview()</a> - Read an overview of the information in the headers of the given message</span></li>
   </ul>
  </p>
 </div>

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