imap-fetchbody.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: hholzgra Status: ready -->
<!-- Reviewed: yes -->
<!-- Rev-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Reviewer: samesch -->
<refentry xml:id="function.imap-fetchbody" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>imap_fetchbody</refname>
  <refpurpose>Liefert einen bestimmten Abschnitt aus dem Textkörper einer Nachricht</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>imap_fetchbody</methodname>
   <methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
   <methodparam><type>int</type><parameter>message_num</parameter></methodparam>
   <methodparam><type>string</type><parameter>section</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   Gibt den mit <parameter>section</parameter> angebenen Teil aus dem
   Textkörper der Nachricht <parameter>message_num</parameter> im aktuellen
   Postfach zurück. Der Teil des Textkörpers wird dabei nicht dekodiert.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &imap.imap-parameter.imap;
    <varlistentry>
     <term><parameter>message_num</parameter></term>
     <listitem>
      <para>
       Die Nummer der Nachricht
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>section</parameter></term>
     <listitem>
      <para>
       Die Nummer des gewünschten Nachrichtenteils. Diese wird gemäß der
       IMAP4-Spezifikation als String von mit Punkten getrennten Zahlen
       angegeben.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       Eine Bitmaske, die sich aus folgenden Werten zusammensetzen kann:
       <itemizedlist>
        <listitem>
         <simpara>
          <constant>FT_UID</constant> - <parameter>message_num</parameter> ist
          eine UID
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>FT_PEEK</constant> - Das \Seen-Flag nicht setzen, falls es
          nicht bereits gesetzt ist
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>FT_INTERNAL</constant> - Rückgabe im internen Format ohne
          Umwandlung der Zeilenenden in CRLF.
         </simpara>
        </listitem>
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Gibt einen bestimmten Teil des Textkörpers der angegebenen Nachricht als
   Textstring zurück. &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>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>imap_savebody</function></member>
    <member><function>imap_fetchstructure</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
-->