array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'fr', ), 'this' => array ( 0 => 'function.imap-delete.php', 1 => 'imap_delete', 2 => 'Marque le message pour l\'effacement, dans la boîte aux lettres courante', ), 'up' => array ( 0 => 'ref.imap.php', 1 => 'Fonctions IMAP', ), 'prev' => array ( 0 => 'function.imap-createmailbox.php', 1 => 'imap_createmailbox', ), 'next' => array ( 0 => 'function.imap-deletemailbox.php', 1 => 'imap_deletemailbox', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'fr', 'path' => 'reference/imap/functions/imap-delete.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

imap_delete

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

imap_delete — Marque le message pour l'effacement, dans la boîte aux lettres courante

Description

imap_delete(IMAP\Connection $imap, string $message_nums, int $flags = 0): true

Marque les messages message_nums pour l'effacement. L'effacement réel n'interviendra que lors de l'appel de la fonction imap_expunge() ou de imap_close() avec le paramètre optionnel CL_EXPUNGE.

Liste de paramètres

imap

Une instance de IMAP\Connection.

message_nums

Une chaîne de caractères représentant un ou plusieurs messages dans un style de format d'une séquence IMAP4 ("n", "n:m", ou une combinaison de ceci, délimité par des virgules).

flags

Il est possible de le définir à FT_UID qui demande à la fonction de traiter l'argument message_nums comme un UID.

Valeurs de retour

Retourne toujours true.

Erreurs / Exceptions

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

Historique

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

Exemples

Exemple #1 Exemple avec imap_delete()

<?php

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

$check = imap_mailboxmsginfo($mbox);
echo "Nombre de messages avant effacement : " . $check->Nmsgs . "<br />\n";

imap_delete($mbox, 1);

$check = imap_mailboxmsginfo($mbox);
echo "Nombre de messages après effacement : " . $check->Nmsgs . "<br />\n";

imap_expunge($mbox);

$check = imap_mailboxmsginfo($mbox);
echo "Nombre de messages après imap_expunge : " . $check->Nmsgs . "<br />\n";

imap_close($mbox);
?>

Notes

Note:

Les boîtes aux lettres IMAP n'ont pas les flags de leurs messages sauvegardés entre les connexions, aussi la fonction imap_expunge() doit être appelée pendant la même connexion pour que les messages marqués pour effacement soient réellement purgés.

Voir aussi