imap_delete
(PHP 3, PHP 4, PHP 5)
imap_delete --
現在のメールボックスから削除するメッセージに印を付ける
説明
bool
imap_delete ( int imap_stream, int msg_number [, int options] )
Returns TRUE.
imap_delete() 関数は、
msg_number が指すメッセージに削除予定の
マークをします。オブションのパラメータ flags
で指定可能なオプションは FT_UID のみです。
このオプションは、引数 msg_number を
UID として処理することを関数に指示します。
削除マークを付けられたメッセージは、
imap_expunge() がコールされるか
imap_close() に CL_EXPUNGE を付けてコールされるか
のどちらかが行われるまでメールボックスに残ったままになります。
注意:
POP3 メールボックスは、コネクション間で保存可能なメッセージフラグを
持っていません。そのため、削除マークをつけたメッセージを本当に削除する
ためには、同一の接続内で imap_expunge() をコールする
必要があります。
例 1. imap_delete() の例
<?php
$mbox = imap_open("{imap.example.org}INBOX", "username", "password")
or die("接続できません: " . 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_undelete()、
imap_expunge() および
imap_close() も参照ください。