imap-open.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: nobody Status: ready -->
<!-- Reviewed: yes -->
<!-- Rev-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Reviewer: samesch -->
<refentry xml:id="function.imap-open" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>imap_open</refname>
  <refpurpose>Öffnet einen <acronym>IMAP</acronym>-Stream zu einem Postfach</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>IMAP\Connection</type><type>false</type></type><methodname>imap_open</methodname>
   <methodparam><type>string</type><parameter>mailbox</parameter></methodparam>
   <methodparam><type>string</type><parameter>user</parameter></methodparam>
   <methodparam><type>string</type><parameter>password</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>retries</parameter><initializer>0</initializer></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>options</parameter><initializer>[]</initializer></methodparam>
  </methodsynopsis>
  <para>
   Öffnet einen <acronym>IMAP</acronym>-Stream zum Postfach
   <parameter>mailbox</parameter>.
  </para>
  <para>
   Diese Funktion kann auch verwendet werden, um Streams zu
   <acronym>POP3</acronym>- und <acronym>NNTP</acronym>-Servern zu öffnen,
   einige Funktionen und Eigenschaften sind aber nur bei
   <acronym>IMAP</acronym>-Verbindungen verfügbar.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>mailbox</parameter></term>
     <listitem>
      <para>
       Ein Postfachname besteht aus einer Serveradresse und dem Pfad zum
       Postfach auf diesem Server. Der reservierte Name
       <literal>INBOX</literal> steht für das persönliche Postfach des
       aktuellen Benutzers. Enthält der Name des Postfachs internationale
       Zeichen außerhalb des druckbaren ASCII-Bereichs, so müssen diese mit
       <function>imap_utf7_encode</function> kodiert werden.
      </para>
      &imap.mailboxname.insecure;
      <para>
       Der Serverteil wird in '{' und '}' eingebettet und besteht aus der
       Domain oder der IP-Adresse des Servers, einer optionalen Portnummer
       (eingeleitet mit ':') und einer optionalen Protokollangabe (eingeleitet
       mit '/').
      </para>
      <para>
       Die Angabe des Serverteils ist immer zwingend bei allen
       Postfach-Parametern.
      </para>
      <para>
       Alle Namen, die mit <literal>{</literal> beginnen, bezeichnen
       Serverdienste und werden in der Form <literal>"{" remote_system_name
       [":" port] [flags] "}"[mailbox_name]</literal> angegeben:
       <itemizedlist>
        <listitem>
         <simpara>
          <literal>remote_system_name</literal> - der Internet-Domain-Name
          oder die in Klammern gesetzte IP-Adresse des Servers
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <literal>port</literal> - die optionale Portnummer, Standard ist der
          jeweilige Standardport des gewählten Protokolls
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <literal>flags</literal> - optionale Flags, siehe folgende Tabelle
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <literal>mailbox_name</literal> - der Name des gewünschten
          Serverpostfachs, Standard ist "INBOX"
         </simpara>
        </listitem>
       </itemizedlist>
      </para>
      <para>
       <table>
        <title>Optionale Flags</title>
        <tgroup cols="2">
         <thead>
          <row>
           <entry>Flag</entry>
           <entry>Beschreibung</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry><literal>/service=</literal><emphasis>service</emphasis></entry>
           <entry>Postfach-Zugriffsprotokoll, Standard ist "imap"</entry>
          </row>
          <row>
           <entry><literal>/user=</literal><emphasis>user</emphasis></entry>
           <entry>Benutzername für die Anmeldung am Mailserver</entry>
          </row>
          <row>
           <entry><literal>/authuser=</literal><emphasis>user</emphasis></entry>
           <entry>
            Benutzername für die Remote-Authentifizierung; falls angegeben,
            ist dies der Benutzername dessen Passwort verwendet wird (&zb;
            administrator)
           </entry>
          </row>
          <row>
           <entry><literal>/anonymous</literal></entry>
           <entry>Zugriff als anonymer Benutzer</entry>
          </row>
          <row>
           <entry><literal>/debug</literal></entry>
           <entry>
            Protokollausgaben im Debug-Log der Anwendung aufzeichnen
           </entry>
          </row>
          <row>
           <entry><literal>/secure</literal></entry>
           <entry>Übertragung von Klartext-Passwörtern wird verhindert</entry>
          </row>
          <row>
           <entry>
            <literal>/imap</literal>, <literal>/imap2</literal>,
            <literal>/imap2bis</literal>, <literal>/imap4</literal>,
            <literal>/imap4rev1</literal>
           </entry>
           <entry>Kurzform für <literal>/service=imap</literal></entry>
          </row>
          <row>
           <entry><literal>/pop3</literal></entry>
           <entry>Kurzform für <literal>/service=pop3</literal></entry>
          </row>
          <row>
           <entry><literal>/nntp</literal></entry>
           <entry>Kurzform für <literal>/service=nntp</literal></entry>
          </row>
          <row>
           <entry><literal>/norsh</literal></entry>
           <entry>
            Für eine vorauthentifizierte IMAP-Verbindung soll weder RSH noch
            SSH verwendet werden
           </entry>
          </row>
          <row>
           <entry><literal>/ssl</literal></entry>
           <entry>
            <literal>Secure Socket Layer</literal> (SSL) zur Verschlüsselung
            der Verbindung verwenden
           </entry>
          </row>
          <row>
           <entry><literal>/validate-cert</literal></entry>
           <entry>TLS/SSL-Zertifikate verifizieren (Standardverhalten)</entry>
          </row>
          <row>
           <entry><literal>/novalidate-cert</literal></entry>
           <entry>
            TLS/SSL-Zertifikate nicht verifizieren; wird für selbstsignierte
            Zertifikate benötigt
           </entry>
          </row>
          <row>
           <entry><literal>/tls</literal></entry>
           <entry>
            <literal>start-TLS</literal>-Verschlüsselung erzwingen und
            Verbindungen zu Servern, die dies nicht unterstützen, ablehnen
           </entry>
          </row>
          <row>
           <entry><literal>/notls</literal></entry>
           <entry>
            <literal>start-TLS</literal> nicht zum Verschlüsseln der
            Verbindung verwenden, auch wenn es der Server unterstützt
           </entry>
          </row>
          <row>
           <entry><literal>/readonly</literal></entry>
           <entry>
            Öffnen des Postfachs im Nur-Lese-Modus anfordern (nur für IMAP,
            NNTP ignoriert dies, POP3 und SMTP verweigern
            readonly-Verbindungen)
           </entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>user</parameter></term>
     <listitem>
      <para>
       Der Benutzername
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>password</parameter></term>
     <listitem>
      <para>
       Das Passwort von <parameter>user</parameter>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       Der Parameter <parameter>flags</parameter> kann sich als Bitmaske aus
       folgenden Werten zusammensetzen:
       <itemizedlist>
        <listitem>
         <simpara>
          <constant>OP_READONLY</constant> - nur lesende Zugriffe
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>OP_ANONYMOUS</constant> - ein existierendes
          <filename>.newsrc</filename> weder lesen noch aktualisieren
          (nur NNTP)
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>OP_HALFOPEN</constant> - Verbindung zum Server öffnen,
          aber noch kein Postfach auswählen (nur <acronym>IMAP</acronym> und
          <acronym>NNTP</acronym>)
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CL_EXPUNGE</constant> - zum Löschen markierte Nachrichten
          beim Schließen des Postfachs automatisch entfernen (siehe auch
          <function>imap_delete</function> und
          <function>imap_expunge</function>)
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>OP_DEBUG</constant> - Protokollverhandlungen debuggen
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>OP_SHORTCACHE</constant> - kurzes Caching (nur
          <literal>elt</literal>)
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>OP_SILENT</constant> - Ereignisse nicht weitergeben
          (interne Einstellung)
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>OP_PROTOTYPE</constant> - Treiber-Prototyp zurückgeben
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>OP_SECURE</constant> - keine unsichere Verbindung zum
          Server öffnen
         </simpara>
        </listitem>
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>retries</parameter></term>
     <listitem>
      <para>
       Maximale Anzahl der Verbindungsversuche
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>options</parameter></term>
     <listitem>
      <para>
       Verbindungsparameter; die folgenden (String-)Schlüssel können verwendet
       werden, um einen oder mehrere Verbindungsparameter anzugeben:
       <itemizedlist>
        <listitem>
         <simpara>
          <literal>DISABLE_AUTHENTICATOR</literal> - Deaktiviere
          Authentifizierungs-Eigenschaften
         </simpara>
        </listitem>
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Gibt bei Erfolg eine <classname>IMAP\Connection</classname>-Instanz 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>
     <row>
      <entry>8.1.0</entry>
      <entry>
       Gibt jetzt eine <classname>IMAP\Connection</classname>-Instanz zurück;
       vorher wurde eine &resource; zurückgegeben.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Verschiedene <function>imap_open</function>-Aufrufe</title>
    <programlisting role="php">
<![CDATA[
<?php
// Verbindung zu einem IMAP-Server auf Port 143 des lokalen Rechners
$mbox = imap_open("{localhost:143}INBOX", "user_id", "password");

// Verbindung zu einem POP3-Server auf Port 110 des lokalen Rechners
$mbox = imap_open ("{localhost:110/pop3}INBOX", "user_id", "password");

// Für SSL-verschlüsselte Verbindungen zu einem IMAP- oder POP3-Server wird
// /ssl an die Protokollspezifikation angefügt
$mbox = imap_open ("{localhost:993/imap/ssl}INBOX", "user_id", "password");

// Zur SSL-Verbindung mit IMAP- oder POP3-Servern mit selbstsignierten
// Zertifikaten muss zusätzlich /novalidate-cert angefügt werden
$mbox = imap_open ("{localhost:995/pop3/ssl/novalidate-cert}", "user_id", "password");

// Verbindung zu einem NNTP-Server auf Port 119 des lokalen Rechners
$nntp = imap_open ("{localhost:119/nntp}comp.test", "", "");
// Für Verbindungen zu anderen Servern wird "localhost" mit dem Namen
// oder der IP-Adresse des Servers ersetzt
?>
]]>
    </programlisting>
   </example>
   <example>
    <title><function>imap_open</function>-Beispiel</title>
    <programlisting role="php">
<![CDATA[
<?php
$mbox = imap_open("{imap.example.org:143}", "username", "password");

echo "<h1>Postfächer</h1>\n";
$folders = imap_listmailbox($mbox, "{imap.example.org:143}", "*");

if ($folders == false) {
    echo "Abruf fehlgeschlagen<br />\n";
} else {
    foreach ($folders as $val) {
        echo $val . "<br />\n";
    }
}

echo "<h1>Nachrichten in INBOX</h1>\n";
$headers = imap_headers($mbox);

if ($headers == false) {
    echo "Abruf fehlgeschlagen<br />\n";
} else {
    foreach ($headers as $val) {
        echo $val . "<br />\n";
    }
}

imap_close($mbox);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

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