imap_lsub
(PHP 4, PHP 5, PHP 7, PHP 8)
imap_lsub — List all the subscribed mailboxes
Descrição
Gets an array of all the mailboxes that you have subscribed.
Parâmetros
-
imap -
An IMAP\Connection instance.
-
reference -
referenceshould normally be just the server specification as described in imap_open()AvisoPassing untrusted data to this parameter is insecure, unless imap.enable_insecure_rsh is disabled.
-
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/%' emUW_IMAPDirá 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, ou false em caso de falha.
Changelog
| Versão | Descrição |
|---|---|
| 8.1.0 |
The imap parameter expects an IMAP\Connection
instance now; previously, a resource was expected.
|
Veja Também
- imap_list() - Read the list of mailboxes
- imap_getmailboxes() - Read the list of mailboxes, returning detailed information on each one
add a note
