mirror of
https://github.com/fofolee/uTools-Manuals.git
synced 2025-06-17 21:16:57 +08:00
158 lines
8.3 KiB
HTML
158 lines
8.3 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>Append a string message to a specified mailbox</title>
|
||
</head>
|
||
<body class="docs"><div id="layout">
|
||
<div id="layout-content"><div id="function.imap-append" class="refentry">
|
||
<div class="refnamediv">
|
||
<h1 class="refname">imap_append</h1>
|
||
<p class="verinfo">(PHP 4, PHP 5, PHP 7)</p><p class="refpurpose"><span class="refname">imap_append</span> — <span class="dc-title">Append a string message to a specified mailbox</span></p>
|
||
|
||
</div>
|
||
<div class="refsect1 description" id="refsect1-function.imap-append-description">
|
||
<h3 class="title">说明</h3>
|
||
<div class="methodsynopsis dc-description">
|
||
<span class="methodname"><strong>imap_append</strong></span>
|
||
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$imap_stream</code></span>
|
||
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$mailbox</code></span>
|
||
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$message</code></span>
|
||
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$options</code><span class="initializer"> = <strong><code>NULL</code></strong></span></span>
|
||
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$internal_date</code><span class="initializer"> = <strong><code>NULL</code></strong></span></span>
|
||
]] ) : <span class="type">bool</span></div>
|
||
|
||
<p class="para rdfs-comment">
|
||
Appends a string <code class="parameter">message</code> to the specified <code class="parameter">mailbox</code>.
|
||
</p>
|
||
</div>
|
||
|
||
<div class="refsect1 parameters" id="refsect1-function.imap-append-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">mailbox</code></dt>
|
||
|
||
<dd>
|
||
|
||
<p class="para">
|
||
The mailbox name, see <span class="function"><a href="imap_open.html" class="function">imap_open()</a></span> for more
|
||
information
|
||
</p>
|
||
<div class="warning"><strong class="warning">Warning</strong><p class="simpara">
|
||
Passing untrusted data to this parameter is <em class="emphasis">insecure</em>, unless
|
||
<a href="imap.configuration.html#ini.imap.enable-insecure-rsh" class="link">imap.enable_insecure_rsh</a> is disabled.
|
||
</p></div>
|
||
</dd>
|
||
|
||
|
||
|
||
<dt>
|
||
<code class="parameter">message</code></dt>
|
||
|
||
<dd>
|
||
|
||
<p class="para">
|
||
The message to be append, as a string
|
||
</p>
|
||
<p class="para">
|
||
When talking to the Cyrus IMAP server, you must use "\r\n" as
|
||
your end-of-line terminator instead of "\n" or the operation will
|
||
fail
|
||
</p>
|
||
</dd>
|
||
|
||
|
||
|
||
<dt>
|
||
<code class="parameter">options</code></dt>
|
||
|
||
<dd>
|
||
|
||
<p class="para">
|
||
If provided, the <code class="parameter">options</code> will also be written
|
||
to the <code class="parameter">mailbox</code>
|
||
</p>
|
||
</dd>
|
||
|
||
|
||
|
||
<dt>
|
||
<code class="parameter">internal_date</code></dt>
|
||
|
||
<dd>
|
||
|
||
<p class="para">
|
||
If this parameter is set, it will set the INTERNALDATE on the appended message. The parameter should be a date string that conforms to the rfc2060 specifications for a date_time value.
|
||
</p>
|
||
</dd>
|
||
|
||
|
||
</dl>
|
||
|
||
</p>
|
||
</div>
|
||
|
||
<div class="refsect1 returnvalues" id="refsect1-function.imap-append-returnvalues">
|
||
<h3 class="title">返回值</h3>
|
||
<p class="para">
|
||
成功时返回 <strong><code>TRUE</code></strong>， 或者在失败时返回 <strong><code>FALSE</code></strong>。
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="refsect1 changelog" id="refsect1-function.imap-append-changelog">
|
||
<h3 class="title">更新日志</h3>
|
||
<p class="para">
|
||
<table class="doctable informaltable">
|
||
|
||
<thead>
|
||
<tr>
|
||
<th>版本</th>
|
||
<th>说明</th>
|
||
</tr>
|
||
|
||
</thead>
|
||
|
||
<tbody class="tbody">
|
||
<tr>
|
||
<td>5.3.2</td>
|
||
<td>
|
||
Added INTERNALDATE support to imap_append.
|
||
</td>
|
||
</tr>
|
||
|
||
</tbody>
|
||
|
||
</table>
|
||
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="refsect1 examples" id="refsect1-function.imap-append-examples">
|
||
<h3 class="title">范例</h3>
|
||
<p class="para">
|
||
<div class="example" id="example-4015">
|
||
<p><strong>Example #1 <span class="function"><strong>imap_append()</strong></span> example</strong></p>
|
||
<div class="example-contents">
|
||
<div class="phpcode"><pre><span style="color: #000000">
|
||
<span style="color: #0000BB"><?php<br />$stream </span><span style="color: #007700">= </span><span style="color: #0000BB">imap_open</span><span style="color: #007700">(</span><span style="color: #DD0000">"{imap.example.org}INBOX.Drafts"</span><span style="color: #007700">, </span><span style="color: #DD0000">"username"</span><span style="color: #007700">, </span><span style="color: #DD0000">"password"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$check </span><span style="color: #007700">= </span><span style="color: #0000BB">imap_check</span><span style="color: #007700">(</span><span style="color: #0000BB">$stream</span><span style="color: #007700">);<br />echo </span><span style="color: #DD0000">"Msg Count before append: "</span><span style="color: #007700">. </span><span style="color: #0000BB">$check</span><span style="color: #007700">-></span><span style="color: #0000BB">Nmsgs </span><span style="color: #007700">. </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">imap_append</span><span style="color: #007700">(</span><span style="color: #0000BB">$stream</span><span style="color: #007700">, </span><span style="color: #DD0000">"{imap.example.org}INBOX.Drafts"<br /> </span><span style="color: #007700">, </span><span style="color: #DD0000">"From: me@example.com\r\n"<br /> </span><span style="color: #007700">. </span><span style="color: #DD0000">"To: you@example.com\r\n"<br /> </span><span style="color: #007700">. </span><span style="color: #DD0000">"Subject: test\r\n"<br /> </span><span style="color: #007700">. </span><span style="color: #DD0000">"\r\n"<br /> </span><span style="color: #007700">. </span><span style="color: #DD0000">"this is a test message, please ignore\r\n"<br /> </span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$check </span><span style="color: #007700">= </span><span style="color: #0000BB">imap_check</span><span style="color: #007700">(</span><span style="color: #0000BB">$stream</span><span style="color: #007700">);<br />echo </span><span style="color: #DD0000">"Msg Count after append : "</span><span style="color: #007700">. </span><span style="color: #0000BB">$check</span><span style="color: #007700">-></span><span style="color: #0000BB">Nmsgs </span><span style="color: #007700">. </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">imap_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$stream</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
|
||
</span>
|
||
</pre></div>
|
||
</div>
|
||
|
||
</div>
|
||
</p>
|
||
</div>
|
||
|
||
</div></div></div></body></html> |