imap_close

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

imap_closeClose an IMAP stream

说明

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

Closes the imap stream.

参数

imap

IMAP\Connection 实例。

flags

If set to CL_EXPUNGE, the function will silently expunge the mailbox before closing, removing all messages marked for deletion. You can achieve the same thing by using imap_expunge()

返回值

总是返回 true

错误/异常

Throws a ValueError if flags is invalid.

更新日志

版本 说明
8.1.0 现在 imap 参数接受 IMAP\Connection 实例,之前接受有效的 imap resource
8.0.0 A ValueError is now thrown on invalid flags parameter values. Previously, a warning was emitted and the function returned false.

参见