imap_delete
(PHP 4, PHP 5, PHP 7)
imap_delete — Mark a message for deletion from current mailbox
说明
imap_delete (
resource
$imap_stream ,
int $msg_number [,
int $options = 0 ] ) :
bool
Marks messages listed in msg_number for deletion. Messages marked for deletion will stay in the mailbox until either imap_expunge() is called or imap_close() is called with the optional parameter CL_EXPUNGE.
参数
-
imap_stream -
由 imap_open() 返回的 IMAP 流。
-
msg_number -
The message number
-
options -
You can set the
FT_UIDwhich tells the function to treat themsg_numberargument as an UID.
返回值
Returns TRUE.
范例
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);
?>
注释
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.
参见
- imap_undelete() - Unmark the message which is marked deleted
- imap_expunge() - Delete all messages marked for deletion
- imap_close() - Close an IMAP stream
