imap_listscan

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

imap_listscanLee la lista de buzones de correo y busca una cadena

Descripción

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

Devuelve un array que contiene los nombres de los buzones de correo que contienen el string content en su nombre.

Esta función es similar a imap_listmailbox(), pero también verifica la presencia del string content en los mensajes del buzón de correo.

Parámetros

imap

An IMAP\Connection instance.

reference

reference debe ser solo el servidor en la forma descrita en imap_open()

Advertencia

El paso de datos no confiables a este parámetro es inseguro, a menos que imap.enable_insecure_rsh esté inhabilitado.

pattern

Especifica 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.

content

El string buscado

Valores devueltos

Devuelve un array que contiene los nombres de los buzones de correo que contienen el string content en el nombre del buzón de correo, o false en caso de error.

Historial de cambios

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

Ver también

add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top