mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-23 04:18:56 +00:00
4d81bf2025
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@325727 c90b9560-bf6c-de11-be94-00142212c4b1
132 lines
4 KiB
XML
132 lines
4 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.imap-createmailbox" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>imap_createmailbox</refname>
|
|
<refpurpose>Create a new mailbox</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>imap_createmailbox</methodname>
|
|
<methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>mailbox</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Creates a new mailbox specified by <parameter>mailbox</parameter>.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
&imap.imap-stream.description;
|
|
<varlistentry>
|
|
<term><parameter>mailbox</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The mailbox name, see <function>imap_open</function> for more
|
|
information. Names containing international characters should be
|
|
encoded by <function>imap_utf7_encode</function>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success;
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>imap_createmailbox</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$mbox = imap_open("{imap.example.org}", "username", "password", OP_HALFOPEN)
|
|
or die("can't connect: " . imap_last_error());
|
|
|
|
$name1 = "phpnewbox";
|
|
$name2 = imap_utf7_encode("phpnewböx"); // phpnewb&w7Y-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 finally remove it to restore
|
|
// your inbox to its initial state
|
|
|
|
if (@imap_createmailbox($mbox, imap_utf7_encode("{imap.example.org}INBOX.$newname"))) {
|
|
$status = @imap_status($mbox, "{imap.example.org}INBOX.$newname", SA_ALL);
|
|
if ($status) {
|
|
echo "your new mailbox '$name1' has the following status:<br />\n";
|
|
echo "Messages: " . $status->messages . "<br />\n";
|
|
echo "Recent: " . $status->recent . "<br />\n";
|
|
echo "Unseen: " . $status->unseen . "<br />\n";
|
|
echo "UIDnext: " . $status->uidnext . "<br />\n";
|
|
echo "UIDvalidity:" . $status->uidvalidity . "<br />\n";
|
|
|
|
if (imap_renamemailbox($mbox, "{imap.example.org}INBOX.$newname", "{imap.example.org}INBOX.$name2")) {
|
|
echo "renamed new mailbox from '$name1' to '$name2'<br />\n";
|
|
$newname = $name2;
|
|
} else {
|
|
echo "imap_renamemailbox on new mailbox failed: " . imap_last_error() . "<br />\n";
|
|
}
|
|
} else {
|
|
echo "imap_status on new mailbox failed: " . imap_last_error() . "<br />\n";
|
|
}
|
|
|
|
if (@imap_deletemailbox($mbox, "{imap.example.org}INBOX.$newname")) {
|
|
echo "new mailbox removed to restore initial state<br />\n";
|
|
} else {
|
|
echo "imap_deletemailbox on new mailbox failed: " . implode("<br />\n", imap_errors()) . "<br />\n";
|
|
}
|
|
|
|
} else {
|
|
echo "could not create new mailbox: " . implode("<br />\n", imap_errors()) . "<br />\n";
|
|
}
|
|
|
|
imap_close($mbox);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>imap_renamemailbox</function></member>
|
|
<member><function>imap_deletemailbox</function></member>
|
|
</simplelist>
|
|
</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:"~/.phpdoc/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
|
|
-->
|