imap_sort

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

imap_sortTrie des messages

Description

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

Récupère et trie les numéros de messages en fonction des paramètres donnés.

Liste de paramètres

imap

Une instance de IMAP\Connection.

criteria

Les critères criteria peuvent être un (et un seul) parmi les suivants :

  • SORTDATE : date du message
  • SORTARRIVAL : date d'arrivée
  • SORTFROM : nom de la première boîte aux lettres de l'adresse d'origine (From address)
  • SORTSUBJECT : sujet du message
  • SORTTO : nom de la première boîte aux lettres de destination (To address)
  • SORTCC : nom de la boîte aux lettres de copie cachée (cc address)
  • SORTSIZE : taille du message en octets
reverse

S'il faut trier en ordre inverse.

flags

Les flags dont des masques de bits, d'un ou plusieurs des éléments suivants :

  • SE_UID : retourne des UID à la place de numéros
  • SE_NOPREFETCH : ne pas prétélécharger les messages trouvés
search_criteria

Critères de recherche IMAP2-format. Pour plus de détails voir imap_search().

charset

Jeu de caractères MIME à utiliser lors de la recherche de chaîne de caractères.

Valeurs de retour

Retourne un tableau de numéros de messages triés en fonction des paramètres fournis, ou false si une erreur survient.

Historique

VersionDescription
8.1.0 La paramètre imap attend désormais une instance de IMAP\Connection ; auparavant, une ressourceimap était attendue.
8.0.0reverse est un bool au lieu de int.
8.0.0search_criteria et charset sont désormais nullable.
To Top