imap_listscan

(PHP 4, PHP 5, PHP 7, PHP 8)

imap_listscanRetorna a lista de caixas de correio que correspondem ao texto fornecido

Descrição

imap_listscan(
    IMAP\Connection $imap,
    string $reference,
    string $pattern,
    string $content
): array|false

Retorna um array contendo os nomes das caixas de correio que têm content no texto da caixa de correio.

Esta função é semelhante a imap_listmailbox(), mas também verificará a presença da string content dentro dos dados da caixa de correio.

Parâmetros

imap

Uma instância de IMAP\Connection.

reference

reference normalmente deve ser apenas a especificação do servidor conforme descrito em imap_open()

Aviso

Passar 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. Se pattern for 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âmetro pattern retornará apenas as caixas de mensagem do nível mais alto; Passar '~/mail/%' em UW_IMAPD retornará todas as caixas de mensagem no diretório ~/mail, mas não retornará nenhuma nas subpastas deste diretório.

content

A string pesquisada

Valor Retornado

Retorna um array contendo os nomes das caixas de correio que têm content no texto da caixa de correio, 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() - Esta função retorna um array de mensagens que correspondem aos critérios de pesquisa fornecidos

adicione uma nota

Notas Enviadas por Usuários (em inglês)

Não há notas de usuários para esta página.
To Top