imap_listscan

(PHP 4, PHP 5)

imap_listscan — Devuelve la lista de buzones que coinciden con el texto dado

Descripción

array imap_listscan ( resource $imap_stream , string $ref , string $pattern , string $content )

Devuelve un array que contiene los nombres de los buzones que tienen el contenido dado por content en el texto del buzón.

Esta función es similar a imap_listmailbox(), excepto que verificará además la presencia de la cadena content dentro de la información del buzón.

Parámetros

imap_stream

IMAP stream devuelto por imap_open().

ref

ref normalmente debería ser la especificación del servidor como está descrita en imap_open()

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

La cadena buscada

Valores devueltos

Devuelve un array que contiene los nombres de los buzones que tienen el contenido dado por content en el texto del buzón.

Ver también