mirror of
https://github.com/fofolee/uTools-Manuals.git
synced 2025-10-11 00:43:20 +08:00
v0.0.2
This commit is contained in:
fofolee
@@ -1,131 +1,131 @@
|
||||
<!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>Save a specific body section to a file</title>
|
||||
</head>
|
||||
<body class="docs"><div id="layout">
|
||||
<div id="layout-content"><div id="function.imap-savebody" class="refentry">
|
||||
<div class="refnamediv">
|
||||
<h1 class="refname">imap_savebody</h1>
|
||||
<p class="verinfo">(PHP 5 >= 5.1.3, PHP 7)</p><p class="refpurpose"><span class="refname">imap_savebody</span> — <span class="dc-title">Save a specific body section to a file</span></p>
|
||||
|
||||
</div>
|
||||
<div class="refsect1 description" id="refsect1-function.imap-savebody-description">
|
||||
<h3 class="title">说明</h3>
|
||||
<div class="methodsynopsis dc-description">
|
||||
<span class="methodname"><strong>imap_savebody</strong></span>
|
||||
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$imap_stream</code></span>
|
||||
, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$file</code></span>
|
||||
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$msg_number</code></span>
|
||||
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$part_number</code><span class="initializer"> = ""</span></span>
|
||||
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$options</code><span class="initializer"> = 0</span></span>
|
||||
]] ) : <span class="type">bool</span></div>
|
||||
|
||||
<p class="para rdfs-comment">
|
||||
Saves a part or the whole body of the specified message.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<div class="refsect1 parameters" id="refsect1-function.imap-savebody-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">file</code></dt>
|
||||
|
||||
<dd>
|
||||
|
||||
<p class="para">
|
||||
The path to the saved file as a string, or a valid file descriptor
|
||||
returned by <span class="function"><a href="fopen.html" class="function">fopen()</a></span>.
|
||||
</p>
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
<dt>
|
||||
<code class="parameter">msg_number</code></dt>
|
||||
|
||||
<dd>
|
||||
|
||||
<p class="para">
|
||||
The message number
|
||||
</p>
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
<dt>
|
||||
<code class="parameter">part_number</code></dt>
|
||||
|
||||
<dd>
|
||||
|
||||
<p class="para">
|
||||
The part number. It is a string of integers delimited by period which
|
||||
index into a body part list as per the IMAP4 specification
|
||||
</p>
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
<dt>
|
||||
<code class="parameter">options</code></dt>
|
||||
|
||||
<dd>
|
||||
|
||||
<p class="para">
|
||||
A bitmask with one or more of the following:
|
||||
<ul class="itemizedlist">
|
||||
<li class="listitem">
|
||||
<span class="simpara">
|
||||
<strong><code>FT_UID</code></strong> - The <code class="parameter">msg_number</code> is a UID
|
||||
</span>
|
||||
</li>
|
||||
<li class="listitem">
|
||||
<span class="simpara">
|
||||
<strong><code>FT_PEEK</code></strong> - Do not set the \Seen flag if
|
||||
not already set
|
||||
</span>
|
||||
</li>
|
||||
<li class="listitem">
|
||||
<span class="simpara">
|
||||
<strong><code>FT_INTERNAL</code></strong> - The return string is in
|
||||
internal format, will not canonicalize to CRLF.
|
||||
</span>
|
||||
</li>
|
||||
</ul>
|
||||
</p>
|
||||
</dd>
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<div class="refsect1 returnvalues" id="refsect1-function.imap-savebody-returnvalues">
|
||||
<h3 class="title">返回值</h3>
|
||||
<p class="para">
|
||||
成功时返回 <strong><code>TRUE</code></strong>， 或者在失败时返回 <strong><code>FALSE</code></strong>。
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<div class="refsect1 seealso" id="refsect1-function.imap-savebody-seealso">
|
||||
<h3 class="title">参见</h3>
|
||||
<p class="para">
|
||||
<ul class="simplelist">
|
||||
<li class="member"><span class="function"><a href="imap_fetchbody.html" class="function" rel="rdfs-seeAlso">imap_fetchbody()</a> - Fetch a particular section of the body of the message</span></li>
|
||||
</ul>
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<!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>Save a specific body section to a file</title>
|
||||
</head>
|
||||
<body class="docs"><div id="layout">
|
||||
<div id="layout-content"><div id="function.imap-savebody" class="refentry">
|
||||
<div class="refnamediv">
|
||||
<h1 class="refname">imap_savebody</h1>
|
||||
<p class="verinfo">(PHP 5 >= 5.1.3, PHP 7)</p><p class="refpurpose"><span class="refname">imap_savebody</span> — <span class="dc-title">Save a specific body section to a file</span></p>
|
||||
|
||||
</div>
|
||||
<div class="refsect1 description" id="refsect1-function.imap-savebody-description">
|
||||
<h3 class="title">说明</h3>
|
||||
<div class="methodsynopsis dc-description">
|
||||
<span class="methodname"><strong>imap_savebody</strong></span>
|
||||
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$imap_stream</code></span>
|
||||
, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$file</code></span>
|
||||
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$msg_number</code></span>
|
||||
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$part_number</code><span class="initializer"> = ""</span></span>
|
||||
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$options</code><span class="initializer"> = 0</span></span>
|
||||
]] ) : <span class="type">bool</span></div>
|
||||
|
||||
<p class="para rdfs-comment">
|
||||
Saves a part or the whole body of the specified message.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<div class="refsect1 parameters" id="refsect1-function.imap-savebody-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">file</code></dt>
|
||||
|
||||
<dd>
|
||||
|
||||
<p class="para">
|
||||
The path to the saved file as a string, or a valid file descriptor
|
||||
returned by <span class="function"><a href="fopen.html" class="function">fopen()</a></span>.
|
||||
</p>
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
<dt>
|
||||
<code class="parameter">msg_number</code></dt>
|
||||
|
||||
<dd>
|
||||
|
||||
<p class="para">
|
||||
The message number
|
||||
</p>
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
<dt>
|
||||
<code class="parameter">part_number</code></dt>
|
||||
|
||||
<dd>
|
||||
|
||||
<p class="para">
|
||||
The part number. It is a string of integers delimited by period which
|
||||
index into a body part list as per the IMAP4 specification
|
||||
</p>
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
<dt>
|
||||
<code class="parameter">options</code></dt>
|
||||
|
||||
<dd>
|
||||
|
||||
<p class="para">
|
||||
A bitmask with one or more of the following:
|
||||
<ul class="itemizedlist">
|
||||
<li class="listitem">
|
||||
<span class="simpara">
|
||||
<strong><code>FT_UID</code></strong> - The <code class="parameter">msg_number</code> is a UID
|
||||
</span>
|
||||
</li>
|
||||
<li class="listitem">
|
||||
<span class="simpara">
|
||||
<strong><code>FT_PEEK</code></strong> - Do not set the \Seen flag if
|
||||
not already set
|
||||
</span>
|
||||
</li>
|
||||
<li class="listitem">
|
||||
<span class="simpara">
|
||||
<strong><code>FT_INTERNAL</code></strong> - The return string is in
|
||||
internal format, will not canonicalize to CRLF.
|
||||
</span>
|
||||
</li>
|
||||
</ul>
|
||||
</p>
|
||||
</dd>
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<div class="refsect1 returnvalues" id="refsect1-function.imap-savebody-returnvalues">
|
||||
<h3 class="title">返回值</h3>
|
||||
<p class="para">
|
||||
成功时返回 <strong><code>TRUE</code></strong>， 或者在失败时返回 <strong><code>FALSE</code></strong>。
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<div class="refsect1 seealso" id="refsect1-function.imap-savebody-seealso">
|
||||
<h3 class="title">参见</h3>
|
||||
<p class="para">
|
||||
<ul class="simplelist">
|
||||
<li class="member"><span class="function"><a href="imap_fetchbody.html" class="function" rel="rdfs-seeAlso">imap_fetchbody()</a> - Fetch a particular section of the body of the message</span></li>
|
||||
</ul>
|
||||
</p>
|
||||
</div>
|
||||
|
||||
</div></div></div></body></html>
|
||||
Reference in New Issue
Block a user