imap_close

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

imap_closeClose an IMAP stream

Descrição

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

Closes the imap stream.

Parâmetros

imap

Uma instância de 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()

Valor Retornado

Sempre retorna true.

Erros/Exceções

Throws a ValueError if flags is invalid.

Registro de Alterações

Versão Descrição
8.1.0 O parâmetro imap agora espera uma instância de IMAP\Connection; anteriormente, um resource imap válido era esperado.
8.0.0 A ValueError is now thrown on invalid flags parameter values. Previously, a warning was emitted and the function returned false.

Veja Também