imap_sort

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

imap_sort — Liefert und sortiert Nachrichten eines Postfachs

Beschreibung

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

Gibt eine gemäß den angegebenen Sortierkriterien sortierte Liste von Nachrichtennummern zurück.

Parameter-Liste

imap

Eine IMAP\Connection-Instanz.

criteria

Nur eines der folgenden Sortierkriterien:

SORTDATE - das Sendedatum
SORTARRIVAL - das Eingangsdatum
SORTFROM - die erste Absenderadresse
SORTSUBJECT - der Betreff
SORTTO - die erste Empfängeradresse
SORTCC - die erste CC-Empfängeradresse
SORTSIZE - die Größe der Nachricht in Bytes

reverse

Sortierung in umgekehrter Reihenfolge, wenn true

flags

Der Parameter flags enthält eine Bitmaske mit einem oder mehreren der folgenden Werte:

SE_UID - es werden UIDs anstelle von Nachrichtennummern zurückgegeben
SE_NOPREFETCH - Nachrichten werden nicht auf Vorrat abgerufen

search_criteria

Ein String mit Suchkriterien im IMAP2-Format. Details können imap_search() entnommen werden.

charset

Der zum Sortieren von Strings zu verwendende MIME-Zeichensatz.

Rückgabewerte

Gibt ein Array mit Nachrichtennummern zurück, die nach den angegebenen Sortierkriterien sortiert sind. Bei einem Fehler wird false zurückgegeben.

Changelog

Version	Beschreibung
8.1.0	Der Parameter `imap` erwartet nun eine IMAP\Connection-Instanz; vorher wurde eine gültige `imap`-Ressource erwartet.
8.0.0	`reverse` ist nun vom Typ bool statt int.
8.0.0	`search_criteria` und `charset` sind nun nullable (akzeptieren den (`null`-Wert).