imap_close

(PHP 4, PHP 5, PHP 7, PHP 8)

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

説明

imap_close(IMAP\Connection $imap, int $flags = 0): true

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

パラメータ

imap

IMAP\Connection クラスのインスタンス。

flags

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

戻り値

常に true を返します。

エラー / 例外

flags が無効な場合、 ValueError がスローされます。

変更履歴

バージョン 説明
8.1.0 引数 imap は、IMAP\Connection クラスのインスタンスを期待するようになりました。 これより前のバージョンでは、有効な imap リソース が期待されていました。
8.0.0 flags が無効な値の場合、 ValueError がスローされるようになりました。 これより前のバージョンでは、 警告が発生し、false を返していました。

参考

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

add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top