<!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><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.imap-alerts.html">imap_alerts</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.imap-base64.html">imap_base64</a></div> <div class="up"><a href="ref.imap.html">IMAP Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="function.imap-append" class="refentry"> <div class="refnamediv"> <h1 class="refname">imap_append</h1> <p class="verinfo">(PHP 4, PHP 5)</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">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">bool</span> <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> ]] )</div> <p class="para rdfs-comment"> Appends a string <em><code class="parameter">message</code></em> to the specified <em><code class="parameter">mailbox</code></em>. </p> </div> <div class="refsect1 parameters" id="refsect1-function.imap-append-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter"> imap_stream</code></em></span><dd> <p class="para">An IMAP stream returned by <span class="function"><a href="function.imap-open.html" class="function">imap_open()</a></span>.</p></dd> </dt> <dt> <span class="term"><em><code class="parameter">mailbox</code></em></span> <dd> <p class="para"> The mailbox name, see <span class="function"><a href="function.imap-open.html" class="function">imap_open()</a></span> for more information </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">message</code></em></span> <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> <dt> <span class="term"><em><code class="parameter">options</code></em></span> <dd> <p class="para"> If provided, the <em><code class="parameter">options</code></em> will also be written to the <em><code class="parameter">mailbox</code></em> </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">internal_date</code></em></span> <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> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.imap-append-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure. </p> </div> <div class="refsect1 changelog" id="refsect1-function.imap-append-changelog"> <h3 class="title">Changelog</h3> <p class="para"> <table class="doctable informaltable"> <thead> <tr> <th>Version</th> <th>Description</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">Examples</h3> <p class="para"> <div class="example" id="example-3352"> <p><strong>Example #1 <span class="function"><strong>imap_append()</strong></span> example</strong></p> <div class="example-contents"> <div class="phpcode"><code><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> </code></div> </div> </div> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.imap-alerts.html">imap_alerts</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.imap-base64.html">imap_base64</a></div> <div class="up"><a href="ref.imap.html">IMAP Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>