imap-open.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.imap-open" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>imap_open</refname>
  <refpurpose>Abre un flujo <acronym>IMAP</acronym> hacia un buzón de correo</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>
   Abre un flujo <acronym>IMAP</acronym> hacia el buzón de correo
   <parameter>mailbox</parameter>.
  </para>
  <para>
   Esta función también puede ser utilizada para abrir flujos en servidores <acronym>POP3</acronym> y <acronym>NNTP</acronym>,
   pero algunas funciones y características solo están disponibles con servidores <acronym>IMAP</acronym>.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>mailbox</parameter></term>
     <listitem>
      <para>
       Un nombre de buzón de correo está compuesto por una dirección de servidor y una dirección de buzón en ese servidor. La palabra reservada
       <literal>INBOX</literal> representa el buzón de correo del usuario actual. Los nombres de buzones de correo que contienen caracteres especiales (fuera del espacio ASCII) deben ser codificados con <function>imap_utf7_encode</function>.
      </para>
      &imap.mailboxname.insecure;
      <para>
       La dirección del servidor, entre llaves '{' y '}', está compuesta por el nombre del servidor o su dirección IP, una especificación de protocolo
       (comenzando por '/') y un puerto opcional (especificado con ':').
      </para>
      <para>
       Esta parte es obligatoria en los parámetros del buzón de correo.
      </para>
      <para>
       Todos los nombres que comienzan con <literal>{</literal> son nombres remotos y tienen la forma <literal>"{" nombre_sistema_remoto [":" puerto] [flags] "}"
       [nombre_buzon]</literal> donde :
       <itemizedlist>
        <listitem>
         <simpara>
          <literal>remote_system_name</literal> : Nombre de dominio de Internet o una
          dirección IP de servidor entre comillas.
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <literal>puerto</literal> : número de puerto TCP (opcional),
          el valor por defecto es el valor del puerto para este servicio.
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <literal>flags</literal> : opciones, ver la tabla siguiente.
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <literal>mailbox_name</literal> : nombre del buzón remoto, por defecto : INBOX
         </simpara>
        </listitem>
       </itemizedlist>
      </para>
      <para>
       <table>
        <title>Flags opcionales para los nombres</title>
        <tgroup cols="2">
         <thead>
          <row>
           <entry>Flag</entry>
           <entry>Descripción</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry><literal>/service=</literal><emphasis>service</emphasis></entry>
           <entry>servicio para el acceso al buzón, por defecto : "imap"</entry>
          </row>
          <row>
           <entry><literal>/user=</literal><emphasis>user</emphasis></entry>
           <entry>nombre del usuario remoto para la identificación en el servidor</entry>
          </row>
          <row>
           <entry><literal>/authuser=</literal><emphasis>user</emphasis></entry>
           <entry>usuario remoto de identificación; si se especifica, este será el nombre del usuario
            cuya contraseña se utiliza (e.g. administrador)</entry>
          </row>
          <row>
           <entry><literal>/anonymous</literal></entry>
           <entry>acceso remoto anónimo</entry>
          </row>
          <row>
           <entry><literal>/debug</literal></entry>
           <entry>la telemetría de registro del protocolo en los logs de depuración de
            la aplicación</entry>
          </row>
          <row>
           <entry><literal>/secure</literal></entry>
           <entry>no transmite una contraseña en claro a través de la red</entry>
          </row>
          <row>
           <entry><literal>/imap</literal>, <literal>/imap2</literal>,
            <literal>/imap2bis</literal>, <literal>/imap4</literal>,
            <literal>/imap4rev1</literal></entry>
           <entry>equivalente a <literal>/service=imap</literal></entry>
          </row>
          <row>
           <entry><literal>/pop3</literal></entry>
           <entry>equivalente a <literal>/service=pop3</literal></entry>
          </row>
          <row>
           <entry><literal>/nntp</literal></entry>
           <entry>equivalente a <literal>/service=nntp</literal></entry>
          </row>
          <row>
           <entry><literal>/norsh</literal></entry>
           <entry>no utilizar rsh o ssh para establecer una sesión de pre identificación
            IMAP</entry>
          </row>
          <row>
           <entry><literal>/ssl</literal></entry>
           <entry>utiliza <literal>Secure Socket Layer</literal> para cifrar la
            sesión</entry>
          </row>
          <row>
           <entry><literal>/validate-cert</literal></entry>
           <entry>valida los certificados desde el servidor TLS/SSL (es el comportamiento por
            defecto)</entry>
          </row>
          <row>
           <entry><literal>/novalidate-cert</literal></entry>
           <entry>no valida los certificados desde el servidor TLS/SSL, necesario si
            el servidor utiliza certificados autofirmados</entry>
          </row>
          <row>
           <entry><literal>/tls</literal></entry>
           <entry>fuerza el uso de <literal>start-TLS</literal> para cifrar la sesión y
            rechaza las conexiones a los servidores que no lo soportan</entry>
          </row>
          <row>
           <entry><literal>/notls</literal></entry>
           <entry>no utiliza <literal>start-TLS</literal> para cifrar la sesión,
            incluso con los servidores que lo soportan</entry>
          </row>
          <row>
           <entry><literal>/readonly</literal></entry>
           <entry>solicita acceso de solo lectura en el buzón (solo IMAP; ignorado en
            NNTP, y un error con SMTP y POP3)</entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>user</parameter></term>
     <listitem>
      <para>
       El nombre de usuario
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>password</parameter></term>
     <listitem>
      <para>
       La contraseña asociada con el usuario <parameter>user</parameter>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       <parameter>flags</parameter> es una máscara de bits, que puede tomar uno o
       varios de los siguientes valores :
       <itemizedlist>
        <listitem>
         <simpara>
          <constant>OP_READONLY</constant> : Abre un buzón de correo en modo de solo lectura
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>OP_ANONYMOUS</constant> : No utilizar, o modificar el fichero
          <filename>.newsrc</filename> para las noticias (solo NNTP)
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>OP_HALFOPEN</constant> : Para los nombres <acronym>IMAP</acronym> y <acronym>NNTP</acronym>,
          abre una conexión pero no abre un buzón de correo.
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CL_EXPUNGE</constant> : Elimina automáticamente el buzón de correo
          de la lista, al finalizar el flujo (ver también
          <function>imap_delete</function> y
          <function>imap_expunge</function>)
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>OP_DEBUG</constant> : negociaciones de depuración del protocolo
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>OP_SHORTCACHE</constant> : Caché corta (<literal>elt</literal> solamente)
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>OP_SILENT</constant> : No transmitir los eventos (uso
          interno)
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>OP_PROTOTYPE</constant> : Devuelve el prototipo del controlador
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>OP_SECURE</constant> : No realizar identificaciones no seguras
         </simpara>
        </listitem>
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>retries</parameter></term>
     <listitem>
      <para>
       El número máximo de intentos de conexión.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>options</parameter></term>
     <listitem>
      <para>
       Parámetros de conexión; las claves pueden ser utilizadas para
       definir uno o varios parámetros de conexión :
       <itemizedlist>
        <listitem>
         <simpara>
          <literal>DISABLE_AUTHENTICATOR</literal> - Desactiva las propiedades de autenticación
         </simpara>
        </listitem>
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Devuelve una instancia de <classname>IMAP\Connection</classname>
   en caso de éxito,&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>
       Ahora devuelve una instancia de <classname>IMAP\Connection</classname> ;
       anteriormente, un &resource; era devuelto.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Diferentes usos de <function>imap_open</function></title>
    <programlisting role="php">
<![CDATA[
<?php
// Para conectarse a un servidor IMAP funcionando en el puerto 143 de la
// máquina local, haga esto :
$mbox = imap_open("{localhost:143}INBOX", "user_id", "password");

// Para conectarse a un servidor POP3 funcionando en el puerto 110 del
// servidor local, haga esto :
$mbox = imap_open ("{localhost:110/pop3}INBOX", "user_id", "password");

// Para conectarse a un servidor SSL IMAP o POP3, añada /ssl
// después de la especificación del protocolo :
$mbox = imap_open ("{localhost:993/imap/ssl}INBOX", "user_id", "password");

// Para conectarse a un servidor SSL IMAP o POP3 con un certificado autofirmado
// añada /ssl/novalidate-cert después del protocolo :
$mbox = imap_open ("{localhost:995/pop3/ssl/novalidate-cert}", "user_id", "password");

// Para conectarse a un servidor NNTP que funciona en
// el puerto 119 de la máquina local se puede utilizar el comando:
$nntp = imap_open ("{localhost:119/nntp}comp.test", "", "");

// Para conectarse a un servidor remoto, reemplace "localhost" por
// el nombre o la dirección IP de la máquina.
?>
]]>
    </programlisting>
   </example>
   <example>
    <title>Ejemplo con <function>imap_open</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$mbox = imap_open("{imap.example.org:143}", "username", "password");

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

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

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

if ($headers == false) {
    echo "Llamada fallida<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
-->