<!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>Create a new mailbox</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.imap-create.html">imap_create</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.imap-delete.html">imap_delete</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-createmailbox" class="refentry"> <div class="refnamediv"> <h1 class="refname">imap_createmailbox</h1> <p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">imap_createmailbox</span> — <span class="dc-title">Create a new mailbox</span></p> </div> <div class="refsect1 description" id="refsect1-function.imap-createmailbox-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><strong>imap_createmailbox</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> )</div> <p class="para rdfs-comment"> Creates a new mailbox specified by <em><code class="parameter">mailbox</code></em>. </p> </div> <div class="refsect1 parameters" id="refsect1-function.imap-createmailbox-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. Names containing international characters should be encoded by <span class="function"><a href="function.imap-utf7-encode.html" class="function">imap_utf7_encode()</a></span> </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.imap-createmailbox-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 examples" id="refsect1-function.imap-createmailbox-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-3354"> <p><strong>Example #1 <span class="function"><strong>imap_createmailbox()</strong></span> example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$mbox </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}"</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">, </span><span style="color: #0000BB">OP_HALFOPEN</span><span style="color: #007700">)<br /> or die(</span><span style="color: #DD0000">"can't connect: " </span><span style="color: #007700">. </span><span style="color: #0000BB">imap_last_error</span><span style="color: #007700">());<br /><br /></span><span style="color: #0000BB">$name1 </span><span style="color: #007700">= </span><span style="color: #DD0000">"phpnewbox"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$name2 </span><span style="color: #007700">= </span><span style="color: #0000BB">imap_utf7_encode</span><span style="color: #007700">(</span><span style="color: #DD0000">"phpnewböx"</span><span style="color: #007700">); </span><span style="color: #FF8000">// phpnewb&w7Y-x<br /><br /></span><span style="color: #0000BB">$newname </span><span style="color: #007700">= </span><span style="color: #0000BB">$name1</span><span style="color: #007700">;<br /><br />echo </span><span style="color: #DD0000">"Newname will be '</span><span style="color: #0000BB">$name1</span><span style="color: #DD0000">'<br />\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">// we will now create a new mailbox "phptestbox" in your inbox folder,<br />// check its status after creation and finally remove it to restore<br />// your inbox to its initial state<br /><br /></span><span style="color: #007700">if (@</span><span style="color: #0000BB">imap_createmailbox</span><span style="color: #007700">(</span><span style="color: #0000BB">$mbox</span><span style="color: #007700">, </span><span style="color: #0000BB">imap_utf7_encode</span><span style="color: #007700">(</span><span style="color: #DD0000">"{imap.example.org}INBOX.</span><span style="color: #0000BB">$newname</span><span style="color: #DD0000">"</span><span style="color: #007700">))) {<br /> </span><span style="color: #0000BB">$status </span><span style="color: #007700">= @</span><span style="color: #0000BB">imap_status</span><span style="color: #007700">(</span><span style="color: #0000BB">$mbox</span><span style="color: #007700">, </span><span style="color: #DD0000">"{imap.example.org}INBOX.</span><span style="color: #0000BB">$newname</span><span style="color: #DD0000">"</span><span style="color: #007700">, </span><span style="color: #0000BB">SA_ALL</span><span style="color: #007700">);<br /> if (</span><span style="color: #0000BB">$status</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"your new mailbox '</span><span style="color: #0000BB">$name1</span><span style="color: #DD0000">' has the following status:<br />\n"</span><span style="color: #007700">;<br /> echo </span><span style="color: #DD0000">"Messages: " </span><span style="color: #007700">. </span><span style="color: #0000BB">$status</span><span style="color: #007700">-></span><span style="color: #0000BB">messages </span><span style="color: #007700">. </span><span style="color: #DD0000">"<br />\n"</span><span style="color: #007700">;<br /> echo </span><span style="color: #DD0000">"Recent: " </span><span style="color: #007700">. </span><span style="color: #0000BB">$status</span><span style="color: #007700">-></span><span style="color: #0000BB">recent </span><span style="color: #007700">. </span><span style="color: #DD0000">"<br />\n"</span><span style="color: #007700">;<br /> echo </span><span style="color: #DD0000">"Unseen: " </span><span style="color: #007700">. </span><span style="color: #0000BB">$status</span><span style="color: #007700">-></span><span style="color: #0000BB">unseen </span><span style="color: #007700">. </span><span style="color: #DD0000">"<br />\n"</span><span style="color: #007700">;<br /> echo </span><span style="color: #DD0000">"UIDnext: " </span><span style="color: #007700">. </span><span style="color: #0000BB">$status</span><span style="color: #007700">-></span><span style="color: #0000BB">uidnext </span><span style="color: #007700">. </span><span style="color: #DD0000">"<br />\n"</span><span style="color: #007700">;<br /> echo </span><span style="color: #DD0000">"UIDvalidity:" </span><span style="color: #007700">. </span><span style="color: #0000BB">$status</span><span style="color: #007700">-></span><span style="color: #0000BB">uidvalidity </span><span style="color: #007700">. </span><span style="color: #DD0000">"<br />\n"</span><span style="color: #007700">;<br /><br /> if (</span><span style="color: #0000BB">imap_renamemailbox</span><span style="color: #007700">(</span><span style="color: #0000BB">$mbox</span><span style="color: #007700">, </span><span style="color: #DD0000">"{imap.example.org}INBOX.</span><span style="color: #0000BB">$newname</span><span style="color: #DD0000">"</span><span style="color: #007700">, </span><span style="color: #DD0000">"{imap.example.org}INBOX.</span><span style="color: #0000BB">$name2</span><span style="color: #DD0000">"</span><span style="color: #007700">)) {<br /> echo </span><span style="color: #DD0000">"renamed new mailbox from '</span><span style="color: #0000BB">$name1</span><span style="color: #DD0000">' to '</span><span style="color: #0000BB">$name2</span><span style="color: #DD0000">'<br />\n"</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$newname </span><span style="color: #007700">= </span><span style="color: #0000BB">$name2</span><span style="color: #007700">;<br /> } else {<br /> echo </span><span style="color: #DD0000">"imap_renamemailbox on new mailbox failed: " </span><span style="color: #007700">. </span><span style="color: #0000BB">imap_last_error</span><span style="color: #007700">() . </span><span style="color: #DD0000">"<br />\n"</span><span style="color: #007700">;<br /> }<br /> } else {<br /> echo </span><span style="color: #DD0000">"imap_status on new mailbox failed: " </span><span style="color: #007700">. </span><span style="color: #0000BB">imap_last_error</span><span style="color: #007700">() . </span><span style="color: #DD0000">"<br />\n"</span><span style="color: #007700">;<br /> }<br /><br /> if (@</span><span style="color: #0000BB">imap_deletemailbox</span><span style="color: #007700">(</span><span style="color: #0000BB">$mbox</span><span style="color: #007700">, </span><span style="color: #DD0000">"{imap.example.org}INBOX.</span><span style="color: #0000BB">$newname</span><span style="color: #DD0000">"</span><span style="color: #007700">)) {<br /> echo </span><span style="color: #DD0000">"new mailbox removed to restore initial state<br />\n"</span><span style="color: #007700">;<br /> } else {<br /> echo </span><span style="color: #DD0000">"imap_deletemailbox on new mailbox failed: " </span><span style="color: #007700">. </span><span style="color: #0000BB">implode</span><span style="color: #007700">(</span><span style="color: #DD0000">"<br />\n"</span><span style="color: #007700">, </span><span style="color: #0000BB">imap_errors</span><span style="color: #007700">()) . </span><span style="color: #DD0000">"<br />\n"</span><span style="color: #007700">;<br /> }<br /><br />} else {<br /> echo </span><span style="color: #DD0000">"could not create new mailbox: " </span><span style="color: #007700">. </span><span style="color: #0000BB">implode</span><span style="color: #007700">(</span><span style="color: #DD0000">"<br />\n"</span><span style="color: #007700">, </span><span style="color: #0000BB">imap_errors</span><span style="color: #007700">()) . </span><span style="color: #DD0000">"<br />\n"</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #0000BB">imap_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$mbox</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> </p> </div> <div class="refsect1 seealso" id="refsect1-function.imap-createmailbox-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="function"><a href="function.imap-renamemailbox.html" class="function" rel="rdfs-seeAlso">imap_renamemailbox()</a> - Rename an old mailbox to new mailbox</span></li> <li class="member"> <span class="function"><a href="function.imap-deletemailbox.html" class="function" rel="rdfs-seeAlso">imap_deletemailbox()</a> - Delete a mailbox</span></li> </ul> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.imap-create.html">imap_create</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.imap-delete.html">imap_delete</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>