imap-mail-move.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 91a4618df8c82d4e84bbb8a9ed430b840cd7da65 Maintainer: hirokawa Status: ready -->
<!-- Credits: mumumu -->
<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>IMAP\Connection</type><parameter>imap</parameter></methodparam>
   <methodparam><type>string</type><parameter>message_nums</parameter></methodparam>
   <methodparam><type>string</type><parameter>mailbox</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   <parameter>message_nums</parameter> で指定されたメッセージを、
   指定されたメールボックス <parameter>mbox</parameter> に移動します。
   実際には <parameter>mailbox</parameter> にメッセージが
   <emphasis>コピー</emphasis> され、
   オリジナルのメッセージには削除済みのフラグが付く点に注意して下さい。
   これは、<parameter>mailbox</parameter> にあるメッセージには、
   新しい UID が割り当てられるということです。
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &imap.imap-parameter.imap;
    <varlistentry>
     <term><parameter>message_nums</parameter></term>
     <listitem>
      <para>
       <parameter>message_nums</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>flags</parameter></term>
     <listitem>
      <para>
       <parameter>flags</parameter> はビットマスクであり、ひとつのオプションをとります。
       <itemizedlist>
        <listitem>
         <simpara>
          <constant>CP_UID</constant> - UIDS を含む処理の数
         </simpara>
        </listitem>
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &imap.changelog.imap-param;
    </tbody>
   </tgroup>
  </informaltable>
 </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
-->