mirror of
https://github.com/fofolee/uTools-Manuals.git
synced 2025-06-29 04:52:50 +08:00
312 lines
9.2 KiB
HTML
312 lines
9.2 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>Read the header of the message</title>
|
|
</head>
|
|
<body class="docs"><div id="layout">
|
|
<div id="layout-content"><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)</p><p class="refpurpose"><span class="refname">imap_headerinfo</span> — <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>
|
|
( <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">$fromlength</code><span class="initializer"> = 0</span></span>
|
|
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$subjectlength</code><span class="initializer"> = 0</span></span>
|
|
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$defaulthost</code><span class="initializer"> = <strong><code>NULL</code></strong></span></span>
|
|
]]] ) : <span class="type">object</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_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">fromlength</code></dt>
|
|
|
|
<dd>
|
|
|
|
<p class="para">
|
|
Number of characters for the <em>fetchfrom</em> property.
|
|
Must be greater than or equal to zero.
|
|
</p>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<code class="parameter">subjectlength</code></dt>
|
|
|
|
<dd>
|
|
|
|
<p class="para">
|
|
Number of characters for the <em>fetchsubject</em> property
|
|
Must be greater than or equal to zero.
|
|
</p>
|
|
</dd>
|
|
|
|
|
|
|
|
<dt>
|
|
<code class="parameter">defaulthost</code></dt>
|
|
|
|
<dd>
|
|
|
|
<p class="para">
|
|
</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>FALSE</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: <em>personal</em>, <em>adl</em>,
|
|
<em>mailbox</em>, and <em>host</em>
|
|
</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: <em>personal</em>, <em>adl</em>,
|
|
<em>mailbox</em>, and <em>host</em>
|
|
</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: <em>personal</em>, <em>adl</em>,
|
|
<em>mailbox</em>, and <em>host</em>
|
|
</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: <em>personal</em>, <em>adl</em>,
|
|
<em>mailbox</em>, and <em>host</em>
|
|
</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: <em>personal</em>, <em>adl</em>,
|
|
<em>mailbox</em>, and <em>host</em>
|
|
</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: <em>personal</em>, <em>adl</em>,
|
|
<em>mailbox</em>, and <em>host</em>
|
|
</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: <em>personal</em>,
|
|
<em>adl</em>, <em>mailbox</em>, and
|
|
<em>host</em>
|
|
</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 - <em>R</em> if recent and seen, <em>N</em>
|
|
if recent and not seen, ' ' if not recent.
|
|
</span>
|
|
</li>
|
|
<li class="listitem">
|
|
<span class="simpara">
|
|
Unseen - <em>U</em> if not seen AND not recent, ' ' if seen
|
|
OR not seen and recent
|
|
</span>
|
|
</li>
|
|
<li class="listitem">
|
|
<span class="simpara">
|
|
Flagged - <em>F</em> if flagged, ' ' if not flagged
|
|
</span>
|
|
</li>
|
|
<li class="listitem">
|
|
<span class="simpara">
|
|
Answered - <em>A</em> if answered, ' ' if unanswered
|
|
</span>
|
|
</li>
|
|
<li class="listitem">
|
|
<span class="simpara">
|
|
Deleted - <em>D</em> if deleted, ' ' if not deleted
|
|
</span>
|
|
</li>
|
|
<li class="listitem">
|
|
<span class="simpara">
|
|
Draft - <em>X</em> if draft, ' ' 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">fromlength</code>
|
|
characters
|
|
</span>
|
|
</li>
|
|
<li class="listitem">
|
|
<span class="simpara">
|
|
fetchsubject - subject line formatted to fit
|
|
<code class="parameter">subjectlength</code> characters
|
|
</span>
|
|
</li>
|
|
</ul>
|
|
</p>
|
|
</div>
|
|
|
|
<div class="refsect1 seealso" id="refsect1-function.imap-headerinfo-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> |