imap_clearflag_full

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

    imap_clearflag_full — Clears flags on messages

    Descripción

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

    This function causes a store to delete the specified flag to the flags set for the messages in the specified sequence.

    Parámetros

    imap

    An IMAP\Connection instance.

    sequence

    A sequence of message numbers. You can enumerate desired messages with the X,Y syntax, or retrieve all messages within an interval with the X:Y syntax

    flag

    The flags which you can unset are "\\Seen", "\\Answered", "\\Flagged", "\\Deleted", and "\\Draft" (as defined by » RFC2060)

    options

    options are a bit mask and may contain the single option:

    • ST_UID - The sequence argument contains UIDs instead of sequence numbers

    Valores devueltos

    Siempre devuelve true.

    Errores/Excepciones

    Throws a ValueError if options is invalid.

    Historial de cambios

    Versión Descripción
    8.1.0 The imap parameter expects an IMAP\Connection instance now; previously, a valid imap recurso was expected.
    8.0.0 A ValueError is now thrown on invalid options parameter values. Previously, a warning was emitted and the function returned false.

    Ver también

    Improve This Page

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes

    There are no user contributed notes for this page.
    To Top