(PHP 4, PHP 5, PHP 7, PHP 8)
imap_list — Lee la lista de buzones de correo
Lee la lista de buzones de correo.
imapAn IMAP\Connection instance.
reference
reference debería ser solo el servidor
en la forma descrita en imap_open()
El paso de datos no confiables a este parámetro es inseguro, a menos que imap.enable_insecure_rsh esté inhabilitado.
patternEspecifica donde en la jerarquía del buzón para empezar a buscar.
Hay dos caracteres especiales que se pueden
pasar como parte del pattern:
'*' y '%'.
'*' significa devolver todos los buzones. Si se pasa el
pattern como '*', se obtendrá
una lista de toda la jerarquía del buzón.
'%'
significa devolver sólo el nivel actual.
'%' como el parámetro pattern
devolverá solamente el nivel superior de los
buzones; '~/mail/%' en UW_IMAPD devolverá cada buzón en el directorio ~/mail, pero no en los subdirectorios de ese directorio.
Devuelve un array que contiene los nombres de los buzones de correo, o false en caso de error.
| Versión | Descripción |
|---|---|
| 8.1.0 |
The imap parameter expects an IMAP\Connection
instance now; previously, a valid imap recurso was expected.
|
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);
?>