imap_sort

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

imap_sortObtém e classifica mensagens

Descrição

imap_sort(
    IMAP\Connection $imap,
    int $criteria,
    bool $reverse,
    int $flags = 0,
    ?string $search_criteria = null,
    ?string $charset = null
): array|false

Obtém e classifica números de mensagens pelos parâmetros fornecidos.

Parâmetros

imap

Uma instância de IMAP\Connection.

criteria

Os critérios podem ser um (e somente um) dos seguintes:

  • SORTDATE - data da mensagem
  • SORTARRIVAL - data de chegada
  • SORTFROM - caixa de correio no primeiro endereço de "From"
  • SORTSUBJECT - assunto da mensagem
  • SORTTO - caixa de correio no primeiro endereço de "To"
  • SORTCC - caixa de correio no primeiro endereço de "Cc"
  • SORTSIZE - tamanho da mensagem em octetos

reverse

Informa se a classificação deve ser feita na ordem inversa.

flags

The flags é uma máscara de bits de uma ou mais das seguintes constantes:

  • SE_UID - Retorna UIDs em vez de números de sequência
  • SE_NOPREFETCH - Não pré-busca mensagens pesquisadas

search_criteria

String de critérios de pesquisa no formato IMAP2. Para detalhes, veja imap_search().

charset

Conjunto de caracteres MIME a ser usado ao classificar strings.

Valor Retornado

Retorna um array de números de mensagens classificadas pelos parâmetros fornecidos, 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.
8.0.0 reverse agora é bool em vez de int.
8.0.0 search_criteria e charset agora são nullable.