imap_delete
(PHP 4, PHP 5, PHP 7, PHP 8)
imap_delete — Mark a message for deletion from current mailbox
說明
$imap, string $message_nums, int $flags = 0): bool Marks messages listed in message_nums 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 IMAP\Connection 實例。
-
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_UIDwhich tells the function to treat themessage_numsargument as aUID.
返回值
Returns true.
更新日誌
| 版本 | 說明 |
|---|---|
| 8.1.0 | 現在 imap 參數接受 IMAP\Connection 實例，之前接受 資源(resource)。 |
範例
示例 #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);
?> 註釋
注意:
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