mirror of
https://github.com/php/doc-es.git
synced 2026-04-28 17:43:11 +02:00
Pedro Antonio Gil Rodríguez
d2821933b2
git-svn-id: https://svn.php.net/repository/phpdoc/es/trunk@329184 c90b9560-bf6c-de11-be94-00142212c4b1
406 lines
14 KiB
XML
406 lines
14 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- EN-Revision: 45b4dc6dc309a77cecc80ea8c9ab4ffc26716ebe Maintainer: seros Status: ready -->
|
|
<!-- Reviewed: no -->
|
|
<refentry xml:id="function.imap-open" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>imap_open</refname>
|
|
<refpurpose>Abrir un flujo <acronym>IMAP</acronym> a un buzón</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>resource</type><methodname>imap_open</methodname>
|
|
<methodparam><type>string</type><parameter>mailbox</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>username</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>password</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>n_retries</parameter><initializer>0</initializer></methodparam>
|
|
<methodparam choice="opt"><type>array</type><parameter>params</parameter><initializer>&null;</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Abre un flujo <acronym>IMAP</acronym> a un buzón dado por <parameter>mailbox</parameter>.
|
|
</para>
|
|
<para>
|
|
Esta función también se puede usar para abrir flujos a servidores <acronym>POP3</acronym> y
|
|
<acronym>NNTP</acronym>, pero sólo algunas funciones y características están
|
|
disponibles en 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 consiste en una ruta de servidor y una de buzón para este servidor.
|
|
El nombre especial <literal>INBOX</literal> permanece para los buzones personales
|
|
de ususarios actuales. Los nombres de buzón que contienen caracteres internacionales
|
|
además de aquellos imprimibles del espacio ASCII tienen que ser codificados con
|
|
<function>imap_utf7_encode</function>.
|
|
</para>
|
|
<para>
|
|
La ruta del servidor, que está encerrada entre '{' y '}', consiste en los nombres de los
|
|
servidores o direcciones ip, y el puerto opcional (prefijado por ':'), y una especificación
|
|
de protocolo opcional (prefijada por '/').
|
|
</para>
|
|
<para>
|
|
La parte del servidor el obligatoria en todos los parámetros
|
|
del buzón.
|
|
</para>
|
|
<para>
|
|
Todos los nombres que empiezan con <literal>{</literal> son nombres remotos, y están
|
|
en la forma <literal>"{" nombre_sistema_remoto [":" puerto] [banderas] "}"
|
|
[nombre_buzón]</literal> donde:
|
|
<itemizedlist>
|
|
<listitem>
|
|
<simpara>
|
|
<literal>nombre_sistema_remoto</literal> - -Nombre de dominio de internet o
|
|
dirección IP del servidor entre corchetes.
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<literal>port</literal> - número de puerto TCP opcional, por omisión es el
|
|
puerto por defecto para ese servicio
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<literal>flags</literal> - banderas opcionales, véase la siguiente tabla.
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<literal>mailbox_name</literal> - nombre del buzón remoto, por defecto es INBOX
|
|
</simpara>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
<para>
|
|
<table>
|
|
<title>Banderas opcionales para los nombres</title>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>Bandera</entry>
|
|
<entry>Descricpción</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry><literal>/service=</literal><emphasis>servicio</emphasis></entry>
|
|
<entry>servicio de acceso al buzón, por defecto es "imap"</entry>
|
|
</row>
|
|
<row>
|
|
<entry><literal>/user=</literal><emphasis>usuario</emphasis></entry>
|
|
<entry>nombre de usuario remoto para identificar en el servidor</entry>
|
|
</row>
|
|
<row>
|
|
<entry><literal>/authuser=</literal><emphasis>usuario</emphasis></entry>
|
|
<entry>usuario de autentificación remoto; si se especifica es el nombre de usuario
|
|
cuya contraseña es usada (p.ej. administrador)</entry>
|
|
</row>
|
|
<row>
|
|
<entry><literal>/anonymous</literal></entry>
|
|
<entry>acceso remoto como usuario anónimo</entry>
|
|
</row>
|
|
<row>
|
|
<entry><literal>/debug</literal></entry>
|
|
<entry>grabar la telemetría de protocolo en el registro de depuración de la aplicación</entry>
|
|
</row>
|
|
<row>
|
|
<entry><literal>/secure</literal></entry>
|
|
<entry>no transmitir una contraseña en texto plano en 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 usar rsh o ssh para establecer una sesión de IMAP
|
|
preautenticada</entry>
|
|
</row>
|
|
<row>
|
|
<entry><literal>/ssl</literal></entry>
|
|
<entry>usar <literal>Secure Socket Layer</literal> (Capa de Conexión Segura) para encriptar la sesión</entry>
|
|
</row>
|
|
<row>
|
|
<entry><literal>/validate-cert</literal></entry>
|
|
<entry>validar certificados desde el servidor TLS/SSL (este es el comportamiento
|
|
predeterminado)</entry>
|
|
</row>
|
|
<row>
|
|
<entry><literal>/novalidate-cert</literal></entry>
|
|
<entry>no validar certificador desde el servidor TLS/SSL, necesario si
|
|
el servidor usa certificados autofirmados</entry>
|
|
</row>
|
|
<row>
|
|
<entry><literal>/tls</literal></entry>
|
|
<entry>forzar el uso de <literal>start-TLS</literal> para encriptar la sesión, y rechazar
|
|
la conexión a servidores que no la soportan</entry>
|
|
</row>
|
|
<row>
|
|
<entry><literal>/notls</literal></entry>
|
|
<entry>no realizar <literal>start-TLS</literal> para encriptar la sesión, incluso con los
|
|
servidores que la soportan</entry>
|
|
</row>
|
|
<row>
|
|
<entry><literal>/readonly</literal></entry>
|
|
<entry>petición de apertura de un buzón de sólo lectura (sólo IMAP; ignorado en NNTP, y
|
|
un error con SMTP y POP3)</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>username</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
El nombre de usuario
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>password</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
La contraseña asociada con <parameter>username</parameter>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>options</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
<parameter>options</parameter> es una máscara de bits con uno o más de lo
|
|
siguiente:
|
|
<itemizedlist>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>OP_READONLY</constant> - Abrir un buzón de sólo lectura
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>OP_ANONYMOUS</constant> - No usar o actualizar un
|
|
<filename>.newsrc</filename> para noticias (sólo NNTP)
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>OP_HALFOPEN</constant> - Para nombres <acronym>IMAP</acronym>
|
|
y <acronym>NNTP</acronym>, abrir una conexión pero
|
|
no abrir el buzón.
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>CL_EXPUNGE</constant> - Expurgar el buzón automáticamente al cierre del mismo
|
|
(véase también <function>imap_delete</function> y
|
|
<function>imap_expunge</function>)
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>OP_DEBUG</constant> - Depurar negociaciones de protocolo
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>OP_SHORTCACHE</constant> - Almacenamiento en caché corto (sólo <literal>elt</literal>)
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>OP_SILENT</constant> - No dejar pasar eventos (uso interno)
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>OP_PROTOTYPE</constant> - Devolver el prototipo de controlador
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>OP_SECURE</constant> - No realizar autenticación no segura
|
|
</simpara>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>n_retries</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Número máximo de intentos de conexión
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>params</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Parámetros de conexión, las siguientes claves (cadena) pueden usarse
|
|
para establecer uno o más parámetros de conexión:
|
|
<itemizedlist>
|
|
<listitem>
|
|
<simpara>
|
|
<literal>DISABLE_AUTHENTICATOR</literal> - Deshabilitar las propieades de autenticación
|
|
</simpara>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Devuelve un flujo IMAP en caso de éxito o &false; en caso de error.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="changelog">
|
|
&reftitle.changelog;
|
|
<para>
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>5.3.2</entry>
|
|
<entry>Se añadió <parameter>params</parameter></entry>
|
|
</row>
|
|
<row>
|
|
<entry>5.2.0</entry>
|
|
<entry>Se añadió <parameter>n_retries</parameter></entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</para>
|
|
</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 que se ejecuta en el puerto 142 de la máquina local,
|
|
// haga lo siguiente:
|
|
$mbox = imap_open("{localhost:143}INBOX", "user_id", "password");
|
|
|
|
// Para conectarse a un servidor POP3 en el puerto 110 del servidor local, use:
|
|
$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 de la especificación del protocolo:
|
|
$mbox = imap_open ("{localhost:995/pop3/ssl/novalidate-cert}", "user_id", "password");
|
|
|
|
// Para conectarse a un servidor NNTP en el puerto 119 en el servidor local, use:
|
|
$nntp = imap_open ("{localhost:119/nntp}comp.test", "", "");
|
|
// Para conectarse a un servidor remoto reemplace "localhost" con el nombre o la
|
|
// dirección IP del servidor al que se quiere conectar.
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
<example>
|
|
<title>Ejemplo de <function>imap_open</function></title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$mbox = imap_open("{imap.example.org:143}", "username", "password");
|
|
|
|
echo "<h1>Buzones</h1>\n";
|
|
$carpetas = imap_listmailbox($mbox, "{imap.example.org:143}", "*");
|
|
|
|
if ($carpetas == false) {
|
|
echo "Llamada fallida<br />\n";
|
|
} else {
|
|
foreach ($carpetas as $val) {
|
|
echo $val . "<br />\n";
|
|
}
|
|
}
|
|
|
|
echo "<h1>Cabeceras en INBOX</h1>\n";
|
|
$cabeceras = imap_headers($mbox);
|
|
|
|
if ($cabeceras == false) {
|
|
echo "Llamada fallida<br />\n";
|
|
} else {
|
|
foreach ($cabeceras 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
|
|
-->
|