array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'ja', ), 'this' => array ( 0 => 'function.imap-close.php', 1 => 'imap_close', 2 => 'IMAP ストリームをクローズする', ), 'up' => array ( 0 => 'ref.imap.php', 1 => 'IMAP 関数', ), 'prev' => array ( 0 => 'function.imap-clearflag-full.php', 1 => 'imap_clearflag_full', ), 'next' => array ( 0 => 'function.imap-create.php', 1 => 'imap_create', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'ja', 'path' => 'reference/imap/functions/imap-close.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

imap_close

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

imap_close — IMAP ストリームをクローズする

説明

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 resource が期待されていました。
8.0.0 flags が無効な値の場合、 ValueError がスローされるようになりました。 これより前のバージョンでは、 警告が発生し、false を返していました。

参考