imap_clearflag_full

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

imap_clearflag_fullLöscht die Flags einer Nachricht

Beschreibung

imap_clearflag_full(
    IMAP\Connection$imap,
    string$sequence,
    string$flag,
    int$options = 0
): true

Diese Funktion bewirkt bei den mit sequence spezifizerten Nachrichten das Löschen der in flag angegebenen Flags.

Parameter-Liste

imap

Eine IMAP\Connection-Instanz.

sequence

Eine Reihe von Nachrichtennummern. Diese können als Aufzählung in der Form X,Y oder als Intervall in der Form X:Y angegeben werden.

flag

Die folgenden Flags werden unterstüzt: "\\Seen", "\\Answered", "\\Flagged", "\\Deleted" und "\\Draft" (siehe auch » RFC2060)

options

options ist eine Bitmaske und kann nur die folgende Option enthalten:

  • ST_UID - der Parameter sequence besteht aus UIDs anstelle von Nachrichtennummern.

Rückgabewerte

Gibt immer true zurück.

Fehler/Exceptions

Wenn options ungültig ist, wird ein ValueError geworfen.

Changelog

VersionBeschreibung
8.1.0 Der Parameter imap erwartet nun eine IMAP\Connection-Instanz; vorher wurde eine gültige imap-Ressource erwartet.
8.0.0 Bei ungültigen Parameterwerten von options wird nun ein ValueError geworfen; zuvor wurde eine Warnung ausgegeben und die Funktion gab false zurück.

Siehe auch

To Top