imap_delete
Mark a message for deletion from current mailbox
Description
true imap_delete(IMAP\Connection $imap
, string $message_nums
, int $flags
= 0)
Parameters
-
imap
-
An IMAP\Connection instance.
-
message_nums
-
A string representing one or more messages in IMAP4-style sequence format
("n"
, "n:m"
, or combination of these
delimited by commas).
-
flags
-
You can set the FT_UID
which tells the function
to treat the message_nums
argument as a
UID
.
Return Values
Always returns true
.
Errors/Exceptions
Throws a ValueError if flags
is invalid.
Examples
Example #1 imap_delete example
<?php
$mbox = imap_open("{imap.example.org}INBOX", "username", "password")
or die("Can't connect: " . imap_last_error());
$check = imap_mailboxmsginfo($mbox);
echo "Messages before delete: " . $check->Nmsgs . "<br />\n";
imap_delete($mbox, 1);
$check = imap_mailboxmsginfo($mbox);
echo "Messages after delete: " . $check->Nmsgs . "<br />\n";
imap_expunge($mbox);
$check = imap_mailboxmsginfo($mbox);
echo "Messages after expunge: " . $check->Nmsgs . "<br />\n";
imap_close($mbox);
?>
Notes
Note:
IMAP mailboxes may not have their message flags saved between connections,
so imap_expunge should be called during the same
connection in order to guarantee that messages marked for deletion will
actually be purged.
See Also
- imap_undelete
- imap_expunge
- imap_close