imap_delete

(PHP3 , PHP4 )

imap_delete --  現在のメールボックスから削除するメッセージに印を付ける

説明

int imap_delete (int imap_stream, int msg_number [, int flags])

trueを返します。

imap_delete() 関数は、msg_number が指す削除する予定のメッセージをマークします。 オブションのパラメータflagsで指定可能な オプションはFT_UIDのみです。 このオプションは、引数msg_numberUIDとして処理することを関数に指定します。 削除マークを付けられたメッセージは、imap_expunge() がコールされるかimap_close()にCL_EXPUNGE を付けてコールされるかのどちらかが行われるまでメールボックス に残ったままになります。

例 1. imap_delete()の例


$mbox = imap_open ("{your.imap.host}INBOX", "username", "password")
    || die ("can't connect: " . imap_last_error());

$check = imap_mailboxmsginfo ($mbox);
print "Messages before delete: " . $check->Nmsgs . "<br>\n" ;
imap_delete ($mbox, 1);
$check = imap_mailboxmsginfo ($mbox);
print "Messages after  delete: " . $check->Nmsgs . "<br>\n" ;
imap_expunge ($mbox);
$check = imap_mailboxmsginfo ($mbox);
print "Messages after expunge: " . $check->Nmsgs . "<br>\n" ;
imap_close ($mbox);