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 -
Uma instância de IMAP\Connection.
-
reference -
referenceshould normally be just the server specification as described in imap_open()AvisoPassar dados não confiáveis para este parâmetro é inseguro, a menos que imap.enable_insecure_rsh esteja desabilitado.
-
pattern -
Especifica onde iniciar a pesquisa na hierarquia da caixa de mensagem.
Existem dois caracteres especiais que podem ser passados como parte do parâmetro
pattern: '*' e '%'. '*' significa retornar todas as caixas de mensagem. Sepatternfor passado como '*', será retornada uma lista de toda a hierarquia da caixa de mensagem. '%' significa retornar apenas o nível atual. Passar '%' como o parâmetropatternretornará apenas as caixas de mensagem do nível mais alto; Passar '~/mail/%' emUW_IMAPDretornará todas as caixas de mensagem no diretório ~/mail, mas não retornará nenhuma nas subpastas deste diretório.
Valor Retornado
Returns an array of all the subscribed mailboxes, ou false em caso de falha.
Registro de Alterações
| Versão | Descrição |
|---|---|
| 8.1.0 |
O parâmetro imap agora espera uma instância de IMAP\Connection;
anteriormente, um resource imap válido era esperado.
|
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
