imap_close

(PHP 4, PHP 5, PHP 7)

imap_closeIMAP ストリームをクローズする

説明

imap_close ( resource $imap_stream [, int $flag = 0 ] ) : bool

IMAP ストリームをクローズします。

パラメータ

imap_stream

imap_open() が返す IMAP ストリーム。

flag

CL_EXPUNGE を指定した場合、メールボックスを閉じる前に暗黙のうちに 削除マークがついた全てのメッセージを削除します。 imap_expunge() を使用して、同じことを行うこともできます。

返り値

成功した場合に TRUE を、失敗した場合に FALSE を返します。

参考

  • imap_open() - メールボックスへの IMAP ストリームをオープンする