imap-body.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: hirokawa Status: ready -->
<refentry xml:id="function.imap-body" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>imap_body</refname>
  <refpurpose>メッセージ本文を読む</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>imap_body</methodname>
   <methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
   <methodparam><type>int</type><parameter>message_num</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>imap_body</function> は、現在のメールボックスにある 
   <parameter>message_num</parameter> 番目のメッセージの本文を返します。
  </para>
  <para>
   <function>imap_body</function> は、メッセージの本文と全く同じ
   コピーのみを返します。マルチパート MIME エンコードされたメッセージの
   一部を展開するには、その構造を解析するために
   <function>imap_fetch_structure</function> を使用し、単一の部分要素の
   コピーを展開する際には、
   <function>imap_fetchbody</function> を使用する必要があります。
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &imap.imap-parameter.imap;
    <varlistentry>
     <term><parameter>message_num</parameter></term>
     <listitem>
      <para>
       メッセージ番号。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       オプションの <parameter>flags</parameter> はビットマスクであり、
       以下の要素の組み合わせとなります。
       <itemizedlist>
        <listitem>
         <simpara>
          <constant>FT_UID</constant> - <parameter>message_num</parameter> は UID です
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>FT_PEEK</constant> - 既に設定されていない場合、\Seen フラグを設定しない
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>FT_INTERNAL</constant> - 内部フォーマットで文字列を返す。
          CRLF に正規化しない。
         </simpara>
        </listitem>
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   指定したメッセージの本文を文字列で返します。
   &return.falseforfailure;
  </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>
 
</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
-->