Files
php-doc-ru/reference/imap/functions/imap-mail-move.xml
2021-01-05 20:16:26 +03:00

118 lines
3.7 KiB
XML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: ca35bb0ee60fdbf44956427c44c4eee7b1ea0fdb Maintainer: rjhdby Status: ready -->
<!-- Reviewed: yes Maintainer: lex -->
<refentry xml:id="function.imap-mail-move" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>imap_mail_move</refname>
<refpurpose>Переместить указанные сообщения в указанный почтовый ящик</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>imap_mail_move</methodname>
<methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam>
<methodparam><type>string</type><parameter>msglist</parameter></methodparam>
<methodparam><type>string</type><parameter>mailbox</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Перемещает письма, заданные в <parameter>msglist</parameter> в указанный
почтовый ящик <parameter>mailbox</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&imap.imap-stream.description;
<varlistentry>
<term><parameter>msglist</parameter></term>
<listitem>
<para>
<parameter>msglist</parameter> - это диапазон, а не просто номера сообщений
(как определено в <link xlink:href="&url.rfc;2060">RFC2060</link>).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mailbox</parameter></term>
<listitem>
<para>
Имя почтового ящика. Более подробно читайте в разделе,
посвящённом функции <function>imap_open</function>
</para>
&imap.mailboxname.insecure;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
<parameter>options</parameter> - битовая маска, которая может принимать всего одно
значение:
<itemizedlist>
<listitem>
<simpara>
<constant>CP_UID</constant> - означает, что в первом параметре не номера
сообщений, а их UID
</simpara>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
Функция <function>imap_mail_move</function> помечает оригинальное сообщение
флагом удаления, так что не забудьте после неё вызвать функцию
<function>imap_expunge</function>.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>imap_mail_copy</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
-->