imap_setflag_full

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

    imap_setflag_full — Positionne un drapeau sur un message

    Description

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

    imap_setflag_full() affecte le flag spécifié aux messages de la sequence donnée.

    Liste de paramètres

    imap

    Une instance de IMAP\Connection.

    sequence

    Une séquence de numéro de messages. Vous pouvez énumérer les messages désirés avec la syntaxe X,Y, ou récupérer tous les messages d'un intervalle avec la syntaxe X:Y

    flag

    Les flags que vous pouvez modifier sont \Seen, \Answered, \Flagged, \Deleted, et \Draft (comme défini dans la » RFC2060).

    options

    options est un masque de bits, qui accepte uniquement la valeur suivante :

    • ST_UID - la séquence contient des UID au lieu de numéros de séquence.

    Valeurs de retour

    Retourne toujours true.

    Erreurs / Exceptions

    Lance une exception ValueError si le paramètre options est invalide.

    Historique

    VersionDescription
    8.1.0 La paramètre imap attend désormais une instance de IMAP\Connection ; auparavant, une ressourceimap était attendue.
    8.0.0 Une exception ValueError est désormais lancée pour des valeurs de paramètre options invalides. Auparavant, un avertissement était émis et la fonction retournait false.

    Exemples

    Exemple #1 Exemple avec imap_setflag_full()

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

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

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

    imap_close($mbox);
    ?>

    Voir aussi

    To Top