imap_setflag_full

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

    imap_setflag_full — Setzt Nachrichtenflags

    Beschreibung

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

    Setzt die mit flag angegebenen Flags bei allen Nachrichten aus der Liste sequence.

    Parameter-Liste

    imap

    Eine IMAP\Connection-Instanz.

    sequence

    Eine Liste von Nachrichtennummern. Sie können die gewünschten Nachrichten mit Komma getrennt aufzählen (X,Y) oder alle Nachrichten in einem bestimmten Intervall mit X:Y auswählen.

    flag

    Die möglichen Flags, die gesetzt werden können, sind \Seen, \Answered, \Flagged, \Deleted und \Draft, wie in » RFC2060 definiert.

    options

    Eine Bitmaske mit Optionen, die zurzeit wird nur eine Option unterstützt:

    • ST_UID - Die Nachrichtenliste sequence enthält 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.

    Beispiele

    Beispiel #1 imap_setflag_full()-Beispiel

    <?php
    $mbox     = imap_open("{imap.example.org:143}", "username", "password")
    or die(    "Kann keine Verbindung aufbauen: " . imap_last_error());

    $status = imap_setflag_full($mbox, "2,5", "\\Seen \\Flagged");

    echo     gettype($status) . "\n";
    echo     $status . "\n";

    imap_close($mbox);
    ?>

    Siehe auch

    To Top