uTools-Manuals/docs/php/imap_fetchheader.html
2019-04-08 23:22:26 +08:00

108 lines
3.8 KiB
HTML

<!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>Returns header for a message</title>
</head>
<body class="docs"><div id="layout">
<div id="layout-content"><div id="function.imap-fetchheader" class="refentry">
<div class="refnamediv">
<h1 class="refname">imap_fetchheader</h1>
<p class="verinfo">(PHP 4, PHP 5, PHP 7)</p><p class="refpurpose"><span class="refname">imap_fetchheader</span> &mdash; <span class="dc-title">Returns header for a message</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.imap-fetchheader-description">
<h3 class="title">说明</h3>
<div class="methodsynopsis dc-description">
<span class="methodname"><strong>imap_fetchheader</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$imap_stream</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$msg_number</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$options</code><span class="initializer"> = 0</span></span>
] ) : <span class="type">string</span></div>
<p class="para rdfs-comment">
This function causes a fetch of the complete, unfiltered <a href="http://www.faqs.org/rfcs/rfc2822" class="link external">&raquo;&nbsp;RFC2822</a> format header of the specified
message.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.imap-fetchheader-parameters">
<h3 class="title">参数</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">
imap_stream</code></dt>
<dd>
<p class="para"><span class="function"><a href="imap_open.html" class="function">imap_open()</a></span> 返回的 IMAP 流。</p></dd>
<dt>
<code class="parameter">msg_number</code></dt>
<dd>
<p class="para">
The message number
</p>
</dd>
<dt>
<code class="parameter">options</code></dt>
<dd>
<p class="para">
The possible <code class="parameter">options</code> are:
<ul class="itemizedlist">
<li class="listitem">
<span class="simpara">
<strong><code>FT_UID</code></strong> - The <code class="parameter">msgno</code>
argument is a UID
</span>
</li>
<li class="listitem">
<span class="simpara">
<strong><code>FT_INTERNAL</code></strong> - The return string
is in &quot;internal&quot; format, without any attempt to
canonicalize to CRLF newlines
</span>
</li>
<li class="listitem">
<span class="simpara">
<strong><code>FT_PREFETCHTEXT</code></strong> - The RFC822.TEXT
should be pre-fetched at the same time. This avoids an
extra RTT on an <acronym title="Internet Message Access Protocol">IMAP</acronym> connection if a full message text is
desired (e.g. in a &quot;save to local file&quot; operation)
</span>
</li>
</ul>
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.imap-fetchheader-returnvalues">
<h3 class="title">返回值</h3>
<p class="para">
Returns the header of the specified message as a text string.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.imap-fetchheader-seealso">
<h3 class="title">参见</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="imap_fetch_overview.html" 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></div></div></body></html>