imap_listscan
(PHP 4, PHP 5, PHP 7, PHP 8)
imap_listscan — Returns the list of mailboxes that matches the given text
Descrição
IMAP\Connection
$imap,string
$reference,string
$pattern,string
$content): array|false
Returns an array containing the names of the mailboxes that have
content in the text of the mailbox.
This function is similar to imap_listmailbox(),
but it will additionally check for the presence of the string
content inside the mailbox data.
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. -
content -
The searched string
Valor Retornado
Returns an array containing the names of the mailboxes that have
content in the text of the mailbox, 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_listmailbox() - Sinônimo de imap_list
- imap_search() - This function returns an array of messages matching the given search criteria
add a note
