imap_close

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

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

説明

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

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

パラメータ

imap

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

flags

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

戻り値

成功した場合に true を、失敗した場合に false を返します。

変更履歴

バージョン 説明
8.1.0 引数 imap は、IMAP\Connection クラスのインスタンスを期待するようになりました。 これより前のバージョンでは、リソース が期待されていました。

参考

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

関連キーワード:  ストリーム, クローズ, Connection, クラス, 期待, バージョン, メールボックス, インスタンス, 削除, flags