mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 22:08:55 +00:00
2d23ddfe59
- Move alised documented to their real function name and document what an alias is. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@99005 c90b9560-bf6c-de11-be94-00142212c4b1
104 lines
3.5 KiB
XML
104 lines
3.5 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.3 $ -->
|
|
<!-- splitted from ./en/functions/imap.xml, last change in rev 1.2 -->
|
|
<refentry id="function.imap-createmailbox">
|
|
<refnamediv>
|
|
<refname>imap_createmailbox</refname>
|
|
<refpurpose>Create a new mailbox</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>imap_createmailbox</methodname>
|
|
<methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>mbox</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>imap_createmailbox</function> creates a new mailbox
|
|
specified by <parameter>mbox</parameter>. Names containing
|
|
international characters should be encoded by <function>imap_utf7_encode</function>
|
|
</para>
|
|
<para>
|
|
Returns &true; on success and &false; on error.
|
|
</para>
|
|
<para>
|
|
See also <function>imap_renamemailbox</function>,
|
|
<function>imap_deletemailbox</function> and
|
|
<function>imap_open</function> for the format
|
|
of <parameter>mbox</parameter> names.
|
|
</para>
|
|
<para>
|
|
<example>
|
|
<title><function>imap_createmailbox</function> example</title>
|
|
<programlisting>
|
|
<![CDATA[
|
|
$mbox = imap_open("{your.imap.host}","username","password",OP_HALFOPEN)
|
|
or die("can't connect: ".imap_last_error());
|
|
|
|
$name1 = "phpnewbox";
|
|
$name2 = imap_utf7_encode("phpnewböx");
|
|
|
|
$newname = $name1;
|
|
|
|
echo "Newname will be '$name1'<br>\n";
|
|
|
|
# we will now create a new mailbox "phptestbox" in your inbox folder,
|
|
# check its status after creation and finaly remove it to restore
|
|
# your inbox to its initial state
|
|
if(@imap_createmailbox($mbox,imap_utf7_encode("{your.imap.host}INBOX.$newname"))) {
|
|
$status = @imap_status($mbox,"{your.imap.host}INBOX.$newname",SA_ALL);
|
|
if($status) {
|
|
print("your new mailbox '$name1' has the following status:<br>\n");
|
|
print("Messages: ". $status->messages )."<br>\n";
|
|
print("Recent: ". $status->recent )."<br>\n";
|
|
print("Unseen: ". $status->unseen )."<br>\n";
|
|
print("UIDnext: ". $status->uidnext )."<br>\n";
|
|
print("UIDvalidity:". $status->uidvalidity)."<br>\n";
|
|
|
|
if(imap_renamemailbox($mbox,"{your.imap.host}INBOX.$newname","{your.imap.host}INBOX.$name2")) {
|
|
echo "renamed new mailbox from '$name1' to '$name2'<br>\n";
|
|
$newname=$name2;
|
|
} else {
|
|
print "imap_renamemailbox on new mailbox failed: ".imap_last_error()."<br>\n";
|
|
}
|
|
} else {
|
|
print "imap_status on new mailbox failed: ".imap_last_error()."<br>\n";
|
|
}
|
|
if(@imap_deletemailbox($mbox,"{your.imap.host}INBOX.$newname")) {
|
|
print "new mailbox removed to restore initial state<br>\n";
|
|
} else {
|
|
print "imap_deletemailbox on new mailbox failed: ".implode("<br>\n",imap_errors())."<br>\n";
|
|
}
|
|
|
|
} else {
|
|
print "could not create new mailbox: ".implode("<br>\n",imap_errors())."<br>\n";
|
|
}
|
|
|
|
imap_close($mbox);
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"../../../../manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|