imap_list

(PHP 4, PHP 5, PHP 7, PHP 8)

imap_listLee la lista de buzones de correo

Descripción

imap_list(IMAP\Connection $imap, string $reference, string $pattern): array|false

Lee la lista de buzones de correo.

Parámetros

imap

An IMAP\Connection instance.

reference

reference debería ser solo el servidor en la forma descrita en imap_open()

Advertencia

Passing untrusted data to this parameter is insecure, unless imap.enable_insecure_rsh is disabled.

pattern

Specifies where in the mailbox hierarchy to start searching.

There are two special characters you can pass as part of the pattern: '*' and '%'. '*' means to return all mailboxes. If you pass pattern as '*', you will get a list of the entire mailbox hierarchy. '%' means to return the current level only. '%' as the pattern parameter will return only the top level mailboxes; '~/mail/%' on UW_IMAPD will return every mailbox in the ~/mail directory, but none in subfolders of that directory.

Valores devueltos

Devuelve un array que contiene los nombres de los buzones de correo, o false si ocurre un error.

Historial de cambios

Versión Descripción
8.1.0 The imap parameter expects an IMAP\Connection instance now; previously, a valid imap resource was expected.

Ejemplos

Ejemplo #1 Ejemplo con imap_list()

<?php
$mbox
= imap_open("{imap.example.org}", "username", "password", OP_HALFOPEN)
or die(
"Conexión imposible: " . imap_last_error());

$list = imap_list($mbox, "{imap.example.org}", "*");
if (
is_array($list)) {
foreach (
$list as $val) {
echo
imap_utf7_decode($val) . "\n";
}
} else {
echo
"imap_list ha fallado: " . imap_last_error() . "\n";
}

imap_close($mbox);
?>

Ver también