imap_delete

(PHP 4, PHP 5, PHP 7)

imap_delete — Marcar un mensaje para su borrado del buzón actual

Descripción

imap_delete ( resource $imap_stream , int $msg_number [, int $options = 0 ] ) : bool

Marca los mensajes listados en msg_number para su eliminación. Los mensajes marcados para eliminar permanecerán en el buzón hasta que se llame imap_expunge() o imap_close() con el parámetro opcional CL_EXPUNGE.

Parámetros

imap_stream

IMAP stream devuelto por imap_open().

msg_number

El número de mensaje

options

Es posible usar el valor FT_UID que indica que la función debe tratar el argumento msg_number como un UID.

Valores devueltos

Devuelve TRUE.

Ejemplos

Ejemplo #1 Ejemplo de imap_delete()

<?php

$buzon = imap_open("{imap.example.org}INBOX", "usuario", "contraseña")
    or die("No es posible conectarse: " . imap_last_error());

$chequeo = imap_mailboxmsginfo($buzon);
echo "Mensajes antes de borrar: " . $chequeo->Nmsgs . "<br />\n";

imap_delete($buzon, 1);

$chequeo = imap_mailboxmsginfo($buzon);
echo "Mensajes después de borrar: " . $chequeo->Nmsgs . "<br />\n";

imap_expunge($buzon);

$chequeo = imap_mailboxmsginfo($buzon);
echo "Mensajes después de purgar: " . $chequeo->Nmsgs . "<br />\n";

imap_close($buzon);
?>

Notas

Nota:

los buzones IMAP quizá no guardan el estado de sus mensajes entre conexiones, así que imap_expunge() debe llamarse durante la misma conexión para garantizar que los mensajes marcados para eliminación sean realmente borrados.

Ver también