Documentación offline PHP master

imap_clearflag_full

master Ver versión oficial en línea Licencia CC-BY-3.0Descargado el 2026-08-02

En esta página

imap_clearflag_full

Elimina un flag en un mensaje

Descripción#

php imap_clearflag_full(IMAP\Connection $imap, string $sequence, string $flag, [int $options]): truephp

imap_clearflag_full borra el flag flag en los mensajes de la secuencia sequence, del flujo imap stream.

Parámetros#

imap
Una instancia de IMAP\Connection.

sequence
Una secuencia de números de mensajes. Se pueden enumerar los mensajes deseados con la sintaxis X,Y, o recuperar todos los mensajes contenidos en un intervalo, con la sintaxis X:Y

flag
Los flags flag que se pueden borrar son "\Seen", "\Answered", "\Flagged", "\Deleted" y "\Draft" (tal como se definen en la RFC2060)

options
options es una máscara de bits, que acepta únicamente el siguiente valor:

  • ST_UID - la secuencia contiene UID en lugar de números de secuencia

Valores devueltos#

Retorna siempre true.

Errores/Excepciones#

Lanza una excepción ValueError si el argumento options es inválido.

Historial de cambios#

Versión Descripción
8.1.0 El parámetro imap ahora espera una instancia de IMAP\Connection ; anteriormente, se esperaba un resource imap válido.
8.0.0 Una excepción ValueError es ahora lanzada para valores inválidos del argumento options. Anteriormente, se emitía una advertencia y la función devolvía false.

Véase también#

imap_setflag_full