imap_lsub
(PHP 4, PHP 5)
imap_lsub — List all the subscribed mailboxes
Descrição
$imap_stream
, string $ref
, string $pattern
)Gets an array of all the mailboxes that you have subscribed.
Parâmetros
-
imap_stream -
Um stream IMAP retornado por imap_open().
-
ref -
refshould normally be just the server specification as described in imap_open() -
pattern -
Especifica aonde na hierarquia da caixa de mensagens deve começar a procura.
Existem dois caracteres especiais que você pode passar como parte para o
pattern: '*' e '%'. '*' significa retornar todas as caixas de mensagens. Se você passarpatterncomo '*', você terá uma lista de toda a hierarquia da caixa de mensagens. '%' significa retornar o nível atual apenas. '%' como o parâmetropatternira retornar apenas as caixar de mensagem do nível superior; '~/mail/%' em UW_IMAPD irá retornar cada caixa de mensagem no diretório ~/mail, mais nenhuma em subpastas deste diretório.
Valor Retornado
Returns an array of all the subscribed mailboxes.
Veja Também
- imap_list() - Read the list of mailboxes
- imap_getmailboxes() - Read the list of mailboxes, returning detailed information on each one