imap_setflag_full

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

imap_setflag_fullEstablece un flag en un mensaje

Descripción

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

imap_setflag_full() asigna el flag especificado a los mensajes de la sequence dada.

Parámetros

imap

An IMAP\Connection instance.

sequence

Una secuencia de números de mensajes. Los mensajes deseados pueden ser enumerados con la sintaxis X,Y, o recuperar todos los mensajes de un intervalo con la sintaxis X:Y

flag

Los flags que pueden ser modificados son \Seen, \Answered, \Flagged, \Deleted, y \Draft (como se define 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

Siempre devuelve 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 The imap parameter expects an IMAP\Connection instance now; previously, a valid imap recurso was expected.
8.0.0 Una excepción ValueError es ahora lanzada para valores de argumento options inválidos. Anteriormente, se emitía una advertencia y la función devolvía false.

Ejemplos

Ejemplo #1 Ejemplo con imap_setflag_full()

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

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

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

imap_close($mbox);
?>

Ver también