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

Una instancia de IMAP\Connection.

reference

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

Advertencia

Pasar datos no confiables a este parámetro es inseguro, a menos que imap.enable_insecure_rsh esté desactivado.

pattern

Especifica en qué parte de la jerarquía del buzón comenzar la búsqueda.

Hay dos caracteres especiales que se pueden pasar como parte del pattern: '*' y '%'. '*' significa devolver todos los buzones. Si se pasa pattern como '*', se obtendrá una lista de toda la jerarquía del buzón. '%' significa devolver solo el nivel actual. '%' como parámetro pattern devolverá solo los buzones de nivel superior; '~/mail/%' en UW_IMAPD devolverá cada buzón en el directorio ~/mail, pero ninguno en las subcarpetas de ese directorio.

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 El parámetro imap ahora espera una instancia de IMAP\Connection; anteriormente, se esperaba un resource imap válido.

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

add a note

User Contributed Notes 2 notes

up
5
Anonymous
6 years ago
use 
echo mb_convert_encoding($val, "utf-8", "UTF7-IMAP");
for cyrrilic folder names
up
2
c6h1206free at gmail dot com
17 years ago
imap_list returns a simple array of strings that look just like the $ref parameter one needs to specify:

<?php

  $srv = '{imap.example.com}';

  $conn = imap_open($srv, 'me', 'mypass');

  $boxes = imap_list($conn, $srv, '*');

  print_r($boxes);
  imap_close($conn);
?>

Output:

<pre>
Array
(
    [0] => {imap.example.com}Calendar
    [1] => {imap.example.com}Contacts
    [2] => {imap.example.com}Deleted Items
    [3] => {imap.example.com}Drafts
    [4] => {imap.example.com}Journal
    [5] => {imap.example.com}Junk E-mail
    [6] => {imap.example.com}Notes
    [7] => {imap.example.com}Outbox
    [8] => {imap.example.com}RSS Feeds
    [9] => {imap.example.com}Sent Items  
    [10] => {imap.example.com}Tasks
)
</pre>

These directly fill in the $ref argument for every function that takes one.
To Top