IMAP_DELETE(3) 1 IMAP_DELETE(3)
imap_delete - Mark a message for deletion from current mailbox
SYNOPSIS
bool imap_delete (resource $imap_stream, int $msg_number, [int $options])
DESCRIPTION
Marks messages listed in $msg_number for deletion. Messages marked for deletion will stay in the mailbox until either imap_expunge(3) is
called or imap_close(3) is called with the optional parameter CL_EXPUNGE.
PARAMETERS
o $
imap_stream -An IMAP stream returned by imap_open(3).
o $msg_number
- The message number
o $options
- You can set the FT_UID which tells the function to treat the $msg_number argument as an UID.
RETURN VALUES
Returns TRUE.
EXAMPLES
Example #1
imap_delete(3) 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 />
";
imap_delete($mbox, 1);
$check = imap_mailboxmsginfo($mbox);
echo "Messages after delete: " . $check->Nmsgs . "<br />
";
imap_expunge($mbox);
$check = imap_mailboxmsginfo($mbox);
echo "Messages after expunge: " . $check->Nmsgs . "<br />
";
imap_close($mbox);
?>
NOTES
Note
IMAP mailboxes may not have their message flags saved between connections, so imap_expunge(3) should be called during the same con-
nection in order to guarantee that messages marked for deletion will actually be purged.
SEE ALSO
imap_undelete(3), imap_expunge(3), imap_close(3).
PHP Documentation Group IMAP_DELETE(3)
